--- title: "Cadastro Ampliado de Pessoa Física" description: "API Cadastro Ampliado de Pessoa Física" lang: pt-BR canonical: https://doc.apibrasil.io/apis/creditos/a925aeff-280a-42d3-91d6-95cbc333b096 markdown: https://doc.apibrasil.io/apis/creditos/a925aeff-280a-42d3-91d6-95cbc333b096.md source: apibrasil-documentation --- # Cadastro Ampliado de Pessoa Física > API Cadastro Ampliado de Pessoa Física - **Categoria:** Consulta CPF - **Cobrança:** por consulta, só com o Bearer Token - **Preço:** R$ 0,79 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/a925aeff-280a-42d3-91d6-95cbc333b096/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=cadastro-pf-plus 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, nome, sexo, data_nascimento, idade, signo, nome_mae, nome_pai, obito, situacao_cadastral, data_situacao_cadastral, ocupacao (código CBO e descrição), classe_social, faixa_salarial, renda_estimada, telefones, enderecos, emails, parentescos, perfil_domiciliar, resumo (totais de telefones, endereços, e-mails e parentescos) e o link pdf do relatório. A cobrança acontece quando há dado cadastral para o CPF e a resposta é HTTP 200; CPF não encontrado ou retorno sem dado cadastral 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": "cadastro-pf-plus", "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":"cadastro-pf-plus","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": "399,210", "balance_before": "400,000", "tax": "0,790", "status_code": 200, "error": false, "message": "Dados validos! Voce foi tarifado em R$ 0,79.", "valor_consulta": 0.79, "api_limit_for": "credit", "homolog": false, "data": { "dados": { "classe_social": "C1", "data_nascimento": "01/01/1980", "data_situacao_cadastral": "01/01/2020", "documento": "123.456.789-09", "emails": [ "[omitido]" ], "enderecos": [ { "bairro": "CENTRO", "cep": "01000000", "cidade": "EXEMPLO", "complemento": "APTO 1", "logradouro": "RUA DE TESTE", "numero": "100", "uf": "SP" } ], "faixa_salarial": "2 a 3 salários mínimos", "idade": 46, "nome": "FULANO DE TESTE", "nome_mae": "MARIA DE TESTE", "nome_pai": "JOSE DE TESTE", "obito": false, "ocupacao": { "codigo_cbo": "000000", "descricao": "Ocupação de teste" }, "parentescos": [ { "cpf": "111.444.777-35", "data_nascimento": "02/02/1982", "data_obito": null, "genero": "M", "grau_parentesco": "Irmão", "nome": "BELTRANO DE TESTE", "obito": false } ], "pdf": "(link do PDF da consulta)", "perfil_domiciliar": { "classe_social_familiar": "C1", "confiabilidade": "Alta", "faixa_renda_per_capita": "2 a 3 salários mínimos", "quantidade_adultos": 2, "quantidade_menores": 1, "quantidade_moradores": 3, "renda_domiciliar": { "texto": "7.000,00", "valor": 7000 }, "renda_per_capita": { "texto": "2.333,33", "valor": 2333.33 }, "tipo_domicilio": "Casa" }, "renda_estimada": { "texto": "3.500,00", "valor": 3500 }, "resumo": { "total_emails": 1, "total_enderecos": 1, "total_parentescos": 1, "total_telefones": 1 }, "sexo": "Masculino", "signo": "Capricórnio", "situacao_cadastral": "Regular", "telefones": [ { "numero": "11900000000", "operadora": "OPERADORA TESTE", "telemarketing_bloqueado": false, "tipo": "Celular", "whatsapp": true } ] } } } ``` 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/a925aeff-280a-42d3-91d6-95cbc333b096/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/a925aeff-280a-42d3-91d6-95cbc333b096