Skip to main content
Esta página mostra o caminho completo de uma integração, do envio do documento até o resultado da análise chegar até você.

​
Pré-requisitos

1

Projeto criado na plataforma

Todo documento enviado pertence a um projeto. Veja Projetos.
2

Chave de API ativa

A chave identifica a organização e o projeto em cada requisição. Veja Chaves de API.

​
Visão geral do fluxo

Envie o documento

Uma chamada com o CPF e as imagens em base64. Você recebe um documentId na hora.

Receba o resultado

Por webhook, se você configurou uma URL, ou por consulta ao documentId.

​
1. Envie o documento

Uma chamada a Enviar Documentos com o CPF do titular e as imagens em data URI base64:
Apenas cpf e identification.front são obrigatórios.

​
Rastreando o envio com seu próprio identificador

O header opcional x-client-id aceita até 255 caracteres e é devolvido no webhook, em metadata.clientId. Use-o para correlacionar o resultado com o registro do seu lado sem precisar guardar o documentId. A resposta traz o documentId, que identifica o documento em todas as consultas seguintes:

​
2. Receba o resultado

​
Por webhook

Com PARAMETER_WEBHOOK_URL configurado, a plataforma faz um POST nessa URL assim que a análise termina, com o documento e o resultado completos. O campo event.type distingue os dois produtos: O envelope completo, os headers da chamada, a validação da assinatura e o que o seu endpoint deve responder estão em Webhook de Resultado.
Responda com um status HTTP de sucesso. A entrega não é repetida em caso de falha — se o seu endpoint estiver indisponível, recupere o resultado pela consulta ao documentId.

​
Por consulta

Sem webhook configurado, consulte o documento pelo identificador em Consultar Documento por ID. O campo result fica preenchido quando o status chega em COMPLETED.

​
Lendo o resultado

O campo result.confidenceScore traz o índice de avaliação de autenticidade apurado na análise, e result.raw_response traz o retorno completo. Em uma rejeição, o motivo está em result.raw_response.penalidades — veja o detalhamento dos campos em Consultar Documento por ID.
MANUAL_REVIEW não é um erro. Ele indica que a análise não reuniu evidência suficiente para aprovar nem para rejeitar. Trate esse caso na sua jornada desde o início da integração.

​
Próximos passos

Enviar Documentos

A referência completa do endpoint de envio

Webhook de Resultado

O envelope completo e a validação da assinatura

Presets de Workflow

Os modos de análise e prazos disponíveis