Request Signers
When you create a prefilled request, you can attach the signers directly instead of collecting their details in the form. Add primarySigner and, optionally, additionalSigners to the request body.
POST /v2/forms/{formId}/requests
Content-Type: application/json
{
"answers": { ... },
"primarySigner": { "fullName": "Jane Smith", "email": "[email protected]" },
"additionalSigners": [
{ "fullName": "John Doe", "email": "[email protected]", "slotIndex": 0 }
]
}| Property | Type | Required | Description |
|---|---|---|---|
primarySigner | object | no* | The main signer, the person the request is sent to. { fullName, email }. |
additionalSigners | array | no | Extra signers you fill in ahead of time. Each { fullName, email, slotIndex }. |
Both fullName (non-blank) and a valid email are required on every signer. The primary signer is the request's initiator; additional signers are added to the case file.
* A primarySigner becomes required when the request resolves a reminder configuration. See Reminders. Without reminders, signers on the request are optional.
Filling a signer slot
A form can define signer slots — named positions like "Guarantor" or "Co-Tenant". Each additional signer you add fills one of these slots. Use slotIndex to say which one: 0 is the first slot, 1 the second, and so on.
The request is rejected if:
- the form has no signer slots;
- a signer is missing its
slotIndex, or points at a slot that doesn't exist; - a signer points at a slot that only appears depending on the respondent's answers — you can't fill those in advance;
- two signers are given the same slot.
What the respondent can do
Signers you add this way are shown as already filled and can't be changed by the respondent. They can still fill any slot you left empty, and add more signers if the form allows it. If you leave a required slot empty, the respondent has to fill it before they can submit.
Locking the request to the primary signer
To require the primary signer to prove their identity before they can open or sign, protect the request with an eID restriction. See Protected Requests.
Updated 17 days ago
