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.
Signature Links Query (GET)
Request
ENDPOINT
/issuer_management/issuer/ISSUER-KEY/auto_signature/signersMETHOD
GETPath Params
| Field | Type | Description | Characters |
|---|---|---|---|
ISSUER-KEY | string | Unique issuer key (UUID v4). | 36 |
Query Params
| Field | Type | Description | Required |
|---|---|---|---|
exclude_qi_signers | boolean | If true, hides QI signers from the response. Default: false. | No |
Response
STATUS
200Response 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
| Field | Type | Description |
|---|---|---|
envelope_key | string | Unique key of the adoption agreement signature envelope. |
status | string | Envelope status in QI SIGN. |
documents | array | Envelope documents. The adoption agreement is the only document. |
issuer_key | string | Unique issuer key. |
issuer_auto_signature_key | string | Unique auto-signature key. |
Fields of documents:
| Field | Type | Description |
|---|---|---|
document_type | string | Always adhesion_auto_signature_term. |
signers | array | Document signers, one item per signer. |
Fields of signers:
| Field | Type | Description |
|---|---|---|
document_number | string | Signer's CPF. |
signature_url | string | This signer's individual signature link. |
name | string | Signer's name. |
email | string | Signer's e-mail. |
status | string | Individual signature status — for example on_signature or signed. |
Errors
| HTTP | Code | When it occurs |
|---|---|---|
| 400 | ISS0000030 (AutoSignatureInWrongStatus) | The adoption agreement has not been sent for signature yet — the auto-signature is in pending_term_generation. |
| 403 | ISS000011 (TenantForbidden) | The client does not have full access to the registration of the given issuer. |
| 404 | ISS000009 (IssuerNotFound) | There is no issuer for the given key. |
| 404 | ISS0000028 (AutoSignatureNotFound) | The issuer has no active auto-signature. |