1. Webhooks
  • Introdução
  • V1
    • Autenticação
      • Login
      • Token
    • Empresa
      • Ver saldo
    • Análises
      • Introdução
      • Criar análise
      • Consultar analise
      • Listar analizes
    • Assinaturas
      • Introdução
      • Templates
        • Lista os templates
        • Cria o template
        • Remove o template
      • Criar documento para assinatura
      • Adicionar Assinante
      • Solicitar assinaturas
      • Assinar documento
      • Listar documentos
      • Busca os dados de um documento
      • Busca os dados completos dos assinantes
      • Busca o histórico do documento
      • Lista os tipos de assinantes
      • Remover assinante
    • Onboardings
      • Introdução
      • Criar links de onboardings
      • Busca os dados do onboarding
      • Tipificação de documentos
      • Atualizar script embedded
    • Pessoas
      • Criar pessoas
      • Solicitar SMS de autenticação
      • Validar código de autenticação
      • Upload de Documentos
    • Compliance
      • Introdução
      • Telefone
        • Consultar
        • Pessoas realacionadas
      • Pessoa Física
        • Consulta básica
        • Pesquisa federal
        • Renda estimada
        • Historico profissional
        • Recomendação de crédito
        • Busca selfies associadas ao nome
        • Consulta de dívidas
        • Midia negativa
        • Mais procurados
        • Analise basica de credito
        • Emprestimos
        • Antecedentes criminais
      • Pessoa Jurídica
        • Consulta básica
        • Receita Federal
        • Histórico de alterações
        • Consulta de dívidas
      • Compartilhado
        • Busca de coordenadas
        • Distancia entre coordenadas
        • Busca de veiculo pela placa
        • Processos judiciais
      • Consultas em lote
        • Consultar valor
      • Outras consultas
        • e consignado
    • Consultas em lote
      • Listar tipos
      • Upload arquivo
      • Download
      • Listar
    • Reconhecimento facial
      • Introdução
      • FaceCheck
      • Liveness
      • FaceRegister
      • FaceUnregister
      • FaceMatch
      • FaceAuth
      • BioCheck
    • Documentos
      • Upload
      • OCR
      • Tipificação
    • Grupos de consultas
      • Criar grupo
      • Finalizar grupo
      • Listar grupos
      • Consultar valor
    • Videos
      • Criar validação
      • Upload de video
      • Processar video
      • Consultar
      • Consultar video
    • Webhooks
      • Introdução
      • Status da análise
      • Assinatura recebida
      • Documento assinado
      • Documentoscopia realizada
      • Biometria facial realizada
  1. Webhooks

Documentoscopia realizada

Sempre que a análise documentoscópica for realizada, você será notificado sobre o resultado da análise na URL definida. Os atributos abaixo explicam e mostram cada item enviado no corpo da resposta do webhook.
Atributos da resposta
AtributoTipoDescrição
eventstringTipo do evento disparado pelo webhook
statusstringStatus da análise. Pode ser (approved, disapproved)
keystringIdentificador do processo de documentoscopia
Exemplo sem webhook seguro
Abaixo um exemplo de resposta completo
{
    "event": "documentoscopy_result",
    "status": "approved",
    "key": "d1efbc32-e1b8-4898-9117-2d464f647948"
}
Exemplo com webhook seguro
{
    "payload": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkFsYnVzIFBlcmNpdmFsIFd1bGZyaWMgQnJpYW4gRHVtYmxlZG9yZSIsImlhdCI6MTUxNjIzOTAyMn0.sPaw-FAEok9rU17uaGYuR7-_7zW-Xm6-_iQPgU2xFiI"
}
Página anterior
Documento assinado
Próxima página
Biometria facial realizada
Built with