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

nametyperequiredconstraints
namestringyesHuman-friendly name of the signing package
typestringyesenum: dynamic, staticWhether templates are generated dynamically or from static assets
signingOrderstringyesenum: sequential, simultaneousControls whether signers act one-after-another or at the same time
deliveryobjectyessee DeliveryEmail/SMS delivery configuration
templatesarrayyesitems: templateOne or more templates containing signing fields
participantsarrayyesitems: participantPeople who will sign or fill fields

Delivery

nametyperequired
fromNamestringyesSender name shown in emails
replyTostringnoReply-to email address
subjectstringyesEmail subject line
smsMessagestringnoOptional SMS body for notifying signers
buttonLabelstringyesText shown on the call-to-action button

Participant

nametyperequiredconstraints
namestringyesParticipant display name
emailstringnoformat: email (pattern permitted)Contact email for delivery and identity
signingOrderintegeryesOrder index when sequential
inPersonSigningbooleanyesdefault: falseWhether the signer completes the process in person
phoneNumberstringnoOptional phone number used for SMS or verification

Template & Field

  • Template: same shape as Document (name, fileId, fields).
  • Field: requires participant and uses a broader fieldType enum.

Field (Sign)

nametyperequiredconstraints
idstringyesField id
fieldSubTypestringyesenum: text, checkbox, radioVisual subtype of placed control
wrapTextbooleanyesdefault: falseWhether text wraps within bounds
requiredbooleanyesdefault: falseWhether signer must complete this field
xPositionnumbernoHorizontal position on page
yPositionnumbernoVertical position on page
pageNumbernumberyesPage index
widthnumbernoControl width
heightnumbernoControl height
fontSizenumbernoFont size for text/date fields
optionValuestringnoValue associated with a specific option
valuestringnoPre-filled value for text/date fields
radioGroupIdstringnoGroup identifier for radio buttons
fieldTypestringyesenum: text, signature, date, checkbox, initials, full_name, radio_button, date_signedLogical field type required by the signing engine
participantstringyesName 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
    }
  ]
}