Document Fields

Fields are positioned elements on document pages — signature boxes, text inputs, date pickers, etc. Coordinates are normalized (0–1) relative to the page dimensions.

GET/api/v1/documents/{id}/fields

Required scope:read:documents

POST/api/v1/documents/{id}/fields

Place a field

Required scope:write:documents

PUT/api/v1/documents/{id}/fields/{fid}

Update a field

Required scope:write:documents

DELETE/api/v1/documents/{id}/fields/{fid}

Remove a field

Required scope:write:documents

Field types

Same types as form questions: digital_signature, initials, short_text, date, email, phone, number, yes_no, mcq, dropdown.

Place a field

Required Fields

Name	Type	Required	Description
label	string	required	Field label`Signature`
type	FieldType	required	Field type`digital_signature`
pageNumber	integer	required	1-indexed page number
x	float	required	Normalized x position (0–1 from left)
y	float	required	Normalized y position (0–1 from top)
width	float	required	Normalized width (0–1)
height	float	required	Normalized height (0–1)

Optional Fields

Name	Type	Required	Description
isRequired	boolean	optional	Whether the field must be filled`true`
isReadOnly	boolean	optional	Pre-filled and locked`false`
defaultValue	string	optional	Pre-populated value. Use __today__ for current date.
assigneeRole	string	optional	Signer role that fills this field`signer_1`
direction	auto \| rtl \| ltr	optional	Text direction for RTL languages

curl -X POST https://formalingo.com/api/v1/documents/DOC_ID/fields \
  -H "Authorization: Bearer af_live_YOUR_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "label": "Client Signature",
    "type": "digital_signature",
    "pageNumber": 3,
    "x": 0.1,
    "y": 0.85,
    "width": 0.35,
    "height": 0.06,
    "isRequired": true,
    "assigneeRole": "signer_1"
  }'

Document Fields

Document Fields

Field types

Place a field

On this page