Skip to main content

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.

Request

ENDPOINT
/commercial_paper/operation/OPERATION-KEY/signed_url
METHOD
GET

Path Params

FieldTypeDescriptionCharacters
OPERATION-KEYstringUnique operation key (UUID v4).36

Response

STATUS
200
Response 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

FieldTypeDescriptionMax Characters
envelope_keystringUnique envelope key (UUID v4).36
statusstringEnvelope statusStatus enumerators
documentslistList of envelope documents-

document object

FieldTypeDescriptionMax Characters
document_typestringDocument type.Document type enumerators
signed_urlstringSigned contract URL for download-
signerslistList of signers-

operation-status enumerators

EnumDescription
waiting_signatureWaiting for signatures from involved parties.
signedSignature completed.
signature_rejectedSignature rejected.
canceledOperation canceled.

document-type enumerators

EnumDescription
contractContract identifier.
ncom_pre_priceCommercial note Pre price.
ncom_pre_price_daysCommercial note Pre price days.
ncom_pre_sacCommercial note Pre sac.
ncom_post_sac_cdiCommercial note Post sac linked to CDI.
ncom_post_sac_ipcaCommercial note Post sac linked to IPCA.
ncom_post_sac_igpmCommercial note Post sac linked to IGP-M.
ncom_post_price_cdiCommercial note Post price linked to CDI.
ncom_post_price_ipcaCommercial note Post price linked to IPCA.
ncom_post_price_igpmCommercial note Post price linked to IGP-M.
ncom_post_price_days_cdiCommercial note Post price days linked to CDI.
ncom_post_price_days_ipcaCommercial note Post price days linked to IPCA.
ncom_post_price_days_igpmCommercial note Post price days linked to IGP-M.
subscription_noteSubscription bulletin.
adhesion_termAdhesion term.