Sign Step
Configures eSignature flows with participants, delivery settings, and positioned signing fields. Use this step to orchestrate signature collection across one or more participants with clear ordering and delivery customization.
Top-level properties
| name | type | required | constraints | |
|---|---|---|---|---|
name | string | yes | Human-friendly name of the signing package | |
type | string | yes | enum: dynamic, static | Whether templates are generated dynamically or from static assets |
signingOrder | string | yes | enum: sequential, simultaneous | Controls whether signers act one-after-another or at the same time |
delivery | object | yes | see Delivery | Email/SMS delivery configuration |
templates | array | yes | items: template | One or more templates containing signing fields |
participants | array | yes | items: participant | People who will sign or fill fields |
Delivery
| name | type | required | |
|---|---|---|---|
fromName | string | yes | Sender name shown in emails |
replyTo | string | no | Reply-to email address |
subject | string | yes | Email subject line |
smsMessage | string | no | Optional SMS body for notifying signers |
buttonLabel | string | yes | Text shown on the call-to-action button |
Participant
| name | type | required | constraints | |
|---|---|---|---|---|
name | string | yes | Participant display name | |
email | string | no | format: email (pattern permitted) | Contact email for delivery and identity |
signingOrder | integer | yes | Order index when sequential | |
inPersonSigning | boolean | yes | default: false | Whether the signer completes the process in person |
phoneNumber | string | no | Optional phone number used for SMS or verification |
Template & Field
- Template: same shape as Document (
name,fileId,fields). - Field: requires
participantand uses a broaderfieldTypeenum.
Field (Sign)
| name | type | required | constraints | |
|---|---|---|---|---|
id | string | yes | Field id | |
fieldSubType | string | yes | enum: text, checkbox, radio | Visual subtype of placed control |
wrapText | boolean | yes | default: false | Whether text wraps within bounds |
required | boolean | yes | default: false | Whether signer must complete this field |
xPosition | number | no | Horizontal position on page | |
yPosition | number | no | Vertical position on page | |
pageNumber | number | yes | Page index | |
width | number | no | Control width | |
height | number | no | Control height | |
fontSize | number | no | Font size for text/date fields | |
optionValue | string | no | Value associated with a specific option | |
value | string | no | Pre-filled value for text/date fields | |
radioGroupId | string | no | Group identifier for radio buttons | |
fieldType | string | yes | enum: text, signature, date, checkbox, initials, full_name, radio_button, date_signed | Logical field type required by the signing engine |
participant | string | yes | Name or id matching a participant |
Example (JSON)
{
"name": "NDA Signing",
"type": "dynamic",
"signingOrder": "sequential",
"delivery": {
"fromName": "Legal Team",
"replyTo": "[email protected]",
"subject": "Please review and sign the NDA",
"smsMessage": "You have a document to sign.",
"buttonLabel": "Review & Sign"
},
"templates": [
{
"name": "NDA",
"fileId": "file_abc",
"fields": [
{
"id": "sig-001",
"fieldSubType": "text",
"wrapText": false,
"required": true,
"xPosition": 100,
"yPosition": 200,
"pageNumber": 1,
"width": 250,
"height": 24,
"fontSize": 12,
"optionValue": "",
"value": "",
"radioGroupId": "",
"fieldType": "text",
"participant": "Signer 1"
},
{
"id": "sig-002",
"fieldSubType": "checkbox",
"wrapText": false,
"required": false,
"xPosition": 100,
"yPosition": 240,
"pageNumber": 1,
"width": 12,
"height": 12,
"fontSize": 10,
"optionValue": "agree",
"value": "agree",
"radioGroupId": "",
"fieldType": "checkbox",
"participant": "Signer 1"
},
{
"id": "sig-003",
"fieldSubType": "radio",
"wrapText": false,
"required": false,
"xPosition": 100,
"yPosition": 280,
"pageNumber": 2,
"width": 12,
"height": 12,
"fontSize": 10,
"optionValue": "A",
"value": "A",
"radioGroupId": "grp-choice",
"fieldType": "radio_button",
"participant": "Signer 2"
},
{
"id": "sig-004",
"fieldSubType": "text",
"wrapText": false,
"required": true,
"xPosition": 100,
"yPosition": 320,
"pageNumber": 2,
"width": 250,
"height": 24,
"fontSize": 12,
"optionValue": "",
"value": "",
"radioGroupId": "",
"fieldType": "signature",
"participant": "Signer 2"
},
{
"id": "sig-005",
"fieldSubType": "text",
"wrapText": false,
"required": false,
"xPosition": 100,
"yPosition": 360,
"pageNumber": 2,
"width": 150,
"height": 24,
"fontSize": 12,
"optionValue": "",
"value": "",
"radioGroupId": "",
"fieldType": "date_signed",
"participant": "Signer 2"
}
]
}
],
"participants": [
{
"name": "Signer 1",
"email": "[email protected]",
"signingOrder": 1,
"inPersonSigning": false,
"phoneNumber": "+15551234567"
},
{
"name": "Signer 2",
"email": "[email protected]",
"signingOrder": 2,
"inPersonSigning": false
}
]
}Updated 22 days ago
