Templates

Gets a page image from a template for display

GET
/v2.1/accounts/{accountId}/templates/{templateId}/documents/{documentId}/pages/{pageNumber}/page_image

Retrieves a page image for display from the specified template.

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.

pageNumber*string

The page number being accessed.

templateId*string

The ID of the template.

Query Parameters

dpi?string

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

max_height?string

Sets the maximum height of the returned images in pixels.

max_width?string

Sets the maximum width of the returned images in pixels.

show_changes?string

Response Body

image/png

image/png

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