PDF Forms

Inspect PDF form fields

Upload a PDF form to retrieve all form fields with their names, types, current values, and available options. Use this to discover field names before filling.

post/api/pdf-forms/fields

Request

  • Base URL: https://api.dokmatiq.com
  • URL: https://api.dokmatiq.com/api/pdf-forms/fields
  • Auth: API key in header X-API-Key

Response

List of form fields

namestring

Fully qualified field name

typestring

Field type: TEXT, CHECKBOX, RADIO, DROPDOWN, LISTBOX, SIGNATURE, BUTTON, UNKNOWN

valuestring

Current field value (empty if not filled)

requiredboolean

Whether the field is required

readOnlyboolean

Whether the field is read-only

maxLengthinteger

Maximum length for text fields (0 = unlimited)

optionsstring[]

Available options for DROPDOWN, LISTBOX, RADIO, CHECKBOX fields

alternativeNamestring

Alternative field name (tooltip/display name)

Example response

{
  "name": "vorname",
  "type": "TEXT",
  "required": true,
  "maxLength": 50,
  "options": [
    "Yes",
    "Off"
  ],
  "alternativeName": "Vorname des Antragstellers"
}

Changes

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