Envelopes: getPageImage

Returns an image of a page in a document for display.

Request

HTTP request

GET /v2.1/accounts/{accountId}/envelopes/{envelopeId}/documents/{documentId}/pages/{pageNumber}/page_image

Parameters

Parameter NameValueDescription
Path Parameters
accountIdstring

The external account number (int) or account ID GUID.

documentIdstring

Integer that identifies the document in the envelope.

envelopeIdstring

The envelope's GUID.

Example: 93be49ab-afa0-4adf-933c-f752070d71ec

pageNumberstring

The page number being accessed.

Optional Query Parameters
dpistring

Sets the dots per inch (DPI) for the returned image.

max_heightstring

Sets the maximum height for the page image in pixels. The DPI is recalculated based on this setting.

max_widthstring

Sets the maximum width for the page image in pixels. The DPI is recalculated based on this setting.

show_changesstring

When true, changes display in the user interface.

Responses

CodeDescriptionReference
200

Successful response.

400

Error encountered.

errorDetails

SDK Method

Envelopes::getDocumentPageImage

Definitions

errorDetails

This object describes errors that occur. It is only valid for responses and ignored in requests.

errorCodestring

The code associated with the error condition.

messagestring

A brief message describing the error condition.

}} />