Fields

A field is an interactive element on the PDF — a signature, a text box, a date — assigned to a specific recipient. The Integration Guide explains how to create them and how to position them (placeholder or coordinates). This resource details the available field types and their configuration options (fieldMeta).

Field types

Type	Description	Auto-filled
SIGNATURE	Drawn, typed, or uploaded signature.	No
INITIALS	The recipient’s initials.	No
NAME	The recipient’s full name.	Yes
EMAIL	The recipient’s email.	Yes
DATE	The date the field was completed.	Yes
TEXT	Free-form text.	No
NUMBER	Numeric, with optional range validation.	No
RADIO	Single selection from options.	No
CHECKBOX	Multiple selection from options.	No
DROPDOWN	Single selection from a dropdown menu.	No

Common options (fieldMeta)

All types accept these base options inside fieldMeta:

Option	Type	Description
label	string	Text shown next to the field.
placeholder	string	Hint text shown when the field is empty.
required	boolean	Whether the field must be completed before signing.
readOnly	boolean	Locks the field with a pre-filled value.
fontSize	number	Text size in pixels (8–96, defaults to 12).
overflow	string	auto, horizontal, vertical, or crop — how text that exceeds the field’s space behaves.

Extra options per type

Type	Extra options
INITIALS, NAME, EMAIL, DATE	textAlign (left, center, right)
TEXT	text (default value), characterLimit, textAlign, lineHeight, letterSpacing, verticalAlign
NUMBER	value, minValue, maxValue, numberFormat, textAlign, lineHeight, letterSpacing, verticalAlign
RADIO	values (options), direction (vertical, horizontal)
CHECKBOX	values, validationRule, validationLength, direction
DROPDOWN	values, defaultValue

// Example: text field with validation
{
  "type": "TEXT",
  "recipientId": 456,
  "page": 1,
  "positionX": 10,
  "positionY": 70,
  "width": 40,
  "height": 4,
  "fieldMeta": {
    "type": "text",
    "label": "Job title",
    "placeholder": "Enter your job title",
    "characterLimit": 100,
    "required": true
  }
}

Signature stamp (Advanced Electronic Signature)

For SIGNATURE fields in an envelope with FEA, fieldMeta also accepts a stamp object that adds the signer’s verified identity to the PDF next to their signature:

{
  "type": "SIGNATURE",
  "fieldMeta": {
    "type": "signature",
    "stamp": {
      "enabled": true,
      "label": "",
      "layout": "sideBySide", // or "textOnly"
      "showName": true,
      "showRut": true,
      "showDate": true,
      "border": true
    }
  }
}

stamp.enabled is off by default. See Advanced Electronic Signature for the rest of what FEA changes.

Create fields

POST /envelope/field/create-many

See the full spec in the API Reference.

Update fields

POST /envelope/field/update-many

Only works while the envelope is in DRAFT — once distributed, fields are fixed.

See the full spec in the API Reference.

Delete a field

POST /envelope/field/delete

See the full spec in the API Reference.

Get a field

GET /envelope/field/{fieldId}

See the full spec in the API Reference.

---

See also

• Integration Guide — positioning fields with a placeholder or coordinates
• Recipients — who each field is assigned to
• Advanced Electronic Signature — additional FEA rules on fields