List page images
The page images available for a document, with the pixel dimensions of each and the path to fetch it from.
source says which stored set answered. signing_render is the full-resolution set rasterized when an envelope is sent, pixel for pixel what a signer sees. preview is the small set written during conversion, which covers only the first few pages and is all that exists before a send, so imageCount can be smaller than documentPageCount.
Every url is a path on this API, never a storage URL, and the caller re-presents its credential for each image. The storage key behind an image is never returned.
A ready document with no images at all answers 409 pages_not_rendered rather than an empty list, which would read as "this document has zero pages".
Request
- Base URL: https://inkseal.net/api/v1
- URL: https://inkseal.net/api/v1/documents/{documentId}/pages
- Auth: HTTP bearer
Query parameters
The first page index to return. A page index, not a page number: the first page is 0, the same space pageIndex and field coordinates use.
How many page images to return. This endpoint has its own cap, unrelated to the shared pagination limit.
Response
The window of page images requested.
Example response
{
"data": {
"documentId": "V1StGXR8_Z5jdHi6B-myT",
"source": "preview",
"imageCount": 4,
"documentPageCount": 12,
"limit": 50,
"pages": [
{
"width": 320,
"height": 414,
"url": "/api/v1/documents/V1StGXR8_Z5jdHi6B-myT/pages/0"
}
]
}
}Changes
No recorded changes to this operation across all 1 revision of this API.