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
      • 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
      • Listar os tipos de assinantes
      • Remover assinante
      • Cancelar assinatura
      • Bloquear assinatura
      • Desbloquear assinatura
    • 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
        • Antecedentes criminais
        • Debitos
        • PEP
      • Pessoa Jurídica
        • Consulta básica
        • Receita Federal
        • Histórico de alterações
        • Consulta de dívidas
        • Debitos
        • Consultar faturamento estimado
        • Lista restritiva
      • Compartilhado
        • Busca de coordenadas
        • Distancia entre coordenadas
        • Busca de veiculo pela placa
        • Processos judiciais
        • Emprestimos
      • 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
      • Listar
      • Criar validação
      • Upload de video
      • Processar video
      • Consultar
      • Consultar video
    • Usuários
      • Listar usuários
      • Cadastrar usuário
      • Ativar/desativar usuário
    • Webhooks
      • Introdução
      • Status da análise
      • Resultado da análise
      • Analise concluida
      • Documento assinado
      • Documentoscopia realizada
      • Biometria facial realizada
      • Bloqueio de assinatura
      • Assinatura recebida
  1. Webhooks

Assinatura recebida

Sempre que uma assinatura for concluida, antes da analise ser realizada, um webhook será enviado para a URL configurada durante a criação do processo. Esse webhook informa o status atualizado da da formalização como concluido.
Os atributos abaixo explicam cada item enviado no corpo da resposta do webhook.
Atributos da resposta
AtributoTipoDescrição
eventstringEspecifica o tipo do evento
formalization_idstringIdentificador único da formalização
person_keystringIdentificador único da pessoa vinculada à formalização
statusstringStatus da formalização (completed)
Exemplo sem webhook seguro
Abaixo um exemplo de resposta completo
{
            "formalization_id" : "bf1c17c1-f36e-4f2b-9482-f56b02db2393",
            "event" : "formalization_completed",
            "status" : "completed",
            "person_key" : "0f940bef-284f-41f1-9c82-c98aa6590974"
}
Exemplo com webhook seguro
{
  "payload": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJmb3JtYWxpemF0aW9uX2lkIjoiYmYxYzE3YzEtZjM2ZS00ZjJiLTk0ODItZjU2YjAyZGIyMzkzIiwiZXZlbnQiOiJmb3JtYWxpemF0aW9uX2NvbXBsZXRlZCIsInN0YXR1cyI6ImNvbXBsZXRlZCIsInBlcnNvbl9rZXkiOiIwZjk0MGJlZi0yODRmLTQxZjEtOWM4Mi1jOThhYTY1OTA5NzQifQ.HlxDuNi84tUp8a_LCXwmV50QteS2BklZyMsEFzx1M2w"
}
Página anterior
Bloqueio de assinatura
Built with