Link de formalização
A resposta da emissão da dívida já traz o link de formalização de cada signatário. A QI Tech também envia esse link ao tomador por WhatsApp, SMS ou e-mail. Você pode usar o link para levar o tomador direto à jornada, por exemplo ao fim do seu fluxo de contratação.
O link na resposta da emissão
Emita a dívida pelo POST /debt. Na resposta, o link de cada signatário está em data.contract.signature_information[].signature_url.
{
"data": {
"contract": {
"document_key": "4b0d7c1e-2f6a-4c9e-8d3b-1a5e7f9c2b60",
"number": "0000192840/AMT",
"urls": [
"https://storage.googleapis.com/live-doc-api/documents/4b0d7c1e-2f6a-4c9e-8d3b-1a5e7f9c2b60/CCB-0000192840.pdf"
],
"signature_information": [
{
"signer_name": "JOAO DA SILVA",
"signer_document_number": "96969879003",
"signer_role": "issuer",
"signer_email": "joao.silva@exemplo.com",
"signer_external_key": null,
"signature_url": "https://<link de assinatura do QI Sign>"
}
]
}
}
}
signature_information tem um item por signatário da dívida, e cada item tem o seu signature_url. O tomador é o item com signer_role igual a issuer. Não confunda com contract.urls: ali está o PDF da CCB ainda não assinada, não o link da jornada.
Cada link abre a jornada de um signatário específico. Entregue a cada pessoa somente o link dela.
O envio do link pela QI Tech
Por padrão, a QI Tech envia o link ao tomador assim que a dívida é emitida. O canal é escolhido no campo signature_method, na raiz da requisição de emissão:
signature_method | Canal | Dado obrigatório do tomador | Erro quando o dado falta |
|---|---|---|---|
email | borrower.email | COP000103 | |
sms | SMS | borrower.phone | COP000104 |
whatsapp | borrower.phone | COP000104 |
Sem signature_method na requisição, vale o canal padrão configurado para a sua integração. Sem canal configurado, o envio é por e-mail.
Sem envio pela QI Tech
A integração pode ser configurada para que a QI Tech não envie o link. Nesse caso, a única forma de o tomador chegar à jornada é o signature_url da resposta da emissão, entregue pelo seu canal. Para mudar essa configuração, fale com o time de suporte da QI Tech.
Depois do envio
- Acompanhe a jornada pelos webhooks de acompanhamento, se estiverem habilitados.
- Receba o resultado pelo webhook de assinatura ou pelo webhook de cancelamento.
As regras que decidem entre os dois estão em Regras de negócio.