Download Attachment (GET /v2.0/envelopes/{envelopeId}/supportingdocuments/{supportingDocumentId}/download)
Download an attachment by Document ID and Attachment ID.
Request Parameters
Request Headers
| Header | Value |
|---|---|
| Authorization | Bearer {access_token} |
| app_auth_type | jsign-oauth2 |
Request Query String Parameters
| Field | Type | Required | Description |
|---|---|---|---|
| envelopeId | GUID | Yes | Envelope ID |
| supportingDocumentId | GUID | Yes | Document ID |
Response Parameters
Response Body Message Field
| Field | Value |
|---|---|
| file_name | The name of the file |
| supporting_document_base64 | Attachment Base64 |
Sample Success Response
REQUEST:
curl --location --request GET '/api/v2.0/envelopes/6a4e4fd3-e4c7-41ed-a15e-a4e0f9867c12/supportingdocuments/fc284121-1d1f-4251-b87d-c14ab6e50bd7/download' \
--header 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9' \
--header 'app_auth_type: jsign-oauth2'
RESPONSE:
{
"message": "",
"data": {
"file_name": "attachment.pdf",
""supporting_document_base64": "JVBERi0xLjcKCjQgMCBvYmoKPDwKL0ZpbHRlciA[.....]
}
}
Sample Error Response
REQUEST:
curl --location --request GET '/api/v2.0/envelopes/6a4e4fd3-e4c7-41ed-a15e-a4e0f9867c12/supportingdocuments/fc284121-1d1f-4251-b87d-c14ab6e50bd7/download' \
--header 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9' \
--header 'app_auth_type: jsign-oauth2'
RESPONSE:
{
"errors": [
{
"error_code": "SUPPORTING_DOCUMENT_NOT_FOUND",
"developer_message": "No supporting document found"
}
]
}
Note: View the full list of applicable error code for this method here.