PDFHQ logo

Documents

DocumentationPDF operations

Fill PDF Form Fields API

Fill existing editable AcroForm text and checkbox fields with validated values.

Server-side API keys Signed storage uploads

Endpoint and task semantics#

Operation code: fill_form

Start this operation with POST /v1/tasks and the tool code shown above. Upload and attach source PDFs (or use task-scoped upload endpoints), then call POST /v1/tasks/{task_id}/process with operation settings.

Prefill onboarding documents, applications and routine business forms.

Inputs: One PDF with AcroForm fields. 1–100 exact field names; values are strings or booleans.

Configuration and extra parameters#

SettingTypeBehaviour
valuesrequired objectMap PDF widget names to string (text) or boolean (checkbox). Missing names and unsupported field types fail instead of silently succeeding.

Options are validated by the API. Unknown settings and unsupported values return an error instead of being ignored.

Working request sequence#

Programming language: cURL

Choose a language · scroll horizontally for all 10 SDK languages

API example · cURL
# Server-side API calls. Save the returned task_id.
curl -fsS -X POST 'https://api.pdfhq.io/v1/tasks' \
  -H 'x-api-key: YOUR_API_KEY' -H 'Content-Type: application/json' \
  -d '{"tool":"fill_form"}'

# Upload and verify 1 PDF(s), then obtain and approve a credit quote:
curl -fsS 'https://api.pdfhq.io/v1/tasks/TASK_ID/quote' -H 'x-api-key: YOUR_API_KEY'

# ONLY after explicit customer approval:
test "$PDFHQ_APPROVE_QUOTE" = yes || { echo "Approval required" >&2; exit 1; }
curl -fsS -X POST 'https://api.pdfhq.io/v1/tasks/TASK_ID/process' \
  -H 'x-api-key: YOUR_API_KEY' -H 'Content-Type: application/json' \
  -d '{"options":{"values":{"FullName":"Jane Doe","AgreeToTerms":true}}}'

curl -fsS 'https://api.pdfhq.io/v1/tasks/TASK_ID' -H 'x-api-key: YOUR_API_KEY'

After starting a task, upload and verify PDFs, review the credit quote, and get explicit approval before processing. API keys belong on your server, never on signed storage uploads.

All 10 SDKs ↓Complete Python walkthrough ↓ Complete Bash/cURL walkthrough ↓ All endpoints → Direct uploads → Error handling →

Generated downloadable packages cover the task workflow only. Full-service SDKs require a verified runtime OpenAPI specification; the Python, JavaScript and TypeScript task SDKs stream file uploads; the other languages require signed multipart uploads implemented by the caller.

The returned task ID is used for both status polling and retrieval. After the task succeeds, request a signed output URL rather than embedding a download secret.

Output and important details#

New editable PDF with widget values populated and appearance updated.

XFA forms, signature fields and unsupported widget types are rejected. Result is not flattened or digitally signed. Existing PDF signatures are rejected.

Errors, retries and billing
PDFHQ logo

PDF tools and document intelligence. Prepare, understand and work with your documents.

© 2026 PDFHQ. All rights reserved.