Request Signers
Work in progress. This feature is still being built and may change.
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]" }
]
}| Property | Type | Required | Description |
|---|---|---|---|
primarySigner | object | no* | The main signer, the person the request is sent to. { fullName, email }. |
additionalSigners | array | no | Other signers on the resulting case file. Each { fullName, email }. |
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.
Request signers vs. form signer slots
These are two different mechanisms:
| Set by | When | |
|---|---|---|
| Request signers (this page) | You, in the request body | Up front, before sending the link |
Signer slots (additionalSignersConfig) | The respondent, in the form | While filling the form |
Use request signers when you already know who signs; use signer slots when the respondent decides.
Updated 4 days ago
