Descrição
O dataset Dados Cadastrais de Recência Configurável contém informações básicas relacionadas aos dados cadastrais de um indivíduo, incluindo nome, documento de identificação, data de nascimento, nome da mãe, entre outros. Além disso, inclui um campo que indica o status do documento consultado, informando se está regular, pendente de regularização, cancelado, pertence a uma pessoa falecida, entre outras situações.
Esses dados também estão disponíveis no dataset Dados Cadastrais Básicos. A principal diferença é que este dataset permite definir um tempo máximo desde a última atualização do documento. Se os dados não forem tão recentes quanto o necessário, os dados que têm como fonte a Receita Federal serão reavaliados em tempo real para fornecer as informações mais atualizadas o possível. Isso permite atender a modelos e regras de negócio mais rigorosos, que exigem um nível ainda mais elevado de recência dos dados em comparação com o dataset Dados Cadastrais Básicos, além de oferecer uma melhor performance em relação à consulta on-demand na Receita Federal.
Origem da Informação
Este dataset reúne informações de diferentes origens, como a Receita Federal do Brasil, o CNIS (Cadastro Nacional de Informações Sociais), processos judiciais e dezenas de outras fontes.
Tabela de preços para esse dataset
| Consultas Realizadas no Mês | Valor por consulta |
|---|---|
| 1 - 10000 | R$ 0,090 |
| 10001 - 50000 | R$ 0,085 |
| 50001 - 100000 | R$ 0,081 |
| 100001 - 500000 | R$ 0,077 |
| 500001 - 1000000 | R$ 0,073 |
| 1000001 - 5000000 | R$ 0,069 |
| 5000001 - 10000000 | R$ 0,066 |
| 10000001 - 50000000 | R$ 0,063 |
| 50000001 e acima | R$ 0,060 |
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 |
| max_days_since_update | Este campo permite restringir o tempo desde a última atualização do documento de modo que, caso os dados não sejam tão recentes quanto o necessário, as fontes do dataset serão reavaliadas em tempo real para ser entregues com as informações mais atualizadas o possível. Importante: Por padrão, o valor de deste campo é "30" e ele não pode assumir valores abaixo de "7". | Número de dias | ℹ️ Opcional |
| name | Possibilita a comparação do nome informado na entrada com o nome encontrado na base, trazendo 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, trazendo o percentual de similaridade entre eles. | Qualquer texto | ℹ️ 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_with_configurable_recency",
"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 | REGULAR, PENDENTE DE REGULARIZACAO, CANCELADA, NULA, SUSPENSA, TITULAR FALECIDO, CPF COM DADOS INCOMPLETOS, BIRTH DATE AND DOCUMENT DOESN'T MATCH, CPF DOES NOT EXIST IN RECEITA FEDERAL DATABASE, INVALID DOCUMENT |
| 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 |