PDF Automation / API-Driven

PDF automation via API.

Create document sessions from your application, prefill field values from your database, retrieve completed and signed PDFs, and receive HMAC-signed webhook events on every submission. TypeScript and Python SDKs ship with every Developer plan.

Start free trial Read the docs →

The API workflow

Programmatic control of every step.

Step 1

Create session via API

POST /sessions with document package ID and prefill values

Step 2

Client receives link

Return the session URL — embed it, email it, or display it in your app

Step 3

Client fills interview

Guided interview runs on Docuplete infrastructure — no frontend work

Step 4

PDF generated on submit

Docuplete fills the PDF, collects the signature, applies timestamp

Step 5

Webhook fired

Your endpoint receives field values, session ID, and PDF download URL

Step 6

Retrieve via API

GET /sessions/:id/pdf to download the completed, signed document

SDKs

TypeScript and Python SDKs. Typed. Documented.

TypeScript / JavaScript

`@docuplete/sdk`

Install: npm install @docuplete/sdk. Typed request and response objects, authentication handling, async/await throughout. Works in Node.js and edge runtimes.

Python

`docuplete`

Install: pip install docuplete. Python 3.8+ support. Typed models via Pydantic. Async support via httpx. Full API coverage — sessions, documents, verification.

OpenAPI 3 spec

Explore without writing code

The full API is documented as an OpenAPI 3 spec — browse every endpoint, see request and response schemas, and test calls from the developer portal without an API key.

Sandbox environment

Test without production data

The Docuplete sandbox is available without an API key. Generate sessions, fill interviews, and trigger webhooks in an isolated environment — no production account required.

HMAC-signed webhooks

Verified events on every submission

Every webhook event is signed with HMAC-SHA256. Verify the signature before processing. Automatic retries with exponential backoff. Delivery logs and manual retry from the dashboard.

Headless mode

Drive the interview from your UI

Use headless mode to embed the interview inside your own application — prefill values from your database, show only the fields that aren't already known, and receive submissions directly.

Code sample

Create a session in three lines.

// TypeScript — create a session and get the interview link
import { DocupleteClient } from '@docuplete/sdk';

const client = new DocupleteClient({ apiKey: process.env.DOCUPLETE_API_KEY });

const session = await client.sessions.create({
  packageId: 'pkg_new_account_application',
  prefill: {
    client_name:    'Jane Smith',
    client_email:   'jane@example.com',
    account_type:   'Traditional IRA',
  },
  expiresIn: '7d',
});

console.log(session.url); // → https://docuplete.app/d/public/tok_abc123

# Python — equivalent in three lines
from docuplete import DocupleteClient

client = DocupleteClient(api_key="your_api_key")

session = client.sessions.create(
    package_id="pkg_new_account_application",
    prefill={"client_name": "Jane Smith", "account_type": "Traditional IRA"},
    expires_in="7d",
)
print(session.url)