v1

latestSwagger 2.02026-07-134146194.6 MB

Envelopes

Gets a page image from an envelope for display.

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

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

Path parameters

accountIdstring required

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

documentIdstring required

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.

envelopeIdstring required

The envelope's GUID.

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

pageNumberstring required

The page number being accessed.

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.

Response

Successful response.