--- title: "Crédito PF Essencial" description: "API Crédito PF Essencial" lang: pt-BR canonical: https://doc.apibrasil.io/apis/creditos/1eecd15a-54ce-4971-b9d6-37ac96c625ba markdown: https://doc.apibrasil.io/apis/creditos/1eecd15a-54ce-4971-b9d6-37ac96c625ba.md source: apibrasil-documentation --- # Crédito PF Essencial > API Crédito PF Essencial - **Categoria:** Análise Antifraude - **Cobrança:** por consulta, só com o Bearer Token - **Preço:** R$ 14,90 por consulta - **Limite:** 990.000 por mês - **Cadastro:** CPF ou CNPJ - **Versão:** v2 - **Publicada por:** APIBrasil - **Especificação OpenAPI:** https://doc.apibrasil.io/apis/creditos/1eecd15a-54ce-4971-b9d6-37ac96c625ba/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=credito-pf e o cpf (11 dígitos, com ou sem máscara; o dígito verificador é conferido). A resposta vem em data.dados e traz identificacao, score (valor, faixa e descricao), restricoes (quantidade, valor_total e lista), contatos (telefones, emails e enderecos), protestos e decisao_sugerida, consulta (tipo, valor, entrada, data_hora, blocos_ok e blocos_total) e o link pdf do relatório; chaves adicionais: decisao_motivos, decisao_aviso, resumo. A cobrança acontece quando os blocos score e restricoes são respondidos; se já houver uma consulta em andamento para o mesmo CPF a resposta é HTTP 429 com retry_after_s, 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": "credito-pf", "cpf": "12345678909", "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":"credito-pf","cpf":"12345678909","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": "385,100", "balance_before": "400,000", "tax": "14,900", "status_code": 200, "error": false, "message": "Dados validos! Voce foi tarifado em R$ 14,90.", "valor_consulta": 14.9, "api_limit_for": "credit", "homolog": false, "data": { "dados": { "identificacao": { "status": "ok", "tempo_ms": 2310, "documento": "***.000.000-**", "nome": "MARIA EXEMPLO DA SILVA", "situacao_cpf": "REGULAR", "data_nascimento": "01/01/1985", "cidade": "CIDADE EXEMPLO", "uf": "SP" }, "score": { "valor": 712, "escala_maxima": 1000, "faixa": "Bom", "classe": "B", "probabilidade_inadimplencia_pct": 12.5, "descricao": "Amostra fictícia: perfil com bom histórico de pagamentos nos últimos meses.", "status": "ok", "tempo_ms": 1840 }, "restricoes": { "quantidade": 2, "valor_total": 1362.4, "lista": [ { "credor": "EMPRESA EXEMPLO DE ENERGIA", "tipo": "COMPRADOR", "valor": 412.4, "data_vencimento": "10/08/2026", "data_inclusao": "05/10/2026", "contrato": "0000123456", "sub_judice": false }, { "credor": "LOJA EXEMPLO DE MOVEIS", "tipo": "COMPRADOR", "valor": 950, "data_vencimento": "02/06/2026", "data_inclusao": "20/09/2026", "contrato": "0000654321", "sub_judice": false } ], "alertas": [ { "titulo": "Consumidor participante do cadastro positivo", "observacao": "Informação de amostra." } ], "status": "ok", "tempo_ms": 2310 }, "contatos": { "status": "ok", "tempo_ms": 2310, "telefones": [ { "numero": "(11) 90000-1234", "tipo": "CELULAR" } ], "emails": [ "[omitido]" ], "enderecos": [ { "logradouro": "RUA EXEMPLO", "numero": "100", "complemento": "", "bairro": "CENTRO", "cidade": "CIDADE EXEMPLO", "uf": "SP", "cep": "00000000" } ] }, "protestos": { "quantidade": 1, "valor_total": 411.4, "lista": [ { "uf": "SP", "cidade": "CIDADE EXEMPLO", "cartorio": "1º TABELIONATO DE PROTESTO EXEMPLO", "data": "15/07/2026", "valor": 411.4 } ], "status": "ok", "tempo_ms": 3050 }, "decisao_sugerida": "atencao", "decisao_motivos": [ "2 restrição(ões) financeira(s) localizada(s).", "1 protesto(s) localizado(s)." ], "decisao_aviso": "Indicativo automático; não substitui a análise de crédito do usuário.", "resumo": { "blocos_total": 5, "blocos_ok": 5, "blocos_indisponiveis": [], "tempo_ms": 3050 }, "consulta": { "tipo": "credito-pf", "valor": 0, "entrada": "***.000.000-**", "data_hora": "2026-11-06T09:30:00-0300", "blocos_ok": 5, "blocos_total": 5 } } } } ``` 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/1eecd15a-54ce-4971-b9d6-37ac96c625ba/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/1eecd15a-54ce-4971-b9d6-37ac96c625ba