Returns document page images based on input
Returns images of the pages in a document for display based on the parameters that you specify.
Authorization
OAuth2 OAuth 2.0 access token obtained via Authorization Code Grant or JWT Grant.
In: header
Path Parameters
The external account number (int) or account ID GUID.
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.
The envelope's GUID.
Example: 93be49ab-xxxx-xxxx-xxxx-f752070d71ec
Query Parameters
The maximum number of results to return.
The number of dots per inch (DPI) for the resulting images. Valid values are 1-310 DPI. The default value is 94.
Sets the maximum height of the returned images in pixels.
Sets the maximum width of the returned images in pixels.
When true, using cache is disabled and image information is retrieved from a database. True is the default value.
When true, changes display in the user interface.
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 Body
application/json
application/json
curl -X GET "https://example.com/v2.1/accounts/string/envelopes/string/documents/string/pages"{ "endPosition": "string", "nextUri": "string", "pages": [ { "dpi": "string", "errorDetails": { "errorCode": "string", "message": "string" }, "height": "string", "imageBytes": "string", "mimeType": "string", "pageId": "string", "sequence": "string", "width": "string" } ], "previousUri": "string", "resultSetSize": "string", "startPosition": "string", "totalSetSize": "string"}