--- title: "Análise de Crédito Plus PF" description: "API Análise de Crédito Plus PF - Decisão rápida e assertiva pelo CPF" lang: en canonical: https://doc.apibrasil.io/apis/creditos/b00c4931-f15f-4c36-8537-417376a19c22 markdown: https://doc.apibrasil.io/apis/creditos/b00c4931-f15f-4c36-8537-417376a19c22.md source: apibrasil-documentation --- # Análise de Crédito Plus PF > API Análise de Crédito Plus PF - Decisão rápida e assertiva pelo CPF - **Category:** Credit Analysis - **Billing:** per query, with the Bearer Token only - **Price:** R$29.02 per query - **Limit:** 999,000 per month - **Registration:** requires a CNPJ - **Version:** v1 - **Published by:** APIBrasil - **OpenAPI specification:** https://doc.apibrasil.io/apis/creditos/b00c4931-f15f-4c36-8537-417376a19c22/openapi.json ## How to call **Base address:** `https://gateway.apibrasil.io/api/v2` Authentication: the `Authorization: Bearer ` header. Nothing else. With `homolog: true` in the body, the gateway answers from a fixed base, with the real shape of the response, and does not charge. The CPF 00000000000 belongs to that base and to nobody: use it in tests, never in production. ## Endpoints (1 endpoint) ### 1. POST /consulta/cpf/credits API Análise de Crédito PF - Decisões Mais Rápidas e Seguras A API Análise de Crédito Plus PF permite que seu sistema realize consultas de crédito completas a partir do CPF, via requisições HTTP POST para o endpoint de ação consulta/cpf/credits. Com integração rápida e documentação direta, você incorpora em poucos passos uma análise robusta de risco, score e histórico de crédito ao fluxo de cadastro, concessão de crédito, venda a prazo ou onboarding de novos clientes. O retorno da API é estruturado para facilitar decisões automáticas, reduzindo fraudes, inadimplência e tempo de aprovação. Assim, seu negócio ganha agilidade e precisão na análise de crédito, melhorando a experiência do cliente e aumentando a conversão em tempo real. - **Method:** `POST` - **Address:** `https://gateway.apibrasil.io/api/v2/consulta/cpf/credits` - **Route version:** v1 **Headers** | Header | Value | | --- | --- | | `Content-Type` | `application/json` | | `Authorization` | `Bearer $APIBRASIL_TOKEN` | **Request body** ```json { "tipo": "analise-credito-plus-pf", "cpf": "00000000000", "homolog": true } ``` **In 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-plus-pf","cpf":"00000000000","homolog":true}' ``` This endpoint accepts `homolog: true` in the body: the response comes back with valid data, `api_limit_for` equal to `homolog` and no charge. **Sample response, from the catalog** ```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/03/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/03/2026", "informante": "FACTORING EXEMPLO LTDA", "moeda": null, "produto": "S", "tipo_ocorrencia": "Cartão de crédito", "tipo_ocorrência": null, "valor": "0,00" }, { "data": "28/02/2026", "informante": "OPERADORA EXEMPLO S.A.", "moeda": null, "produto": "S", "tipo_ocorrencia": "Outros", "tipo_ocorrência": null, "valor": "0,00" }, { "data": "20/02/2026", "informante": "SP-ANALISE DE CREDITO EXEMPLO", "moeda": null, "produto": "N", "tipo_ocorrencia": "Outros", "tipo_ocorrência": null, "valor": "0,00" } ], "consultas_anteriores_cheque": [], "debitos": [], "decisao": { "aprova": "N", "documento": "00000000000000", "score": "0002", "texto": "NEGOCIAÇÃO NÃO RECOMENDADA", "tipo_documento": "CPF" }, "devolucoes_informadas_pelo_usuario": [], "endereco_telefones_agencia_bancaria": [], "historico_cheque_informado": [], "historico_conta_corrente_informada": [], "identificacao": { "cidade_nascimento": null, "data_atualizacao": "10/03/2026", "data_emissao_rg": "-", "data_nascimento": "15/07/1985", "documento": "00000000000", "estado_civil": "Não informado", "grau_instrucao": "Não informado", "nome_mae": "MARIA SILVA SANTOS", "nomes": "JOAO DA SILVA SANTOS", "numero_dependentes": "0", "numero_rg": null, "obito": null, "orgao_emissor": null, "regiao_cpf": "SP", "sexo_consultado": "Masculino", "situacao_receita": "Regular", "titulo_eleitor": "0000000000000", "unidade_fedarativa_rg": null }, "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": [], "outras_grafias": [], "relacao_de_acoes_civeis": [], "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": "0000", "total_3": "0004", "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_de_acoes_civeis": { "periodo_final": null, "periodo_inicial": null, "quantidade": 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": "C", "classificacao_numerica": "10", "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": "02320", "score": "380", "texto": "De cada 100 pessoas classificadas nesta classe de score, é provável que 23 apresentem débitos no mercado nos próximos 6 meses.", "texto2": null, "tipo_score": "1" }, { "classificacao_alfabetica": null, "classificacao_numerica": "03", "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": "3", "texto": "De R$ 801 até R$ 1.400", "texto2": "Renda estimada a partir de informações comportamentais e cadastrais do consumidor.", "tipo_score": "1" } ], "telefone_vinculado_documento_informado": [], "titulos_protestados": [] } } } ``` In the sample responses, the fields of the account that generated the sample (`user.first_name`, `user.email`, `user.cellphone`) come out as `[omitido]`. The rest is what the catalog publishes. ## Pitfalls: what an integration gets wrong without warning Established from the responses the catalog itself publishes. In every one of them the code works on the happy path and fails silently everywhere else: 1. **The error arrives in the BODY, with HTTP 200.** The response carries a boolean `error` field and a `message`. Checking only `response.ok` or the HTTP status lets a failure through as a success. ALWAYS check `error === false` before reading `data`. 2. **`balance`, `tax` and `extra_charges.total` are STRINGS in Brazilian format — and the format varies between APIs.** Values seen in the catalog: `"154,380"`, `"497,84"`, `"0,000"` and `"0.19"`. Comma in some, dot in another; three decimal places in some, two in another. In JavaScript, `parseFloat("154,380")` returns `154` and drops the cents with no error at all, and `Number("154,380")` returns `NaN`. Write a converter that handles both separators, and never use these fields in a financial decision without converting them. 3. **Every call costs money.** Blind retries multiply the bill. Never automatically repeat a 4xx: a bad parameter repeated is still bad, and still charged. Retry only timeouts and 5xx, with exponential backoff and a small attempt ceiling. 4. **HTTP 402 means insufficient balance, and retrying does not fix it.** It is the one status that needs a human — a top-up. Treat it as a terminal error with its own message, and do not lump it in with generic 4xx. 5. **`extra_charges` bills on top of the lookup price.** When the body asks for add-on services, the response lists each one with its price plus a `total` that is NOT included in the base amount. If you show cost to an end user, add both. ## See also - OpenAPI specification: https://doc.apibrasil.io/apis/creditos/b00c4931-f15f-4c36-8537-417376a19c22/openapi.json - API catalog: [API catalog](https://doc.apibrasil.io/apis.md) - Official SDKs: [Official SDKs](https://doc.apibrasil.io/sdks.md) - Documentation index: https://doc.apibrasil.io/llms.txt - HTML version of this page: https://doc.apibrasil.io/apis/creditos/b00c4931-f15f-4c36-8537-417376a19c22