v1

latestSwagger 2.02026-07-134146194.6 MB

Envelopes

Returns document page images based on input.

Returns images of the pages in a document for display based on the parameters that you specify.

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

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

Query parameters

countstring

The maximum number of results to return.

dpistring

The number of dots per inch (DPI) for the resulting images. Valid values are 1-310 DPI. The default value is 94.

max_heightstring

Sets the maximum height of the returned images in pixels.

max_widthstring

Sets the maximum width of the returned images in pixels.

nocachestring

When true, using cache is disabled and image information is retrieved from a database. True is the default value.

show_changesstring

When true, changes display in the user interface.

start_positionstring

The position within the total result set from which to start returning values. The value thumbnail may be used to return the page image.

Response

Successful response.