Skip to main content
O

Onfido

@codespar/mcp-onfido · v0.2.2

🌐 GlobalIdentity & KYCAuth · API Keybeta20 tools2 env vars

Global KYC leader (Entrust-owned). Applicants, document upload, live photos, checks (document + facial + watchlist + known-faces), reports. Pairs with Unico (BR-first) for global coverage when commerce touches non-LatAm users.

Get started · freeView docs

MIT · runs locally with your own credentials

Package
@codespar/mcp-onfido
Version
0.2.2
npm dist-tag
latest
Category
Identity & KYC
Auth
API Key
Country
🌐 Global
License
MIT
Transport
stdio · streamable-http

Quickstart

Install, set the credentials, make the first call.

Pick your client. The server runs locally over stdio, with your own credentials.

Add the server to your clientOne config entry. No build step, no SDK required.
Set the environment variables2 variables read by this server's code, listed below.
Restart and make the first callThe agent can call any of the 20 tools. Try create_applicant first.
terminal
# Claude Code claude mcp add onfido -e ONFIDO_API_TOKEN=… -e ONFIDO_REGION=… -- npx -y @codespar/mcp-onfido@0.2.2 # then: /mcp to confirm the server is connected
Environment variables2 variables
ONFIDO_API_TOKENOnfido API token. Sent as 'Authorization: Token token=<value>'.requiredsecret
ONFIDO_REGIONRegion for the API host: 'eu' (api.eu.onfido.com), 'us' (api.us.onfido.com), 'ca' (api.ca.onfido.com). Defaults to api.onfido.com when unset.optional

Names read from the package code (@codespar/mcp-onfido@0.2.2). Descriptions and flags come from its manifest. Self-hosted, you hold the credentials.

First call democreate_applicant

"Create an Onfido applicant — the person record that documents, live photos, and checks attach to. Required before any verification"

tools/callcreate_applicantresult returned

Tools

What your agent can call.

20 tools, as the package's tools/list returns them.

create_applicant

Create an Onfido applicant — the person record that documents, live photos, and checks attach to. Required before any verification.

retrieve_applicant

Retrieve an applicant by id.

update_applicant

Update fields on an existing applicant. Send only the fields you want to change.

upload_document

Upload an identity document image for an applicant. Sent as multipart/form-data. Pass file as base64-encoded bytes plus file_name and content_type (image/jpeg, image/png, application/pdf).

retrieve_document

Retrieve document metadata by id.

upload_live_photo

Upload a live photo (selfie) for an applicant, used by facial_similarity_photo reports. Sent as multipart/form-data. NOTE: Onfido recommends capturing live photos via their SDK; direct API upload may be restricted on some accounts.

retrieve_live_photo

Retrieve a live photo record by id.

create_check

Run a verification check on an applicant. A check is a bundle of one or more reports (document, facial_similarity_photo, watchlist, etc). This is the step that actually triggers the verification.

retrieve_check

Retrieve a check by id. Returns the overall status ('in_progress' | 'awaiting_applicant' | 'complete' | 'withdrawn' | 'paused' | 'reopened'), result ('clear' | 'consider'), and ids of contained reports — poll this to track progress.

list_checks

List all checks for a given applicant.

retrieve_report

Retrieve an individual report by id. A report is one verification component of a check (e.g. the document report, the facial_similarity report). Contains the detailed breakdown of sub-checks.

delete_applicant

Soft-delete an applicant. Onfido retains the record for 30 days before permanent deletion; during that window it can be restored via the dashboard.

Names and descriptions come from the package's tools/list (@codespar/mcp-onfido@0.2.2). A kind (read, write, delete) is shown only when the package annotates its tools or each tool was verified one by one; neither exists for this server yet.

Compatibility

MCP is a protocol. Any client that speaks it can mount this server.

The CodeSpar runtime does not route this server. Mount it in your client over stdio · streamable-http.

Protocol

Any MCP client

stdio · streamable-http

Questions

Before you install.

How do I install the Onfido MCP server?

Run npx -y @codespar/mcp-onfido@0.2.2 and add the config block above to your MCP client: Claude Code, Cursor, Claude Desktop, VS Code, or any MCP-compatible client. No build step, no SDK required.

What can my agent do with Onfido?

Onfido exposes 20 tools for identity & kyc. Your agent calls them directly; the full list is above.

How does Onfido authenticate, and how are credentials stored?

Onfido uses API Key. Self-hosted, you hold the credentials: the server reads them from its environment variables.

How does Onfido handle upstream API changes?

Every server is versioned independently on npm. The command on this page pins 0.2.2, the version whose tools are listed here; your agent keeps running it until you change the version.

Is Onfido open source? How do I report a bug?

Yes. Onfido is MIT-licensed and published on npm as @codespar/mcp-onfido, source on GitHub (link in the Details panel). Report issues on the package repository; security issues go to security@codespar.dev, and we respond within 24 hours.

Pairs well with

Identity & KYC · same category.

Start in seconds.

Add the config above, set the variables, and your agent calls the tools.

Start in seconds demo
Add the server to your client with the config above.
Set the environment variables listed above.
Ask your agent for the first call.
Onfido — MCP server · 20 tools | CodeSpar