Fontes de Consulta
Retornos apresentados por cada uma das fontes de consulta assíncrona pela Netrin. Você pode solicitar acesso a estas fontes através de suporte@netrin.com.br
Regularidade do CPF
Definição
A consulta de regularidade de CPF permite validar um CPF conforme os parâmetros solicitados. Inicialmente, a consulta é executada em nossa base offline, que contém os dados mais recentes deste CPF consultados ou atualizados periodicamente pelos nossos algoritmos. É importante observar que esses dados visam cobrir mais de 99% das informações em relação aos dados oficiais da fonte original, neste caso, a Receita Federal. No entanto, é possível que ocorram inconsistências entre os dados em nossa base e a fonte oficial, especialmente em relação à situação cadastral do CPF ou a um registro de óbito ainda não capturado pelos nossos algoritmos ou uma consulta recente.
De qualquer forma, ao fazer uma requisição para a consulta de CPF, logo após a API retornar os dados de nossa base offline, uma busca online na fonte oficial (Receita Federal) será realizada para confirmar ou não as informações, em um tempo médio de 10 segundos*. Se uma inconsistência for identificada, um e-mail será enviado para a caixa de e-mail configurada com os detalhes da divergência. Para informações que não apresentarem inconsistências, nenhum aviso ou e-mail será emitido.
Informamos que este tempo médio de 10 segundos pode variar de acordo com a disponibilidade e performance de respostas dos sites e aplicativos da receita federal. Todas as requisições na consulta assíncrona são enfileiradas para checagem on-line na Receita Federal,
caso o site ou aplicativo da Receita Federal esteja fora do ar elas serão avaliadas tão logo eles voltem a operar normalmente e, nestes casos, eventuais emails com alertas de inconsistências podem demorar mais tempo a chegar. Esclarecemos ainda que a Netrin possui um monitoramento constante da disponibilidade destes sites e aplicativos e possui área específica no portal do cliente para demonstrar esta disponibilidade, além de enviar comunicados específicos em casos de indisponibilidade duradoura.
Caso o usuário deseje realizar uma confirmação síncrona dos dados, em que o retorno será baseado nas informações reais encontradas na Receita Federal de forma online, é possível especificar o parâmetro de entrada “comprovante-sincrono=true”. Nesse caso, a consulta se tornará síncrona, exigindo aguardar o tempo total de processamento. Se esse parâmetro não for especificado, o padrão “false” será assumido.
Em ambos os casos, um link com o endereço para o comprovante da consulta será fornecido imediatamente. No caso de uma consulta assíncrona, pode levar até 10 segundos após o retorno para o arquivo do comprovante estar fisicamente disponível no endereço.
Por exemplo, uma consulta assíncrona que retorne a informação em 0,5 segundos pode levar até 10 segundos* para que o comprovante esteja disponível na URL indicada.
Requisição
URL do serviço: https://regularidade-cpf.netrin.com.br/v1/
| Parâmetros | Descrição |
|---|---|
| token | Token de acesso |
| cpf | CPF da pessoa a ser consultada |
| comprovante-sincrono | *Caso deseje receber o serviço de forma sincrona defina o parâmetro como "comprovante-sincrono=true" |
OBS: O parâmetro comprovante-sincrono é opcional.
Ex: https://regularidade-cpf.netrin.com.br/v1/?token=0000&cpf=0000
Response
{
"cpf": "00000000000",
"regularidadeCpf": {
"cpf": "00000000000",
"nome": "FULANO",
"primeiroNome": "FULANO",
"sobrenome": "FULANO",
"situacaoCadastral": "REGULAR",
"paisOrigem": "BRAZIL",
"idade": "20",
"nomeMae": "FULANA",
"genero": "M",
"digitoVerificador": "00",
"comprovante": "",
"dataNascimento": "10/08/2000",
"dataInscricao": "10/08/2000",
"anoObito": "",
"dataAtualizacao": "2023-08-14T05:47:03.092866",
"urlComprovante": ""
}
}
- Retorno das Exceções
As exceções da API podem ser encontradas na página de definições, na guia lateral.
Clique aqui para ir para as Definições da API
- Detalhamento do retorno JSON
| Chave | Tipo | Descrição | Valores |
|---|---|---|---|
| cpf | string | Número do CPF | - |
| nome | string | Nome atrelado ao CPF | - |
| primeiroNome | string | Primeiro nome atrelado ao CPF | - |
| sobrenome | string | Sobrenome atrelado ao CPF | - |
| situacaoCadastral | string | Situacao cadastral do CPF | REGULAR / SUSPENSA / TITULAR FALECIDO / PENDENTE DE REGULARIZAÇÃO / CANCELADA / NULA |
| paisOrigem | string | Pais de origem atrelado ao CPF | - |
| idade | int | Idade atrelado ao CPF | - |
| nomeMae | string | Nome da mãe atrelado ao CPF | - |
| genero | string | Gênero atrelado ao CPF | M = Masculino / F = Feminino / U = Indefinido |
| digitoVerificador | string | Dígito verificador do CPF | - |
| comprovante | string | Código de controle do comprovante da Receita Federal | - |
| dataNascimento | string | Data de nascimento atrelado ao CPF no padrão DD/MM/AAAA | - |
| dataInscricao | string | Data de inscrição do CPF no padrão DD/MM/AAAA | Quando o CPF retornado tiver sido cadastrado antes de 1990, a frase "anterior a" será adicionada antes da data |
| anoObito | string | Ano de óbtido do CPF no padrão AAAA | - |
| dataAtualizacao | string | Data que informa quando foi realizada a última atualização de dados deste CPF na Receita Federal no padrão AAAA-MM-DD HH:MM:SS | - |
| urlComprovante | link | URL para download do comprovante da consulta | - |
Comprovante
O acesso ao comprovante da consulta por meio da URL pode resultar em quatro situações:
- Visualização do comprovante como emitido pela Receita Federal.
- Mensagem: “Temporariamente indisponível, tente novamente mais tarde”, em caso de indisponibilidade técnica momentânea.
{
"message": "Temporariamente indisponível, tente novamente mais tarde",
}
- Mensagem: "Arquivo não disponível", quando o arquivo não é localizado em nosso sistema (como links quebrados ou incorretos).
{
"message": "Arquivo não disponível",
}
- Mensagem: "Arquivo Expirado", quando o prazo de validade ou armazenamento já se esgotou.
{
"message": "Arquivo Expirado",
}
Validação dos dados (Callback)
Além da notificação via e-mail, também é possível buscar os documentos que tiveram divergências através de uma consulta no endpoint https://regularidade-cpf.netrin.com.br/v1/divergencias?token= Nesse endpoint, serão listados todos os documentos que apresentaram informações diferentes em comparação com a primeira busca na base offline, comparando-os com a segunda consulta na Receita Federal.
O retorno apresentará apenas as divergências ainda não lidas, ou seja, na segunda chamada as divergências já abertas não estarão mais no retorno, apenas as novas, caso haja. Na tag "divergences_unread_total," será possível verificar o total de divergências ainda não lidas e que devem ser atualizadas. Na tag "asyncReturn," será disponibilizado o retorno que foi obtido na base offline, e na tag "receitaFederalReturn," o retorno oficial da Receita Federal, bem como os dados mais atualizados da fonte.
É igualmente importante verificar a tag "urlComprovante," que conterá o comprovante mais recente da consulta e que deverá ser armazenado internamente.
URL do serviço: https://regularidade-cpf.netrin.com.br/v1/divergencias?token=
| Parâmetros | Descrição |
|---|---|
| token | Token de acesso |
Ex: https://regularidade-cpf.netrin.com.br/v1/divergencias?token=0000000
Response
{
"divergences_unread_total":2,
"divergences_current":2,
"divergencias":[
{
"cpf":"000",
"nome":"NOME",
"dataNascimento":"01/01/2000",
"asyncReturn":{
"situacaoCadastral":"REGULAR",
"dataInscricao":"01/01/2000",
"digitoVerificador":"00",
"anoObito":""
},
"receitaFederalReturn":{
"situacaoCadastral":"PENDENTE DE REGULARIZAÇÃO",
"dataInscricao":"01/01/2000",
"digitoVerificador":"04",
"anoObito":""
},
"consultation_date":"2023-08-25T00:00:00.000000",
"notified_divergent_time":"5.686521",
"urlComprovante":""
},
{
"cpf":"0000",
"nome":"NOME",
"dataNascimento":"09/09/1999",
"asyncReturn":{
"situacaoCadastral":"PENDENTE DE REGULARIZAÇÃO",
"dataInscricao":"06/08/2002",
"digitoVerificador":"00",
"anoObito":""
},
"receitaFederalReturn":{
"situacaoCadastral":"REGULAR",
"dataInscricao":"06/08/2002",
"digitoVerificador":"00",
"anoObito":""
},
"consultation_date":"2023-08-25T00:00:00.000000",
"notified_divergent_time":"5.686521",
"urlComprovante":""
}
]
}
Validação dos dados (Webhook)
O serviço de webhook também está disponível para que você receba automaticamente o retorno em JSON dos dados divergentes, sem a necessidade de ficar perguntando para o endpoint de callback. Para usar este recurso, basta criar uma URL aberta em sua infraestrutura e notificar a equipe de suporte (suporte@netrin.com.br) que gostaria de receber as informações de divergências através do webhook por este link.
Ao contrário das informações em callback, que armazenam tudo em uma única resposta e entregam um array com várias divergências, a opção de webhook enfileira individualmente as divergências e entrega uma a uma. Ela só será considerada entregue ao cliente quando a URL aberta responder com status code 200.
É igualmente importante verificar a tag "urlComprovante", que conterá o comprovante mais recente da consulta e deverá ser armazenado internamente.
Response
{
"divergences_unread_total":1,
"divergences_current":1,
"divergencias":[
{
"cpf":"000",
"nome":"NOME",
"dataNascimento":"01/01/2000",
"asyncReturn":{
"situacaoCadastral":"REGULAR",
"dataInscricao":"01/01/2000",
"digitoVerificador":"00",
"anoObito":""
},
"receitaFederalReturn":{
"situacaoCadastral":"PENDENTE DE REGULARIZAÇÃO",
"dataInscricao":"01/01/2000",
"digitoVerificador":"04",
"anoObito":""
},
"consultation_date":"2023-08-25T00:00:00.000000",
"notified_divergent_time":"5.686521",
"urlComprovante":""
}
]
}