--- title: "Data Match" description: "Confere se um nome bate com os dados de um cadastro (documento, celular, CEP, número do endereço, e-mail e data de nascimento) e devolve as pessoas que casam, com a evidência de cada casamento. Cobrada quando a base devolve ao menos um casamento, um descarte ou um vínculo de cartão; dado inválido é recusado sem cobrança." lang: pt-BR canonical: https://doc.apibrasil.io/apis/creditos/12c405a2-ddd0-11f1-98bb-bc24118aba26 markdown: https://doc.apibrasil.io/apis/creditos/12c405a2-ddd0-11f1-98bb-bc24118aba26.md source: apibrasil-documentation --- # Data Match > Confere se um nome bate com os dados de um cadastro (documento, celular, CEP, número do endereço, e-mail e data de nascimento) e devolve as pessoas que casam, com a evidência de cada casamento. Cobrada quando a base devolve ao menos um casamento, um descarte ou um vínculo de cartão; dado inválido é recusado sem cobrança. - **Categoria:** Antifraude e Compliance - **Cobrança:** por consulta, só com o Bearer Token - **Preço:** R$ 0,79 por consulta - **Limite:** 990.000 por mês - **Cadastro:** exige CNPJ - **Versão:** v2 - **Publicada por:** APIBrasil - **Especificação OpenAPI:** https://doc.apibrasil.io/apis/creditos/12c405a2-ddd0-11f1-98bb-bc24118aba26/openapi.json ## Como chamar **Endereço base:** `https://gateway.apibrasil.io/api/v2` Autenticação: cabeçalho `Authorization: Bearer `. Nada além disso. Com `homolog: true` no corpo, o gateway responde de uma base fixa, com a forma real da resposta, e não cobra. O CPF 00000000000 é dessa base e não é de ninguém: use-o nos testes, nunca em produção. ## Endpoints (1 endpoint) ### 1. POST /consulta/data-match/credits ⚠️ Aviso: a consulta é cobrada quando a base devolve ao menos um casamento, um descarte ou um vínculo de cartão. Envie um POST com tipo=data-match e o nome a conferir (o do titular do cartão, por exemplo). Os dados do cadastro são opcionais e só os enviados são comparados: documento (CPF ou CNPJ), telefone (celular com DDD e o 9, 11 dígitos), cep, numero (do endereço), email e data_nascimento. O email é comparado em minúsculas e sem os caracteres que não cabem num endereço (acento, espaço), que são removidos antes da consulta. Número de cartão, IP e dados da transação não são aceitos. O campo data traz o nome consultado, dados_cadastro_site (o cadastro informado), matches (pessoas que casam, com tipos_match e a evidência), no_matches e cartoes_vinculados_ao_nome (só prefixo e sufixo). Nome ou dado do cadastro inválido é recusado com HTTP 400, sem cobrança; nome sem casamento na base devolve HTTP 404, sem cobrança. Base de dados indisponível devolve HTTP 502, 503 ou 504, sem cobrança. Em homologação (homolog=true), sem cobrança e com qualquer nome válido, a resposta traz dados fictícios. - **Método:** `POST` - **Endereço:** `https://gateway.apibrasil.io/api/v2/consulta/data-match/credits` - **Versão da rota:** v2 **Cabeçalhos** | Cabeçalho | Valor | | --- | --- | | `Content-Type` | `application/json` | | `Authorization` | `Bearer $APIBRASIL_TOKEN` | **Corpo da requisição** ```json { "tipo": "data-match", "nome": "João da Silva", "documento": "123.456.789-09", "telefone": "(11) 99999-8888", "cep": "80010-000", "numero": "1500", "email": "fulano@exemplo.com.br", "data_nascimento": "10/03/1995", "homolog": true } ``` **Em cURL** ```bash curl -X POST "https://gateway.apibrasil.io/api/v2/consulta/data-match/credits" \ -H "Content-Type: application/json" \ -H "Authorization: Bearer $APIBRASIL_TOKEN" \ -d '{"tipo":"data-match","nome":"João da Silva","documento":"123.456.789-09","telefone":"(11) 99999-8888","cep":"80010-000","numero":"1500","email":"fulano@exemplo.com.br","data_nascimento":"10/03/1995","homolog":true}' ``` Este endpoint aceita `homolog: true` no corpo: a resposta volta com dados válidos, `api_limit_for` igual a `homolog` e sem tarifação. **Resposta de exemplo, do catálogo** ```json { "user": { "first_name": "[omitido]", "email": "[omitido]", "cellphone": "[omitido]", "notification": "yes" }, "balance": "399,210", "balance_before": "400,000", "tax": "0,790", "status_code": 200, "error": false, "message": "Dados validos! Voce foi tarifado em R$ 0,79.", "valor_consulta": 0.79, "api_limit_for": "credit", "homolog": false, "data": { "busca_indice_relacionamento_mercado": "NAO", "cartoes_vinculados_ao_nome": [ { "cartao_prefixo": "000000", "cartao_sufixo": "0000" } ], "dados_cadastro_site": { "cpf_cnpj": "00000000000", "cpf_cnpj_completo": "", "data_nascimento": "1990-01-01", "data_situacao_receita": "1990-01-01 00:00:00", "idade": "00", "menor_idade": { "chave": "18", "existe_menor": "NAO", "faixa_etaria": "MAIOR 18", "mensagem": "" }, "nome": "NOME FICTICIO", "numero_cartao": "", "obito": "", "pessoa": "FISICA", "relacionamento_com_mercado": "", "sexo": "MASCULINO", "situacao_receita": "REGULAR", "uf": "PR" }, "features": {}, "matches": [ { "cidade": "CIDADE FICTICIA", "cpf_cnpj": "00000000000", "cpf_cnpj_completo": "", "data_situacao_receita": "1990-01-01 00:00:00", "idade": "00", "menor_idade": { "chave": "18", "existe_menor": "NAO", "faixa_etaria": "MAIOR 18", "mensagem": "" }, "nascimento": "1990-01-01", "nome": "NOME FICTICIO DOIS", "numero_cartao": "", "obito": "", "pessoa": "FISICA", "relacionamento_com_mercado": "", "sexo": "MASCULINO", "situacao_receita": "REGULAR", "tipos_match": [ { "evidencia": "O documento informado na Loja (00000000000) é o mesmo do titular do Cartão.", "natureza_match": "CL", "tipo": "mesma_pessoa", "titulo": "Mesma pessoa" } ], "uf": "PR" } ], "no_matches": [], "nome": "JOAO DA SILVA", "nomes_vinculados_ao_cartao": [] } } ``` Nos exemplos de resposta, os campos da conta que gerou o exemplo (`user.first_name`, `user.email`, `user.cellphone`) saem como `[omitido]`. O resto é o que o catálogo publica. ## Armadilhas: o que uma integração erra sem avisar Apuradas nas respostas que o próprio catálogo publica. Em todas elas o código funciona no caminho feliz e falha em silêncio no resto: 1. **O erro chega no CORPO, com HTTP 200.** A resposta traz um campo `error` booleano e uma `message`. Checar só `response.ok` ou o status HTTP deixa passar falha como sucesso. Confira SEMPRE `error === false` antes de ler `data`. 2. **`balance`, `tax` e `extra_charges.total` são STRING em formato brasileiro — e o formato varia entre APIs.** Valores observados no catálogo: `"154,380"`, `"497,84"`, `"0,000"` e `"0.19"`. Vírgula em umas, ponto em outra; três casas decimais em umas, duas em outra. Em JavaScript, `parseFloat("154,380")` devolve `154` e perde os centavos sem erro nenhum, e `Number("154,380")` devolve `NaN`. Escreva um conversor que trate os dois separadores, e nunca use esses campos numa decisão financeira sem convertê-los. 3. **Cada chamada custa dinheiro.** Retry cego multiplica a conta. Nunca repita automaticamente um 4xx: parâmetro errado repetido continua errado e continua cobrando. Repita só tempo esgotado e 5xx, com recuo exponencial e um teto pequeno de tentativas. 4. **HTTP 402 é saldo insuficiente, e repetir não resolve.** É o único status que exige ação humana — recarregar. Trate-o como erro terminal, com mensagem própria, e não o jogue no mesmo balde dos 4xx genéricos. 5. **`extra_charges` cobra à parte do preço da consulta.** Quando o corpo pede serviços adicionais, a resposta traz cada um com o preço e um `total` que NÃO está incluso no valor base. Se você mostra custo a quem usa, some os dois. ## Ver também - Especificação OpenAPI: https://doc.apibrasil.io/apis/creditos/12c405a2-ddd0-11f1-98bb-bc24118aba26/openapi.json - Catálogo de APIs: [Catálogo de APIs](https://doc.apibrasil.io/apis.md) - SDKs oficiais: [SDKs oficiais](https://doc.apibrasil.io/sdks.md) - Índice da documentação: https://doc.apibrasil.io/llms.txt - Versão HTML desta página: https://doc.apibrasil.io/apis/creditos/12c405a2-ddd0-11f1-98bb-bc24118aba26