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

# IdentityCheck plugin

> Start StackGo identity verifications and retrieve their results.

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

* **Paid plan.** StackGo's API and webhooks come with the Professional plan and up; trial accounts get no API access. Create the key as a user with the developer permission (Account, then Users). Keys start with `key-` and carry fixed scopes: `verification.create`, `verification.info` and `verification.image`.
* **Calls that spend credit or contact people.** `verification.create`, `sms`, `kyb` and `tranche2` each start a check paid from the plan's credit. `sms` texts the person, and `create` emails them an invitation when the body has `emailUser: "Yes"`. All four are marked destructive.
* **Open request and response bodies.** StackGo has not published field-level schemas yet, so request bodies are sent as given and results come back as plain objects. The quickstart's fields are `firstName`, `lastName`, `email`, `emailUser`, `type` (`kyc`), `triggeredBy` (`direct`) and `active`.
* **Images.** `verification.image` downloads a captured document or selfie and returns it as a file (base64 content, type and size).
* **Webhook.** StackGo sends `verification.decision` through Svix. Store the endpoint's signing secret (`whsec_…`) as the webhook signature; deliveries without a valid signature are refused.
* **No local data.** Every call returns live data from StackGo.

**What you get:**

* 6 typed API operations
* 1 incoming webhook event types

## Setup

**1. Install**

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

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

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

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

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

## Example API calls

**`verification.get`**

```ts theme={null}
const tenant = corsair.withTenant('acme');
await tenant.identitycheck.api.verification.get({});
```

**`verification.create`**

```ts theme={null}
const tenant = corsair.withTenant('acme');
await tenant.identitycheck.api.verification.create({});
```

See the full list on the [API](https://docs.corsair.dev/plugins/identitycheck/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/identitycheck/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/identitycheck/api.md)
>
> Every `identitycheck.api.*` operation with input and output types.

> [card] [Webhooks](https://docs.corsair.dev/plugins/identitycheck/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.