--- title: "Relatório Positivo PF" description: "API Relatório Positivo PF - Decisões Mais Assertivas em Instantes" lang: en 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 - **Category:** Credit Analysis - **Billing:** per query, with the Bearer Token only - **Price:** R$36.30 per query - **Limit:** 999,000 per month - **Registration:** requires a CNPJ - **Version:** v1 - **Published by:** APIBrasil - **OpenAPI specification:** https://doc.apibrasil.io/apis/creditos/db2066d6-a371-4a09-aeab-85c52fa7dd0c/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 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. - **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": "relatorio-positivo", "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":"relatorio-positivo","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": { "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" } } } ``` 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/db2066d6-a371-4a09-aeab-85c52fa7dd0c/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/db2066d6-a371-4a09-aeab-85c52fa7dd0c