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]" }
  ]
}
PropertyTypeRequiredDescription
primarySignerobjectno*The main signer, the person the request is sent to. { fullName, email }.
additionalSignersarraynoOther 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 byWhen
Request signers (this page)You, in the request bodyUp front, before sending the link
Signer slots (additionalSignersConfig)The respondent, in the formWhile filling the form

Use request signers when you already know who signs; use signer slots when the respondent decides.