--- title: "Relatório de Crédito e Cadastro Positivo PF" description: "API Relatório de Crédito e Cadastro Positivo PF" lang: pt-BR canonical: https://doc.apibrasil.io/apis/creditos/6ce12b6c-4abd-4ebe-a964-d0588166b07a markdown: https://doc.apibrasil.io/apis/creditos/6ce12b6c-4abd-4ebe-a964-d0588166b07a.md source: apibrasil-documentation --- # Relatório de Crédito e Cadastro Positivo PF > API Relatório de Crédito e Cadastro Positivo PF - **Categoria:** Análise de Crédito - **Cobrança:** por consulta, só com o Bearer Token - **Preço:** R$ 24,59 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/6ce12b6c-4abd-4ebe-a964-d0588166b07a/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=acerta-mais-positivo-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 documento, dados cadastrais (nome, filiação, nascimento, situação do CPF e outros), telefones, enderecos, restricoes, participacao_em_empresas, pendencias_financeiras, protestos, cheque_sem_fundo, falencias_acoes_recuperacoes, scores, passagens_comerciais, acoes_civeis, decisao, renda_presumida, controle_positivo, resumo e o link pdf do relatório. A cobrança acontece quando o CPF é localizado e o relatório traz conteúdo; CPF não localizado ou retorno vazio responde HTTP 404, 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": "acerta-mais-positivo-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":"acerta-mais-positivo-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": "375,410", "balance_before": "400,000", "tax": "24,590", "status_code": 200, "error": false, "message": "Dados validos! Voce foi tarifado em R$ 24,59.", "valor_consulta": 24.59, "api_limit_for": "credit", "homolog": false, "data": { "dados": { "acoes_civeis": { "data_maior": "01/03/2026", "data_menor": "01/03/2026", "data_primeiro": "01/03/2026", "data_ultimo": "01/03/2026", "ocorrencias": [ { "acao": "Cobranca", "autor": "AUTOR DE TESTE", "comarca": "Exemplo", "data_distribuicao": "01/03/2026", "documento": "12345678909", "foro": "Foro de Exemplo", "origem": "Local", "processo": "0000001-00.2026.8.26.0001", "requerido": "FULANO DE TESTE", "valor": 5000, "vara": "1a Vara Civel" } ], "quantidade": 1, "valor_maior": 5000, "valor_menor": 5000, "valor_primeiro": 5000, "valor_total": 5000, "valor_ultimo": 5000 }, "cartao_nacional_saude": "000000000000000", "cheque_sem_fundo": { "bacen": { "correntista": null, "documento": null, "quantidade": 0, "tipo_pessoa": null }, "varejo": { "correntista": null, "documento": null, "quantidade": 0, "tipo_pessoa": null } }, "classe_social": "C1", "controle_positivo": { "notas_contratos_recentes": [ 7 ], "notas_faturas_em_atraso": [ 4 ] }, "data_atualizacao_receita": "01/10/2026", "data_nascimento": "01/01/1980", "decisao": { "codigo_situacao": "02", "descricao": "Analise recomendada", "layout": "ACERTA MAIS", "resultado": "Aprovar com ressalvas" }, "documento": "123.456.789-09", "email": "[omitido]", "enderecos": [ { "bairro": "CENTRO", "cep": "01310100", "cidade": "EXEMPLO", "complemento": "APTO 1", "logradouro": "RUA DE TESTE", "numero": "100", "uf": "SP" } ], "estado_civil": "Solteiro", "faixa_renda": "De 3 a 5 salarios", "falencias_acoes_recuperacoes": { "ocorrencias": [], "quantidade": 0, "ultimo_registro": null, "valor_total": null }, "grau_instrucao": "Superior completo", "indicacao_obito": "Nao", "nacionalidade": "Brasileira", "naturalidade": "Exemplo/SP", "nome": "FULANO DE TESTE", "nome_mae": "MARIA DE TESTE", "nome_pai": "JOSE DE TESTE", "nome_social": null, "numero_dependentes": 1, "origem_cpf": "Receita Federal", "participacao_em_empresas": { "ocorrencias": [ { "cargo": "Administrador", "cnpj": "11222333000181", "documento_participante": "12345678909", "participacao": 50, "quantidade_outros_socios": 1, "razao_social": "EMPRESA TESTE LTDA", "renda_participante": 5000, "tipo_participante": "Socio" } ], "quantidade": 1 }, "passagens_comerciais": { "ocorrencias": [ { "cliente_consulta": "LOJA DE TESTE", "data_consulta": "01/11/2026", "endereco_cliente": "RUA DE TESTE, 1", "hora_consulta": "10:00", "telefone_cliente": "1133330000" } ], "quantidade": 1 }, "pdf": "(link do PDF da consulta)", "pendencias_financeiras": { "data_maior": "10/09/2026", "data_primeiro": "10/09/2026", "ocorrencias": [ { "contrato": "0001", "credor": "BANCO DE TESTE", "data_inclusao": "20/09/2026", "data_vencimento": "10/09/2026", "entidade": "Entidade de teste", "informante": "BANCO DE TESTE", "modalidade": "Cartao", "moeda": "R$", "origem": "Local", "sub_judice": "Nao", "tipo_devedor": "Principal", "valor": 1250.5 } ], "periodo_final": "10/09/2026", "periodo_inicial": "10/09/2026", "provedores": [ "Cadastro de exemplo" ], "quantidade": 1, "total_credores": 1, "ultimo_vencimento": "10/09/2026", "valor_maior": 1250.5, "valor_primeiro": 1250.5, "valor_total": 1250.5 }, "pis": "00000000000", "poder_aquisitivo": "Medio", "protestos": { "data_maior": "05/08/2026", "data_primeiro": "05/08/2026", "data_ultimo": "05/08/2026", "ocorrencias": [ { "anuencia": "Nao", "cartorio": "1 TABELIONATO DE EXEMPLO", "credor": "CREDOR DE TESTE", "data": "05/08/2026", "moeda": "R$", "origem": "Local", "quantidade": 1, "sub_judice": "Nao", "tipo_anotacao": "Protesto", "valor": 800, "valor_custas": 30, "vencimento": "01/07/2026" } ], "quantidade": 1, "ultimo_protesto": "05/08/2026", "valor_maior": 800, "valor_primeiro": 800, "valor_total": 800, "valor_ultimo": 800 }, "qtd_dependentes_bolsa_familia": 0, "renda_presumida": { "dados_cadastro_positivo": "Sim", "data_referencia": "01/10/2026", "descricao": "Renda presumida (amostra)", "faixa": "De 3 a 5 salarios", "mensagem": "Estimativa de homologacao", "renda_anual": 60000, "valor_presumido": 5000 }, "restricoes": { "ocorrencias": [ { "codigo": "001", "descricao": "Restricao de exemplo", "observacao": "Registro ficticio de homologacao", "titulo": "Aviso de teste" } ], "quantidade": 1 }, "resumo": { "cheque_sem_fundo": false, "classificacao_score": "B", "decisao": "Aprovar com ressalvas", "possui_restricao": true, "score": 650, "total_acoes_civeis": 1, "total_empresas_participacao": 1, "total_falencias_acoes_recuperacoes": 0, "total_passagens_comerciais": 1, "total_pendencias_financeiras": 1, "total_protestos": 1, "total_restricoes": 1, "valor_pendencias_financeiras": 1250.5, "valor_protestos": 800 }, "rg": "000000000", "rg_data_emissao": "01/01/2010", "rg_uf": "SP", "scores": { "ocorrencias": [ { "classificacao": "B", "classificacao_numero": 3, "descricao_plano": "Plano de exemplo", "descricao_score": "Probabilidade de pagamento", "execucao": "12/11/2026", "informante": "Exemplo", "layout": "ACERTA MAIS", "modelo_score": "Modelo de teste", "probabilidade_inadimplencia": 12.5, "risco": "Medio", "score": 650, "texto": "Risco moderado (amostra)", "tipo_score": "Score de credito" } ], "quantidade": 1 }, "sexo": "Masculino", "situacao_cpf": "REGULAR", "telefones": [ { "ddd": "11", "numero": "900000000", "telefone_completo": "11900000000" } ], "titulo_eleitor": "000000000000", "ultimo_imposto_renda": "2025" } } } ``` 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/6ce12b6c-4abd-4ebe-a964-d0588166b07a/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/6ce12b6c-4abd-4ebe-a964-d0588166b07a