Webhooks de acompanhamento do QI Sign

Informação

O timeout para resposta de nosso webhooks é de 5 segundos.

Atenção!

Os webhooks da QI Tech não devem ser mapeadas de forma restrita. Campos adicionais podem ser incluídos aos payloads dos webhooks retornados em nossas APIs.

Reenvio de Webhooks

Você pode consultar e reenviar webhooks seguindo as instruções detalhadas na documentação: Reenvio de Webhooks.

Para dívidas formalizadas através do QI Sign é possível configurar webhooks para acompanhar a evolução do cliente na jornada ou o abandono dela.

---

Exemplos de webhook de acompanhamento

Request Body

Notificação de início da jornada

{
    "key": "e299f7c2-03fa-4ea9-a2bc-e1a4e44440ac",
    "data": {
      "id": "d1c37283-8ac0-4aaf-9ffe-0f0071d401b9",
      "name": "JOAO DA SILVA",
      "type": "signer_link_clicked",
      "email": null,
      "status": "on_signature",
      "document_number": "969.698.790-03",
      "credit_operation_key": "e299f7c2-03fa-4ea9-a2bc-e1a4e44440ac"
    },
    "status": "on_signature",
    "webhook_type": "document.signer.status_change",
    "event_datetime": "2026-10-02T16:25:02"
}

Etapa concluída

{
    "key": "eed08ea1-a187-4e0f-9535-134c3683b6f8",
    "data": {
      "id": "d648f566-aa8b-4a64-88db-d29311a2eab8",
      "name": "MARIA SOUZA",
      "type": "signer_step_completed",
      "email": "maria.souza@exemplo.com",
      "status": "on_signature",
      "document_number": "123.456.789-09",
      "credit_operation_key": "eed08ea1-a187-4e0f-9535-134c3683b6f8",
      "enrich_personal_data": {
        "email": "maria.souza@exemplo.com",
        "phone": {
          "number": "999999999",
          "area_code": "11",
          "international_dial_code": "55"
        },
        "address": {
          "uf": "SP",
          "city": "São Paulo",
          "number": "100",
          "street": "Rua Exemplo",
          "postal_code": "01000-000",
          "neighborhood": "Centro"
        },
        "pix_key": "12345678909"
      },
      "completed_signer_signature_step": "enrich_personal_data"
    },
    "status": "on_signature",
    "webhook_type": "document.signer.status_change",
    "event_datetime": "2026-10-02T18:35:39"
}

Jornada abandonada

{
    "key": "e7ef9e1a-d5c8-46c8-9b7e-32ca4f67a9fa",
    "data": {
      "id": "262f0f2c-0220-41f7-8189-aae098e98580",
      "name": "MARIA SOUZA",
      "type": "signer_step_abandoned",
      "email": "maria.souza@exemplo.com",
      "phone": {
        "number": "999999999",
        "area_code": "11",
        "international_dial_code": "55"
      },
      "status": "on_signature",
      "address": {
        "uf": "SP",
        "city": "Juquitiba",
        "number": "100",
        "street": "Rua Exemplo",
        "complement": "Casa1",
        "postal_code": "01000-000",
        "neighborhood": "Centro"
      },
      "pix_key": "12345678909",
      "document_number": "123.456.789-09",
      "credit_operation_key": "e7ef9e1a-d5c8-46c8-9b7e-32ca4f67a9fa",
      "next_signer_signature_step": "face_recognition",
      "completed_signer_signature_step": "device_scan"
    },
    "status": "on_signature",
    "webhook_type": "document.signer.status_change",
    "event_datetime": "2026-10-02T19:05:50"
}

Descritivo dos campos

Campos da raiz

Campo	Tipo	Descrição
key	UUID	Chave identificadora da dívida (debt_key ou credit_operation_key).
data	objeto	Dados do signatário e do evento. Ver Campos de data.
status	string	Status do signatário na assinatura, sempre on_signature.
webhook_type	string	Tipo do webhook. Para estes eventos, document.signer.status_change.
event_datetime	DateTime	Data e hora em que o evento ocorreu.

Campos de data

Campo	Tipo	Descrição
id	UUID	Chave identificadora do signatário.
name	string	Nome do signatário.
type	string	Tipo do evento. Ver Enumeradores para type.
email	string	E-mail do signatário. Pode ser null.
status	string	Status do signatário na assinatura. Ex.: on_signature.
document_number	string	CPF do signatário, formatado.
credit_operation_key	UUID	Chave identificadora da dívida.
completed_signer_signature_step	string	Última etapa da jornada concluída pelo signatário. Presente em signer_step_completed e signer_step_abandoned.
next_signer_signature_step	string	Etapa em que o signatário abandonou a jornada. Presente apenas em signer_step_abandoned.
enrich_personal_data	objeto	Dados informados pelo signatário na etapa enrich_personal_data. Presente em signer_step_completed dessa etapa.
phone	objeto	Telefone do signatário. Presente em signer_step_abandoned, na raiz de data.
address	objeto	Endereço do signatário. Presente em signer_step_abandoned, na raiz de data.
pix_key	string	Chave Pix do signatário. Presente em signer_step_abandoned, na raiz de data.

Campos de enrich_personal_data

Campo	Tipo	Descrição
email	string	E-mail do signatário.
phone	objeto	Telefone. Ver Campos de phone.
address	objeto	Endereço. Ver Campos de address.
pix_key	string	Chave Pix do signatário.

Campos de phone

Campo	Tipo	Descrição
number	string	Número do telefone, sem DDD.
area_code	string	DDD.
international_dial_code	string	Código do país. Ex.: 55.

Campos de address

Campo	Tipo	Descrição
uf	string	Sigla do estado.
city	string	Cidade.
number	string	Número.
street	string	Logradouro.
complement	string	Complemento. Pode não estar presente.
postal_code	string	CEP, formatado.
neighborhood	string	Bairro.

Enumeradores para type

Enumerador	Descrição
signer_link_clicked	O signatário abriu o link e iniciou a jornada de assinatura.
signer_step_completed	O signatário concluiu uma etapa da jornada.
signer_step_abandoned	O signatário abandonou a jornada antes de concluí-la.