Pular para o conteúdo principal

Assinaturas alternativas

Para o uso de formas alternativas de assinatura é necessario que o dossie de arquivos de comprovação sejá compactado em um arquivo .zip e enviado através do endpoint /upload QI TECH, assim o document_key retornado pode ser ultilizado neste endpoint como forma de assinatura de contrato.

Exemplos de assinaturas alternativas:
  • Ligação gravada;

  • Analise de crédito;

Request

ENDPOINT
/debt/DEBT-KEY/signed
MÉTODO
POST
Request 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

CampoTipoDescriçãoCaracteres
debt_key *stringChave da divida devolvida no momento da criação da operação de crédito.-

Body Params

CampoTipoDescriçãoCaracteres
type *stringTipo de assinatura que será enviada.-
signatures *array of objectsLista contendo objetos de comprovação de assinatura - deve ser enviado no caso de assinatura "type": "data-signature".Objetos signatures
path-pdf-signed *stringURL com o PDF assinado - deve ser enviado no caso de assinatura "type": "pdf-signature".-

Objeto signatures

CampoTipoDescriçãoCaracteres
signed_objectobjectObjeto contendo o documento que esta sendo assinado.Objetos signed_object
authenticityobjectobjeto com dados de autenticação.Objetos authenticity
signerobjectObjeto com os dados do signatário.Objeto signer
authentication_type *stringTipo de assinatura.-

Objeto signed_object

CampoTipoDescriçãoCaracteres
raw_textstringTexto corrido com os dados do contrato que será assinado (Obrigatório para autenticação tipo opt-in).-
document_keystringDOCUMENT_KEY do arquivo assinado enviado a partir da API 1.1 (obrigatório apenas caso o campo "raw_text" não seja enviado).-
document_md5stringDOCUMENT_MD% do arquivo assinado enviado a partir da API 1.1 (obrigatório apenas caso o campo "raw_text" não seja enviado).-

Objeto authenticity

CampoTipoDescriçãoCaracteres
timestamp *stringData da assinatura.-
document_key *stringDOCUMET_KEY retornado pela API 1.1 após o envio do arquivo com as evidencias de assinatura.-
document_md5 *stringDOCUMET_MD5 retornado pela API 1.1 após o envio do arquivo com as evidencias de assinatura.-

Objeto signer

CampoTipoDescriçãoCaracteres
name *stringNome do signatário.-
email *stringE-mail do signatário.-
phonestringObjeto de telefone do signatário.Objeto phone
document_number *stringNumero de documento do signatário.-

Objeto phone

CampoTipoDescriçãoCaracteres
country_code *stringCódigo DDI do telefone (https://ddi.guiamais.com.br/)3
area_code *stringCódigo DDD do telefone (https://ddd.guiamais.com.br/)2
number *stringNúmero de telefone (apenas números)10

Response

STATUS
200
Response Body
{
"data": {},
"event_datetime": "2022-11-07 15:24:47",
"key": "\<DEBT-KEY\>",
"status": "signature_received",
"webhook_type": "debt"
}

STATUS
400
Response Body
{
"data": "{\"title\": \"Bad Request\", \"description\": \"Invalid request body.\", \"translation\": \"Corpo da requisição inválido.\", \"extra_fields\": {}, \"code\": \"LEG000069\"}"
}