Envelope Details (GET /v2.0/envelopes/{envelopeId}/details)
Get the envelope's metadata. Similar to the envelope detail page in web application.
Request Parameters
Request Headers
| Header | Value |
|---|---|
| Authorization | Bearer {access_token} |
| app_auth_type | jsign-oauth2 |
Request Parameters
| Field | Type | Required | Description |
|---|---|---|---|
| envelopeId | GUID | Yes | Envelope ID |
Response Parameters
Response Body Message Field
| Field | Value |
|---|---|
| message | The returned message with envelope metadata details |
Response Body Data Fields
| Field | Always preset | Description |
|---|---|---|
| envelope | Yes | JSON Object of envelope basic details |
| envelope.id | Yes | Envelope ID |
| envelope.name | Yes | Envelope name |
| envelope.description | Yes | Envelope description |
| envelope.created_by | Yes | Envelope creator's email |
| envelope.creation_time_utc | Yes | Envelope creation time UTC |
| envelope.documents | Yes | The total number of documents in the envelope |
| envelope.sign_process_flow | Yes | Signature flow type |
| envelope.envelope_status | Yes | Envelope status |
| envelope.signing_due_date | No | Envelope sign due date |
| envelope.cancel_reason | No | Reason given if envelope is cancelled |
| envelope.document_cancel_date_utc | No | Cancellation date in UTC format |
| envelope.categories[] | No | Envelope tags |
| documents | Yes | JSON Object of documents basic details |
| documents.name | Yes | Document name with extension |
| documents.documents_id | Yes | Document ID |
| documents.blockchain | Yes | Blockchain transaction information |
| documents.blockchain.original_document_hash | Yes | Document file hash |
| documents.blockchain.signed_document_hash | No | Signed document file hash |
| documents.blockchain.blockchain_hash | No | Block hash |
| documents.blockchain.is_sign_process_completed | Yes | Is document notarized? |
| recipients | Yes | Contains signers and observers information |
| recipients.signers | Yes | Signers information |
| recipients.email | Yes | Signer's email address |
| recipients.first_name | Yes | Signer's first name |
| recipients.last_name | Yes | Signer's last name |
| recipients.signing_order | Yes | Signing order only considered if document flow is set to sequential |
| recipients.is_signed | Yes | Indicates if signer has signed the document |
| recipients.is_declined | No | Indicates if the signer declined to sign the document |
| recipients.declined_reason | No | Reason for the decline |
| recipients.observers | Yes | Observer information |
| recipients.observers[].email | No | Observer's email |
| recipients.observers[].first_name | No | Observer's first name |
| recipients.observers[].last_name | No | Observer's last name |
Sample Success Response
REQUEST:
curl --location --request GET '/api/v2.0/envelopes/eaec5fd0-8b28-4787-ba8b-f9f26ee06711/details' \
--header 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9' \
--header 'app_auth_type: jsign-oauth2'
RESPONSE:
{
"message": "",
"data": {
"envelope": {
"id": "c85f61cb-9c86-4611-9e7a-ba132061530c",
"name": "Sample Envelopes",
"description": "this is test description",
"created_by": "[email protected]",
"creation_time_utc": "2022-06-04T11:32:59.42Z",
"documents": 2,
"sign_process_flow": "Parallel",
"reminder_period": 2,
"envelope_status": "Unsigned",
"signing_due_date": "2022-06-08T23:59:59",
"cancel_reason": null,
"document_cancel_date_utc": null,
"categories": [
"New Envelope",
"NDA"
]
},
"documents": [
{
"name": "Sample Document One",
"document_id": "bbd13bf4-185d-4687-bb24-23d8953f48d9",
"blockchain": {
"original_document_hash": "4e0f631a5083f46dec17c07a2a3d5ead3523d6566424d68786cd5224ec3b205e",
"signed_document_hash": null,
"blockchain_hash": null,
"is_sign_process_completed": false
}
},
{
"name": "Sample Document Two",
"document_id": "d5d841e9-341f-4714-bbeb-74488118e4a8",
"blockchain": {
"original_document_hash": "cb672335638598e7db8d090f89ad6e657fe0abf51d3cd308e53c7ddae26a59de",
"signed_document_hash": null,
"blockchain_hash": null,
"is_sign_process_completed": false
}
}
],
"recipients": {
"signers": [
{
"email": "[email protected]",
"first_name": "Neal",
"last_name": "Davis",
"signing_order": 1,
"is_signed": false,
"is_declined": false,
"declined_reason": ""
}
],
"observers": [
{
"email": "[email protected]",
"first_name": "David",
"last_name": "Thomas"
}
]
}
}
}
Sample Error Response
REQUEST:
curl --location --request GET '/api/v2.0/envelopes/c85f61cb-9c86-4611-9e7a-ba132061530/details' \
--header 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9' \
--header 'app_auth_type: jsign-oauth2'
RESPONSE:
{
"errors": [
{
"error_code": "INVALID_REQUEST_PARAMETER",
"developer_message": "The request contained at least one invalid parameter: envelopeId."
}
]
}
Note: View the full list of applicable error code for this method here.