--- title: "Similaridade de Dados Brasil" description: "API Similaridade de Dados Brasil" lang: pt-BR canonical: https://doc.apibrasil.io/apis/creditos/7cfdcc0d-1416-47fc-adaf-87d1f7563e4d markdown: https://doc.apibrasil.io/apis/creditos/7cfdcc0d-1416-47fc-adaf-87d1f7563e4d.md source: apibrasil-documentation --- # Similaridade de Dados Brasil > API Similaridade de Dados Brasil - **Categoria:** Antifraude e Compliance - **Cobrança:** por consulta, só com o Bearer Token - **Preço:** R$ 1,58 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/7cfdcc0d-1416-47fc-adaf-87d1f7563e4d/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/cpf/credits Envie um POST com tipo=similaridade-brasil e o cpf (11 dígitos, com ou sem máscara; o dígito verificador é conferido) ou, sem o cpf, nome, sobrenome e data_nascimento; opcionalmente endereco, cidade, estado (UF), cep e telefone para comparar mais dados. A resposta vem em data.dados e traz campos_comparados (quantidade de campos comparados), um bloco para cada campo informado ({informado, distancia, descricao}: o valor enviado, a distância calculada pela base e a descrição do resultado) -- cpf, nome, sobrenome, data_nascimento, endereco, cidade, estado e cep --, o cep com a comparação também dos primeiros dígitos, telefones (lista com a mesma comparação por telefone) e o link pdf do relatório. A cobrança acontece quando a comparação é concluída, inclusive quando a distância é alta ou o resultado traz ressalvas (distância alta é resultado, não erro); quando a base não tem informação para os dados enviados a resposta é HTTP 404, sem cobrança; campo cpf ausente ou inválido é recusado com HTTP 400, sem cobrança. Fonte indisponível responde HTTP 502, 503 ou 504, também sem cobrança. Em homologação (homolog=true) a resposta é uma amostra fictícia completa, sem cobrança, para qualquer cpf válido. - **Método:** `POST` - **Endereço:** `https://gateway.apibrasil.io/api/v2/consulta/cpf/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": "similaridade-brasil", "cpf": "12345678909", "nome": "FULANO", "sobrenome": "DE TESTE", "data_nascimento": "01/01/1990", "homolog": true } ``` **Em cURL** ```bash curl -X POST "https://gateway.apibrasil.io/api/v2/consulta/cpf/credits" \ -H "Content-Type: application/json" \ -H "Authorization: Bearer $APIBRASIL_TOKEN" \ -d '{"tipo":"similaridade-brasil","cpf":"12345678909","nome":"FULANO","sobrenome":"DE TESTE","data_nascimento":"01/01/1990","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": "398,420", "balance_before": "400,000", "tax": "1,580", "status_code": 200, "error": false, "message": "Dados validos! Voce foi tarifado em R$ 1,58.", "valor_consulta": 1.58, "api_limit_for": "credit", "homolog": false, "data": { "dados": { "campos_comparados": 9, "cep": { "descricao": "Codigo postal nao confere", "descricao_primeiros_digitos": "Primeiros digitos conferem", "distancia": 3, "distancia_primeiros_digitos": 0, "informado": "12345-123" }, "cidade": { "descricao": "Cidade confere", "distancia": 0, "informado": "Cidade Exemplo" }, "cpf": { "descricao": "CPF confere com a base", "distancia": 0, "informado": "12345678909" }, "data_nascimento": { "descricao": "Data de nascimento confere", "distancia": 0, "informado": "1990/01/01" }, "endereco": { "descricao": "Endereco semelhante ao da base", "distancia": 4, "informado": "Rua Exemplo 100" }, "estado": { "descricao": "Estado confere", "distancia": 0, "informado": "SP" }, "nome": { "descricao": "Nome confere com a base", "distancia": 0, "informado": "FULANO" }, "pdf": "(link do PDF da consulta)", "sobrenome": { "descricao": "Sobrenome confere parcialmente", "distancia": 1, "informado": "DE TESTE" }, "telefones": [ { "descricao": "Telefone nao encontrado na base", "distancia": 8, "informado": "11900000000" } ] } } } ``` 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/7cfdcc0d-1416-47fc-adaf-87d1f7563e4d/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/7cfdcc0d-1416-47fc-adaf-87d1f7563e4d