Pular para o conteúdo principal

Webhook

Todas as notificações do evento de assinatura serão enviadas para o endereço registrado na criação do evento. Em todas as chamadas de webhook, o payload conterá os dados de batch_group, batches, related_parties, signer_groups e signer.

A notificação será enviada sempre que ocorrer a conclusão de uma das seguintes etapas: partes relacionadas, inicio da criação dos arquivos ZIP ou finalização do evento de assinatura.

Notificação da Parte Relacionada Assinada​

Nesse caso, o campo signature_status da parte relacionada, do grupo de assinantes e dos assinantes estarão com o valor signed. Já o campo internal_status estará com o valor pending.

Exemplos de Webhook​

Response Body
{
"batch_group_key": "uuid",
"name": "Contrato de exemplo",
"main_related_party": "aaa",
"number_of_documents": 1,
"total_value": 0,
"all_files_url": "",
"send_to_fund_administrator": 0,
"signature_expiration_date": null,
"webhook_key": "uuid",
"client_key": "uuid",
"requester_key": null,
"signature_status": "pending",
"internal_status": "pending",
"attached_document_number": "71029579000163",
"current_signature_position": "1",
"control_number": null,
"internal_webhook_key": null,
"created_at": "2023-05-18 00:02:49",
"batch_group_type": "icp_signature",
"requester_identifier": null,
"send_emails": true,
"batches": [
{
"document_batch_key": "uuid",
"name": "Outros",
"document_type": "other",
"signature_type": "cades",
"signature_status": "pending",
"created_at": "2023-05-18 00:02:49",
"related_parties": [
{
"related_party_key": "uuid",
"name": "Signatário Exemplo",
"role": "assignor",
"signature_status": "signed",
"signature_position": "1",
"created_at": "2023-05-18 00:02:49",
"auto_signature": 0,
"notify_to": [],
"signer_groups": [
{
"id": 38598,
"expiration": null,
"minimum_required_signers": 1,
"signable_limit": null,
"signature_status": "signed",
"created_at": "2023-05-18 00:02:49",
"signers": [
{
"id": 65095,
"signer_control_number": "1",
"signature_timestamp": "2023-05-18 00:06:08",
"signature_status": "signed",
"name": "Signatário Exemplo",
"is_group_mandatory": true,
"email": "signatario@example.com",
"document_number": "69397891111",
"created_at": "2023-05-18 00:02:49"
}
]
}
]
},
{
"related_party_key": "uuid",
"name": "Turing",
"role": "guarantor",
"signature_status": "pending",
"signature_position": "1",
"created_at": "2023-05-18 00:02:49",
"auto_signature": 0,
"notify_to": [],
"signer_groups": [
{
"id": 38599,
"expiration": null,
"minimum_required_signers": 1,
"signable_limit": null,
"signature_status": "pending",
"created_at": "2023-05-18 00:02:49",
"signers": [
{
"id": 65096,
"signer_control_number": "1",
"signature_timestamp": null,
"signature_status": "pending",
"name": "Turing",
"is_group_mandatory": true,
"email": "testemunha@example.com",
"document_number": "58014216296",
"created_at": "2023-05-18 00:02:49"
}
]
}
]
}
],
"documents": [
{
"document_key": "uuid",
"control_number": "uuid",
"file_size": 1669,
"file_url": "https://qi.example.com/arquivos/uuid/documento_exemplo_original.pdf",
"name": "documento_exemplo.pdf",
"original_file_url": "https://qi.example.com/arquivos/uuid/documento_exemplo_original.pdf",
"status": "pending",
"signed_file_url": null,
"created_at": "2023-05-18 00:02:49",
"signatures": [
{
"signer": {
"id": 65095,
"signer_control_number": "1",
"signature_timestamp": "2023-05-18 00:06:08",
"signature_status": "signed",
"name": "Signatário Exemplo",
"is_group_mandatory": true,
"email": "signatario@example.com",
"document_number": "69397891111",
"created_at": "2023-05-18 00:02:49"
},
"signed_hash": "EjBUEGsOkny9SXaZbmLQLy+IRjvTtYnc73V8Hbb02uMktDn3/PJ24Gj7xQMj3jdOuRLVNzi1Fz02QYc2FEUdPxjOPQoycyQmI8ppPFwNsADym79EGRYqHlCGu9CccolZgA8FbgQgQ8FJAboQV9uSAPsS6zui1CHdmy4/3xink33KFpR9k42rI3iZgzi42gkrACJ1hhLPecc4HdTBQS6h+fsMNk/hsdKR3OLlXC+Ri3k8I/fJmNp2BBqILOhSxPeD4RpeyCtDFDbiKKA3pYgQqPqtEdfRdVFWY9uNGcoF1oIzGQg32Fh9o2UCqu58f+VqaElRGuCK6DZQ5nTZp2bbEg==",
"signature_timestamp": "2023-05-18 00:06:08",
"signature_status": "signed",
"role": "assignor",
"created_at": "2023-05-18 00:06:13"
}
]
}
]
}
],
"watcher_clients": [],
"zip_file_keys_list": []
}

Finalização do evento​

Para a finalização do evento, será enviado primeiramente um webhook informando que todas as partes relacionadas já assinaram. Nesse momento, o campo internal_status estará com o valor waiting_zip_files_creation. O link para os documentos assinados já estará disponível.

Após o webhook mencionado anteriormente, será enviado um novo webhook informando a finalização completa do evento. Nesse momento, o campo internal_status estará com o valor finished e o evento será complementado com o arquivo ZIP que pode ser consultado através das chaves contidas em zip_file_keys_list. O arquivo ZIP contém todos os documentos e o arquivo de assinatura.

Para entender como consultar o arquivo ZIP acesse o trecho 4.5. Consultar URL.

Exemplos de Webhook Aguardando geração do ZIP​

Response Body
{
"batch_group_key": "uuid",
"name": "Contrato de exemplo",
"main_related_party": "aaa",
"number_of_documents": 1,
"total_value": 0,
"all_files_url": null,
"send_to_fund_administrator": 0,
"signature_expiration_date": null,
"webhook_key": "uuid",
"client_key": "uuid",
"requester_key": null,
"signature_status": "signed",
"internal_status": "waiting_zip_files_creation",
"attached_document_number": "71029579000163",
"current_signature_position": "1",
"control_number": null,
"internal_webhook_key": null,
"created_at": "2023-05-18 00:02:49",
"batch_group_type": "icp_signature",
"requester_identifier": null,
"send_emails": true,
"batches": [
{
"document_batch_key": "uuid",
"name": "Outros",
"document_type": "other",
"signature_type": "cades",
"signature_status": "signed",
"created_at": "2023-05-18 00:02:49",
"related_parties": [
{
"related_party_key": "uuid",
"name": "Signatário Exemplo",
"role": "assignor",
"signature_status": "signed",
"signature_position": "1",
"created_at": "2023-05-18 00:02:49",
"auto_signature": 0,
"notify_to": [],
"signer_groups": [
{
"expiration": null,
"minimum_required_signers": 1,
"signable_limit": null,
"signature_status": "signed",
"created_at": "2023-05-18 00:02:49",
"signers": [
{
"signer_control_number": "1",
"signature_timestamp": "2023-05-18 00:06:08",
"signature_status": "signed",
"name": "Signatário Exemplo",
"is_group_mandatory": true,
"email": "signatario@example.com",
"document_number": "69397891111",
"created_at": "2023-05-18 00:02:49"
}
]
}
]
},
{
"related_party_key": "uuid",
"name": "Turing",
"role": "guarantor",
"signature_status": "signed",
"signature_position": "1",
"created_at": "2023-05-18 00:02:49",
"auto_signature": 0,
"notify_to": [],
"signer_groups": [
{
"expiration": null,
"minimum_required_signers": 1,
"signable_limit": null,
"signature_status": "signed",
"created_at": "2023-05-18 00:02:49",
"signers": [
{
"signer_control_number": "1",
"signature_timestamp": "2023-05-18 00:09:44",
"signature_status": "signed",
"name": "Turing",
"is_group_mandatory": true,
"email": "testemunha@example.com",
"document_number": "58014216296",
"created_at": "2023-05-18 00:02:49"
}
]
}
]
}
],
"documents": [
{
"document_key": "uuid",
"control_number": "uuid",
"file_size": 1669,
"file_url": "https://qi.example.com/arquivos/uuid/documento_exemplo_assinado.p7s",
"name": "documento_exemplo.pdf",
"original_file_url": "https://qi.example.com/arquivos/uuid/documento_exemplo_original.pdf",
"status": "signed",
"signed_file_url": "https://qi.example.com/arquivos/uuid/documento_exemplo_assinado.pdf",
"created_at": "2023-05-18 00:02:49",
"signatures": [
{
"signer": {
"signer_control_number": "1",
"signature_timestamp": "2023-05-18 00:06:08",
"signature_status": "signed",
"name": "Signatário Exemplo",
"is_group_mandatory": true,
"email": "signatario@example.com",
"document_number": "69397891111",
"created_at": "2023-05-18 00:02:49"
},
"signed_hash": "EjBUEGsOkny9SXaZbmLQLy+IRjvTtYnc73V8Hbb02uMktDn3/PJ24Gj7xQMj3jdOuRLVNzi1Fz02QYc2FEUdPxjOPQoycyQmI8ppPFwNsADym79EGRYqHlCGu9CccolZgA8FbgQgQ8FJAboQV9uSAPsS6zui1CHdmy4/3xink33KFpR9k42rI3iZgzi42gkrACJ1hhLPecc4HdTBQS6h+fsMNk/hsdKR3OLlXC+Ri3k8I/fJmNp2BBqILOhSxPeD4RpeyCtDFDbiKKA3pYgQqPqtEdfRdVFWY9uNGcoF1oIzGQg32Fh9o2UCqu58f+VqaElRGuCK6DZQ5nTZp2bbEg==",
"signature_timestamp": "2023-05-18 00:06:08",
"signature_status": "signed",
"role": "assignor",
"created_at": "2023-05-18 00:06:13"
},
{
"signer": {
"signer_control_number": "1",
"signature_timestamp": "2023-05-18 00:09:44",
"signature_status": "signed",
"name": "Turing",
"is_group_mandatory": true,
"email": "testemunha@example.com",
"document_number": "58014216296",
"created_at": "2023-05-18 00:02:49"
},
"signed_hash": "z7M0ozYCDGKWjkV4a1U5fK8tl0OcNqJGQXyJmreX16KjvQduv9qFevEc3tWej+1kpXm7jvhUuawSgSA7LJWQ/Flp+TRVyrfOgeBM3Xd+6uJA/c3zA9ASVlaEgwFw8/nD/dXE4EmLVOPhq9Mg3WeIDtq+c93TGhZtvdBpEuGu4q5/wfSTUhYYDPvljbjUvDXEOSTrvYboW1wDJyACCeeYLyPVaqTdOZ9ovXcVOZIpO8+fuIeNKGkuc6m7bXTvE5pD4FSxx5oNPj4N13E4TQN5wcNX+F0svVeVqA+2zrLU2mKGczVsgWO7qte1vct4eREs4dONStPvZ7+JQDSg+OotpQ==",
"signature_timestamp": "2023-05-18 00:09:44",
"signature_status": "signed",
"role": "guarantor",
"created_at": "2023-05-18 00:09:45"
}
]
}
]
}
],
"watcher_clients": [],
"zip_file_keys_list": []
}

Exemplos de Webhook Evento finalizado​

Response Body
{
"batch_group_key": "uuid",
"name": "Contrato de exemplo",
"main_related_party": "aaa",
"number_of_documents": 1,
"total_value": 0,
"all_files_url": "https://qi.example.com/arquivos/uuid/uuid.zip",
"send_to_fund_administrator": 0,
"signature_expiration_date": null,
"webhook_key": "uuid",
"client_key": "uuid",
"requester_key": null,
"signature_status": "signed",
"internal_status": "finished",
"attached_document_number": "71029579000163",
"current_signature_position": "1",
"control_number": null,
"internal_webhook_key": null,
"created_at": "2023-05-18 00:02:49",
"batch_group_type": "icp_signature",
"requester_identifier": null,
"send_emails": true,
"batches": [
{
"document_batch_key": "uuid",
"name": "Outros",
"document_type": "other",
"signature_type": "cades",
"signature_status": "signed",
"created_at": "2023-05-18 00:02:49",
"related_parties": [
{
"related_party_key": "uuid",
"name": "Signatário Exemplo",
"role": "assignor",
"signature_status": "signed",
"signature_position": "1",
"created_at": "2023-05-18 00:02:49",
"auto_signature": 0,
"notify_to": [],
"signer_groups": [
{
"expiration": null,
"minimum_required_signers": 1,
"signable_limit": null,
"signature_status": "signed",
"created_at": "2023-05-18 00:02:49",
"signers": [
{
"signer_control_number": "1",
"signature_timestamp": "2023-05-18 00:06:08",
"signature_status": "signed",
"name": "Signatário Exemplo",
"is_group_mandatory": true,
"email": "signatario@example.com",
"document_number": "69397891111",
"created_at": "2023-05-18 00:02:49"
}
]
}
]
},
{
"related_party_key": "uuid",
"name": "Turing",
"role": "guarantor",
"signature_status": "signed",
"signature_position": "1",
"created_at": "2023-05-18 00:02:49",
"auto_signature": 0,
"notify_to": [],
"signer_groups": [
{
"expiration": null,
"minimum_required_signers": 1,
"signable_limit": null,
"signature_status": "signed",
"created_at": "2023-05-18 00:02:49",
"signers": [
{
"signer_control_number": "1",
"signature_timestamp": "2023-05-18 00:09:44",
"signature_status": "signed",
"name": "Turing",
"is_group_mandatory": true,
"email": "testemunha@example.com",
"document_number": "58014216296",
"created_at": "2023-05-18 00:02:49"
}
]
}
]
}
],
"documents": [
{
"document_key": "uuid",
"control_number": "uuid",
"file_size": 1669,
"file_url": "https://qi.example.com/arquivos/uuid/documento_exemplo_assinado.p7s",
"name": "documento_exemplo.pdf",
"original_file_url": "https://qi.example.com/arquivos/uuid/documento_exemplo_original.pdf",
"status": "signed",
"signed_file_url": "https://qi.example.com/arquivos/uuid/documento_exemplo_assinado.pdf",
"created_at": "2023-05-18 00:02:49",
"signatures": [
{
"signer": {
"signer_control_number": "1",
"signature_timestamp": "2023-05-18 00:06:08",
"signature_status": "signed",
"name": "Signatário Exemplo",
"is_group_mandatory": true,
"email": "signatario@example.com",
"document_number": "69397891111",
"created_at": "2023-05-18 00:02:49"
},
"signed_hash": "EjBUEGsOkny9SXaZbmLQLy+IRjvTtYnc73V8Hbb02uMktDn3/PJ24Gj7xQMj3jdOuRLVNzi1Fz02QYc2FEUdPxjOPQoycyQmI8ppPFwNsADym79EGRYqHlCGu9CccolZgA8FbgQgQ8FJAboQV9uSAPsS6zui1CHdmy4/3xink33KFpR9k42rI3iZgzi42gkrACJ1hhLPecc4HdTBQS6h+fsMNk/hsdKR3OLlXC+Ri3k8I/fJmNp2BBqILOhSxPeD4RpeyCtDFDbiKKA3pYgQqPqtEdfRdVFWY9uNGcoF1oIzGQg32Fh9o2UCqu58f+VqaElRGuCK6DZQ5nTZp2bbEg==",
"signature_timestamp": "2023-05-18 00:06:08",
"signature_status": "signed",
"role": "assignor",
"created_at": "2023-05-18 00:06:13"
},
{
"signer": {
"signer_control_number": "1",
"signature_timestamp": "2023-05-18 00:09:44",
"signature_status": "signed",
"name": "Turing",
"is_group_mandatory": true,
"email": "testemunha@example.com",
"document_number": "58014216296",
"created_at": "2023-05-18 00:02:49"
},
"signed_hash": "z7M0ozYCDGKWjkV4a1U5fK8tl0OcNqJGQXyJmreX16KjvQduv9qFevEc3tWej+1kpXm7jvhUuawSgSA7LJWQ/Flp+TRVyrfOgeBM3Xd+6uJA/c3zA9ASVlaEgwFw8/nD/dXE4EmLVOPhq9Mg3WeIDtq+c93TGhZtvdBpEuGu4q5/wfSTUhYYDPvljbjUvDXEOSTrvYboW1wDJyACCeeYLyPVaqTdOZ9ovXcVOZIpO8+fuIeNKGkuc6m7bXTvE5pD4FSxx5oNPj4N13E4TQN5wcNX+F0svVeVqA+2zrLU2mKGczVsgWO7qte1vct4eREs4dONStPvZ7+JQDSg+OotpQ==",
"signature_timestamp": "2023-05-18 00:09:44",
"signature_status": "signed",
"role": "guarantor",
"created_at": "2023-05-18 00:09:45"
}
]
}
]
}
],
"watcher_clients": [],
"zip_file_keys_list": [
"uuid",
"uuid"
]
}