Download Package (base64) - SigningHub-APIGuide

Business applications can use this service API to download the document in Base64 encoded byte format.

The package ID is provided in the resource URL.

If the package contains only one document, the download is the Base64 encoded PDF document.

Alternatively, if the package has more than one document, the download is the Base64 encoded zip file of all documents.

The x-password and x-otp headers are optional. They are required if the document owner set them during the workflow creation phase.

https://api.signinghub.com/v3/packages/{package_id}/base64
HTTP Verb		GET
Accept		application/octet-stream
Authorization		Bearer {access_token}
x-password		"pincode123"
x-otp		"123456"
Request Body
Status Code	Message	Response Body
200	OK	file(base64)
401	Unauthorized	`{` `"Message":` `"Request authorization denied"` `}`
401	Unauthorized	`{` `"Message":` `"User authentication required"` `}`
403	Forbidden	`{` `"Error":` `"invalid_credentials"` `"Message":` `"You have entered incorrect authentication credentials - try again"` `}`
		`{` `"Error":` `"otp_required"` `"Message":` `"One time password is required"` `}`
		`{` `"Error":` `"password_required"` `"Message":` `"Password authentication is required"` `}`
		`{` `"Message":` `"Document does not belong to user"` `}`
		`{` `"Message":` `"You cannot access this document before the access period starts"` `}`
		`{` `"Message":` `"You cannot access this document after the access period ends"` `}`
		`{` `"Message":` `"This document is no longer available for your review - your signature delegation rights have changed or expired"` `}`
		`{` `"Message":` `"The One Time Password (OTP) does not match"` `}`
		`{` `"Message":` `"Downloading document is not allowed in draft mode"` `}`
		`{` `"Message":` `"Account is disabled"` `}`
		`{` `"Message":` `"You are not allowed to perform the requested operation"` `}`
404	Not Found	`{` `"Message":` `"Document not found"` `}`
500	Internal Server Error	`{` `"Message":` `"An internal server error occurred while processing the request"` `}`

The detail of each item provided in the request and response is provided below:

Item Details
Names	Description
Request Parameters
access_token	The access token obtained as a result of successful authentication. If the "scope" parameter was used in authentication request, then this service requires the access token to be obtained using the credentials of an Enterprise admin whose enterprise role has the application integration privileges.
x-password (optional)	Password required to view the document if set by the owner for the recipient.
x-otp (optional)	OTP required to view the document if set by the owner for the recipient.
package_id	The package ID to be downloaded.
Response Parameters
file(base64)	The package file in Base64 encoded format.
Message	The service specific error message returned by the API. This message provides useful information about why the service has returned an error response.