Consulta dos Links de Assinatura do Termo de Adesão
Este endpoint retorna um link de assinatura por assinante do termo de adesão da auto-assinatura, com o status individual de cada um. Cada assinante do emissor assina pelo seu próprio link.
Os links ficam disponíveis assim que a solicitação da habilitação responde — é ela que abre o envelope e leva a auto-assinatura a pending_signature. Se a geração do termo tiver falhado, a auto-assinatura fica em pending_term_generation, sem envelope, e este endpoint responde ISS0000030 até que a solicitação seja repetida.
Consulta dos Links de Assinatura (GET)
Request
ENDPOINT
/issuer_management/issuer/ISSUER-KEY/auto_signature/signersMÉTODO
GETPath Params
| Campo | Tipo | Descrição | Caracteres |
|---|---|---|---|
ISSUER-KEY | string | Chave única do emissor (UUID v4). | 36 |
Query Params
| Campo | Tipo | Descrição | Obrigatório |
|---|---|---|---|
exclude_qi_signers | boolean | Se true, oculta da resposta os assinantes que são da QI. Padrão: false. | Não |
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
| Campo | Tipo | Descrição |
|---|---|---|
envelope_key | string | Chave única do envelope de assinatura do termo de adesão. |
status | string | Status do envelope no QI SIGN. |
documents | array | Documentos do envelope. O termo de adesão é o único documento. |
issuer_key | string | Chave única do emissor. |
issuer_auto_signature_key | string | Chave única da auto-assinatura. |
Campos de documents:
| Campo | Tipo | Descrição |
|---|---|---|
document_type | string | Sempre adhesion_auto_signature_term. |
signers | array | Assinantes do documento, um item por assinante. |
Campos de signers:
| Campo | Tipo | Descrição |
|---|---|---|
document_number | string | CPF do assinante. |
signature_url | string | Link individual de assinatura desse assinante. |
name | string | Nome do assinante. |
email | string | E-mail do assinante. |
status | string | Status individual da assinatura — por exemplo on_signature ou signed. |
Erros
| HTTP | Código | Quando ocorre |
|---|---|---|
| 400 | ISS0000030 (AutoSignatureInWrongStatus) | O termo de adesão ainda não foi enviado para assinatura — a auto-assinatura está em pending_term_generation. |
| 403 | ISS000011 (TenantForbidden) | O cliente não possui acesso completo ao cadastro do emissor informado. |
| 404 | ISS000009 (IssuerNotFound) | Não existe emissor para a chave informada. |
| 404 | ISS0000028 (AutoSignatureNotFound) | O emissor não possui auto-assinatura ativa. |