> ## 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.

# Paradym plugin

> Paradym is the easiest way to issue, verify, and manage verifiable credentials. This plugin manages wallets, SD-JWT VC credential templates and trusted entities, creates OpenID4VC issuance offers and verification requests, batch-revokes issued credentials, and manages webhook subscriptions with delivery history.

Use **Paradym** through Corsair: one client, typed API calls, and incoming webhooks.

Authenticate with an API key from the Paradym dashboard; the plugin sends it in the `x-access-token` header. Every wallet-scoped operation is called against the account's wallet: store the wallet id on the account (`wallet_id`) or pass `walletId` in the plugin options (create one with wallets.create, or read the id from the dashboard).
Listing wallets needs no wallet id. Issuance offers and verification sessions are created as sessions that a holder wallet completes; poll issuance.getSession or verification.getSession, or listen for the openid4vc.\* webhooks (the createSubscription response carries the signatureSecret used to verify deliveries).
This plugin covers the OpenID4VC routes of the published OpenAPI specification. The DIDComm routes, certificates and CSRs, keys and key backends, OAuth clients, attribute providers, authorization servers, mDoc and AnonCreds credential templates, mediator and messaging routes, and wallet profiles are documented by Paradym but not part of this plugin.
Every operation is described in the official OpenAPI specification: [https://api.paradym.id/openapi.json](https://api.paradym.id/openapi.json)

**What you get:**

* 33 typed API operations
* 1 incoming webhook event types

## Setup

**1. Install**

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

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

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

```bash bun theme={null}
bun add corsair @corsair-dev/paradym 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 { paradym } from '@corsair-dev/paradym';

export const corsair = createCorsair({
	plugins: [
		paradym(),
	],
	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 Paradym API key before the first call: `pnpm corsair setup --plugin=paradym --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}
> paradym()
> ```
>
> 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: 'paradym',
	tenantId: 'acme',
});
// redirect the user's browser to connectUrl
```

## Example API calls

**List issuance sessions**

```ts theme={null}
const tenant = corsair.withTenant('acme');
await tenant.paradym.api.issuance.listSessions({});
```

**Create a credential offer**

```ts theme={null}
const tenant = corsair.withTenant('acme');
await tenant.paradym.api.issuance.createOffer({
	credentials: [{
		credentialTemplateId: 'tmpl_1',
		attributes: { given_name: 'Jane' },
	}],
});
```

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

## Webhooks

This plugin registers **1** webhook event type. Configure the provider to POST to your Corsair HTTP handler, then use `webhookHooks` on the plugin factory.

See [Webhooks](https://docs.corsair.dev/plugins/paradym/webhooks.md) for every event path and payload shape, and [Webhooks concept](https://docs.corsair.dev/concepts/webhooks.md) for routing.

## What's next

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

> [card] [Webhooks](https://docs.corsair.dev/plugins/paradym/webhooks.md)
>
> Event paths, payloads, and `webhookHooks` examples.

> [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.