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
    • 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
        • Debitos
      • Pessoa Jurídica
        • Consulta básica
        • Receita Federal
        • Histórico de alterações
        • Consulta de dívidas
        • Debitos
        • Consultar faturamento estimado
      • 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
      • 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
      • Assinatura recebida
      • Documento assinado
      • Documentoscopia realizada
      • Biometria facial realizada
      • Bloqueio de assinatura
  1. Webhooks

Bloqueio de assinatura

Sempre que uma assinatura for bloqueada por qualquer razão, um webhook será enviado para a URL configurada durante a criação do processo. Esse webhook informa o status atualizado da formalização e o motivo do bloqueio, permitindo que você tome as ações necessárias no seu sistema.
Os atributos abaixo explicam cada item enviado no corpo da resposta do webhook.
Atributos da resposta
AtributoTipoDescrição
eventstringEspecifica o tipo do evento
formalization_keystringIdentificador único da formalização
person_keystringIdentificador único da pessoa vinculada à formalização
statusstringStatus da formalização (formalization_rejected, formalization_blocked, etc.)
descriptionstringDescrição detalhando o motivo do bloqueio ou rejeição
Exemplo sem webhook seguro
Abaixo um exemplo de resposta completo
{
  "event": "formalization_status_changed",
  "formalization_key": "c3234ef3-fb34-40a7-b4c0-921e852803b8",
  "person_key": "eeab7a58-735a-4771-9355-faa7e3f8f04b",
  "status": "formalization_rejected",
  "description": "O limite de tentativas de validação facial foi atingido."
}
Exemplo com webhook seguro
{
  "payload": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJldmVudCI6ImZvcm1hbGl6YXRpb25fc3RhdHVzX2NoYW5nZWQiLCJmb3JtYWxpemF0aW9uX2tleSI6ImMzMjM0ZWYzLWZiMzQtNDBhNy1iNGMwLTkyMWU4NTI4MDNiOCIsInBlcnNvbl9rZXkiOiJlZWFiN2E1OC03MzVhLTQ3NzEtOTM1NS1mYWE3ZTNmOGYwNGIiLCJzdGF0dXMiOiJmb3JtYWxpemF0aW9uX3JlamVjdGVkIiwiZGVzY3JpcHRpb24iOiJPIExpbWl0ZSBkZSB0ZW50YXRpdmFzIGRlIHZhbGlkYcOnw6NvIGZhY2lhbCBmb2kgYXRpbmdpZG8uIn0.WdD1Q9Z7n5ahg8RtI9ZPb7hhts8pwD2Kx4S-KY93WvA"
}
Página anterior
Biometria facial realizada
Built with