--- title: "CPF Hotline" description: "API CPF Hotline - Cadastro e Contato em Instantes" lang: pt-BR canonical: https://doc.apibrasil.io/apis/creditos/4c5f8699-bd91-42cc-ba50-a78258459c8b markdown: https://doc.apibrasil.io/apis/creditos/4c5f8699-bd91-42cc-ba50-a78258459c8b.md source: apibrasil-documentation --- # CPF Hotline > API CPF Hotline - Cadastro e Contato em Instantes - **Categoria:** Busca & Cobrança - **Cobrança:** por consulta, só com o Bearer Token - **Preço:** R$ 3,49 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/4c5f8699-bd91-42cc-ba50-a78258459c8b/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 API Cadastro CPF - Dados Completos em Segundos A API CPF Hotline oferece integração rápida e segura para fornecer, via POST, todas as informações cadastrais, contatos e histórico associados a um CPF em tempo real, em formato JSON padronizado. Com essa solução, seu sistema ganha agilidade e confiabilidade na validação de usuários, tornando processos como onboarding, análise de crédito e prevenção a fraudes muito mais eficientes e assertivos. Ideal para automatizar decisões, aprimorar cadastros e adicionar valor ao seu negócio, a API também está disponível em ambiente de homologação com dados mockados para facilitar testes e implantação rápida. - **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 { "cpf": "00000000000", "tipo": "cpf-hotline", "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 '{"cpf":"00000000000","tipo":"cpf-hotline","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": "108,300", "balance_before": "108,300", "tax": "0,000", "status_code": 200, "error": false, "message": "Dados validos em homologacao! Voce nao foi tarifado e a requisicao nao foi contabilizada.", "valor_consulta": 0, "api_limit_for": "homolog", "homolog": true, "data": { "results": { "cadastral": { "ds_genero": "Masculino", "ds_status_cpf": "Regular", "dt_nascimento": "1989-09-09", "dt_obito": null, "idade": "35", "nm_completo": "FULANO HOMOLOG CPF TESTE", "nm_mae": "CICLANA HOMOLOG CPF TESTE", "nome": [ { "cd_ordem": 1, "dt_ultima_visualizacao": "2099-12-31", "nm_completo": "FULANO HOMOLOG CPF TESTE", "nm_meio": "HOMOLOG CPF", "nm_primeiro": "FULANO", "nm_ultimo": "TESTE" } ], "nr_cpf": "00000000000", "obito": null, "sg_genero": "M", "sg_status_cpf": "R" }, "contato": { "email": [ { "cd_ordem": 1, "ds_email": "[omitido]", "dt_ultima_visualizacao": "2099-12-31" }, { "cd_ordem": 2, "ds_email": "[omitido]", "dt_ultima_visualizacao": "2099-12-31" }, { "cd_ordem": 3, "ds_email": "[omitido]", "dt_ultima_visualizacao": "2099-12-31" } ], "endereco": [ { "cd_ordem": 1, "ds_bairro": "BAIRRO FICTICIO 01", "ds_cidade": "CIDADE HOMOLOGACAO", "ds_complemento": "ANDAR TESTE", "ds_logradouro": "AVENIDA DOS DADOS MOCK", "dt_ultima_visualizacao": "2099-12-31", "nr_cep": "00000-001", "nr_numero": "100", "regiao": "Ambiente de Teste", "sg_uf": "TS" }, { "cd_ordem": 2, "ds_bairro": "BAIRRO FICTICIO 02", "ds_cidade": "CIDADE HOMOLOGACAO", "ds_complemento": null, "ds_logradouro": "RUA PLACEHOLDER", "dt_ultima_visualizacao": "2099-12-31", "nr_cep": "00000-002", "nr_numero": "200", "regiao": "Ambiente de Teste", "sg_uf": "TS" }, { "cd_ordem": 3, "ds_bairro": "BAIRRO FICTICIO 03", "ds_cidade": "CIDADE HOMOLOGACAO", "ds_complemento": "SALA 303", "ds_logradouro": "TRAVESSA MOCK", "dt_ultima_visualizacao": "2099-12-31", "nr_cep": "00000-003", "nr_numero": "303", "regiao": "Ambiente de Teste", "sg_uf": "TS" } ], "telefone": [ { "cd_ordem": 1, "ds_regiao": "Ambiente de Teste", "ds_tipo": "Movel", "dt_ultima_visualizacao": "2099-12-31", "nr_ddd": "99", "nr_telefone": "900000001", "sg_uf": "TS" }, { "cd_ordem": 2, "ds_regiao": "Ambiente de Teste", "ds_tipo": "Fixo", "dt_ultima_visualizacao": "2099-12-31", "nr_ddd": "99", "nr_telefone": "300000002", "sg_uf": "TS" }, { "cd_ordem": 3, "ds_regiao": "Ambiente de Teste", "ds_tipo": "Fixo", "dt_ultima_visualizacao": "2099-12-31", "nr_ddd": "99", "nr_telefone": "300000003", "sg_uf": "TS" } ] }, "informacoes_historicas": { "contato": { "email": [ { "cd_ordem": 1, "ds_email": "[omitido]", "dt_ultima_visualizacao": "2099-12-31" }, { "cd_ordem": 2, "ds_email": "[omitido]", "dt_ultima_visualizacao": "2099-12-31" }, { "cd_ordem": 3, "ds_email": "[omitido]", "dt_ultima_visualizacao": "2099-12-31" } ], "endereco": [ { "cd_ordem": 1, "ds_bairro": "BAIRRO FICTICIO 01", "ds_cidade": "CIDADE HOMOLOGACAO", "ds_complemento": "ANDAR TESTE", "ds_logradouro": "AVENIDA DOS DADOS MOCK", "dt_ultima_visualizacao": "2099-12-31", "nr_cep": "00000-001", "nr_numero": "100", "regiao": "Ambiente de Teste", "sg_uf": "TS" }, { "cd_ordem": 2, "ds_bairro": "BAIRRO FICTICIO 02", "ds_cidade": "CIDADE HOMOLOGACAO", "ds_complemento": null, "ds_logradouro": "RUA PLACEHOLDER", "dt_ultima_visualizacao": "2099-12-31", "nr_cep": "00000-002", "nr_numero": "200", "regiao": "Ambiente de Teste", "sg_uf": "TS" }, { "cd_ordem": 3, "ds_bairro": "BAIRRO FICTICIO 03", "ds_cidade": "CIDADE HOMOLOGACAO", "ds_complemento": "SALA 303", "ds_logradouro": "TRAVESSA MOCK", "dt_ultima_visualizacao": "2099-12-31", "nr_cep": "00000-003", "nr_numero": "303", "regiao": "Ambiente de Teste", "sg_uf": "TS" } ], "telefone": [ { "cd_ordem": 1, "ds_regiao": "Ambiente de Teste", "ds_tipo": "Movel", "dt_ultima_visualizacao": "2099-12-31", "nr_ddd": "99", "nr_telefone": "900000001", "sg_uf": "TS" }, { "cd_ordem": 2, "ds_regiao": "Ambiente de Teste", "ds_tipo": "Fixo", "dt_ultima_visualizacao": "2099-12-31", "nr_ddd": "99", "nr_telefone": "300000002", "sg_uf": "TS" }, { "cd_ordem": 3, "ds_regiao": "Ambiente de Teste", "ds_tipo": "Fixo", "dt_ultima_visualizacao": "2099-12-31", "nr_ddd": "99", "nr_telefone": "300000003", "sg_uf": "TS" } ] } } } } } ``` 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/4c5f8699-bd91-42cc-ba50-a78258459c8b/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/4c5f8699-bd91-42cc-ba50-a78258459c8b