> ## Documentation Index
> Fetch the complete documentation index at: https://docs.corsair.dev/llms.txt
> Use this file to discover all available pages before exploring further.

# Docparser plugin

> Send documents to Docparser parsers and read the data they extract (invoices, orders, bank statements, forms).

Use **Docparser** through Corsair: one client, typed API calls, local DB sync.

Get the secret API key under Account > API in Docparser. It is sent as HTTP Basic with the key as the username and an empty password.
The usual flow: `parsers.list` to find the parser, `documents.fetch` (public URL) or `documents.upload` (base64) to send a document, `documents.status` until `done` is true (parsing takes a minute or more), then `results.get` for the extracted fields. Parsing rules are set up in the Docparser app; the API runs them.
Importing a document uses parsing credits, one per 5 pages, charged only the first time it is parsed (the free trial has 50), so `documents.fetch` and `documents.upload` are destructive. `documents.reparse` costs nothing but replaces the parsed data with a run of the current rules, and `documents.reintegrate` sends the parsed data to the parser's integrations and webhooks again; both are destructive too.
Results come back whole, with every field the parser extracted. Only parser, layout and result metadata (ids, file name, page count, dates) is stored locally; parsed values, media links and document URLs are not stored and stay out of events.

**What you get:**

* 10 typed API operations
* 4 synced entities (`models`, `parsers`, `pings`, `results`) for fast `.search()` / `.list()`

## Setup

**1. Install**

```bash npm theme={null}
npm install corsair @corsair-dev/docparser better-sqlite3
npm install --save-dev @types/better-sqlite3
```

```bash yarn theme={null}
yarn add corsair @corsair-dev/docparser better-sqlite3
yarn add --dev @types/better-sqlite3
```

```bash pnpm theme={null}
pnpm install corsair @corsair-dev/docparser better-sqlite3
pnpm install --save-dev @types/better-sqlite3
```

```bash bun theme={null}
bun add corsair @corsair-dev/docparser better-sqlite3
bun add --dev @types/better-sqlite3
```

**2. Add the plugin**

```ts corsair.ts theme={null}
import Database from 'better-sqlite3';
import { createCorsair } from 'corsair';
import { docparser } from '@corsair-dev/docparser';

export const corsair = createCorsair({
	plugins: [
		docparser(),
	],
	database: new Database('corsair.db'),
	kek: process.env.CORSAIR_KEK!,
	multiTenancy: true,
	hub: {
		projectApiKey: process.env.CORSAIR_API_KEY!,
		signingSecret: process.env.CORSAIR_SIGNING_SECRET!,
	},
});
```

With `multiTenancy: true`, scope calls with `corsair.withTenant(id)`. See [Quick start](https://docs.corsair.dev/quick-start.md) for KEK + Hub keys, and [Multi-tenancy](https://docs.corsair.dev/concepts/multi-tenancy.md) for account isolation.

**3. Choose authentication**

> [tab] API Key (Recommended)
>
> Store the Docparser API key before the first call: `pnpm corsair setup --plugin=docparser --tenant=acme api_key=<your-key>` (leave out `--tenant` without `multiTenancy`), or pass it as `key` in the plugin options. With Hub, each tenant enters their own key on the connect page. See [API key auth](https://docs.corsair.dev/concepts/api-key).
>
> ```ts theme={null}
> docparser()
> ```
>
> More: [API Key](https://docs.corsair.dev/concepts/api-key)

**4. Connect a tenant**

Mint a connect link and send the tenant to it. Hub hosts the page and delivers the result to your app — see [Connect / OAuth](https://docs.corsair.dev/management/connect).

```ts theme={null}
const { connectUrl } = await corsair.manage.connect.createLink({
	plugin: 'docparser',
	tenantId: 'acme',
});
// redirect the user's browser to connectUrl
```

## Example API calls

**Get the newest parsed documents**

```ts theme={null}
const tenant = corsair.withTenant('acme');
await tenant.docparser.api.results.list({ parserId: 'balhnyuzdezt', limit: 20 });
```

**Send an invoice PDF to a parser**

```ts theme={null}
const tenant = corsair.withTenant('acme');
await tenant.docparser.api.documents.fetch({ parserId: 'balhnyuzdezt', url: 'https://example.com/invoices/inv-1001.pdf', remoteId: 'inv-1001' });
```

See the full list on the [API](https://docs.corsair.dev/plugins/docparser/api.md) page.

## Query synced data

Synced entities support `tenant.docparser.db.<entity>.search()` and `.list()`: `models`, `parsers`, `pings`, `results`.

See [Database](https://docs.corsair.dev/plugins/docparser/database.md) for filters and operators.

## What's next

> [card] [API reference](https://docs.corsair.dev/plugins/docparser/api.md)
>
> Every `docparser.api.*` operation with input and output types.

> [card] [Database](https://docs.corsair.dev/plugins/docparser/database.md)
>
> Synced entities, search filters, and operators.

> [card] [Connect / OAuth](https://docs.corsair.dev/management/connect)
>
> createLink, Hub delivery, and tenant connect flows.

> [card] [Use with agents](https://docs.corsair.dev/mcp-adapters/mcp-adapters)
>
> Expose this plugin's operations as MCP tools.


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.