Signature Request Model
The top-level signing transaction object created through the API.
Schema
A signature request combines templates, signers and configuration:
JSON
{
"mode": "email",
"message": "Please sign the official documents.",
"sequential_signing": "Yes",
"field_visibility": "No",
"external_id": "ORDER-99281",
"metadata": {},
"templates": [],
"webhook": {}
}
Fields
| Field | Required | Type | Description |
|---|---|---|---|
| mode | optional | string | Delivery mode: email (default, auto-sends links) or local (retrieve links via API). |
| message | optional | string | Custom invitation email body message. Defaults to an empty string. |
| sequential_signing | optional | string | Yes routes signers in order (Signer 2 is emailed only after Signer 1 completes); No (default) lets everyone sign in any order. |
| field_visibility | optional | string | Yes lets signers see other parties' entries; No (default) keeps them hidden. |
| external_id | optional | string | Associate the request with a record in your system. |
| metadata | optional | object | Extensible application context. |
| templates | required | array | One or more template requests. |
| webhook | optional | object | Webhook configuration (url + events). |
| webhook_url | optional | string | Legacy string callback URL. Used if the webhook object is omitted. |