Overview
A high-level picture of how DocParse works end-to-end. If you're new here, this gives you the mental model in 5 minutes.
The flow
plaintext
ββββββββββββ ββββββββββββββββ βββββββββββββββββββ βββββββββββββ
β Your app β β β POST /extractβ β β DocParse engine β β β JSON back β
ββββββββββββ ββββββββββββββββ βββββββββββββββββββ βββββββββββββ
β β
β β
βββββββ poll /status OR webhook ββββββββββββ- Define an Extraction template in the dashboard β basically a schema: the fields you want, their types, optional examples.
- Upload documents to that template via the REST API.
- Get results back either synchronously (for fast jobs) or via the webhook you've configured.
Two completion patterns
- Polling β call
GET /extractions/{id}/statusuntil status isprocessed. Good for ad-hoc scripts and CLI tools. - Webhook β register a URL in the dashboard's API page. We POST the results to your endpoint when each file finishes. Good for production integrations.
See Polling vs Webhook for the detailed comparison.
Two products
DocParse has two API surfaces:
- Data Extraction API β schema-driven field extraction. You define what fields to pull from invoices/receipts/forms; we return them as JSON. Endpoints β
- Document Classification API β given a folder of mixed documents, sort each one into a category (invoice / contract / resume / etc.) and optionally chain into an extraction template per category. Endpoints β
Free tier
Every account gets 100 pages every month, free, forever. Once you're past 100, see pricing.
Where to next
- Authentication β get your API key.
- Supported File Types β what we accept.
- Data Extraction API β the main endpoint reference.