--- title: "Análise de Crédito Essencial PF" description: "API Análise de Crédito PF - Decisão rápida com risco controlado" lang: pt-BR canonical: https://doc.apibrasil.io/apis/creditos/c4952860-6dd3-453d-a8d6-168af4b1a4d4 markdown: https://doc.apibrasil.io/apis/creditos/c4952860-6dd3-453d-a8d6-168af4b1a4d4.md source: apibrasil-documentation --- # Análise de Crédito Essencial PF > API Análise de Crédito PF - Decisão rápida com risco controlado - **Categoria:** Análise de Crédito - **Cobrança:** por consulta, só com o Bearer Token - **Preço:** R$ 15,19 por consulta - **Limite:** 999.000 por mês - **Cadastro:** exige CNPJ - **Versão:** v1 - **Publicada por:** APIBrasil - **Especificação OpenAPI:** https://doc.apibrasil.io/apis/creditos/c4952860-6dd3-453d-a8d6-168af4b1a4d4/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 Análise de Crédito PF - Decisão rápida com risco controlado A API Análise de Crédito Essencial PF traz agilidade e segurança para o processo de concessão de crédito em seu negócio, analisando o risco de pessoas físicas em segundos e integrando-se facilmente ao seu sistema via método POST. Com dados essenciais e critérios prontos para uso, você automatiza decisões, reduz a inadimplência e proporciona uma experiência mais eficiente ao cliente. O retorno detalhado auxilia sua equipe a tomar decisões consistentes, além de permitir fácil implementação em CRMs, ERPs, plataformas de e-commerce, internet banking ou qualquer solução digital. Ganhe velocidade na aprovação, padronize critérios, aumente a conversão de propostas e mantenha o controle total do risco de crédito — tudo em um processo simples, moderno e escalável. - **Método:** `POST` - **Endereço:** `https://gateway.apibrasil.io/api/v2/consulta/cpf/credits` - **Versão da rota:** v1 **Cabeçalhos** | Cabeçalho | Valor | | --- | --- | | `Content-Type` | `application/json` | | `Authorization` | `Bearer $APIBRASIL_TOKEN` | **Corpo da requisição** ```json { "tipo": "analise-credito-essencial-pf", "cpf": "00000000000", "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":"analise-credito-essencial-pf","cpf":"00000000000","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": "105,660", "balance_before": "105,660", "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": { "resultado": { "cheque_talao_sustado": [], "cheques_sustados_pelo_motivo_21": [], "confirmacao_cep": [], "confirmacao_telefone": [], "consultas_anteriores": [ { "data": "15/02/2026", "informante": "BANCO EXEMPLO S.A.", "moeda": null, "produto": "S", "tipo_ocorrencia": "Cartão de crédito", "tipo_ocorrência": null, "valor": "0,00" }, { "data": "10/02/2026", "informante": "FINANCEIRA MODELO LTDA", "moeda": null, "produto": "S", "tipo_ocorrencia": "Empréstimo pessoal", "tipo_ocorrência": null, "valor": "0,00" }, { "data": "05/02/2026", "informante": "LOJA VIRTUAL EXEMPLO", "moeda": null, "produto": "N", "tipo_ocorrencia": "Outros", "tipo_ocorrência": null, "valor": "0,00" }, { "data": "28/01/2026", "informante": "SP-SNE/ANALISE DE CREDITO", "moeda": null, "produto": "N", "tipo_ocorrencia": "Outros", "tipo_ocorrência": null, "valor": "0,00" } ], "consultas_anteriores_cheque": [], "debitos": [], "devolucoes_informadas_pelo_usuario": [], "endereco_telefones_agencia_bancaria": [], "historico_cheque_informado": [], "historico_conta_corrente_informada": [], "identificacao": { "cidade_nascimento": "SAO PAULO", "data_atualizacao": "15/01/2026", "data_emissao_rg": "10/05/2015", "data_nascimento": "15/03/1990", "documento": "00000000000", "estado_civil": "Solteiro", "grau_instrucao": "Superior completo", "nome_mae": "MARIA SILVA SANTOS", "nomes": "JOAO DA SILVA SANTOS", "numero_dependentes": "1", "numero_rg": "12345678", "obito": null, "orgao_emissor": "SSP", "regiao_cpf": "SP", "sexo_consultado": "Masculino", "situacao_receita": "Regular", "titulo_eleitor": "123456789012", "unidade_fedarativa_rg": "SP" }, "informacoes_complementares": [], "informacoes_complementares_cheque": [], "localizacao": { "bairro": "CENTRO", "cep": "01310100", "cidade": "SAO PAULO", "complemento": "APTO 101", "ddd_1": "0011", "ddd_2": null, "ddd_3": null, "nome_logradouro": "AVENIDA PAULISTA", "numero_logradouro": "1000", "telefone_1": "987654321", "telefone_2": null, "telefone_3": null, "tipo_logradouro": "Avenida", "unidade_federativa": "SP" }, "nome_documentos": [], "relacao_devolucoes_informadas_pelo_ccf": [], "resumo_consultas_anteriores_90_dias": { "ano_1": "2026", "ano_2": "2026", "ano_3": "2026", "ano_4": "2025", "mes_1": "03", "mes_2": "02", "mes_3": "01", "mes_4": "12", "total": "00004", "total_1": "0000", "total_2": "0002", "total_3": "0002", "total_4": "0000" }, "resumo_consultas_anteriores_cheque": { "dia": null, "numero_documento": null, "pre_datado": null, "tipo_documento": null, "total": null, "valor": null, "valor_dia": null, "valor_pre_datado": null }, "resumo_devolucoes_informada_pelo_usuario": { "data_primeira_devolucao": null, "data_ultima_devolucao": null, "numero_documento": null, "tipo_documento": null, "total": null }, "resumo_devolucoes_informadas_pelo_ccf": { "motivo_12": null, "motivo_13": null, "motivo_14": null, "motivo_99": null, "nomes": null, "numero_documento": null, "tipo_documento": null, "total_devolucoes": null, "total_nomes": null }, "resumo_ocorrencias_de_debitos": { "data_maior_debito": null, "data_primeiro_debito": null, "total_avalista": null, "total_devedor": null, "valor_acomulado": null, "valor_maior_debito": null, "valor_primeiro_debito": null }, "resumo_titulos_protestados": { "moeda": null, "periodo_final": null, "periodo_inicial": null, "total": null, "uf": null, "valor_acumulado": null }, "score_classificacao_varios_modelos": [ { "classificacao_alfabetica": "B", "classificacao_numerica": "08", "codigo_natureza_modelo": "101", "descricao_natureza": "CREDITO", "modelo_plano": "63", "modelo_score": "63", "nome_plano": null, "nome_score": "NOVO RISCO 6 MESES", "plano_execucao": "N", "probabilidade": "01580", "score": "650", "texto": "De cada 100 pessoas classificadas nesta classe de score, é provável que 16 apresentem débitos no mercado nos próximos 6 meses.", "texto2": null, "tipo_score": "1" }, { "classificacao_alfabetica": null, "classificacao_numerica": "05", "codigo_natureza_modelo": "103", "descricao_natureza": "RENDA PRESUMIDA", "modelo_plano": "41", "modelo_score": "41", "nome_plano": null, "nome_score": "Renda Presum Faixa", "plano_execucao": "N", "probabilidade": "00000", "score": "5", "texto": "De R$ 2.001 até R$ 3.000", "texto2": "Renda estimada a partir de informações comportamentais e cadastrais do consumidor.", "tipo_score": "1" } ], "titulos_protestados": [] } } } ``` 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/c4952860-6dd3-453d-a8d6-168af4b1a4d4/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/c4952860-6dd3-453d-a8d6-168af4b1a4d4