Manual Consignado Privado - Formalização Externa
A API ainda está em fase de desenvolvimento, sendo assim, este manual esta sujeito a alterações.
Nesta seção, você encontrará as orientações necessárias para utilizar as APIs de formalização de operações originadas no fluxo ativo sem o uso do QIsign, a solução de assinatura eletrônica da QI Tech.
Este fluxo é destinado a clientes que optam por utilizar uma solução externa de assinatura eletrônica (como DocuSign, Clicksign, entre outras) para formalizar seus contratos.
1 - Envio de documentos
É obrigatório o envio dos dados complementares do contrato.
Os documentos devem ser enviados através do endpoint de upload de documentos e devem seguir a seguinte formatação:
| Validações | Valores |
|---|---|
| Formato | JPEG |
| Tamanho mínimo | 250 x 250 px |
Após o upload dos documentos, as chaves dos documentos enviados devem ser informadas no payload de criação da operação ou após, através do seguinte endpoint:
Request Body
{
"document_identification": "2893fc74-88fd-4cc9-a5c6-8a63d9d00f41",
"document_identification_back": "e881ddf4-bc9a-48e0-9555-cac979f65431",
"selfie": "ca37979e-6f11-4465-bf3b-69cd8307549c"
}
A related_party_key é retornada na response da criação de dívida dentro do objeto borrower
2 - Formalização da operação
Após o input dos documentos a operação pode seguir para formalização.
No caso de assinatura por parte do representante legal, no campo "data.contract.signers[i]" serão retornados os dados do representante legal, e o valor do objeto "data.contract.signers[i].signer_role" será "issuer_legal_representative".
No payload de assinatura devem conter os campos obrigatórios relacionados aos documentos enviados no item 1. Os campos obrigatórios são os seguintes: ip_address e signature_datetime.
Request
EXEMPLOS DE PAYLOAD
Request Body - PDF Assinado
{
"path-pdf-signed": "https://storage.googleapis.com/sandbox-doc-api-private/documents/8b740ca1-405d-4507-a7b3-e7de01c4e008/BENJAMINERAPHAELA-NOME_DEVEDOR-CCB-LCM3307596554-20250721184150_signed.pdf",
"type": "pdf-signature",
"biometry_analysis_reference": "serpro",
"similarity_score": "0.96",
"ip_address": "192.168.0.0",
"signature_datetime": "2025-07-22T14:30:12.729Z"
}
Request Body - Assinatura Por Evidências
{
"biometry_analysis_reference": "serpro",
"signature_datetime": "2025-07-21T10:38:23.382748Z",
"similarity_score": 0.98,
"ip_address": "179.104.42.245",
"type": "data-signature",
"signatures": [
{
"authenticity": {
"timestamp": "2025-07-21 10:38:23",
"ip_address": "179.104.42.245",
"session_id": "ddb1d063-4fdf-4330-af9c-3316e9142ff3"
},
"signer": {
"name": "Nome devedor",
"email": "naotem@gmail.com",
"phone": {
"country_code": "055",
"area_code": "84",
"number": "999538380"
},
"document_number": "11200770870"
},
"authentication_type": "opt-in"
}
]
}
O payload de envio da assinatura varia de acordo com o processo de formalização do parceiro e deve ser alinhado com o time de integração da QI Tech.
Enumeradores Biometry Analysis Reference
| Enumerador | Descrição |
|---|---|
| serpro | Utilizado quando o similarity_score for retornado através de consulta realizada na base de documentos com foto do Detran (Serviço prestado através da Serpro) |
| tse | Utilizado quando o similarity_score for retornado através de consulta realizada na base de documentos com foto do TSE |
| not_found | Deve ser informado quando a biometria facial não for localizada em nenhuma das bases governamentais anteriores (serpro ou tse). Neste caso o similarity_score deve ser null ou o grau de similaridade da selfie com o documento oficial com foto, retornado pelo parceiro. |