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

# Interzoid plugin

> Data matching, entity resolution, data quality, validation, enrichment, and normalization cloud APIs.

Use **Interzoid** through Corsair: one client, typed API calls.

Interzoid provides AI and algorithmic data matching keys (SimKeys), standardization, enrichment, and validation APIs.
An Interzoid API key (license) is required for authenticated operations.
Every API call consumes credits: standard calls generally cost one credit, while premium APIs and selected AI models can cost multiple credits. Review Interzoid's pricing and model-credit documentation before choosing paid operations.

**What you get:**

* 75 typed API operations

## Setup

**1. Install**

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

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

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

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

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

## Example API calls

**Generate company match similarity key**

```ts theme={null}
const tenant = corsair.withTenant('acme');
await tenant.interzoid.api.matching.getCompanyMatchAdvanced({ company: 'IBM Corporation', algorithm: 'model-v4-wide' });
```

**Standardize a company name (Interzoid has no writes; every operation is a lookup)**

```ts theme={null}
const tenant = corsair.withTenant('acme');
await tenant.interzoid.api.standardization.getOrgStandard({ org: 'ibm inc' });
```

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

## What's next

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

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