Envelopes: getPageImage

Retrieves a page image for display from the specified envelope.

Request

HTTP request

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

Parameters

Parameter name Value Description
Path parameters
accountId string

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

documentId string

The ID of the document being accessed.

envelopeId string

The envelope's GUID. Eg 93be49ab-afa0-4adf-933c-f752070d71ec

pageNumber string

The page number being accessed.

Optional query parameters
dpi string

Sets the dpi for the image.

max_height string

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

max_width string

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

show_changes string

Responses

image/png

Code Description Reference
200 OK Successful response.
400 Bad Request Error encountered.

SDK Method

Envelopes::getDocumentPageImage

Definitions Expand All | Collapse All

errorDetails

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

errorCode string

An error code associated with the error.

message string

A short error message.