Templates

List embedded AcroForm fields of the base PDF

Fillable PDFs (e.g. IRS tax forms like the W-9 or W-8BEN) embed their form fields in the file. This returns each field with its exact position, type, and name, so template fields can be created with acroFieldName links instead of guessed coordinates. Returns an empty list for flat PDFs.

get/api/v1/templates/{id}/form-fields

Request

  • Base URL: https://api.korala.ai
  • URL: https://api.korala.ai/api/v1/templates/{id}/form-fields
  • Auth: one of:
    • API key in header X-API-Key
    • bearer (a scheme the document does not define)

Path parameters

idstring required

Response

namestring required

Fully-qualified AcroForm field name (unique per field)

kind'text' | 'checkbox' | 'radio' | 'dropdown' | 'signature' required

Kind of embedded form field

pageNumbernumber required

1-based page number

xPositionnumber required

PDF points from the left edge (top-left origin)

yPositionnumber required

PDF points from the top edge (top-left origin)

widthnumber required
heightnumber required
maxLengthnumber

Maximum characters the form field accepts (comb/character boxes)

multilineboolean

Whether the text field is multiline

combboolean

Comb field: characters sit in maxLength equally spaced cells

labelstring

The form author's tooltip (/TU) for this field — its human-readable label

requiredboolean

Whether the form itself marks this field as required

readOnlyboolean

Read-only fields are computed or locked by the form and are never imported as signer-fillable fields

fontSizenumber

Point size from the field default appearance (/DA); absent when the form auto-sizes the text

fontFamilystring

Base font the form draws this field with

textColorstring

Text color from the field default appearance, as #rrggbb

alignment'left' | 'center' | 'right'

Horizontal alignment of the value inside the field box

optionValuestring

For radio groups (one entry per option): the option export value

optionsstring[]

For dropdowns/list boxes: the allowed values

currentValuestring

Value already present in the PDF ('checked' for checked boxes)

Example response

[
  {
    "name": "topmostSubform[0].Page1[0].f1_01[0]",
    "pageNumber": 1,
    "xPosition": 59,
    "yPosition": 118,
    "width": 517,
    "height": 14,
    "maxLength": 9,
    "label": "Employee's social security number",
    "fontSize": 9,
    "fontFamily": "Helvetica",
    "textColor": "#000080",
    "optionValue": "married",
    "options": [
      "CA",
      "NY"
    ]
  }
]

Changes

No recorded changes to this operation across all 1 revision of this API.