Pular para o conteúdo principal

Consulta dos Links para assinatura via QI SIGN da Operação

Este endpoint permite consultar todos os links para assinatura de uma operação específica via QI SIGN, utilizando sua chave única.


Consulta de Operação (GET)

Request

ENDPOINT
/commercial_paper/operation/OPERATION-KEY/signers
MÉTODO
GET

Path Params

CampoTipoDescriçãoCaracteres
OPERATION-KEYstringChave única da operação (UUID v4).36

Response

STATUS
200
Response Body
{
"envelope_key": "5b930d3d-3713-4c42-85d5-f8e9e44e30ce",
"status": "pending_signature",
"documents": [
{
"document_type": "adhesion_term",
"signers": [
{
"document_number": "145.736.070-56",
"signature_url": "https://sign.qitech.com.br/s/s2S33dD",
"name": "Emissor assinante",
"email": "emissor@qitech.com.br",
"status": "on_signature"
},
{
"document_number": "145.736.070-56",
"signature_url": "https://sign.qitech.com.br/s/s2S33dD",
"name": "Assinante QI DTVM",
"email": "dtvm@qitech.com.br",
"status": "on_signature"
},
{
"document_number": "145.736.070-56",
"signature_url": "https://sign.qitech.com.br/s/s2S33dD",
"name": "Assinante QI TECH",
"email": "qi@qitech.com.br",
"status": "on_signature"
}
]
},
{
"document_type": "ncom_pre_price",
"signers": [
{
"document_number": "145.736.070-56",
"signature_url": "https://sign.qitech.com.br/s/s2S33dD",
"name": "Assinante QI TECH",
"email": "qi@qitech.com.br",
"status": "on_signature"
},
{
"document_number": "145.736.070-56",
"signature_url": "https://sign.qitech.com.br/s/s2S33dD",
"name": "Emissor assinante",
"email": "emissor@qitech.com.br",
"status": "on_signature"
},
{
"document_number": "145.736.070-56",
"signature_url": "https://sign.qitech.com.br/s/s2S33dD",
"name": "Assinante QI DTVM",
"email": "dtvm@qitech.com.br",
"status": "on_signature"
}
]
}
]
}

Response Body Params

CampoTipoDescriçãoCaracteres Máx.
envelope_keystringChave única do envelope (UUID v4).36
statusstringStatus dos envelopesEnumeradores operation status
documentslistLista de documentos do envelope-

Objeto document

CampoTipoDescriçãoCaracteres Máx.
document_typestringTipo do documento.Enumeradores document type
signerslistLista de assinantes-

Objeto signer

CampoTipoDescriçãoCaracteres Máx.
document_numberstringDocumento do assinante.18
signature_urlstringLink do assinante-
statusstringStatus do assinante.Enumeradores status
namestringnome do assinante-
emailstringemail do assinante-

Enumeradores operation-status

EnumDescrição
waiting_signatureAguardando assinaturas dos envolvidos.
signedAssinatura finalizada.
signature_rejectedAssinatura rejeitada.
canceledOperação cancelada.

Enumeradores status

EnumDescrição
on_signatureAguardando assinaturas dos envolvidos.
analyzedAssinatura completa via API.
signedAssinatura finalizada.
signature_rejectedAssinatura rejeitada.
canceledOperação cancelada.

Enumeradores document-type

EnumDescrição
contractIdentificador do contrato.
ncom_pre_priceNota comercial Pre price.
ncom_pre_price_daysNota comercial Pre price days.
ncom_pre_sacNota comercial Pre sac.
ncom_post_sac_cdiNota comercial Pós sac vinculado ao CDI.
ncom_post_sac_ipcaNota comercial Pós sac vinculado ao IPCA.
ncom_post_sac_igpmNota comercial Pós sac vinculado ao IGP-M.
ncom_post_price_cdiNota comercial Pós price vinculado ao CDI.
ncom_post_price_ipcaNota comercial Pós price vinculado ao IPCA.
ncom_post_price_igpmNota comercial Pós price vinculado ao IGP-M.
ncom_post_price_days_cdiNota comercial Pós price days vinculado ao CDI.
ncom_post_price_days_ipcaNota comercial Pós price days vinculado ao IPCA.
ncom_post_price_days_igpmNota comercial Pós price days vinculado ao IGP-M.
subscription_noteBoletim de subscrição.
adhesion_termTermo de adesão.