curl --request PUT \
--url https://app.vumasign.com/api/v1/templates/{templateId}/people/{personId} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--header 'If-Match: <if-match>' \
--data '
{
"decision": "signer"
}
'import requests
url = "https://app.vumasign.com/api/v1/templates/{templateId}/people/{personId}"
payload = { "decision": "signer" }
headers = {
"If-Match": "<if-match>",
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {
'If-Match': '<if-match>',
Authorization: 'Bearer <token>',
'Content-Type': 'application/json'
},
body: JSON.stringify({decision: 'signer'})
};
fetch('https://app.vumasign.com/api/v1/templates/{templateId}/people/{personId}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://app.vumasign.com/api/v1/templates/{templateId}/people/{personId}"
payload := strings.NewReader("{\n \"decision\": \"signer\"\n}")
req, _ := http.NewRequest("PUT", url, payload)
req.Header.Add("If-Match", "<if-match>")
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}{
"warnings": [],
"id": "01960000-0000-4000-8000-0000000007e1",
"name": "Employment contract",
"created_at": "2026-09-01T08:30:00.000Z",
"documents": [
{
"id": "01960000-0000-4000-8000-00000000d0c5",
"page_count": 1
}
],
"pages": [
{
"document_id": "01960000-0000-4000-8000-00000000d0c5",
"page": 1,
"width": 595.28,
"height": 841.89,
"rotation": 0
}
],
"roles": [
{
"name": "Employee",
"routing_type": "sign",
"kind": "party",
"presign_hint": false
}
],
"subjects": [
{
"key": "employee",
"label": "Employee"
}
],
"questions": [],
"fields": [
{
"id": "01960000-0000-4000-8000-00000000f1e1",
"type": "text",
"label": "Full name",
"required": true,
"role": "Employee",
"document_id": "01960000-0000-4000-8000-00000000d0c5",
"page": 1,
"subject": "employee",
"data_key": "staff.full_name",
"tier": "organisation",
"question_id": null,
"option_value": null,
"options": null,
"rect": {
"x": 0.1007929,
"y": 0.2107045,
"w": 0.5689591,
"h": 0.0213805
},
"context": {
"label": "Full name",
"row": null,
"column": "Full name",
"option": null,
"section": "Employment contract",
"nearby": [
"<<text:Employee:Full name:subject(employee):key(staff.full_name)>>",
"Full name"
],
"widget_name": null,
"tooltip": null
},
"cells": null,
"continuations": null
}
],
"coverage": {
"prefillable": 1,
"core": 0,
"organisation": 1,
"legacy": 0,
"unnamed": 0,
"questions": 0,
"unnamed_groups": 0,
"unnamed_options": 0,
"collisions": 0
}
}{
"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>"
}
}{
"error": {
"code": "unauthenticated",
"message": "<string>"
}
}{
"error": {
"code": "unauthenticated",
"message": "<string>"
}
}{
"error": {
"code": "unauthenticated",
"message": "<string>"
}
}Decide one person: a subject for their details, a signing role, both, or a witness.
RUNS THE EDITOR’S PEOPLE STEP FOR ONE PERSON: the same rules, in the same order. It creates the subject and role the decision needs, gives the fields in the person’s part of the form that subject and role — never changing a field’s key — and removes only a subject or role this person’s earlier decision made that nothing uses any more. Recorded in the template’s naming record.
⚠️ A SAVED WITNESS IS NOT CHANGED HERE (witness_is_permanent): a witness role can never become anything else, so change that decision in the editor. ⚠️ LIVE KEYS ONLY, templates:name named on the key, and If-Match required.
curl --request PUT \
--url https://app.vumasign.com/api/v1/templates/{templateId}/people/{personId} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--header 'If-Match: <if-match>' \
--data '
{
"decision": "signer"
}
'import requests
url = "https://app.vumasign.com/api/v1/templates/{templateId}/people/{personId}"
payload = { "decision": "signer" }
headers = {
"If-Match": "<if-match>",
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {
'If-Match': '<if-match>',
Authorization: 'Bearer <token>',
'Content-Type': 'application/json'
},
body: JSON.stringify({decision: 'signer'})
};
fetch('https://app.vumasign.com/api/v1/templates/{templateId}/people/{personId}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://app.vumasign.com/api/v1/templates/{templateId}/people/{personId}"
payload := strings.NewReader("{\n \"decision\": \"signer\"\n}")
req, _ := http.NewRequest("PUT", url, payload)
req.Header.Add("If-Match", "<if-match>")
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}{
"warnings": [],
"id": "01960000-0000-4000-8000-0000000007e1",
"name": "Employment contract",
"created_at": "2026-09-01T08:30:00.000Z",
"documents": [
{
"id": "01960000-0000-4000-8000-00000000d0c5",
"page_count": 1
}
],
"pages": [
{
"document_id": "01960000-0000-4000-8000-00000000d0c5",
"page": 1,
"width": 595.28,
"height": 841.89,
"rotation": 0
}
],
"roles": [
{
"name": "Employee",
"routing_type": "sign",
"kind": "party",
"presign_hint": false
}
],
"subjects": [
{
"key": "employee",
"label": "Employee"
}
],
"questions": [],
"fields": [
{
"id": "01960000-0000-4000-8000-00000000f1e1",
"type": "text",
"label": "Full name",
"required": true,
"role": "Employee",
"document_id": "01960000-0000-4000-8000-00000000d0c5",
"page": 1,
"subject": "employee",
"data_key": "staff.full_name",
"tier": "organisation",
"question_id": null,
"option_value": null,
"options": null,
"rect": {
"x": 0.1007929,
"y": 0.2107045,
"w": 0.5689591,
"h": 0.0213805
},
"context": {
"label": "Full name",
"row": null,
"column": "Full name",
"option": null,
"section": "Employment contract",
"nearby": [
"<<text:Employee:Full name:subject(employee):key(staff.full_name)>>",
"Full name"
],
"widget_name": null,
"tooltip": null
},
"cells": null,
"continuations": null
}
],
"coverage": {
"prefillable": 1,
"core": 0,
"organisation": 1,
"legacy": 0,
"unnamed": 0,
"questions": 0,
"unnamed_groups": 0,
"unnamed_options": 0,
"collisions": 0
}
}{
"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>"
}
}{
"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.
Headers
The ETag of the template you read. ⚠️ REQUIRED: without it, or with *, the answer is precondition_required; a stale one is template_changed, with the current ETag.
An entity tag, quoted.
Path Parameters
The template’s id, as returned by the list endpoint.
A template id.
"01960000-0000-4000-8000-0000000007e1"
The person’s id, from GET /api/v1/templates/{templateId}/people or a run’s proposals.people.
A person id: 32 lower-case hexadecimal digits.
^[0-9a-f]{32}$Body
The decision.
The decision.
subject: their details get a subject, and they sign nothing. signer: a signing role for their signature, initials and signing date. both: a subject and a signing role. mandate_signed: a signing role marked as one your organisation normally pre-signs under a standing authorisation (information only: a send applies a mandate only when it names one). witness: a witness role.
subject, signer, both, mandate_signed, witness The subject’s key, for subject, both and witness.
1 - 100The subject’s name.
1 - 200Whether the person is always on the form.
required, conditional The role’s name, for every decision but subject.
1 - 200For both: who fills the person’s details. current (the default) leaves them with whoever fills them now; own gives them to the person’s own role.
current, own Response
The template as it now stands, with its new ETag.
The template, in full.
The template’s id. A bare uuid, no prefix.
What the sender called it.
ISO 8601, UTC. Also the order this list is in — newest first.
What the template’s upload warned about, kept with the template: on the create response and on every read, so a template somebody uploaded on the dashboard says here what its upload said. Empty when there was nothing to say, and always present. A retry of the create’s Idempotency-Key answers with the same list.
10Show child attributes
Show child attributes
The pack, in the order it is stacked.
Show child attributes
Show child attributes
⚠️ THE DENOMINATOR FOR EVERY Field.rect, and a client doing field matching cannot skip it: a rectangle of fractions is dimensionless without the page it is a fraction of. Join on (document_id, page), the same pair fields is joined by.
Every page of every document of the pack, in the pack’s order and then by page number — the order a signer scrolls.
Show child attributes
Show child attributes
The signing roles, in routing order.
Show child attributes
Show child attributes
The people whose data this template collects.
Show child attributes
Show child attributes
The tickbox questions and how many answers each takes.
Show child attributes
Show child attributes
⚠️ A FLAT LIST, NOT A MAP KEYED BY ADDRESS. Several fields sharing one (subject, data_key) pair is NORMAL — real forms ask for an ID number on the application and again on the declaration, and initials in the footer of all nine pages. A value supplied for an address means it for every box that asks.
Show child attributes
Show child attributes
How much of the template your integration can address, counted by the same code as the editor’s coverage line, so the two always agree. Part of the body, so the template’s ETag changes when it does.
Show child attributes
Show child attributes