Get Document Image - SigningHub-APIGuide

Business applications can use this service API to get an image of a particular page as identified by the page_no. 800 x 600 can be replaced by any given resolution to match the device displaying resolution.

https://api.signinghub.com/v3/packages/{package_id}/documents/{document_id}/images/{page_no} /800x600
HTTP Verb		GET
Accept		image/png
Authorization		Bearer {access_token}
x-password		"pincode123"
x-otp		"123456"
Request Body
Response Header
x-page-width		600
x-page-height		800
Status Code	Message	Response Body
200	OK	file(binary)
401	Unauthorized	`{` `"Message":` `"Request authorization denied"` `}`
		`{` `"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":` `"Account is disabled"` `}`
404	Not Found	`{` `"Message":` `"Document not found"` `}`
		`{` `"Message":` `"Page 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 "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	Password of the document, if a document opening password was set by the document owner for the recipient. Otherwise null or ignore.
x-otp	OTP value for opening the document, if a document opening OTP permission was set by the document owner. Otherwise null or ignore.
package_id	Package ID of the package of which the document is part of.
document_id	The ID of the document for which the image is to be requested.
page_no	Page number in the document for which the image is requested.
dimensions (optional)	Dimensions are provided in the URL in the form of width x height. This width height can be any value desired by the client application. Width and height are calculated in pixels.
Response Parameters
x-page-width	width of the image returned in response.
x-page-height	Height of the image returned in response.
Message	The service specific error message returned by the API. This message provides useful information about why the service has returned an error response.
Binary	A stream of png image for the page.