These docs are for v1.0. Click to read the latest docs for v3.0.

Evento Refusal

🚧

Atenção

Com a evolução do sistema, as informações podem sofrer alterações. Atente-se para a presença de novos campos.

Quando ocorrerem eventos nos documentos, uma requisição HTTP POST será disparada para a URL previamente cadastrada nas configurações da conta. Veja mais em Cadastro de Webhooks. A seguir, os detalhes do evento refusal.

EventoDescrição
refusalOcorre quando um documento é recusado.
{
  "event":{
    "name":"refusal",
    "data":{
      "signer":{
        "key":"09739802-19bb-4352-9c96-1b3af7694f7d",
        "email":"[email protected]",
        "name":"Empresa de Teste",
        "birthday":"1959-03-31",
        "documentation":"000.007.000-91",
        "has_documentation":true,
        "created_at":"2023-03-22T09:30:15.252-03:00",
        "auths":["email"],
        "selfie_enabled":false,
        "handwritten_enabled":false,
        "official_document_enabled":false,
        "liveness_enabled":false,
        "facial_biometrics_enabled":false,
        "communicate_by":"email",
        "sign_as":["administrator"]
      },
      "refusal":{
        "reasons":
        [
          "Conteúdo do documento",
          "Dados pessoais incorretos",
          "Forma de autenticação",
          "Uso de assinatura eletrônica",
          "Outros"
        ],
        "comment":"mais de 18 caracteres"
      },
      "account":{"key":"18ccd207-58b8-410f-a73e-585a4109a483"}
    }
  },
}

Acesse aqui o exemplo do campo Document.