Download Envelope Document (GET /v2.0/envelopes/{envelopeId}/{documentId}/download)
Download a signed or unsigned copy of an envelope document.
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 |
| documentId | GUID | Yes | Document ID |
Request Query Parameters
| Field | Type | Required | Description |
|---|---|---|---|
| signedCopy | Boolean | Yes | Download signed copy |
Response Parameters
Response Body Message Field
| Field | Value |
|---|---|
| message | The returned message |
Response Body Data Fields
| Field | Always preset | Description |
|---|---|---|
| envelope_id | Yes | Envelope ID |
| document_id | Yes | Document ID |
| document_name | Yes | Document name |
| file_name | Yes | Document file name with extension |
| document_base64 | Yes | Document file base64 |
Sample Success Response
REQUEST:
curl --location --request GET '/api/v2.0/envelopes/wrg134t6-86u0-24f8-1asg-gsd0i4xz1232/225de81a-c71a-417c-a8be-603868acb491/download?signedCopy=false' \
--header 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9' \
--header 'app_auth_type: jsign-oauth2'
RESPONSE:
{
"message": "",
"data": {
"envelope_id": "wrg134t6-86u0-24f8-1asg-gsd0i4xz1232",
"document_id": "dcf144b6-19d0-45b0-9dda-bbe0e4ca6269",
"document_name": "My document",
"file_name": "Consent_Example_Final_v3.pdf",
"document_base64": "JVBERi0xLjcNCiW1tbW1DQoxIDAgb2JqDQo8PC9UeXBlL0NhdGFsb2cvUGFnZXMgMiAwIFIv[...]
}
}
Sample Error Response
REQUEST:
curl --location --request GET '/api/v2.0/envelopes/wrg134t6-86u0-24f8-1asg-gsd0i4xz1232/225de81a-c71a-417c-a8be-603868acb491/download?signedCopy=true' \
--header 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9' \
--header 'app_auth_type: jsign-oauth2'
RESPONSE:
{
"errors": [
{
"error_code": "DOCUMENT_IS_NOT_SIGNED", "
developer_message": "The requested document is not signed.."
}
]
}
Note: View the full list of applicable error code for this method here.