@didit-protocol/mcp-server 3.0.0 → 3.0.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (2) hide show
  1. package/README.md +186 -0
  2. package/package.json +1 -1
package/README.md ADDED
@@ -0,0 +1,186 @@
1
+ # Didit MCP Server
2
+
3
+ The official [Model Context Protocol](https://modelcontextprotocol.io/) server for [Didit](https://www.didit.me) identity verification. Connect AI coding agents to the full Didit platform — register accounts, verify identities, manage workflows, screen against watchlists, and more — all through natural language.
4
+
5
+ **47 tools** covering every public Didit API.
6
+
7
+ ## Quick Start
8
+
9
+ Add to your MCP client config:
10
+
11
+ **Cursor** (`.cursor/mcp.json`):
12
+ ```json
13
+ {
14
+ "mcpServers": {
15
+ "didit": {
16
+ "command": "npx",
17
+ "args": ["@didit-protocol/mcp-server"],
18
+ "env": {
19
+ "DIDIT_API_KEY": "your_api_key_here"
20
+ }
21
+ }
22
+ }
23
+ }
24
+ ```
25
+
26
+ **Claude Desktop** (`claude_desktop_config.json`):
27
+ ```json
28
+ {
29
+ "mcpServers": {
30
+ "didit": {
31
+ "command": "npx",
32
+ "args": ["@didit-protocol/mcp-server"],
33
+ "env": {
34
+ "DIDIT_API_KEY": "your_api_key_here"
35
+ }
36
+ }
37
+ }
38
+ }
39
+ ```
40
+
41
+ Works with **Cursor, Claude Code, GitHub Copilot, Windsurf, Devin, OpenHands, Codex**, and any MCP-compatible agent.
42
+
43
+ ## No API Key Yet?
44
+
45
+ The agent can register for you — no browser needed:
46
+
47
+ 1. Ask the agent: *"Register me a Didit account with dev@company.com"*
48
+ 2. Agent calls `didit_register` → you get a 6-character code via email
49
+ 3. Tell the agent the code → it calls `didit_verify_email`
50
+ 4. Response includes your `api_key` — add it to the MCP config
51
+
52
+ Two API calls, zero friction. See [Programmatic Registration](https://docs.didit.me/integration/programmatic-registration) for details.
53
+
54
+ ## Available Tools
55
+
56
+ ### Auth
57
+
58
+ | Tool | Description |
59
+ |------|-------------|
60
+ | `didit_register` | Register a new account (sends verification code to email) |
61
+ | `didit_verify_email` | Verify email with 6-char code → get `api_key` and credentials |
62
+ | `didit_login` | Login to existing account → get access token |
63
+ | `didit_list_organizations` | List organizations you belong to |
64
+ | `didit_get_application` | Get application details (client_id, api_key) |
65
+
66
+ ### Sessions
67
+
68
+ | Tool | Description |
69
+ |------|-------------|
70
+ | `didit_create_session` | Create a verification session → returns session URL |
71
+ | `didit_list_sessions` | List sessions with status, vendor_data, and pagination filters |
72
+ | `didit_get_session_decision` | Get full verification decision and extracted data |
73
+ | `didit_update_session_status` | Approve, decline, or request resubmission |
74
+ | `didit_delete_session` | Delete a single session and all associated data |
75
+ | `didit_batch_delete_sessions` | Delete multiple sessions by number, or delete all |
76
+ | `didit_generate_session_pdf` | Generate a PDF verification report |
77
+ | `didit_list_session_reviews` | List review history and activity log |
78
+ | `didit_add_session_review` | Add a review note or status change |
79
+ | `didit_share_session` | Share a verified session with a partner (Reusable KYC) |
80
+ | `didit_import_shared_session` | Import a shared session from a partner |
81
+
82
+ ### Workflows
83
+
84
+ | Tool | Description |
85
+ |------|-------------|
86
+ | `didit_list_workflows` | List all verification workflows |
87
+ | `didit_create_workflow` | Create a workflow (ID scan, liveness, face match, AML, etc.) |
88
+ | `didit_get_workflow` | Get full workflow configuration |
89
+ | `didit_update_workflow` | Update feature toggles, thresholds, accepted documents |
90
+ | `didit_delete_workflow` | Delete a workflow |
91
+
92
+ ### Questionnaires
93
+
94
+ | Tool | Description |
95
+ |------|-------------|
96
+ | `didit_list_questionnaires` | List custom questionnaires |
97
+ | `didit_create_questionnaire` | Create with questions, branching logic, multi-language |
98
+ | `didit_get_questionnaire` | Get full questionnaire details |
99
+ | `didit_update_questionnaire` | Update questions, options, or translations |
100
+ | `didit_delete_questionnaire` | Delete a questionnaire |
101
+
102
+ ### Users
103
+
104
+ | Tool | Description |
105
+ |------|-------------|
106
+ | `didit_list_users` | List verified users with status filtering |
107
+ | `didit_get_user` | Get user details by vendor_data identifier |
108
+ | `didit_update_user` | Update user metadata or tags |
109
+ | `didit_delete_users` | Batch delete users by vendor_data list |
110
+
111
+ ### Billing
112
+
113
+ | Tool | Description |
114
+ |------|-------------|
115
+ | `didit_get_balance` | Check credit balance and auto-refill settings |
116
+ | `didit_top_up` | Create a Stripe checkout to add credits (min $50) |
117
+
118
+ ### Blocklist
119
+
120
+ | Tool | Description |
121
+ |------|-------------|
122
+ | `didit_list_blocklist` | List blocked faces, documents, phones, and emails |
123
+ | `didit_add_to_blocklist` | Block items from a session (face, document, phone, email) |
124
+ | `didit_remove_from_blocklist` | Unblock items from a session |
125
+
126
+ ### Standalone APIs
127
+
128
+ Run verification checks directly without creating a session.
129
+
130
+ | Tool | Description |
131
+ |------|-------------|
132
+ | `didit_id_verification` | Verify identity documents — OCR extraction + authenticity |
133
+ | `didit_poa_verification` | Proof of address — extract and validate address data |
134
+ | `didit_database_validation` | Validate identity against national/global databases |
135
+ | `didit_passive_liveness` | Detect if a person is physically present (single image) |
136
+ | `didit_face_match` | Compare two faces — 1:1 matching |
137
+ | `didit_face_search` | Search face against verified database — 1:N matching |
138
+ | `didit_age_estimation` | Estimate age from facial image |
139
+ | `didit_aml_screening` | Screen against AML, sanctions, and PEP watchlists |
140
+ | `didit_email_send` | Send email verification OTP |
141
+ | `didit_email_check` | Verify email OTP code |
142
+ | `didit_phone_send` | Send phone verification OTP via SMS |
143
+ | `didit_phone_check` | Verify phone OTP code |
144
+
145
+ ## Example Conversation
146
+
147
+ > **You:** Set up identity verification for my app with ID scan and liveness
148
+ >
149
+ > **Agent:** I'll create a workflow for you.
150
+ > *calls `didit_create_workflow`* with `is_ocr_enabled: true, is_liveness_enabled: true`
151
+ >
152
+ > Done! Workflow "Standard KYC" is ready with ID document scanning and liveness detection.
153
+ > To create a verification session:
154
+ > ```bash
155
+ > curl -X POST https://verification.didit.me/v3/session/ \
156
+ > -H "x-api-key: YOUR_API_KEY"
157
+ > ```
158
+
159
+ > **You:** Check my credit balance and list recent sessions
160
+ >
161
+ > **Agent:** *calls `didit_get_balance`* → 4,250 credits remaining
162
+ > *calls `didit_list_sessions`* → 12 sessions (8 Approved, 2 Pending, 2 Declined)
163
+
164
+ > **You:** Screen "John Smith" born 1985-03-15 against AML watchlists
165
+ >
166
+ > **Agent:** *calls `didit_aml_screening`* with `full_name: "John Smith", date_of_birth: "1985-03-15"`
167
+ > → No matches found. Clean result.
168
+
169
+ ## Environment Variables
170
+
171
+ | Variable | Required | Description |
172
+ |----------|----------|-------------|
173
+ | `DIDIT_API_KEY` | Yes | Your Didit API key (from verify-email response or console) |
174
+ | `DIDIT_API_BASE_URL` | No | Override verification API URL (default: `https://verification.didit.me/v3`) |
175
+ | `DIDIT_AUTH_BASE_URL` | No | Override auth API URL (default: `https://apx.didit.me/auth/v2`) |
176
+
177
+ ## Documentation
178
+
179
+ - [AI Agent Integration Guide](https://docs.didit.me/integration/ai-agent-integration)
180
+ - [Programmatic Registration](https://docs.didit.me/integration/programmatic-registration)
181
+ - [API Reference](https://docs.didit.me)
182
+ - [Didit Console](https://console.didit.me)
183
+
184
+ ## License
185
+
186
+ MIT
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@didit-protocol/mcp-server",
3
- "version": "3.0.0",
3
+ "version": "3.0.1",
4
4
  "description": "Didit MCP Server - AI agent integration for identity verification APIs",
5
5
  "main": "dist/index.js",
6
6
  "bin": {