Envelopes are signature requests which are composed of one or many documents which are sent to a maximum of 45 signers for receiving signatures.
{
"id": 6232978,
"owner_user_id": 9978630,
"status": "incomplete",
"created_time": 1688619773,
"last_modified_time": 1688619776,
"owner_email": "[email protected]",
"owner_first_name": "Karthikeyan",
"owner_last_name": "KC",
"owner_company": null,
"next": 10164762,
"is_ordered": 1,
"is_envelope": 1,
"has_markers": 1,
"aadhaar_enabled": 0,
"expiry_time": 1693803774,
"signer_verification": null,
"recipients": [
{
"recipient_id": 10164762,
"recipient_user_id": 9960172,
"first_name": "Mario",
"last_name": "A",
"email": "[email protected]",
"status": "not_viewed",
"order_id": 1,
"last_modified_time": 1688619775,
"phone_number": "",
"country_code": "",
"2fa_enable": false,
"otp_type": null,
"verification_time": null,
"verification_status": 0,
"created_time": 1688619775
},
{
"recipient_id": 10164763,
"recipient_user_id": 9960173,
"first_name": "Luigi",
"last_name": "B",
"email": "[email protected]",
"status": "not_viewed",
"order_id": 2,
"last_modified_time": 1688619775,
"phone_number": "",
"country_code": "",
"2fa_enable": false,
"otp_type": null,
"verification_time": null,
"verification_status": 0,
"created_time": 1688619775
}
],
"request_info": {
"key1": "value1",
"key2": "value2"
},
"message": "This is a sample request.",
"subject": "",
"is_readonly": 0,
"is_in_person": 0,
"public_link": "0",
"is_embedded_signing": 0,
"envelope_size": 2,
"has_radio_buttons": 0,
"cc": [],
"is_need_your_action": 0,
"is_waiting_for_others": 1,
"sources": [
{
"id": 59925063,
"name": "agreement",
"type": "original"
},
{
"id": 4263523,
"name": "nda",
"type": "template"
}
]
}
| Attributes | Type | Description |
|---|---|---|
id | integer | The unique ID of the pending file. |
created_time | time | The time in epoch, when the signature request was initiated and the pending file created. |
last_modified_time | time | The time in epoch, when the pending file was last modified. |
is_ordered | integer | Flag indicating if the signing sequence would be ordered or not. 0: Parallel signing, the recipients can sign in any order. 1: Sequential signing, the recipients can only sign when it is their turn. |
owner_email | The email address of the signature request initiator. | |
owner_first_name | string | The first name of the signature request initiator. |
owner_last_name | string | The last name of the signature request initiator. |
owner_company | string | The company details of the signature request initiator. |
expiry_time | time | The time in epoch, when the signature request expires. |
has_markers | boolean | Flag indicating if fields were added to the document before sending. |
next | integer | The ID of the recipient who is in the queue to sign the document next. This will be null in case of parallel signing. |
recipients.recipient_id | integer | Unique ID for this recipient. Unique only for this signature request. Use this ID to figure out who is the next signer. |
recipients.email | The email address of the recipient. | |
recipients.first_name | string | The first name of the recipient. |
recipients.last_name | string | The last name of the recipient. |
recipients.created_time | time | The time in epoch, when this recipient was added to the signature request. |
recipients.last_modified_time | time | The time in epoch, when the recipient last acted on the signature request (viewed, signed, declined etc). |
recipients.order_id | integer | Used only in sequential signing. Indicates the signing order for this recipient. |
recipients.status | string | The status of the recipient. One of viewed, not_viewed, declined, finalized. Read more about each of these statuses here. |
status | string | The status of the signature request. One of incomplete, complete, recipient_declined, canceled. Read more about each of these statuses here. |
sources | array | The list of documents (originals and templates) in the envelope. |