---
title: "Inspect PDF form fields"
method: POST
path: "/api/pdf-forms/fields"
tags: ["PDF Forms"]
---

# Inspect PDF form fields

`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`

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.

## Response `200`

List of form fields

- PdfFormField: Description of a single PDF form field
  - `name` string: Fully qualified field name
  - `type` string: Field type: TEXT, CHECKBOX, RADIO, DROPDOWN, LISTBOX, SIGNATURE, BUTTON, UNKNOWN
  - `value` string: Current field value (empty if not filled)
  - `required` boolean: Whether the field is required
  - `readOnly` boolean: Whether the field is read-only
  - `maxLength` integer: Maximum length for text fields (0 = unlimited)
  - `options` string[]: Available options for DROPDOWN, LISTBOX, RADIO, CHECKBOX fields
  - `alternativeName` string: Alternative field name (tooltip/display name)

## Other responses

- `400`: Invalid PDF or processing error

---

[API](https://skmtc.dev/dokmatiq/apis/docgen-api.md) · [All operations](https://skmtc.dev/dokmatiq/apis/docgen-api/llms.txt) · [OpenAPI document](https://skmtc.dev/dokmatiq/apis/docgen-api/revisions/3fa1a922764d?raw)