v1

latestSwagger 2.02026-07-134146194.6 MB

Templates

Gets a page image from a template for display.

Retrieves a page image for display from the specified template.

get/v2.1/accounts/{accountId}/templates/{templateId}/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.

pageNumberstring required

The page number being accessed.

templateIdstring required

The ID of the template.

Query parameters

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.

show_changesstring

Response

Successful response.