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

The documentId is set by the API client. It is an integer that falls between 1 and 2,147,483,647. The value is encoded as a string without commas. The values 1, 2, 3, and so on are typically used to identify the first few documents in an envelope. Tab definitions include a documentId property that specifies the document on which to place the tab.

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.

}} />