--- title: "Cadastro e Receita Federal PF" description: "API Cadastro e Receita Federal PF" lang: pt-BR canonical: https://doc.apibrasil.io/apis/creditos/b27261d0-2552-402f-9273-b3670ed9771b markdown: https://doc.apibrasil.io/apis/creditos/b27261d0-2552-402f-9273-b3670ed9771b.md source: apibrasil-documentation --- # Cadastro e Receita Federal PF > API Cadastro e Receita Federal PF - **Categoria:** Consulta CPF - **Cobrança:** por consulta, só com o Bearer Token - **Preço:** R$ 0,92 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/b27261d0-2552-402f-9273-b3670ed9771b/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=receita-federal-pessoa-fisica e o cpf consultado (somente tipo, cpf e homolog são aceitos no corpo; outro campo é recusado com HTTP 400). A resposta vem em data e traz o bloco receita (numeroCPF, nomePessoaFisica, situacaoCadastral, dataInscricao, dataNascimento, possuiObito, anoObito e codigoControleComprovante) e o bloco cadastro (nome, nomeMae, dataNascimento, idade, sexo, enderecos, telefones, emails e faixa de renda estimada). A cobrança acontece quando o CPF é localizado na Receita Federal; dado de entrada ausente ou inválido é recusado com HTTP 400, sem cobrança. Registro não localizado responde HTTP 404 e 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, sem cobrança. - **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": "receita-federal-pessoa-fisica", "cpf": "00000000000", "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":"receita-federal-pessoa-fisica","cpf":"00000000000","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": "400,000", "balance_before": "400,000", "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": { "cadastro": { "cpf": "000.000.000-00", "dataNascimento": "14/02/1992 00:00:00", "emails": [ { "enderecoEmail": "[omitido]" }, { "enderecoEmail": "[omitido]" }, { "enderecoEmail": "[omitido]" } ], "enderecos": [ { "bairro": "JARDIM HORIZONTE", "cep": "04123-456", "cidade": "SAO PAULO", "complemento": "AP 42", "logradouro": "RUA DAS ACACIAS", "numero": "128", "uf": "SP" }, { "bairro": "CENTRO HISTORICO", "cep": "70010-020", "cidade": "BRASILIA", "complemento": null, "logradouro": "AVENIDA DOS ARQUIVOS", "numero": "915", "uf": "DF" }, { "bairro": "VILA DAS OLIVEIRAS", "cep": "88030-600", "cidade": "FLORIANOPOLIS", "complemento": "CASA", "logradouro": "ALAMEDA DO LUAR", "numero": "75", "uf": "SC" } ], "idade": 33, "nome": "LUNA ANDRADE COSTA", "nomeMae": "REGINA ANDRADE COSTA", "rendaEstimada": "9870.50", "rendaFaixaSalarial": "Faixa 4 a 6 salarios minimos", "sexo": "Feminino", "signo": "GEMEOS", "telefones": [ { "operadora": "VIVO", "telefoneComDDD": "(11) 998776655", "telemarketingBloqueado": true, "tipoTelefone": "TELEFONE MOVEL", "whatsApp": true }, { "operadora": "CLARO", "telefoneComDDD": "(21) 997001122", "telemarketingBloqueado": false, "tipoTelefone": "TELEFONE MOVEL", "whatsApp": true }, { "operadora": "TIM", "telefoneComDDD": "(31) 988554433", "telemarketingBloqueado": null, "tipoTelefone": "TELEFONE MOVEL", "whatsApp": true }, { "operadora": "OI", "telefoneComDDD": "(41) 996443322", "telemarketingBloqueado": true, "tipoTelefone": "TELEFONE MOVEL", "whatsApp": false }, { "operadora": "SERCOMTEL", "telefoneComDDD": "(51) 981234567", "telemarketingBloqueado": false, "tipoTelefone": "TELEFONE FIXO", "whatsApp": false } ] }, "consultaRealizadaEm": "2026-11-13T13:59:09Z", "cpf": "00000000000", "dataConsulta": "13/11/2026 13:59:09", "documentoConsultado": "00000000000", "eventosFuturosSIMEI": [ { "dataFim": null, "dataInicio": null, "detalhamento": "Nao Existem" } ], "eventosFuturosSimplesNacional": [ { "dataFim": null, "dataInicio": null, "detalhamento": "Nao Existem" } ], "meiTransportadorAutonomo": [ { "dataFim": null, "dataInicio": null, "detalhamento": "Nao Existem" } ], "nome": "", "nomeEmpresarial": "", "optanteSimei": false, "optanteSimplesNacional": false, "pendencias": [], "possuiPendencias": false, "receita": { "anoObito": null, "codigoControleComprovante": "FAKE.8A2C.4F1E.9B7D", "dataConsulta": "13/11/2026 13:59:09", "dataEmissao": "13/11/2026 13:59:09", "dataInscricao": "08/01/2014 00:00:00", "dataInscricaoAnterior1990": null, "dataNascimento": "14/02/1992 00:00:00", "digitoVerificador": "00", "nomePessoaFisica": "LUNA ANDRADE COSTA", "nomeSocial": null, "numeroCPF": "000.000.000-00", "possuiObito": false, "situacaoCadastral": "REGULAR" }, "simeiPeriodosAnteriores": [ { "dataFim": null, "dataInicio": null, "detalhamento": "Nao Existem" } ], "simplesNacionalPeriodosAnteriores": [ { "dataFim": null, "dataInicio": null, "detalhamento": "Nao Existem" } ], "situacaoSIMEI": "NAO enquadrado no SIMEI", "situacaoSimplesNacional": "Situacao nao informada", "status": "Nao foram encontradas pendencias.", "totalPendencias": 0 } } ``` 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/b27261d0-2552-402f-9273-b3670ed9771b/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/b27261d0-2552-402f-9273-b3670ed9771b