Pular para o conteúdo principal

Webhook de assinatura

A QI Tech envia este webhook quando todos os signatários concluíram a jornada do QI Sign e as regras de assinatura aprovaram. A dívida (CCB) passa para o status signed e segue para o desembolso. O webhook traz a CCB assinada e o dossiê de cada signatário.

Se você analisa o dossiê numa mesa de aprovação própria, este é o webhook que dispara a sua análise. Para recusar a dívida depois de analisar, cancele-a antes do desembolso; veja Cancelamento de dívida antes do desembolso.

Atenção!

Os webhooks da QI Tech não devem ser mapeados de forma restrita. Campos adicionais podem ser incluídos nos payloads.

Os dois formatos​

O conteúdo é o mesmo nos dois formatos. Muda o webhook_type e o status, conforme o produto da dívida:

Dívidawebhook_typestatus
Consignado privado, originação leilãolaas.credit_operation.status_changesigned
Demais dívidas emitidas pelo POST /debtdebtsignature_finished

No formato laas.credit_operation.status_change, operation_type vem também na raiz do webhook, além de data.operation_type.

Corpo do webhook​

CampoTipoDescrição
keyuuidChave da dívida (CCB).
statusstringsigned ou signature_finished. Veja Os dois formatos.
webhook_typestringlaas.credit_operation.status_change ou debt.
event_datetimestringData e hora da assinatura, no formato AAAA-MM-DD HH:MM:SS.
requester_identifier_keystringO identificador que você enviou na emissão da dívida.
contract_document_keyuuidChave do documento da CCB.
signed_contract_urlstringA CCB assinada, em PDF.
signersarrayO dossiê de cada signatário. Veja Dossiê do signatário.
data.operation_typestringO tipo da operação. Ex.: structured_operation.
As URLs das imagens expiram

As URLs de signers[].images expiram cerca de 24 horas depois do envio do webhook. Baixe e guarde os arquivos ao receber o webhook.

Exemplo — dívida assinada, com os dados extras da jornada​

Dívida de consignado privado assinada com CNH digital. O dossiê traz os dados extras da jornada (document.ocr e liveness.flags); veja Dados extras da jornada. As URLs assinadas estão encurtadas.

{
"key": "7f3e9a21-5c4b-4d8e-9a1f-2b6c8d0e4f13",
"status": "signed",
"webhook_type": "laas.credit_operation.status_change",
"event_datetime": "2026-11-18 13:04:27",
"operation_type": "structured_operation",
"requester_identifier_key": "7f3e9a21-5c4b-4d8e-9a1f-2b6c8d0e4f13",
"contract_document_key": "a1c4e7f0-3d2b-4c6a-8e9f-5b7d1c3a9e42",
"signed_contract_url": "https://storage.googleapis.com/live-doc-api/documents/a1c4e7f0-3d2b-4c6a-8e9f-5b7d1c3a9e42/CCB-0000192840_signed.pdf",
"data": {
"operation_type": "structured_operation"
},
"signers": [
{
"id": "c5d8b2e4-1f7a-4b3c-9d6e-0a2f4c8e6b17",
"signer_data": {
"id": "c5d8b2e4-1f7a-4b3c-9d6e-0a2f4c8e6b17",
"name": "JOAO DA SILVA",
"email": "joao.silva@exemplo.com",
"phone": {
"number": "999999999",
"area_code": "11",
"international_dial_code": "55"
},
"birthdate": "1990-05-20",
"callback_url": "https://www.exemplo.com.br/status",
"document_number": "969.698.790-03",
"submission_method": "email"
},
"images": {
"face_image_url": "https://qisign-face-images-bucket-production.s3.amazonaws.com/0e6b4d2a-8c1f-4a7e-b3d5-9f2c6a1e8d04.jpeg?AWSAccessKeyId=...&Signature=...&Expires=1795093455",
"document_full_url": "https://qisign-personal-documents-bucket-production.s3.amazonaws.com/4f8a2c6e-0b3d-4e9a-a7c1-6d5e2b9f3a80.pdf?AWSAccessKeyId=...&Signature=...&Expires=1795093455",
"document_full_template": "cnh_digital",
"simplified_dossier": "https://qisign-signer-dossiers-bucket-production.s3.amazonaws.com/b9e3f1a7-6d2c-4b8e-8f4a-1c7e5d3b2a96.pdf?AWSAccessKeyId=...&Signature=...&Expires=1795093454"
},
"biometry": {
"face_validation": {
"score": 100,
"provider": "qitech",
"available": true,
"recommendation": "approve"
},
"fraud_base_flag": false,
"face_validation_score": 100,
"face_validation_available": true
},
"document": {
"template": "cnh_digital",
"face_match_score": 99,
"ocr": [
{
"file_type": "pdf",
"template_type": "cnh_digital",
"document_data": {
"name": "JOAO DA SILVA",
"category": "AB",
"birthdate": "1990-05-20",
"rg_issuer": "SSP",
"rg_number": "123456789",
"cnh_number": "01234567890",
"cpf_number": "969.698.790-03",
"father_name": "JOSE DA SILVA",
"mother_name": "MARIA DA SILVA",
"issuance_date": "2026-03-23",
"place_of_birth": "SAO PAULO - SP",
"cnh_issuer_city": "SAO PAULO",
"expiration_date": "2031-03-20",
"rg_issuer_state": "SP",
"cnh_issuer_state": "SP",
"cpf_signer_mismatch": false,
"creation_and_modification_date_mismatch": false,
"found_anomalous_pdf_creator_or_producer": false
}
}
]
},
"liveness": {
"result": "live",
"flags": {
"multiple_people": false,
"total_execution_time": 394.956
}
},
"device_data": {
"ip": "203.0.113.10",
"model": "iPhone",
"user_agent": "Mozilla/5.0 (iPhone; CPU iPhone OS 18_7 like Mac OS X) AppleWebKit/605.1.15 (KHTML, like Gecko) Version/18.7 Mobile/15E148 Safari/604.1",
"coordinates": [-46.6333, -23.5505]
},
"locations": [],
"link_first_clicked_at": "2026-11-18T12:59:55Z",
"signed_at": "2026-11-18T13:03:31Z",
"ip_address": "203.0.113.10",
"similarity_score": 1.0,
"biometry_analysis_reference": "qitech"
}
]
}

No formato debt, o mesmo webhook chega com "webhook_type": "debt", "status": "signature_finished" e sem o operation_type na raiz.

Erros​

Este webhook não devolve erro ao originador. A sua URL deve responder com um status 2xx em até 5 segundos. O comportamento de entrega e o reenvio estão em Configurando webhooks e Reenvio de notificações.