Descrição
O dataset de Dados Cadastrais Básicos contém o conjunto mais simples de informações de todos os datasets, com informações cadastrais recuperadas de fontes oficiais e combinadas com inferências e outros dados relacionados. Exemplos de informações retornadas nesse escopo são o nome, o CPF, o nome da mãe e a data de nascimento.
Para consultas realizadas através de chaves de entrada que não são o CPF (consulta por nome e data de nascimento, ou por e-mail, ou qualquer outra chave), podem ser retornados múltiplos objetos de Dados Cadastrais Básicos, um para cada "candidato" encontrado na pesquisa.
Esse dataset suporta uma série de parâmetros opcionais, listados mais abaixo, que possibilitam, além da consulta aos dados em si, a validação de informações enviadas na entrada. Os parâmetros opcionais podem ser utilizados de forma isolada, ou em conjunto, realizando múltiplas validações em uma única chamada sem nenhum custo adicional.
Origem da Informação
Esse dataset reúne informações de diferentes origens, como a Receita Federal do Brasil (e órgãos equivalentes no exterior), o CNIS (Cadastro Nacional de Informações Sociais), processos judiciais, e dezenas de outras fontes de informação específicas. A informação de óbito é coletada da Receita Federal do Brasil e de entidades de classe.
Tabela de preços para esse dataset
| Consultas Realizadas no Mês | Valor por consulta |
|---|---|
| 1 - 10000 | R$ 0,030 |
| 10001 - 50000 | R$ 0,028 |
| 50001 - 100000 | R$ 0,027 |
| 100001 - 500000 | R$ 0,026 |
| 500001 - 1000000 | R$ 0,025 |
| 1000001 - 5000000 | R$ 21.000,00 (preço fixo) |
| 5000001 e acima | Entre em contato |
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 |
| name | Possibilita a comparação de um nome informado na entrada com o nome encontrado na base, retornando o percentual de similaridade entre eles. | Qualquer texto | ℹ️ Opcional |
| mothername | Possibilita a comparação do nome da mãe informado na entrada com o nome da mãe encontrado na base, retornando o percentual de similaridade entre eles. | Qualquer texto | ℹ️ Opcional |
| fathername | Possibilita a comparação do nome do pai informado na entrada com o nome do pai encontrado na base, retornando o percentual de similaridade entre eles. | Qualquer texto | ℹ️ Opcional |
| birthdate | Data de Nascimento | yyyy-MM-dd | ℹ️ Opcional |
| dateformat | Formato da Data | yyyy-MM-dd, dd/MM/yyyy | ℹ️ 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": "basic_data",
"q": "doc{CPF}"
}
Retornos específicos para menores de idade
Devido às mudanças nas regras de tratamento de dados impostas pela LGPD, e por como essa lei trata dispositivos específicos da Lei da Criança e do Adolescente, todas as consultas feitas na API de Pessoas à CPFs de indivíduos entre 0 e 18 anos de idade obedecem a regras específicas de retorno de informação para esse público. Veja quais são elas clicando aqui.
Campos com valores predefinidos
Alguns campos, como o status do CPF na Receita Federal e o Gênero, têm valores predefinidos. Os valores possíveis para esses campos seguem abaixo.
| Campo | Valores Possíveis |
|---|---|
| TaxIdStatus | BIRTH DATE AND DOCUMENT DOESN'T MATCH, CANCELADA, CPF COM DADOS INCOMPLETOS, CPF DOES NOT EXIST IN RECEITA FEDERAL DATABASE, INVALID DOCUMENT, NULA, PENDENTE DE REGULARIZACAO, REGULAR, SUSPENSA, TITULAR FALECIDO |
| TaxIdFiscalRegion | "DF-GO-MS-MT-TO", "AC-AM-AP-PA-RO-RR", "CE-MA-PI", "AL-PB-PE-RN", "BA-SE", "MG", "ES-RJ", "SP", "PR-SC", "RS" |
| Gender | M, F, U |
| Signo | CAPRICORNIO, ARIES, LEAO, CANCER, LIBRA, AQUARIO, SAGITARIO, GEMEOS, VIRGEM, TOURO, PEIXES, ESCORPIAO |
Consulta direta ao site da Receita Federal
Se o CPF consultado não estiver presente em nossa base de dados, realizaremos uma captura on-demand diretamente junto à Receita Federal, integrada à própria requisição ao dataset de Dados Básicos. Por se tratar de um processo complexo e dependente da disponibilidade do serviço da Receita Federal, o tempo de resposta nesses casos poderá ser maior.
Em geral, não é necessário recorrer à consulta direta ao site da Receita, pois nossa base é mantida atualizada de forma contínua. Atualizamos os dados dos CPFs com uma frequência máxima de quatro meses, sem considerar o mês vigente, além de adicionarmos novos registros diariamente. CPFs com status de risco — como "PENDENTE DE REGULARIZACAO" e "SUSPENSA" — são verificados todos os meses.
Para casos em que haja necessidade de dados mais recentes, recomendamos o uso do nosso dataset de Dados Cadastrais de Recência Configurável. Ele permite definir, em dias, o tempo máximo desde a última captura que será aceito. Se a informação disponível em nossa base for mais antiga que esse limite, realizamos automaticamente uma nova consulta à Receita Federal. O valor mínimo de recência permitida é de 7 dias.
Em situações excepcionais que exijam dados do mesmo dia, sugerimos o uso do nosso serviço on-demand de Consulta de CPF na Receita Federal, lembrando que o tempo de resposta e a disponibilidade estão sujeitos ao funcionamento do serviço da Receita.
Retorno de Datas de Nascimento Inválidas
De acordo com os dados da Receita Federal, alguns indivíduos possuem datas de nascimento inválidas, impossibilitando sua formatação para o campo BirthDate. Nesses casos, o indicador IsValidBirthDateInRFSource será false, e o campo CapturedBirthDateFromRFSource retornará a data capturada na Receita Federal, sempre no formato yyyy-MM-dd.
Uma data é considerada inválida quando não existe no calendário, como:
- Dias além do limite do mês (ex.: 2023-04-31, já que abril tem apenas 30 dias).
- 29 de fevereiro em anos que não são bissextos (ex.: 2002-02-29, 1987-02-29).