Alternative Signatures
For the use of alternative forms of signature, the proof file dossier must be compressed into a .zip file and sent via the QI TECH /upload endpoint. The returned document_key can then be used in this endpoint as a form of contract signature.
Examples of alternative signatures:-
Recorded call;
-
Credit analysis;
Request
ENDPOINT
/debt/DEBT-KEY/signedMETHOD
POSTRequest Body
{
"type": "data-signature",
"signatures": [
{
"signed_object": {
"raw_text": "Lorem ipsum dolor sit amet, consectetur a....",
"document_key": "79003de0-2590-455d-9b73-426b8ca284eb",
"document_md5": "7521bd5621d97af26b2c1721fc4023a8"
},
"authenticity": {
"timestamp": "1970-01-01 00:00:01",
"document_key": "79003de0-2590-455d-9b73-426b8ca284eb",
"document_md5": "79003de0-2590-455d-9b73-426b8ca284eb"
},
"signer": {
"name": "IVANILDO DE SENA LIMA",
"email": "ivanlima2604@gmail.com",
"phone": {
"country_code": "055",
"area_code": "11",
"number": "999999999"
},
"document_number": "61766976204"
},
"authentication_type": "zip"
}
]
}
Path Params
Field | Type | Description | Characters |
---|---|---|---|
debt_key * | string | Debt key returned at the moment of credit operation creation. | - |
Body Params
Field | Type | Description | Characters |
---|---|---|---|
type * | string | Type of signature to be sent. | - |
signatures * | array of objects | List containing signature proof objects - must be sent in case of signature "type": "data-signature". | Objects signatures |
path-pdf-signed * | string | URL with the signed PDF - must be sent in case of signature "type": "pdf-signature". | - |
Object signatures
Field | Type | Description | Characters |
---|---|---|---|
signed_object | object | Object containing the document being signed. | Objects signed_object |
authenticity | object | Object with authentication data. | Objects authenticity |
signer | object | Object with the signatory's data. | Object signer |
authentication_type * | string | Type of signature. | - |
Object signed_object
Field | Type | Description | Characters |
---|---|---|---|
raw_text | string | Plain text with the contract data to be signed (Mandatory for opt-in type authentication). | - |
document_key | string | DOCUMENT_KEY of the signed file sent via API 1.1 (mandatory only if the "raw_text" field is not sent). | - |
document_md5 | string | DOCUMENT_MD5 of the signed file sent via API 1.1 (mandatory only if the "raw_text" field is not sent). | - |
Object authenticity
Field | Type | Description | Characters |
---|---|---|---|
timestamp * | string | Data da assinatura. | - |
document_key * | string | DOCUMET_KEY retornado pela API 1.1 após o envio do arquivo com as evidencias de assinatura. | - |
document_md5 * | string | DOCUMET_MD5 retornado pela API 1.1 após o envio do arquivo com as evidencias de assinatura. | - |
Object signer
Field | Type | Description | Characters |
---|---|---|---|
name * | string | Name of the signatory. | - |
email * | string | Signatory's email. | - |
phone | string | Object containing the signatory's phone. | Object phone |
document_number * | string | Signatory's document number. | - |
Object phone
Field | Type | Description | Characters |
---|---|---|---|
country_code * | string | Phone DDI code (https://ddi.guiamais.com.br/) | 3 |
area_code * | string | Phone area code (DDD) (https://ddd.guiamais.com.br/) | 2 |
number * | string | Phone number (numbers only) | 10 |
Response
STATUS
200Response Body
{
"data": {},
"event_datetime": "2022-11-07 15:24:47",
"key": "\<DEBT-KEY\>",
"status": "signature_received",
"webhook_type": "debt"
}
STATUS
400Response Body
{
"data": "{\"title\": \"Bad Request\", \"description\": \"Invalid request body.\", \"translation\": \"Corpo da requisição inválido.\", \"extra_fields\": {}, \"code\": \"LEG000069\"}"
}