Overview

• Read-only. All four operations are GraphQL queries; none of them writes or deletes anything at Enigma.
• Matching, not search listings. brands.match and locations.match send the terms to Enigma’s resolver and return the single best match, or null when nothing clears the confidence bar. Narrow with address and raise matchThreshold (0.0 to 1.0) to reject weak matches.
• prompt. brands.match accepts a natural-language business description instead of name, website or phone, but it cannot be combined with any of them or with address.
• Paging. brands.get pages the brand’s operating locations with locationsFirst and the endCursor from the previous page’s pageInfo. legalEntitiesFirst sizes the legal entities list, which is not paged.
• Card revenue costs credits. cardRevenue12m is the projected 12-month card revenue Enigma reports for the brand or location, in dollars. Enigma bills it per value returned (25 credits each on its price list as of November 2026), so brands.get with the default 10 locations can use about 275 credits in one call. Set locationsFirst lower when you only need the brand’s details. brands.match returns one value.
• Rate limits. Limits are per plan, daily and monthly. Over the limit the API answers 429 with a Retry-After header; the plugin retries up to three times, honoring that header. A 402 means the account is out of credits and is not retried.
• Webhooks. Enigma does not send webhooks to this plugin.

• 4 typed API operations

​

Setup

npm install corsair @corsair-dev/enigma better-sqlite3

yarn add corsair @corsair-dev/enigma better-sqlite3

pnpm install corsair @corsair-dev/enigma better-sqlite3

bun add corsair @corsair-dev/enigma better-sqlite3

import Database from 'better-sqlite3';
import { createCorsair } from 'corsair';
import { enigma } from '@corsair-dev/enigma';

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

enigma()

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

​

Example API calls

const tenant = corsair.withTenant('acme');
await tenant.enigma.api.brands.match({
	name: 'Starbucks',
	address: { state: 'WA' },
	matchThreshold: 0.5,
});

const tenant = corsair.withTenant('acme');
await tenant.enigma.api.brands.get({ id: '5f1147ed-4d0e-4f36-a1d2-c2b3f2b1a9c4', locationsFirst: 10 });

​

What’s next