--- title: "CPF Relatorio" description: "API CPF Relatório — Consultas completas de CPF em PDF instantaneamente ⚠️ Atenção: os valores podem variar conforme os serviços adicionais ativados na consulta." lang: pt-BR canonical: https://doc.apibrasil.io/apis/creditos/1623ff95-cde5-4eb3-9ffd-818e17a867fd markdown: https://doc.apibrasil.io/apis/creditos/1623ff95-cde5-4eb3-9ffd-818e17a867fd.md source: apibrasil-documentation --- # CPF Relatorio > API CPF Relatório — Consultas completas de CPF em PDF instantaneamente > ⚠️ Atenção: os valores podem variar conforme os serviços adicionais ativados na consulta. - **Categoria:** Relatórios Whitelabel - **Cobrança:** por consulta, só com o Bearer Token - **Preço:** R$ 0,45 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/1623ff95-cde5-4eb3-9ffd-818e17a867fd/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 CPF Relatório — Consultas completas de CPF em PDF instantaneamente A API CPF Relatório permite consultar dados de CPF de forma rápida e simples, retornando um relatório completo em PDF em poucos segundos. Ideal para análise cadastral, crédito e validação de informações, a API oferece dados organizados, confiáveis e prontos para uso. O serviço possui modelo pay-per-use, iniciando em R$ 0,45 por consulta (dados cadastrais via cpf-search), podendo aumentar conforme a ativação de funções adicionais, como SPC e score de crédito. Valores individuais por consulta: CPF Search: R$ 0,45 SPC Terceiros: R$ 13,80 Score Credito Quod: R$ 7,50 SPC Boa Vista: R$ 5,00 Consulta completa: R$ 26,75* *Valor considerando a utilização de todos os serviços disponíveis na consulta. - **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": "cpf-relatorio", "cpf": "00000000000", "homolog": true, "extra": { "spc-terceiros-pf": true, "score-credito-quod": true, "spc-boa-vista": true }, "whitelabel": { "empresa": "APIBRASIL PROCESSAMENTO DE DADOS", "logo": "https://doc.apibrasil.io/images/design-mode-images-logo.png", "font-size": "14px", "font-color": "#000000", "header-color": "#000000", "font-header-color": "#ffffff" } } ``` **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":"cpf-relatorio","cpf":"00000000000","homolog":true,"extra":{"spc-terceiros-pf":true,"score-credito-quod":true,"spc-boa-vista":true},"whitelabel":{"empresa":"APIBRASIL PROCESSAMENTO DE DADOS","logo":"https://doc.apibrasil.io/images/design-mode-images-logo.png","font-size":"14px","font-color":"#000000","header-color":"#000000","font-header-color":"#ffffff"}}' ``` 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": "154,380", "error": false, "message": "Dados validos em homologacao! Voce nao foi tarifado e a requisicao nao foi contabilizada.", "tax": "0,000", "valor_consulta": 0, "api_limit_for": "homolog", "homolog": true, "extra_charges": { "services": [ { "service": "spc-terceiros-pf", "price": 13.8 }, { "service": "score-credito-quod", "price": 7.5 }, { "service": "spc-boa-vista", "price": 5 } ], "total": "26,300" }, "data": { "code": "000", "content": { "alerta_monitore": { "conteudo": [], "existe_informacao": "NAO" }, "alerta_participacoes": { "conteudo": [], "existe_informacao": "NAO" }, "contato_preferencial": { "conteudo": [], "existe_informacao": "NAO" }, "dados_parentes": { "conteudo": [], "existe_informacao": "NAO" }, "emails": { "conteudo": [], "existe_informacao": "NAO" }, "matriz_filial": { "conteudo": [], "existe_informacao": "NAO" }, "nome": { "conteudo": { "data_nascimento": "03/03/1900", "data_obito": "", "documento": "00000000000", "estrangeiro": { "estrangeiro": "Brasileiro", "existe_informacao": "NAO", "pais_origem": { "codigo": "", "origem": "Brasileiro" } }, "idade": "290 anos", "mae": "NOME FICTICIO DA SILVA", "nome": "NOME FICTICIO DA SILVA", "obito": null, "outras_datas_nascimento": [], "outras_grafias": [], "pessoa_exposta_publicamente": { "conteudo": "", "existe_informacao": "NAO", "relacionados": 0 }, "sexo": "MASCULINO", "signo": "", "situacao_receita": "", "situacao_receita_data": "", "situacao_receita_hora": "", "tipo_documento": "CPF", "uf": "" }, "existe_informacao": "SIM" }, "numero_beneficio": { "conteudo": [], "existe_informacao": "NAO" }, "outros_documentos": { "existe_informacao": "NAO", "rg": null }, "pesquisa_enderecos": { "conteudo": [ { "bairro": "UM BAIRO", "cep": "30000-000", "cidade": "UMA CIDADE", "complemento": "CASA", "estado": "UF", "logradouro": "UMA RUA", "numero": "2900" } ], "existe_informacao": "SIM" }, "pesquisa_telefones": { "conteudo": [ { "data_referencia": "00/00/0000", "img": null, "nao_pertube": "NAO", "numero": "31999999999", "operadora": "VIVO", "prioridade": "alta", "tem_zap": null, "tipo_tel": "CELULAR" } ], "existe_informacao": "SIM" }, "pessoas_contato": { "conteudo": [], "existe_informacao": "NAO" }, "protocolo": "260409104600157", "residentes_mesmo_domicilio": { "conteudo": [], "existe_informacao": "NAO" }, "trabalha_trabalhou": { "conteudo": [], "existe_informacao": "NAO" } }, "date": "2026-04-09", "hour": "10:46:00", "message": "Pesquisa feita com sucesso", "revision": "Tempo de execução: 0.355 segundos", "server": "02APIBRASIL" } } ``` 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/1623ff95-cde5-4eb3-9ffd-818e17a867fd/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/1623ff95-cde5-4eb3-9ffd-818e17a867fd