🔌 Introdução à API

Esta página tem uma introdução rápida às especificações de referência da nossa API, com alguns detalhes sobre os estados e resultados dos relatórios e o status da pessoa/pasta.

Autenticação 🔒

A autenticação requer apenas o cabeçalho X-Api-Key configurado com sua chave API.

Como obter uma Chave API 🔑

A Chave API é o token que você precisará para se autenticar em nossos sistemas. Se você ainda precisa obter uma, por favor entre em contato conosco.

Estados e resultados de relatórios

Cada relatório executado passa por uma série de estados até a conclusão. Os valores possíveis de state são PENDING, PENDING_MANUAL_REVIEW (se habilitado), COMPLETED, ERROR e INCOMPLETE. Cada state pode ter um resultado PASSED, FAILED ou INFO.

Para uma compreensão mais profunda de como os relatórios funcionam, você pode verificar o diagrama Fluxo de Estados de Relatórios em nossos guias.

Estados 📌

PENDING ou PENDING_MANUAL_REVIEW

Estamos construindo os detalhes do relatório e o resultado para você, aguardando que as fontes retornem com os resultados das verificações e revisando aquelas que requerem intervenção humana de nossa equipe de especialistas.

COMPLETED

Excelente! Todas as verificações foram realizadas com sucesso e você deve ter seu resultado final.

INCOMPLETE

Verifique a mensagem dentro dos detalhes do seu relatório. Use o endpoint Obter detalhes de relatórios.

ERROR

Ops! Algo deu errado ao processar este relatório. Você pode tentar acionar uma atualização de relatórios ou entrar em contato com nossa equipe de suporte.

Estado	Descrição
PENDING	O primeiro estado de todos os relatórios quando uma pessoa é criada, atualizada ou a atualização de relatórios é acionada. Significa que as verificações estão sendo realizadas.
PENDING_MANUAL_REVIEW	O relatório está na fila para Revisão Manual. Acontece quando verificações automatizadas foram realizadas, mas o relatório precisou de uma Revisão Manual (geralmente quando há um resultado FAILED das verificações automatizadas).
COMPLETED	Este estado representa que o relatório completou todas as verificações e deve incluir um resultado final (PASSED ou FAILED) ou apenas os dados solicitados (para relatórios com resultado BODY - sem tomada de decisão).
INCOMPLETE	Significa que o relatório não conseguiu ser completado por algum motivo: a entrada fornecida não era válida ou não foi encontrada nas fontes/bancos de dados, os dados encontrados não foram suficientes para alcançar um resultado final sob as regras fornecidas.
ERROR	Este estado significa que algo deu errado com a verificação: as fontes podem ter ficado fora do ar por muito tempo ou ocorreu um erro interno na API da Emptor.

Resultados ✅

Resultado	Descrição
PASSED	Este resultado significa que, sob as regras fornecidas pelo cliente (previamente acordadas ou fornecidas dentro da solicitação Criar uma Pessoa), nenhum dado foi encontrado para resultar em um resultado FAILED (ex. nenhum registro criminal encontrado).
FAILED	Significa que, sob as regras fornecidas pelo cliente (previamente acordadas ou fornecidas dentro da solicitação Criar uma Pessoa), informações suficientes foram encontradas para resultar em um resultado FAILED (ex. registros criminais encontrados).
INFO	Este resultado significa que o relatório foi solicitado apenas como informativo e será limitado a retornar um conjunto de dados, não um resultado de tomada de decisão como PASSED ou FAILED.

Status da Pasta 🧾

A pasta é, basicamente, o agregado de todos os relatórios habilitados para uma determinada Pessoa. Ao contrário dos relatórios, que têm state e outcome, a pasta tem apenas um status que inclui valores tanto dos estados quanto dos resultados dos relatórios conforme descrito abaixo.

O status da pasta é o mesmo que o status da Pessoa, que você pode recuperar fazendo uma solicitação ao endpoint Obter Status de uma Pessoa.

Para uma compreensão mais profunda de como as Pastas funcionam, você pode verificar o gráfico Fluxo de Status de Pastas nos Guias.

Status	Descrição
PENDING	Quando todos os relatórios estão em state PENDING.
PENDING_MANUAL_REVIEW	Quando há relatórios em state PENDING_MANUAL_REVIEW.
PASSED	Quando todos os relatórios estão em state COMPLETED e nenhum deles resultou em um outcome FAILED.
FAILED	Quando todos os relatórios estão em state COMPLETED e pelo menos um deles resultou em um outcome FAILED.
INCOMPLETE	Quando não há relatórios em estado ERROR, mas pelo menos um deles está em state INCOMPLETE.
ERROR	Quando pelo menos um relatório está em estado ERROR ou se houve um problema ao calcular o status.

Fluxo de Status do Relatório

Para cada relatório executado, ele passa por uma série de estados até a conclusão. Esses estados são PENDING, PENDING_MANUAL_REVIEW (se habilitado), COMPLETED, ERROR e INCOMPLETE. Cada estado pode ter um resultado PASSED, FAILED ou INFO. Você pode ver a transição entre estados no diagrama a seguir.

Fluxo de Status da Pasta

Após criar uma pessoa, atualizar uma pessoa, ou acionar a atualização de relatórios, a lógica do status da pasta pode ser determinada com o diagrama a seguir.

Estamos aqui para ajudar! 🙋‍♂️

Se você tiver alguma dúvida, ainda pode entrar em contato conosco em support@emptor.io 📧.