--- title: "Análise de Crédito Complete - PF" description: "API Análise de Crédito PF - Decisão Rápida e Completa em Segundos" lang: pt-BR canonical: https://doc.apibrasil.io/apis/creditos/0165169c-e21a-4314-a3aa-0885df29a588 markdown: https://doc.apibrasil.io/apis/creditos/0165169c-e21a-4314-a3aa-0885df29a588.md source: apibrasil-documentation --- # Análise de Crédito Complete - PF > API Análise de Crédito PF - Decisão Rápida e Completa em Segundos - **Categoria:** Análise de Crédito - **Cobrança:** por consulta, só com o Bearer Token - **Preço:** R$ 43,60 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/0165169c-e21a-4314-a3aa-0885df29a588/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 visão completa do CPF A API Análise de Crédito Complete PF (POST analise-credito-complete-pf, action consulta/cpf/credits) oferece uma visão detalhada do perfil de crédito do consumidor a partir do CPF, permitindo decisões mais assertivas em concessão de crédito, vendas a prazo e onboarding digital. Com integração rápida via REST e retorno estruturado em JSON, você conecta seu sistema em poucas horas e passa a contar com indicadores de risco, histórico e score de crédito em tempo real. Use os dados retornados para automatizar regras de aprovação, segmentar propostas comerciais, definir limites personalizados e reduzir inadimplência sem fricção na jornada do cliente. - **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-complete-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-complete-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_cheque": [], "debitos": [], "decisao": { "aprova": "S", "documento": "00000000000000", "score": "0003", "texto": "NEGOCIAÇÃ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": "15/11/2025", "data_emissao_rg": "-", "data_nascimento": "22/05/1992", "documento": "00000000000", "estado_civil": "Não informado", "grau_instrucao": "Não informado", "mensagem": null, "nacionalidade": null, "nome_mae": "PATRICIA FERNANDA OLIVEIRA", "nomes": "CARLOS EDUARDO OLIVEIRA SOUZA", "numero_dependentes": "0", "numero_rg": null, "obito": null, "orgao_emissor": null, "regiao_cpf": "RJ", "sexo_consultado": "Masculino", "situacao_receita": "Regular", "titulo_eleitor": "0000000000000", "unidade_fedarativa_rg": null }, "informacoes_complementares": [], "informacoes_complementares_cheque": [], "localizacao": { "bairro": "COPACABANA", "cep": "22070001", "cidade": "RIO DE JANEIRO", "complemento": "BL 2 AP 305", "ddd_1": "0021", "ddd_2": null, "ddd_3": null, "nome_logradouro": "AVENIDA ATLANTICA", "numero_logradouro": "1250", "telefone_1": "998765432", "telefone_2": null, "telefone_3": null, "tipo_logradouro": "Avenida", "unidade_federativa": "RJ" }, "mensagem_registro": [], "nome_documentos": [], "outras_grafias": [], "painel_controle_positivo": { "indicadores_positivos_comportamento_consumo": { "cartao_credito_cheque_especial_e_outros_rotativos": [], "operacoes_parceladas": [], "servicos_continuados": [] }, "indicadores_positivos_comportamento_pagamento": { "cartao_credito": [], "operacoes_parceladas": [], "servicos_continuados": [] }, "maturidade_credito": { "id_tempo_experiencia": null, "meses_contrato_mais_antigo": null, "modalidade_list": [], "txt_tempo_experiencia": null }, "mensagem": null }, "participacoes_do_documento_consultado": [], "relacao_consultas_anteriores_credito_segmento": [ { "data": "12/11/2025", "descricao_grupo": "O PROPRIO EMITENTE", "descricao_ramo": "SEM CODIFICACAO", "descricao_segmento": null, "documento": "00000000000000", "grupo": "0005", "informante": "CREDITO FÁCIL CONSULTORIA LTDA", "moeda": null, "ramo_atividade": "9999998", "segmento": null, "tipo_documento": "CPF", "tipo_ocorrencia": "Cartão de crédito", "valor": "00000000000" }, { "data": "12/11/2025", "descricao_grupo": "AC DO RIO DE JANEIRO / CAPITAL", "descricao_ramo": "AC DO RIO DE JANEIRO / CAPITAL", "descricao_segmento": null, "documento": "00000000000000", "grupo": "0035", "informante": "FINANCEIRA EXEMPLO S.A.", "moeda": null, "ramo_atividade": "9999935", "segmento": null, "tipo_documento": "CPF", "tipo_ocorrencia": "Cartão de crédito", "valor": "00000000000" }, { "data": "05/11/2025", "descricao_grupo": "ASSOCIACOES GRANDE RJ", "descricao_ramo": "ASSOCS GRANDE RIO DE JANEIRO", "descricao_segmento": null, "documento": "00000000000000", "grupo": "0030", "informante": "RJ-CONSULTORIA DE CREDITO", "moeda": null, "ramo_atividade": "9999932", "segmento": null, "tipo_documento": "CPF", "tipo_ocorrencia": "Outros", "valor": "00000000000" }, { "data": "28/10/2025", "descricao_grupo": "O PROPRIO EMITENTE", "descricao_ramo": "SEM CODIFICACAO", "descricao_segmento": null, "documento": "00000000000000", "grupo": "0005", "informante": "OPERADORA TELECOMUNICACOES S.A.", "moeda": null, "ramo_atividade": "9999998", "segmento": null, "tipo_documento": "CPF", "tipo_ocorrencia": "Outros", "valor": "00000000000" } ], "relacao_de_acoes_civeis": [], "relacao_devolucoes_informadas_pelo_ccf": [], "relacao_falencia_recuperacao_judicial": [], "resumo_consultas_anteriores": { "numero_documento": "00000000000000", "periodo": "11/2025", "periodo_ante_penultimo_mes": null, "periodo_final": "11/2025", "periodo_inicial": "11/2025", "periodo_penultimo_mes": null, "tipo_documento": "CPF", "total_ante_penultimo_mes": null, "total_de_consultas": "00004", "total_penultimo_mes": null, "total_ultimo_mes": "00004" }, "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": "B", "classificacao_numerica": "10", "codigo_natureza_modelo": "115", "descricao_natureza": "POSITIVO PF", "mensagem": "O cálculo deste score não considera informações do Cadastro Positivo - Lei 12.414/2011 (dados com informações de adimplemento para formação de histórico de crédito).", "modelo_plano": null, "modelo_score": "1D", "nome_plano": null, "nome_score": "P5", "plano_execucao": "N", "probabilidade": "00900", "score": "444", "texto": "É provável que 91% das pessoas com esse mesmo comportamento, paguem suas contas nos próximos 6 meses.", "texto2": null, "tipo_score": "1", "valor": "0" }, { "classificacao_alfabetica": null, "classificacao_numerica": "00", "codigo_natureza_modelo": "116", "descricao_natureza": "RENDA PRESUMIDA POSITIVA", "mensagem": null, "modelo_plano": "1F", "modelo_score": "1F", "nome_plano": null, "nome_score": "RankRnd Positiva P5", "plano_execucao": "N", "probabilidade": "00000", "score": "3", "texto": "De R$ 1.401 até R$ 2.000", "texto2": "Renda estimada a partir de informações comportamentais e cadastrais do consumidor.", "tipo_score": "1", "valor": "0" }, { "classificacao_alfabetica": null, "classificacao_numerica": "00", "codigo_natureza_modelo": "109", "descricao_natureza": "LIMITE DE PARCELA", "mensagem": null, "modelo_plano": "3F", "modelo_score": "3F", "nome_plano": null, "nome_score": "LIMITE CREDITO P5", "plano_execucao": "N", "probabilidade": "00000", "score": "302", "texto": "Valor de Parcela mensal sugerida (Em Reais)", "texto2": "Valor estimado a partir da combinação de informações cadastrais, comportamentais e IBGE.", "tipo_score": "1", "valor": "0" } ], "status_consumidor": { "mensagem": "CONSUMIDOR SEM HISTÓRICO DE CRÉDITO" }, "telefone_vinculado_documento_informado": [], "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/0165169c-e21a-4314-a3aa-0885df29a588/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/0165169c-e21a-4314-a3aa-0885df29a588