Query Signed Contract Link via QI SIGN of the Operation
This endpoint allows you to query all signed documents of a specific operation via QI SIGN, using its unique key.
Attention
The signed contract link is valid for 24 hours. After that, it is necessary to renew the link by making a new request through the endpoint.
Query Operation Signed Link (GET)
Request
ENDPOINT
/commercial_paper/operation/OPERATION-KEY/signed_urlMETHOD
GETPath Params
| Field | Type | Description | Characters |
|---|---|---|---|
OPERATION-KEY | string | Unique operation key (UUID v4). | 36 |
Response
STATUS
200Response Body
{
"envelope_key": "5b930d3d-3713-4c42-85d5-f8e9e44e30ce",
"status": "signed",
"documents": [
{
"document_type": "ncom_pre_price",
"signed_url": "https://qisign-dossiers.com/7bcf5868-784a-4356-85fb-dd72fd53cd4a.pdf",
"signers": []
},
{
"document_type": "adhesion_term",
"signed_url": "https://qisign-dossiers.com/7bcf5868-784a-4356-85fb-dd72fd53cd4a.pdf",
"signers": []
}
]
}
Response Body Params
| Field | Type | Description | Max Characters |
|---|---|---|---|
envelope_key | string | Unique envelope key (UUID v4). | 36 |
status | string | Envelope status | Status enumerators |
documents | list | List of envelope documents | - |
document object
| Field | Type | Description | Max Characters |
|---|---|---|---|
document_type | string | Document type. | Document type enumerators |
signed_url | string | Signed contract URL for download | - |
signers | list | List of signers | - |
operation-status enumerators
| Enum | Description |
|---|---|
waiting_signature | Waiting for signatures from involved parties. |
signed | Signature completed. |
signature_rejected | Signature rejected. |
canceled | Operation canceled. |
document-type enumerators
| Enum | Description |
|---|---|
contract | Contract identifier. |
ncom_pre_price | Commercial note Pre price. |
ncom_pre_price_days | Commercial note Pre price days. |
ncom_pre_sac | Commercial note Pre sac. |
ncom_post_sac_cdi | Commercial note Post sac linked to CDI. |
ncom_post_sac_ipca | Commercial note Post sac linked to IPCA. |
ncom_post_sac_igpm | Commercial note Post sac linked to IGP-M. |
ncom_post_price_cdi | Commercial note Post price linked to CDI. |
ncom_post_price_ipca | Commercial note Post price linked to IPCA. |
ncom_post_price_igpm | Commercial note Post price linked to IGP-M. |
ncom_post_price_days_cdi | Commercial note Post price days linked to CDI. |
ncom_post_price_days_ipca | Commercial note Post price days linked to IPCA. |
ncom_post_price_days_igpm | Commercial note Post price days linked to IGP-M. |
subscription_note | Subscription bulletin. |
adhesion_term | Adhesion term. |