Envelopes

Gets a page image from an envelope for display

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

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

Authorization

OAuth2
AuthorizationBearer <token>

OAuth 2.0 access token obtained via Authorization Code Grant or JWT Grant.

In: header

Path Parameters

accountId*string

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

documentId*string

The unique ID of the document within the envelope.

Unlike other IDs in the eSignature API, you specify the documentId yourself. Typically the first document has the ID 1, the second document 2, and so on, but you can use any numbering scheme that fits within a 32-bit signed integer (1 through 2147483647).

Tab objects have a documentId property that specifies the document on which to place the tab.

envelopeId*string

The envelope's GUID.

Example: 93be49ab-xxxx-xxxx-xxxx-f752070d71ec

pageNumber*string

The page number being accessed.

Query Parameters

dpi?string

Sets the dots per inch (DPI) for the returned 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

When true, changes display in the user interface.

Response Body

image/png

image/png

curl -X GET "https://example.com/v2.1/accounts/string/envelopes/string/documents/string/pages/string/page_image"
null