Document Step

Generates documents without collecting signatures. Use this step to place fields onto static or dynamic templates that will be filled with workflow data and rendered to files (e.g., PDFs).

Top-level properties

nametyperequiredconstraints
namestringyesHuman-friendly name of this document set
typestringyesenum: dynamic, staticWhether templates are generated dynamically or from static assets
templatesarrayyesitems: templateOne or more document templates to render

Template

nametyperequired
namestringyesTemplate display name
fileIdstringyesIdentifier of the base file or template to render
fieldsarrayyesPositioned fields that will be populated

Field

nametyperequiredconstraints
idstringyesField id for reference
fieldSubTypestringyesenum: text, checkbox, radioVisual subtype of the positioned field
wrapTextbooleanyesdefault: falseWhether text wraps within the bounding box
requiredbooleanyesdefault: falseWhether a value must be supplied
xPositionnumbernoHorizontal position on the page (units defined by renderer)
yPositionnumbernoVertical position on the page
pageNumbernumberyesPage index to place the field on
widthnumbernoBounding box width
heightnumbernoBounding box height
fontSizenumbernoFont size for text fields
optionValuestringnoSpecific option value for radio/checkbox toggles
valuestringnoStatic value to inject (for text fields)
radioGroupIdstringnoIdentifier to group related radio options
fieldTypestringyesenum: form_fieldFixed type indicating a standard form field

Example (JSON)

{
  "name": "Onboarding Packet",
  "type": "dynamic",
  "templates": [
    {
      "name": "Packet",
      "fileId": "file_123",
      "fields": [
        {
          "id": "fld-001",
          "fieldSubType": "text",
          "wrapText": false,
          "required": true,
          "xPosition": 120,
          "yPosition": 240,
          "pageNumber": 1,
          "width": 300,
          "height": 24,
          "fontSize": 12,
          "optionValue": "",
          "value": "",
          "radioGroupId": "",
          "fieldType": "form_field"
        },
        {
          "id": "fld-002",
          "fieldSubType": "checkbox",
          "wrapText": false,
          "required": false,
          "xPosition": 120,
          "yPosition": 300,
          "pageNumber": 1,
          "width": 12,
          "height": 12,
          "fontSize": 10,
          "optionValue": "yes",
          "value": "yes",
          "radioGroupId": "",
          "fieldType": "form_field"
        },
        {
          "id": "fld-003",
          "fieldSubType": "radio",
          "wrapText": false,
          "required": false,
          "xPosition": 120,
          "yPosition": 340,
          "pageNumber": 2,
          "width": 12,
          "height": 12,
          "fontSize": 10,
          "optionValue": "A",
          "value": "A",
          "radioGroupId": "grp-choices",
          "fieldType": "form_field"
        }
      ]
    }
  ]
}