--- title: "Relatório Positivo PF" description: "API Relatório Positivo PF - Decisões Mais Assertivas em Instantes" lang: pt-BR canonical: https://doc.apibrasil.io/apis/creditos/db2066d6-a371-4a09-aeab-85c52fa7dd0c markdown: https://doc.apibrasil.io/apis/creditos/db2066d6-a371-4a09-aeab-85c52fa7dd0c.md source: apibrasil-documentation --- # Relatório Positivo PF > API Relatório Positivo PF - Decisões Mais Assertivas em Instantes - **Categoria:** Análise de Crédito - **Cobrança:** por consulta, só com o Bearer Token - **Preço:** R$ 36,30 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/db2066d6-a371-4a09-aeab-85c52fa7dd0c/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 Relatório Positivo PF - Crédito mais assertivo em segundos A API Relatório Positivo PF oferece uma consulta ágil e segura ao histórico positivo de crédito de pessoas físicas, proporcionando uma integração rápida ao seu sistema através do serviço relatorio-positivo. Em poucas horas, você conta com respostas estruturadas e de alto valor de negócio, prontas para enriquecer processos de análise de risco, aprimorar scoring interno e personalizar ofertas para seus clientes. Com dados consolidados entregues em tempo real e alta disponibilidade, sua empresa reduz inadimplência e amplia aprovações, otimizando todo o ciclo de concessão de crédito de forma prática e eficiente. - **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": "relatorio-positivo", "cpf": "000000000000", "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":"relatorio-positivo","cpf":"000000000000","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": { "consultas": { "contagem_consultas_31_a_60_dias": 2, "contagem_consultas_61_a_90_dias": 3, "contagem_consultas_mais_90_dias": 8, "contagem_consultas_ultimos_30_dias": 5, "detalhes_consultas": [ { "contagem_consultas": 2, "data_consulta": { "ano": "2026", "dia": "15", "mes": "03" }, "segmento": "0" }, { "contagem_consultas": 3, "data_consulta": { "ano": "2026", "dia": "10", "mes": "03" }, "segmento": "0" }, { "contagem_consultas": 1, "data_consulta": { "ano": "2026", "dia": "28", "mes": "02" }, "segmento": "0" }, { "contagem_consultas": 2, "data_consulta": { "ano": "2026", "dia": "20", "mes": "02" }, "segmento": "0" }, { "contagem_consultas": 1, "data_consulta": { "ano": "2026", "dia": "15", "mes": "02" }, "segmento": "0" }, { "contagem_consultas": 1, "data_consulta": { "ano": "2026", "dia": "05", "mes": "02" }, "segmento": "0" }, { "contagem_consultas": 2, "data_consulta": { "ano": "2026", "dia": "25", "mes": "01" }, "segmento": "0" }, { "contagem_consultas": 1, "data_consulta": { "ano": "2026", "dia": "10", "mes": "01" }, "segmento": "0" }, { "contagem_consultas": 1, "data_consulta": { "ano": "2025", "dia": "28", "mes": "12" }, "segmento": "0" } ] }, "dados_cadastrais": { "cpf": "00000000000", "data_nascimento": { "ano": "1985", "dia": "15", "mes": "07" }, "data_obito": { "ano": null, "dia": null, "mes": null }, "emails": { "data_ultima_visualizacao": { "ano": "2026", "dia": "10", "mes": "03" }, "emails": "[omitido]" }, "enderecos": { "bairro": "CENTRO", "cidade": "SAO PAULO", "codigo_postal": "01310100", "complemento": "APTO 101", "data_ultima_visualizacao": { "ano": "2026", "dia": "05", "mes": "02" }, "estado": "SP", "numero": "1000", "rua": "AVENIDA PAULISTA" }, "falecido": null, "genero": "M", "historico_email": { "emails": [ { "data_ultima_visualizacao": { "ano": "2026", "dia": "10", "mes": "03" }, "emails": "[omitido]" }, { "data_ultima_visualizacao": { "ano": "2025", "dia": "15", "mes": "11" }, "emails": "[omitido]" } ] }, "historico_endereco": { "enderecos": [ { "bairro": "CENTRO", "cidade": "SAO PAULO", "codigo_postal": "01310100", "complemento": "APTO 101", "data_ultima_visualizacao": { "ano": "2026", "dia": "05", "mes": "02" }, "estado": "SP", "numero": "1000", "rua": "AVENIDA PAULISTA" } ] }, "historico_nome_pessoa": { "nomes": [ { "data_ultima_visualizacao": { "ano": "2025", "dia": "20", "mes": "12" }, "nomes": { "completo": "JOAO DA SILVA SANTOS", "meio": "DA SILVA", "prefixo": null, "primeiro": "JOAO", "sufixo": null, "ultimo": "SANTOS" } } ] }, "historico_numero_celular": { "numero_celular": [ { "data_ultima_visualizacao": { "ano": "2026", "dia": "01", "mes": "03" }, "numero_telefone": "11987654321" } ] }, "historico_numero_telefone": { "numero_telefone": [] }, "idade": "40", "nome_mae": { "completo": "MARIA SILVA SANTOS" }, "nome_pessoa": { "data_ultima_visualizacao": { "ano": "2025", "dia": "20", "mes": "12" }, "nomes": { "completo": "JOAO DA SILVA SANTOS" } }, "numero_celular": { "data_ultima_visualizacao": { "ano": "2026", "dia": "01", "mes": "03" }, "numero_telefone": "11987654321" }, "numero_telefone": { "data_ultima_visualizacao": { "ano": null, "dia": null, "mes": null }, "numero_telefone": null }, "status_cpf": "R" }, "indicadores": { "pontualidade_de_pagamento": { "descricao": "Alta", "descricao_complementar": "O consumidor paga 100% ou a maioria das suas contas em dia na média dos últimos 12 meses." }, "relacionamento_com_mercado": { "descricao": "Bom", "descricao_complementar": "O consumidor apresenta comportamento adequado na utilização de produtos financeiros." } }, "negativacoes": { "acoes_judiciais_apontamentos": [], "apontamentos": [], "ccf_apontamentos": [], "controle_pendencias_credito": "0", "data_ultimo_apontamento": { "ano": null, "dia": null, "mes": null } }, "participacao_societaria_em_empresas": [], "possui_apenas_dados_pessoais_minimos": false, "possui_dados_consulta": true, "possui_dados_negativacoes": false, "possui_linhas_credito": null, "protestos": [ { "cartorios": [], "cnpj": null, "cpf_cnpj": null, "data_consulta": "2026-03-15", "descricao_erro": null, "erro": null, "id_transacao": null, "retorno": null, "situacao": null, "valor_protestados_total": null } ], "score_credito": { "descricao_probabilidade_pagamento": "A chance deste consumidor não pagar nos próximos meses é de 8%.", "descricao_score": "Capacidade de pagamento maior do que a média da população brasileira.", "probabilidade_pagamento": "92% e 95%", "risco": "Baixo", "score": 825, "score_compromisso_pagamento": 92, "score_perfil": 65, "segmento": "4.0" }, "segmento": "4", "status_cadastro_positivo": "1" } } } ``` 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/db2066d6-a371-4a09-aeab-85c52fa7dd0c/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/db2066d6-a371-4a09-aeab-85c52fa7dd0c