Definição

Este documento descreve o funcionamento da API Assíncrona, o seu objetivo, os parâmetros da chamada e os seus respectivos retornos. O conteúdo desta documentação e as especificações da API Assíncrona estão sujeitos a alterações sem aviso prévio.

Consulta

A chamada à API Assíncrona proporciona a realização de consultas sem a necessidade de aguardar a conclusão integral da busca pela informação na fonte oficial. Isso permite que a aplicação integrada continue suas operações sem esperar pelo resultado completo do processamento. Seu desenvolvimento prevê que a primeira resposta à chamada da API forneça a versão mais atualizada dos dados disponíveis em nossas bases. Posteriormente, de maneira assíncrona, esses dados serão confrontados com a base oficial da qual se originam. Caso sejam identificadas divergências, um e-mail de alerta será enviado para notificar sobre o retorno mais atualizado, bem como a informação inconsistente encontrada.

A precisão das informações e a taxa de detecção de inconsistências dependerão de cada fonte de dados acessada.

Requisição

Para o processo de requisição será necessário o token de acesso, caso ainda não tenha o seu entre em contato com o suporte netrin, e o número do documento que deseja executar a busca

Mensagens de retorno

Status Code

Status Code	Message	Ações
200	Sucesso	-
206	Retorno Parcial	Avaliar código interno (tabela abaixo)
408	Timeout	Avaliar código interno (tabela abaixo)
401	Token Inválido / Expirado	Analisar token
403	Usuário não possui permissão para acessar este recurso	Contatar Suporte
404	Parâmetros inválidos	Rever nome do(s) serviço(s)
502	Falha na chamada	Contatar Suporte

Códigos Internos

Códigos Internos	Descrição	Definições
601	Lentidão ao gerar captcha	Contatar Suporte em caso de reincidência
602	Lentidão do site	Avaliar consumo do serviço
603	Site fora do ar	Aguardar retorno do site
604	Em manutenção	Contatar Suporte para prazo de retorno
605	Parâmetros faltantes para a fonte	Contatar Suporte em caso de dúvida
606	Não encontrado	Dados não existem na base da fonte de origem
607	Menor de idade	O documento consultado pertence a um menor de idade
608	Não foi possível emitir	O site não permitiu emitir o comprovante
609	Parâmetro(s) inválido(s)	Verificar os valores dos parâmetros fornecidos
610	Limite de tentativas excedido	Limite diário de tentativas foi excedido
611	Franquia excedida	O valor contrado foi excedido
612	Franquia inativa	A franquia foi inativada
613	Franquia expirada	A franquia não foi renovada
614	PEP / VIP	O documento pertence a uma pessoa de destaque (ou pessoa renomada) e os dados não podem ser divulgados
615	Documento bloqueado na base de dados de origem	O documento está bloqueado e não será possível consultá-lo
616	Documento inativo	O documento está inativo e não será possível consultá-lo
617	Informações Pessoais identificáveis mínimas (PII)	Dados Pessoais Identificáveis Mínimos (PII)
618	Pessoa falecida	O documento pertence a um titular falecido
619	Não possui histórico de crédito	Sem histório de crédito para apresentar
620	Documento Inválido	O documento consultado é inválido
621	Limite de erros excedido, temporariamente bloqueado	Mensagem dedicada para o excesso de erros na validação com microdepósito
622	Serviço temporariamente indisponível	O serviço de consulta não está atualmente disponível. Em caso de dúvida, contate o suporte.
623	Usuário não possui permissão para acessar este recurso	O serviço consultado não está atualmente liberado. Em caso de dúvida, contate o suporte.
624	O CPF informado possui restrições para este serviço	O CPF consultado está temporariamente impedido de ser validado através deste serviço
625	Banco de destino não respondeu à requisição, tente novamente mais tarde	Instabilidade temporária no banco de destino. Tentar novamente mais tarde.
650	Problemas na busca	Contatar Suporte em caso de reincidência