Descrição
A consulta de CPF na Receita Federal retorna o resultado da consulta de status do CPF disponível no site da Receita Federal, incluindo o Status, protocolo de consulta, informação de óbito (quando disponível) e outros detalhes. Embora a consulta no site exija a data de nascimento como um parâmetro de entrada, ele não é obrigatório para esse dataset. Caso não seja informada, será utilizada a informação de data de nascimento disponível dentro da base da BigData Corp. No entanto, podem existir casos raros onde não temos uma data de nascimento em nossa base, e nesses casos você receberá uma mensagem "BIRTH DATE PARAMETER MUST BE FILLED OUT" (-123). Todos os dados de certidões e certificações consultados em um modelo "on-demand" são retornados em uma mesma estrutura de objetos, e os objetos em si são retornados no campo de OnlineCertificates do objeto principal de retorno.
Origem da Informação
As informações retornadas nesta consulta são retiradas da consulta pública de status do CPF no site da Receita Federal. O link de acesso a essa consulta pode ser visto aqui.
Tabela de preços para esse dataset
Consultas Realizadas no Mês | Valor por consulta |
---|---|
1 - 10000 | R$ 0,050 |
10001 - 50000 | R$ 0,048 |
50001 - 100000 | R$ 0,046 |
100001 - 500000 | R$ 0,044 |
500001 - 1000000 | R$ 0,042 |
1000001 - 5000000 | R$ 0,040 |
5000001 - 10000000 | R$ 0,038 |
10000001 - 50000000 | R$ 0,036 |
50000001 e acima | R$ 0,034 |
Parâmetros de consulta
A tabela abaixo detalha os campos aceitos na consulta a este dataset.
Campo | Descrição | Valores Possíveis | Tipo de Campo |
---|---|---|---|
doc | Documento de identificação | CPF | 🛑 Obrigatório |
birthdate | Data de Nascimento do Indivíduo Consultado | Qualquer data válida | ⚠️ Semi-Obrigatório |
dateformat | Formato da data de nascimento informada | String de formatação da data, como yyyy-MM-dd ou similar | ℹ️ Opcional |
Clique aqui para saber mais sobre os parâmetros de consulta da Plataforma de Dados.
Abaixo está um exemplo de como realizar a chamada apenas com os parâmetros obrigatórios:
{
"Datasets": "ondemand_rf_status_person",
"q": "doc{CPF}"
}
Descrição dos campos do objeto principal de retorno
Campo | Descrição |
---|---|
Origin | Fonte dos Dados Entregues |
InputParameters | Parâmetros de entrada |
ProtocolNumber | Número de protocolo da certidão |
BaseStatus | Status base retornado pela certidão. |
QueryDate | Data de realização da consulta. |
AdditionalOutputData.Name | Nome de acordo com a certidão. |
AdditionalOutputData.Birthdate | Data de Nascimento de acordo com a certidão. |
AdditionalOutputData.QueryTime | Horário da consulta. |
AdditionalOutputData.SocialName | Nome Social de acordo com a certidão. |
AdditionalOutputData.Digit | Dígito da Receita Federal. |
AdditionalOutputData.RegistrationDate | Data de registro na Receita Federal. |
AdditionalOutputData.IsDead | Indicação de Óbito. |
AdditionalOutputData.DeathYear | Ano de Óbito. |