Skip to main content

Adoption Agreement Signature Links Query

This endpoint returns one signature link per signer of the auto-signature adoption agreement, with each signer's individual status. Each issuer signer signs through their own link.

The links are available as soon as the enablement request responds — it is the request that opens the envelope and takes the auto-signature to pending_signature. If the agreement generation failed, the auto-signature stays in pending_term_generation, with no envelope, and this endpoint responds with ISS0000030 until the request is repeated.


Request​

ENDPOINT
/issuer_management/issuer/ISSUER-KEY/auto_signature/signers
METHOD
GET

Path Params​

FieldTypeDescriptionCharacters
ISSUER-KEYstringUnique issuer key (UUID v4).36

Query Params​

FieldTypeDescriptionRequired
exclude_qi_signersbooleanIf true, hides QI signers from the response. Default: false.No

Response​

STATUS
200
Response Body
{
"envelope_key": "9c3f0f1e-6a2b-4c58-9c9c-0f6b1d2a7e34",
"status": "pending_signature",
"documents": [
{
"document_type": "adhesion_auto_signature_term",
"signers": [
{
"document_number": "123.456.789-01",
"signature_url": "https://sign.qitech.com.br/s/s2S33dD",
"name": "Joao da Silva",
"email": "joao.silva@example.com",
"status": "on_signature"
},
{
"document_number": "987.654.321-00",
"signature_url": "https://sign.qitech.com.br/s/f7Kd91P",
"name": "Maria de Souza",
"email": "maria.souza@example.com",
"status": "signed"
},
{
"document_number": "421.820.518-30",
"signature_url": "https://sign.qitech.com.br/s/q1W2e3R",
"name": "Assinante QI CTVM",
"email": "assinaturas.estruturadas@qitech.com.br",
"status": "on_signature"
}
]
}
],
"issuer_key": "07b1ac01-5fc4-475f-930b-19595f24bc1e",
"issuer_auto_signature_key": "9c3f0f1e-6a2b-4c58-9c9c-0f6b1d2a7e34"
}

Response Body Params​

FieldTypeDescription
envelope_keystringUnique key of the adoption agreement signature envelope.
statusstringEnvelope status in QI SIGN.
documentsarrayEnvelope documents. The adoption agreement is the only document.
issuer_keystringUnique issuer key.
issuer_auto_signature_keystringUnique auto-signature key.

Fields of documents:

FieldTypeDescription
document_typestringAlways adhesion_auto_signature_term.
signersarrayDocument signers, one item per signer.

Fields of signers:

FieldTypeDescription
document_numberstringSigner's CPF.
signature_urlstringThis signer's individual signature link.
namestringSigner's name.
emailstringSigner's e-mail.
statusstringIndividual signature status — for example on_signature or signed.

Errors​

HTTPCodeWhen it occurs
400ISS0000030 (AutoSignatureInWrongStatus)The adoption agreement has not been sent for signature yet — the auto-signature is in pending_term_generation.
403ISS000011 (TenantForbidden)The client does not have full access to the registration of the given issuer.
404ISS000009 (IssuerNotFound)There is no issuer for the given key.
404ISS0000028 (AutoSignatureNotFound)The issuer has no active auto-signature.