Query Signature Links via QI SIGN for Operation

This endpoint allows querying all signature links for a specific operation via QI SIGN, using its unique key.

---

Query Signature Link for Operation (GET)

Request

ENDPOINT

/commercial_paper/operation/OPERATION-KEY/signers

METHOD

GET

Path Params

Field	Type	Description	Characters
OPERATION-KEY	string	Unique operation key (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 CTVM",
                    "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 CTVM",
                    "email": "dtvm@qitech.com.br",
                    "status": "on_signature"
                }
            ]
        }
    ]
}

Response Body Params

Field	Type	Description	Max Characters
envelope_key	string	Unique envelope key (UUID v4).	36
status	string	Envelope status	operation status enumerators
documents	list	List of envelope documents	-

document object

Field	Type	Description	Max Characters
document_type	string	Document type.	document type enumerators
signers	list	List of signers	-

signer object

Field	Type	Description	Max Characters
document_number	string	Signer's document.	18
signature_url	string	Signer's link	-
status	string	Signer's status.	status enumerators
name	string	Signer's name	-
email	string	Signer's email	-

operation-status Enumerators

Enum	Description
waiting_signature	Waiting for signatures from involved parties.
signed	Signature completed.
signature_rejected	Signature rejected.
canceled	Operation canceled.

status Enumerators

Enum	Description
on_signature	Waiting for signatures from involved parties.
analyzed	Signature completed via API.
signed	Signature completed.
signature_rejected	Signature rejected.
canceled	Operation canceled.
created	Signature created.
submitted	Sent to signer.
sending_sign_receipt	Sending simplified signature dossier.
analyzing	Signers under analysis.
completed	Signature completed.
expired	Signature expired.
removed	Signer removed.
failed_waiting_for_manual_fix	Signature creation failed, manual QI action required.

document-type Enumerators

Enum	Description
contract	Contract identifier.
ncom_pre_price	Pre price commercial note.
ncom_pre_price_days	Pre price days commercial note.
ncom_pre_sac	Pre sac commercial note.
ncom_post_sac_cdi	Post sac commercial note linked to CDI.
ncom_post_sac_ipca	Post sac commercial note linked to IPCA.
ncom_post_sac_igpm	Post sac commercial note linked to IGP-M.
ncom_post_price_cdi	Post price commercial note linked to CDI.
ncom_post_price_ipca	Post price commercial note linked to IPCA.
ncom_post_price_igpm	Post price commercial note linked to IGP-M.
ncom_post_price_days_cdi	Post price days commercial note linked to CDI.
ncom_post_price_days_ipca	Post price days commercial note linked to IPCA.
ncom_post_price_days_igpm	Post price days commercial note linked to IGP-M.
subscription_note	Subscription bulletin.
adhesion_term	Adhesion term.