# PDF Form Filler — Fill AcroForm Fields (`hipersoft/pdf-fill-form`) Actor

Fill PDF form fields from JSON values and optionally flatten the result so it can't be edited. Auto-generate filled contracts, applications and government forms at scale.

- **URL**: https://apify.com/hipersoft/pdf-fill-form.md
- **Developed by:** [hiper soft](https://apify.com/hipersoft) (community)
- **Categories:** Developer tools, Other
- **Stats:** 2 total users, 1 monthly users, 100.0% runs succeeded, 0 bookmarks
- **User rating**: No ratings yet

## Pricing

from $0.005 / pdf form filled

This Actor is paid per event. You are not charged for the Apify platform usage, but only a fixed price for specific events.
Since this Actor supports Apify Store discounts, the price gets lower the higher subscription plan you have.

Learn more: https://docs.apify.com/platform/actors/running/actors-in-store#pay-per-event

## What's an Apify Actor?

Actors are web data automations that power AI and operations. They run on the Apify platform to scrape websites, process data, connect APIs, and automate workflows.
In Batch mode, an Actor accepts a well-defined JSON input, performs an action which can take anything from a few seconds to a few hours,
and optionally produces a well-defined JSON output, datasets with results, or files in key-value store.
In Standby mode, an Actor provides a web server which can be used as a website, API, or an MCP server.
Actors are written with capital "A".

## How to integrate an Actor?

If asked about integration, you help developers integrate Actors into their projects.
You adapt to their stack and deliver integrations that are safe, well-documented, and production-ready.
The best way to integrate Actors is as follows.

- **AI agents and MCP clients** — the [Apify MCP server](https://docs.apify.com/integrations/mcp.md) at `https://mcp.apify.com` (remote, streamable HTTP, OAuth on first use).
- **Agentic workflows and local Actor development** — [Agent Skills](https://apify.com/.well-known/agent-skills/index.json) with the [Apify CLI](https://docs.apify.com/cli/docs.md): `npm install -g apify-cli`, then `apify login`.
- **JavaScript/TypeScript projects** — the official [JS/TS client](https://docs.apify.com/api/client/js/docs.md): `npm install apify-client`.
- **Python projects** — the official [Python client](https://docs.apify.com/api/client/python/docs.md): `pip install apify-client`.
- **Any other language** — the [REST API](https://docs.apify.com/api/v2.md).

For usage examples, see the [API](#api) section below.

For more details, see Apify documentation as [Markdown index](https://docs.apify.com/llms.txt) and [Markdown full-text](https://docs.apify.com/llms-full.txt).

# README

## PDF Form Filler — Fill AcroForm Fields in Bulk

**Fill PDF form fields from JSON values** — and optionally flatten the result so it can't be edited. Auto-generate filled contracts, applications, tax forms and government paperwork at scale, straight from your data.

### What it does

- Fills **text fields, checkboxes, radio buttons and dropdowns** from a `{ field: value }` map.
- Optionally **flattens** the form so the values become permanent.
- Lists the form's **available fields** so you know exactly what to fill.

### Use cases

- **Document automation** — generate filled contracts/applications from a database or CRM.
- **Government & tax forms** — batch-fill standard PDF forms.
- **HR & onboarding** — pre-fill offer letters and forms per employee.

### Input

```json
{ "pdfUrl": "https://example.com/form.pdf", "fields": { "Name": "Ada Lovelace", "Email": "ada@example.com", "Subscribe": true }, "flatten": false }
```

| Field | Type | Description |
|---|---|---|
| `pdfUrl` | string | A fillable PDF (with AcroForm fields). |
| `fields` | object | `{ fieldName: value }` — strings, booleans (checkboxes), option values (dropdowns/radios). |
| `flatten` | boolean | Lock the filled values so they can't be edited. |
| `outputName` | string | Output filename. |

Tip: run once with any values to see `availableFields` in the output, then map your data to those names.

### Output

```json
{ "fieldsFilled": 3, "flattened": false, "availableFields": ["Name", "Email", "Subscribe"], "resultUrl": "https://api.apify.com/v2/key-value-stores/.../records/filled.pdf" }
```

#### Output schema

| Field | Type | Description |
|---|---|---|
| `fieldsFilled` | integer | How many fields were filled. |
| `flattened` | boolean | Whether the form was flattened. |
| `resultUrl` | string (URL) | Link to the filled PDF. |

### FAQ

**How do I find the field names?** Run once — the output lists `availableFields`.

**Can I automate it?** Yes — via [integrations on the Apify platform](https://apify.com/integrations) and the [Apify API](https://docs.apify.com/api/v2).

### Notes

Original clean-room implementation.

# Actor input Schema

## `pdfUrl` (type: `string`):

Direct link to a fillable PDF (with AcroForm fields).

## `fields` (type: `object`):

A { "fieldName": value } map. Text fields take strings, checkboxes take true/false, dropdowns/radios take the option value. Run once with any values to see availableFields in the output.

## `flatten` (type: `boolean`):

Flatten the form so the filled values become static and can't be edited.

## `outputName` (type: `string`):

Name for the filled PDF file.

## Actor input object example

```json
{
  "pdfUrl": "https://www.irs.gov/pub/irs-pdf/fw9.pdf",
  "fields": {
    "Name": "Ada Lovelace",
    "Email": "ada@example.com"
  },
  "flatten": false,
  "outputName": "filled.pdf"
}
```

# Actor output Schema

## `results` (type: `string`):

The results as dataset items.

# API

You can run this Actor programmatically using our API. Below are code examples in JavaScript, Python, and CLI, as well as the OpenAPI specification and MCP server setup.

## JavaScript example

```javascript
import { ApifyClient } from 'apify-client';

// Initialize the ApifyClient with your Apify API token
// Replace the '<YOUR_API_TOKEN>' with your token
const client = new ApifyClient({
    token: '<YOUR_API_TOKEN>',
});

// Prepare Actor input
const input = {
    "pdfUrl": "https://www.irs.gov/pub/irs-pdf/fw9.pdf",
    "fields": {
        "Name": "Ada Lovelace",
        "Email": "ada@example.com"
    }
};

// Run the Actor and wait for it to finish
const run = await client.actor("hipersoft/pdf-fill-form").call(input);

// Fetch and print Actor results from the run's dataset (if any)
console.log('Results from dataset');
console.log(`💾 Check your data here: https://console.apify.com/storage/datasets/${run.defaultDatasetId}`);
const { items } = await client.dataset(run.defaultDatasetId).listItems();
items.forEach((item) => {
    console.dir(item);
});

// 📚 Want to learn more 📖? Go to → https://docs.apify.com/api/client/js/docs

```

## Python example

```python
from apify_client import ApifyClient

# Initialize the ApifyClient with your Apify API token
# Replace '<YOUR_API_TOKEN>' with your token.
client = ApifyClient("<YOUR_API_TOKEN>")

# Prepare the Actor input
run_input = {
    "pdfUrl": "https://www.irs.gov/pub/irs-pdf/fw9.pdf",
    "fields": {
        "Name": "Ada Lovelace",
        "Email": "ada@example.com",
    },
}

# Run the Actor and wait for it to finish
run = client.actor("hipersoft/pdf-fill-form").call(run_input=run_input)

# Fetch and print Actor results from the run's dataset (if there are any)
print(f"💾 Check your data here: https://console.apify.com/storage/datasets/{run.default_dataset_id}")
for item in client.dataset(run.default_dataset_id).iterate_items():
    print(item)

# 📚 Want to learn more 📖? Go to → https://docs.apify.com/api/client/python/docs/quick-start

```

## CLI example

```bash
echo '{
  "pdfUrl": "https://www.irs.gov/pub/irs-pdf/fw9.pdf",
  "fields": {
    "Name": "Ada Lovelace",
    "Email": "ada@example.com"
  }
}' |
apify call hipersoft/pdf-fill-form --silent --output-dataset

```

## MCP server setup

```json
{
    "mcpServers": {
        "apify": {
            "type": "http",
            "url": "https://mcp.apify.com/?tools=fetch-actor-details,hipersoft/pdf-fill-form"
        }
    }
}

```

The hosted server signs you in with OAuth on first connect, so no API token belongs in this config. Clients without OAuth support can send an `Authorization: Bearer <APIFY_API_TOKEN>` header instead, using a token from API & Integrations in Apify Console (https://console.apify.com/settings/integrations).

## OpenAPI specification

Download the OpenAPI definition: https://api.apify.com/v2/actors/ackEkuT1T74O8vtGm/builds/QM9rj3CxrfuIBMOfu/openapi.json