Form Filling

DeepRead's Form Fill API lets you automatically fill PDF forms by providing field values as JSON. The AI visually detects form fields and maps your data to the correct locations—works with any PDF form, including scanned documents. Form fill is available on the Enterprise plan; a request from another plan is refused with 402 naming the plan that has it.

Quick example

Upload a PDF form and provide the values you want filled:

curl -X POST https://api.deepread.tech/v1/form-fill \
  -H "X-API-Key: $DEEPREAD_API_KEY" \
  -F "file=@application_form.pdf" \
  -F 'form_fields={"full_name": "John Doe", "date_of_birth": "1990-01-15", "address": "123 Main St, New York, NY 10001"}'

Check the results

The API returns a job ID immediately. You can track your form fill jobs and download results from the Dashboard Jobs page, or poll for results via the API:

curl https://api.deepread.tech/v1/form-fill/550e8400-e29b-41d4-a716-446655440000 \
  -H "X-API-Key: $DEEPREAD_API_KEY"

Response when complete:

{
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "status": "completed",
  "file_name": "application_form.pdf",
  "filled_form_url": "https://storage.deepread.tech/filled/abc123.pdf",
  "fields_detected": 12,
  "fields_filled": 10,
  "fields_verified": 10,
  "fields_hil_flagged": 0
}

How it works

1. Upload a blank PDF form with your field data as JSON
2. AI detects all fillable fields using vision AI (works with any PDF)
3. Smart mapping matches your data keys to detected fields semantically
4. Fill & verify inserts values and runs quality checks
5. Download the filled PDF from the signed URL

Supported forms

The form fill API works with:

• Standard PDF forms with AcroForm fields
• Scanned paper forms (no digital fields)
• Government forms, applications, contracts
• Any PDF with visible input areas

Next steps

• Form Filling Concepts - Understand the visual detection approach
• API Reference - Complete endpoint documentation