💡A API Receita Federal - Pessoa Física permite consultar dados cadastrais e fiscais de pessoas físicas, incluindo situação cadastral, informações de inscrição e possíveis registros de óbito na Receita Federal.
Introdução
A API Receita Federal - Pessoa Física fornece informações detalhadas sobre a situação cadastral e fiscal de uma Pessoa Física perante a Receita Federal. Ideal para validação de cadastro, análises fiscais e compliance.
URL Base
A API está hospedada no seguinte endereço:
https://api.directd.com.br
Endpoint
Consulta de Receita Federal - Pessoa Física
GET /api/ReceitaFederalPessoaFisica
Descrição: Endpoint para consultar dados cadastrais e fiscais de uma Pessoa Física.
Nota: É possível gerar um comprovante em PDF mediante configuração adicional.
Autenticação
Para acessar esta API, é necessário fornecer um token de autenticação.
Regras de Autenticação:
- O token deve ser enviado como parâmetro na URL da requisição.
- O token é obrigatório para realizar consultas.
Campos da API
Dados da Receita Federal
- Número do CPF: CPF do indivíduo consultado.
- Nome da Pessoa Física: Nome completo da pessoa física.
- Nome Social: Nome social, se aplicável.
- Data de Nascimento: Data de nascimento do indivíduo.
- Situação Cadastral: Situação cadastral do CPF perante a Receita Federal.
- Data de Inscrição: Data de inscrição no CPF.
- Flag Data de Inscrição anterior a 1990: Indica se a inscrição ocorreu antes de 1990.
- Dígito Verificador: Dígito verificador do CPF.
- Flag Possui Óbito: Indica se o CPF está vinculado a um registro de óbito.
- Ano de Óbito: Ano de ocorrência do óbito, se aplicável.
- Data de Emissão: Data de emissão do comprovante de consulta.
- Código de Controle do Comprovante: Código de verificação do comprovante.
- Data da Consulta: Data em que a consulta foi realizada.
Parâmetros
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
| CPF | string | Sim | CPF da pessoa consultada. Pode ser enviado com ou sem formatação. |
| DATANASCIMENTO | string | Sim | Data de nascimento da pessoa consultada. Formatação livre. |
| TOKEN | string | Sim | Token de autenticação necessário para a consulta. |
| GERARCOMPROVANTE | string | Não | Gera comprovante em PDF: Habilitar ou Desabilitar. |
Exemplos de Requisição
Usando cURL
curl 'https://api.directd.com.br/api/ReceitaFederalPessoaFisica?CPF=12345678909&DATANASCIMENTO=01-01-1980&TOKEN=seu_token_aqui&GERARCOMPROVANTE=Habilitar'
Respostas
Sucesso (200)
Exemplo de Resposta
{
"metaDados": {
"consultaNome": "Receita Federal - Pessoa Física",
"consultaUid": "receitaPessoaFisica-123456",
"usuario": "João Silva",
"mensagem": "Sucesso",
"apiVersao": "v3",
"tempoExecucaoMs": 150
},
"retorno": {
"numeroCPF": "123.456.789-09",
"nomePessoaFisica": "João da Silva",
"nomeSocial": null,
"dataNascimento": "1980-01-01",
"situacaoCadastral": "Regular",
"dataInscricao": "1990-01-01",
"dataInscricaoAnterior1990": true,
"digitoVerificador": "9",
"dataEmissao": "2024-12-09",
"codigoControleComprovante": "ABC123DEF",
"dataConsulta": "2024-12-09",
"possuiObito": false,
"anoObito": null}
}
9. Erros Comuns
| Código | Descrição |
|---|---|
| 400 | Requisição inválida: parâmetros incorretos. |
| 401 | Não autenticado: token inválido ou ausente. |
| 403 | Não autorizado: saldo insuficiente para realizar a consulta. |
| 404 | Não encontrado: registro não localizado. |
| 408 | Tempo esgotado: consulta não foi concluída no prazo. |
| 500 | Erro interno: falha no processamento da consulta. |
| 503 | Serviço em manutenção: indisponível temporariamente. |
10. Notas Importantes
- Apenas um CPF deve ser informado por requisição.
- O comprovante em PDF é opcional e gera um custo adicional.
- Certifique-se de que seu saldo na plataforma seja suficiente para a consulta.