curl --request GET \
--url https://app.vumasign.com/api/v1/documents/{documentId}/pages/{pageNumber} \
--header 'Authorization: Bearer <token>'import requests
url = "https://app.vumasign.com/api/v1/documents/{documentId}/pages/{pageNumber}"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://app.vumasign.com/api/v1/documents/{documentId}/pages/{pageNumber}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://app.vumasign.com/api/v1/documents/{documentId}/pages/{pageNumber}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}"<string>"{
"error": {
"code": "unauthenticated",
"message": "<string>"
}
}{
"error": {
"code": "unauthenticated",
"message": "<string>"
}
}{
"error": {
"code": "unauthenticated",
"message": "<string>"
}
}{
"error": {
"code": "unauthenticated",
"message": "<string>"
}
}{
"error": {
"code": "unauthenticated",
"message": "<string>"
}
}{
"error": {
"code": "unauthenticated",
"message": "<string>"
}
}{
"error": {
"code": "unauthenticated",
"message": "<string>"
}
}One page of a document, as a PDF, to look at.
THE PAGE ITSELF. GET /api/v1/templates/{templateId} tells you where every field is; this is the picture those coordinates are measured against. Fetch it, render it, and every Field.rect on this page lands on its box.
⚠️ IT ANSWERS application/pdf, NOT AN IMAGE, AND THAT IS DELIBERATE. The page is served as a one-page PDF carrying the original page’s vectors, fonts, images and field boxes. Every model that accepts a screenshot accepts this too, and rasterises it at the resolution IT wants rather than one we picked — too low and the OCR-derived labels this feature exists to disambiguate are unreadable, too high and it is a render nobody asked for. You also keep the text layer, which a PNG would have thrown away.
One page carries that page’s content and every font and image it uses, so it is usually far smaller than the whole document; a page that shares its resources with every other page carries all of them. GET /api/v1/documents/{documentId}/content serves every page at once.
⚠️ THE PAGE IS NOT FILLABLE, AND IT IS INERT. Its field boxes draw from the appearance saved with them, but the form itself does not come across, so this is a picture of the page and not a copy of the form. The page is rebuilt: no script, action, embedded file, file-attachment or media annotation the uploader left on it is served, and a link keeps only a go-to to this same page or an address beginning http://, https:// or mailto:. Values are supplied through values on POST /api/v1/envelopes.
⚠️ ONLY A DOCUMENT A LIVE TEMPLATE HOLDS. The document must belong to a template of your organisation that is not archived.
⚠️ FOUR SITUATIONS ANSWER WITH THE SAME 404: no such document anywhere; a document belonging to another organisation; a document no live template of yours holds; and an id that is not a uuid. Once the document has been found under YOUR key, a pageNumber it does not have, or one that is not a page number at all, is the same code with a specific message — “this document has 6 pages” — because that is the point at which a refusal is allowed to say something.
Never cached, by anything: Cache-Control: private, no-store. This is one organisation’s confidential paperwork selected by a request header, and a shared cache keyed on the URL would hand it to the next caller of the same path.
curl --request GET \
--url https://app.vumasign.com/api/v1/documents/{documentId}/pages/{pageNumber} \
--header 'Authorization: Bearer <token>'import requests
url = "https://app.vumasign.com/api/v1/documents/{documentId}/pages/{pageNumber}"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://app.vumasign.com/api/v1/documents/{documentId}/pages/{pageNumber}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://app.vumasign.com/api/v1/documents/{documentId}/pages/{pageNumber}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}"<string>"{
"error": {
"code": "unauthenticated",
"message": "<string>"
}
}{
"error": {
"code": "unauthenticated",
"message": "<string>"
}
}{
"error": {
"code": "unauthenticated",
"message": "<string>"
}
}{
"error": {
"code": "unauthenticated",
"message": "<string>"
}
}{
"error": {
"code": "unauthenticated",
"message": "<string>"
}
}{
"error": {
"code": "unauthenticated",
"message": "<string>"
}
}{
"error": {
"code": "unauthenticated",
"message": "<string>"
}
}Authorizations
Authorization: Bearer vsk_live_…. Chosen over a bespoke X-API-KEY header because every client, proxy and log-redaction rule already knows this one. What a key may DO is its scopes — see x-scopes at the root of this document and x-required-scope on each operation. The scope list is not written here because OpenAPI reserves a requirement’s scope array for oauth2 and openIdConnect and requires it to be empty for an http scheme.
Path Parameters
1-indexed, WITHIN this document. The same number as Field.page and Page.page. ⚠️ There is one spelling of each page: 01, 1.0 and 1 are refused rather than accepted as 1, so that one page does not answer to five URLs.
Which page of the document.
x >= 14
Response
The page, as a one-page PDF. Content-Disposition: inline; filename="page-N.pdf" — the filename names the page and nothing about the customer.
The PDF bytes. ⚠️ NOT JSON. Its refusals still are: every non-2xx is the same Error envelope in application/json.