@didit-protocol/mcp-server 4.0.0 → 5.1.34
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.
- package/LICENSE +21 -0
- package/README.md +583 -227
- package/dist/audit-log.d.ts +22 -0
- package/dist/audit-log.d.ts.map +1 -0
- package/dist/audit-log.js +77 -0
- package/dist/audit-log.js.map +1 -0
- package/dist/auth/introspection-verifier.d.ts +16 -0
- package/dist/auth/introspection-verifier.d.ts.map +1 -0
- package/dist/auth/introspection-verifier.js +77 -0
- package/dist/auth/introspection-verifier.js.map +1 -0
- package/dist/auth/verifier.d.ts +19 -0
- package/dist/auth/verifier.d.ts.map +1 -0
- package/dist/auth/verifier.js +88 -0
- package/dist/auth/verifier.js.map +1 -0
- package/dist/blank-args.d.ts +10 -0
- package/dist/blank-args.d.ts.map +1 -0
- package/dist/blank-args.js +34 -0
- package/dist/blank-args.js.map +1 -0
- package/dist/chatgpt-app.d.ts +44 -0
- package/dist/chatgpt-app.d.ts.map +1 -0
- package/dist/chatgpt-app.js +52 -0
- package/dist/chatgpt-app.js.map +1 -0
- package/dist/config.d.ts +93 -5
- package/dist/config.d.ts.map +1 -1
- package/dist/config.js +198 -27
- package/dist/config.js.map +1 -1
- package/dist/dates.d.ts +2 -0
- package/dist/dates.d.ts.map +1 -0
- package/dist/dates.js +23 -0
- package/dist/dates.js.map +1 -0
- package/dist/feature-config-schema.d.ts +66 -0
- package/dist/feature-config-schema.d.ts.map +1 -0
- package/dist/feature-config-schema.js +192 -0
- package/dist/feature-config-schema.js.map +1 -0
- package/dist/http.d.ts +4 -0
- package/dist/http.d.ts.map +1 -0
- package/dist/http.js +230 -0
- package/dist/http.js.map +1 -0
- package/dist/index.d.ts +20 -1
- package/dist/index.d.ts.map +1 -1
- package/dist/index.js +2397 -510
- package/dist/index.js.map +1 -1
- package/dist/internal-tools.d.ts +17 -0
- package/dist/internal-tools.d.ts.map +1 -0
- package/dist/internal-tools.js +26 -0
- package/dist/internal-tools.js.map +1 -0
- package/dist/mcp-modern.d.ts +36 -0
- package/dist/mcp-modern.d.ts.map +1 -0
- package/dist/mcp-modern.js +152 -0
- package/dist/mcp-modern.js.map +1 -0
- package/dist/orgapp.d.ts +34 -0
- package/dist/orgapp.d.ts.map +1 -0
- package/dist/orgapp.js +93 -0
- package/dist/orgapp.js.map +1 -0
- package/dist/permissions.d.ts +24 -0
- package/dist/permissions.d.ts.map +1 -0
- package/dist/permissions.js +210 -0
- package/dist/permissions.js.map +1 -0
- package/dist/privileged-tools.d.ts +14 -0
- package/dist/privileged-tools.d.ts.map +1 -0
- package/dist/privileged-tools.js +21 -0
- package/dist/privileged-tools.js.map +1 -0
- package/dist/schema/feature-config-schema.json +4446 -0
- package/dist/security.d.ts +168 -0
- package/dist/security.d.ts.map +1 -0
- package/dist/security.js +858 -0
- package/dist/security.js.map +1 -0
- package/dist/session-pdf-download.d.ts +8 -0
- package/dist/session-pdf-download.d.ts.map +1 -0
- package/dist/session-pdf-download.js +91 -0
- package/dist/session-pdf-download.js.map +1 -0
- package/dist/tools/analytics.d.ts +13 -0
- package/dist/tools/analytics.d.ts.map +1 -0
- package/dist/tools/analytics.js +171 -0
- package/dist/tools/analytics.js.map +1 -0
- package/dist/tools/auth.d.ts +10 -3
- package/dist/tools/auth.d.ts.map +1 -1
- package/dist/tools/auth.js +68 -11
- package/dist/tools/auth.js.map +1 -1
- package/dist/tools/billing.d.ts +2 -2
- package/dist/tools/billing.d.ts.map +1 -1
- package/dist/tools/billing.js +37 -4
- package/dist/tools/billing.js.map +1 -1
- package/dist/tools/blocklist.d.ts +5 -0
- package/dist/tools/blocklist.d.ts.map +1 -0
- package/dist/tools/blocklist.js +21 -0
- package/dist/tools/blocklist.js.map +1 -0
- package/dist/tools/businesses.d.ts +1 -1
- package/dist/tools/businesses.d.ts.map +1 -1
- package/dist/tools/businesses.js +31 -9
- package/dist/tools/businesses.js.map +1 -1
- package/dist/tools/cases.d.ts +6 -0
- package/dist/tools/cases.d.ts.map +1 -0
- package/dist/tools/cases.js +63 -0
- package/dist/tools/cases.js.map +1 -0
- package/dist/tools/compliance.d.ts +8 -0
- package/dist/tools/compliance.d.ts.map +1 -0
- package/dist/tools/compliance.js +95 -0
- package/dist/tools/compliance.js.map +1 -0
- package/dist/tools/context.d.ts +2 -0
- package/dist/tools/context.d.ts.map +1 -0
- package/dist/tools/context.js +37 -0
- package/dist/tools/context.js.map +1 -0
- package/dist/tools/customization.d.ts +10 -4
- package/dist/tools/customization.d.ts.map +1 -1
- package/dist/tools/customization.js +21 -11
- package/dist/tools/customization.js.map +1 -1
- package/dist/tools/feature-config.d.ts +53 -0
- package/dist/tools/feature-config.d.ts.map +1 -0
- package/dist/tools/feature-config.js +432 -0
- package/dist/tools/feature-config.js.map +1 -0
- package/dist/tools/lists.d.ts.map +1 -1
- package/dist/tools/lists.js +17 -16
- package/dist/tools/lists.js.map +1 -1
- package/dist/tools/members.d.ts +7 -0
- package/dist/tools/members.d.ts.map +1 -0
- package/dist/tools/members.js +60 -0
- package/dist/tools/members.js.map +1 -0
- package/dist/tools/observability.d.ts +4 -0
- package/dist/tools/observability.d.ts.map +1 -0
- package/dist/tools/observability.js +17 -0
- package/dist/tools/observability.js.map +1 -0
- package/dist/tools/questionnaires.d.ts +62 -3
- package/dist/tools/questionnaires.d.ts.map +1 -1
- package/dist/tools/questionnaires.js +131 -6
- package/dist/tools/questionnaires.js.map +1 -1
- package/dist/tools/reports.d.ts +5 -0
- package/dist/tools/reports.d.ts.map +1 -0
- package/dist/tools/reports.js +89 -0
- package/dist/tools/reports.js.map +1 -0
- package/dist/tools/search.d.ts +30 -0
- package/dist/tools/search.d.ts.map +1 -0
- package/dist/tools/search.js +317 -0
- package/dist/tools/search.js.map +1 -0
- package/dist/tools/session-explain-levers.d.ts +17 -0
- package/dist/tools/session-explain-levers.d.ts.map +1 -0
- package/dist/tools/session-explain-levers.js +139 -0
- package/dist/tools/session-explain-levers.js.map +1 -0
- package/dist/tools/session-explain.d.ts +3 -0
- package/dist/tools/session-explain.d.ts.map +1 -0
- package/dist/tools/session-explain.js +180 -0
- package/dist/tools/session-explain.js.map +1 -0
- package/dist/tools/sessions.d.ts +9 -2
- package/dist/tools/sessions.d.ts.map +1 -1
- package/dist/tools/sessions.js +131 -22
- package/dist/tools/sessions.js.map +1 -1
- package/dist/tools/settings.d.ts +15 -1
- package/dist/tools/settings.d.ts.map +1 -1
- package/dist/tools/settings.js +143 -6
- package/dist/tools/settings.js.map +1 -1
- package/dist/tools/standalone.d.ts +7 -6
- package/dist/tools/standalone.d.ts.map +1 -1
- package/dist/tools/standalone.js +41 -26
- package/dist/tools/standalone.js.map +1 -1
- package/dist/tools/transactions.d.ts +9 -0
- package/dist/tools/transactions.d.ts.map +1 -1
- package/dist/tools/transactions.js +77 -4
- package/dist/tools/transactions.js.map +1 -1
- package/dist/tools/users.d.ts +1 -1
- package/dist/tools/users.d.ts.map +1 -1
- package/dist/tools/users.js +30 -9
- package/dist/tools/users.js.map +1 -1
- package/dist/tools/webhooks.d.ts.map +1 -1
- package/dist/tools/webhooks.js +22 -5
- package/dist/tools/webhooks.js.map +1 -1
- package/dist/tools/workflow-graph.d.ts +65 -0
- package/dist/tools/workflow-graph.d.ts.map +1 -0
- package/dist/tools/workflow-graph.js +686 -0
- package/dist/tools/workflow-graph.js.map +1 -0
- package/package.json +23 -6
package/README.md
CHANGED
|
@@ -1,242 +1,598 @@
|
|
|
1
1
|
# Didit MCP Server
|
|
2
2
|
|
|
3
|
-
The official [Model Context Protocol](https://modelcontextprotocol.io
|
|
3
|
+
The official [Model Context Protocol](https://modelcontextprotocol.io) server for [Didit](https://didit.me) — bring KYC, KYB, AML screening, transaction monitoring, biometrics, and full workspace operations to Claude, Cursor, VS Code, Windsurf, Zed, and any MCP client.
|
|
4
4
|
|
|
5
|
-
**
|
|
5
|
+
- **140+ tools** across sessions, workflows, vendor users/businesses, transactions, networks, the standalone verification APIs, lists, cases, reports, webhooks, and billing.
|
|
6
|
+
- **Auth is "Log in with Didit" (OAuth 2.1 + PKCE)** — the MCP acts as the signed-in **user** with their role's permissions. There is **no API-key mode**: every tool calls the user-scoped console endpoints, which only accept a Bearer token.
|
|
7
|
+
- Tools call Didit REST endpoints. Session PDF generation returns a temporary download URL for the original PDF.
|
|
6
8
|
|
|
7
|
-
|
|
9
|
+
> Full documentation: **https://docs.didit.me/integration/mcp/overview**
|
|
8
10
|
|
|
9
|
-
|
|
11
|
+
## Session PDF downloads
|
|
12
|
+
|
|
13
|
+
`didit_session_generate_pdf` returns `download_url`, `expires_at` (UTC), and
|
|
14
|
+
`expires_in` (300 seconds). Fetch the URL without an Authorization header to save
|
|
15
|
+
the original Didit PDF. The server checks PDF access before issuing the link and
|
|
16
|
+
fetches the original report again at download time using the same user and organization.
|
|
17
|
+
It does not reconstruct the report from session data. If the session changes between
|
|
18
|
+
issuance and download, the download reflects the current report. Revoked or expired
|
|
19
|
+
user access can invalidate a link before its five-minute expiry.
|
|
20
|
+
|
|
21
|
+
Deployments must set `MCP_PDF_DOWNLOAD_KEY` to 32 cryptographically random bytes
|
|
22
|
+
encoded as 64 hexadecimal characters, shared across all replicas, and set
|
|
23
|
+
`MCP_RESOURCE_URI` to the public HTTPS MCP endpoint. Route
|
|
24
|
+
`/downloads/session-report.pdf` to this HTTP server. The authenticated-encryption
|
|
25
|
+
key protects the credentials embedded in the session-scoped link; rotating it
|
|
26
|
+
invalidates outstanding links. Treat links as secrets and redact the `token` query
|
|
27
|
+
parameter in proxy/access logs. Responses use `Cache-Control: no-store`.
|
|
28
|
+
|
|
29
|
+
Stdio deployments need a reachable HTTP deployment with the same key, API base URL,
|
|
30
|
+
and `MCP_RESOURCE_URI`; stdio alone cannot serve download links. Missing key
|
|
31
|
+
configuration produces an actionable tool error instead of inline PDF data.
|
|
32
|
+
|
|
33
|
+
## Quick start
|
|
34
|
+
|
|
35
|
+
### Hosted (recommended)
|
|
36
|
+
|
|
37
|
+
No install, no API key — point your client at the hosted URL and sign in via the browser:
|
|
38
|
+
|
|
39
|
+
```
|
|
40
|
+
https://mcp.didit.me/mcp
|
|
41
|
+
```
|
|
42
|
+
|
|
43
|
+
**Claude Code**
|
|
44
|
+
|
|
45
|
+
```bash
|
|
46
|
+
claude mcp add --transport http didit https://mcp.didit.me/mcp
|
|
47
|
+
```
|
|
48
|
+
|
|
49
|
+
**Cursor** (`~/.cursor/mcp.json`)
|
|
10
50
|
|
|
11
|
-
**Cursor** (`.cursor/mcp.json`):
|
|
12
51
|
```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
|
-
}
|
|
52
|
+
{ "mcpServers": { "didit": { "url": "https://mcp.didit.me/mcp" } } }
|
|
24
53
|
```
|
|
25
54
|
|
|
26
|
-
**
|
|
55
|
+
**Windsurf / Zed** (via the `mcp-remote` bridge)
|
|
56
|
+
|
|
27
57
|
```json
|
|
28
|
-
{
|
|
29
|
-
|
|
30
|
-
|
|
31
|
-
|
|
32
|
-
|
|
33
|
-
|
|
34
|
-
|
|
35
|
-
|
|
36
|
-
|
|
37
|
-
|
|
38
|
-
|
|
58
|
+
{ "mcpServers": { "didit": { "command": "npx", "args": ["-y", "mcp-remote@latest", "https://mcp.didit.me/mcp"] } } }
|
|
59
|
+
```
|
|
60
|
+
|
|
61
|
+
See [per-client setup](https://docs.didit.me/integration/mcp/installation) for Claude Desktop and VS Code.
|
|
62
|
+
|
|
63
|
+
## Authentication
|
|
64
|
+
|
|
65
|
+
The MCP is an OAuth 2.1 **resource server**; the Didit console (`business.didit.me`) is the **authorization server**. On first connect your client opens a browser, you **Log in with Didit** and approve the scopes, and the MCP then acts as **you** — across every organization you belong to, with your role's permissions. Tokens are short-lived and refreshed automatically.
|
|
66
|
+
|
|
67
|
+
Scopes: `didit:management` (workspace operations), `didit:verification` (running checks) and `didit:staff` (Didit staff accounts only; the authorization server never issues it to anyone else). Your console **role** is enforced server-side on every call.
|
|
68
|
+
|
|
69
|
+
> **There is no API-key mode.** Every tool targets the user-scoped console endpoints (`/organization/{org}/application/{app}/…`), which authorize a Bearer token with per-role privileges and reject `x-api-key`. (For raw REST access with an application API key — e.g. creating sessions from your backend — use the [REST API](https://docs.didit.me) directly, not this server.)
|
|
70
|
+
|
|
71
|
+
See [Authentication](https://docs.didit.me/integration/mcp/authentication).
|
|
72
|
+
|
|
73
|
+
## Tools
|
|
74
|
+
|
|
75
|
+
140+ tools, grouped by area. The full catalogue with read/write/destructive markers is in [`docs/TOOLS.md`](docs/TOOLS.md) and at [docs.didit.me](https://docs.didit.me/integration/mcp/tools). Highlights:
|
|
76
|
+
|
|
77
|
+
- **Discovery & cross-app:** `didit_context_get`, `didit_session_search`, `didit_transaction_search`, `didit_vendor_user_search`, `didit_analytics` — aggregate across every org/app in one call.
|
|
78
|
+
- **Sessions:** create, list, get decision, update status, reviews, bulk import, webhook delivery log + resend (`didit_session_webhooks` waits for a sandbox session's webhook so an integration can be verified end to end).
|
|
79
|
+
- **Verification APIs:** `didit_verify_id`, `didit_verify_aml`, `didit_verify_face_match`, `didit_verify_kyb_search`, …
|
|
80
|
+
- **Workflows (incl. branching graphs):** `didit_workflow_search`, `didit_workflow_get_graph`, `didit_workflow_edit_graph` — build conditional/branching workflows (fuzzy-match conditions, Document-AI steps) by sending small ops; large feature configs are kept server-side, never resent. `didit_workflow_get_id_verification_methods_catalog` and `didit_workflow_get_kyb_registry_catalog` answer the server-driven questions a config write depends on (which countries offer non-doc lookup / wallets, which KYB data tiers and monitoring a country's registries sell).
|
|
81
|
+
- **Compliance:** transaction monitoring, custom and preset rule management with backtesting, lists/blocklist/allowlist, cases, reports, audit logs, alerts.
|
|
82
|
+
- **Workspace:** questionnaires, webhooks, members, billing, branding.
|
|
83
|
+
|
|
84
|
+
### File inputs
|
|
85
|
+
|
|
86
|
+
Tools that consume files (face upload, ID/PoA/liveness/face/age verification, branding) accept the file in one of two forms:
|
|
87
|
+
|
|
88
|
+
- **`*_path`** — an absolute path on the machine running the MCP server. Only works for local/stdio runs (e.g. Claude Code with a local server), where your files and the server share a filesystem.
|
|
89
|
+
- **`*_base64`** — the file content inline, as raw base64 or a `data:` URL. Use this against the hosted endpoint; it is how the Didit Console Copilot passes chat attachments (its agent resolves attachment references like `att_1` into base64 before the call reaches the MCP).
|
|
90
|
+
|
|
91
|
+
Both forms enforce the same 15MB cap and magic-bytes allow-list (png/jpg/jpeg/webp/gif/bmp/ico/pdf). The hosted transport's JSON body limit is 25MB (`MCP_JSON_BODY_LIMIT`).
|
|
92
|
+
|
|
93
|
+
## Run it yourself
|
|
94
|
+
|
|
95
|
+
The hosted server above is the easy path — no install. To self-host, clone this repo and run it with **Docker** or Node. It authenticates the user the same way (OAuth, or a user Bearer token for headless runs); there is no API-key mode.
|
|
96
|
+
|
|
97
|
+
```bash
|
|
98
|
+
git clone https://github.com/didit-protocol/mcp.git && cd mcp
|
|
99
|
+
|
|
100
|
+
# Docker (recommended) — serves /mcp and /healthz on port 3000
|
|
101
|
+
docker build -t didit-mcp . && docker run -p 3000:3000 --env-file .env didit-mcp
|
|
102
|
+
|
|
103
|
+
# …or with Node
|
|
104
|
+
npm install && npm run build
|
|
105
|
+
node dist/http.js # hosted HTTP/OAuth
|
|
106
|
+
DIDIT_ACCESS_TOKEN=<user-access-token> node dist/index.js # stdio (headless)
|
|
39
107
|
```
|
|
40
108
|
|
|
41
|
-
|
|
42
|
-
|
|
43
|
-
##
|
|
44
|
-
|
|
45
|
-
|
|
46
|
-
|
|
47
|
-
|
|
48
|
-
|
|
49
|
-
|
|
50
|
-
|
|
51
|
-
|
|
52
|
-
|
|
53
|
-
|
|
54
|
-
|
|
55
|
-
|
|
56
|
-
###
|
|
57
|
-
|
|
58
|
-
|
|
59
|
-
|
|
60
|
-
|
|
|
61
|
-
|
|
|
62
|
-
| `
|
|
63
|
-
| `
|
|
64
|
-
| `
|
|
65
|
-
| `
|
|
66
|
-
| `
|
|
67
|
-
|
|
68
|
-
|
|
69
|
-
|
|
70
|
-
|
|
|
71
|
-
|
|
72
|
-
| `
|
|
73
|
-
| `
|
|
74
|
-
| `
|
|
75
|
-
| `
|
|
76
|
-
| `
|
|
77
|
-
| `
|
|
78
|
-
| `
|
|
79
|
-
| `
|
|
80
|
-
| `
|
|
81
|
-
| `
|
|
82
|
-
| `
|
|
83
|
-
| `
|
|
84
|
-
| `
|
|
85
|
-
|
|
86
|
-
|
|
87
|
-
|
|
88
|
-
|
|
|
89
|
-
|
|
90
|
-
| `
|
|
91
|
-
|
|
92
|
-
|
|
93
|
-
|
|
94
|
-
|
|
95
|
-
|
|
96
|
-
|
|
97
|
-
|
|
|
98
|
-
|
|
99
|
-
| `
|
|
100
|
-
| `
|
|
101
|
-
| `
|
|
102
|
-
| `
|
|
103
|
-
| `
|
|
104
|
-
|
|
105
|
-
|
|
106
|
-
|
|
107
|
-
|
|
|
108
|
-
|
|
109
|
-
| `
|
|
110
|
-
| `
|
|
111
|
-
| `
|
|
112
|
-
| `
|
|
113
|
-
| `
|
|
114
|
-
|
|
115
|
-
|
|
116
|
-
|
|
117
|
-
|
|
|
118
|
-
|
|
119
|
-
| `
|
|
120
|
-
|
|
121
|
-
|
|
122
|
-
|
|
123
|
-
|
|
124
|
-
|
|
125
|
-
|
|
126
|
-
|
|
127
|
-
|
|
128
|
-
|
|
|
129
|
-
|
|
130
|
-
| `
|
|
131
|
-
| `
|
|
132
|
-
| `
|
|
133
|
-
| `
|
|
134
|
-
| `
|
|
135
|
-
| `
|
|
136
|
-
|
|
137
|
-
|
|
138
|
-
|
|
139
|
-
|
|
|
140
|
-
|
|
141
|
-
| `
|
|
142
|
-
| `
|
|
143
|
-
| `
|
|
144
|
-
| `
|
|
145
|
-
|
|
146
|
-
|
|
147
|
-
|
|
148
|
-
|
|
|
149
|
-
|
|
150
|
-
| `
|
|
151
|
-
| `
|
|
152
|
-
|
|
153
|
-
|
|
154
|
-
|
|
155
|
-
|
|
|
156
|
-
|
|
157
|
-
| `
|
|
158
|
-
| `
|
|
159
|
-
|
|
160
|
-
|
|
161
|
-
|
|
162
|
-
|
|
|
163
|
-
|
|
164
|
-
| `
|
|
165
|
-
| `
|
|
166
|
-
|
|
167
|
-
|
|
168
|
-
|
|
169
|
-
|
|
170
|
-
|
|
171
|
-
|
|
172
|
-
|
|
|
173
|
-
|
|
174
|
-
| `
|
|
175
|
-
| `
|
|
176
|
-
| `
|
|
177
|
-
| `
|
|
178
|
-
| `
|
|
179
|
-
| `
|
|
180
|
-
|
|
181
|
-
|
|
182
|
-
|
|
183
|
-
|
|
184
|
-
|
|
185
|
-
|
|
186
|
-
|
|
187
|
-
|
|
188
|
-
|
|
|
189
|
-
|
|
190
|
-
| `
|
|
191
|
-
| `
|
|
192
|
-
| `
|
|
193
|
-
| `
|
|
194
|
-
| `
|
|
195
|
-
| `
|
|
196
|
-
| `
|
|
197
|
-
| `
|
|
198
|
-
|
|
199
|
-
|
|
200
|
-
|
|
201
|
-
|
|
202
|
-
|
|
203
|
-
|
|
|
204
|
-
|
|
205
|
-
|
|
206
|
-
|
|
207
|
-
|
|
208
|
-
|
|
209
|
-
|
|
210
|
-
|
|
211
|
-
|
|
212
|
-
|
|
213
|
-
|
|
214
|
-
|
|
215
|
-
|
|
216
|
-
|
|
217
|
-
|
|
218
|
-
|
|
219
|
-
|
|
220
|
-
|
|
221
|
-
|
|
222
|
-
|
|
223
|
-
|
|
224
|
-
|
|
225
|
-
|
|
226
|
-
|
|
227
|
-
|
|
|
228
|
-
|
|
229
|
-
| `
|
|
230
|
-
| `
|
|
231
|
-
| `
|
|
232
|
-
|
|
233
|
-
|
|
234
|
-
|
|
235
|
-
|
|
236
|
-
|
|
237
|
-
|
|
238
|
-
|
|
109
|
+
All Didit base URLs and OAuth endpoints are environment variables with public defaults (`verification.didit.me`, `apx.didit.me`, `business.didit.me`) — override them for a private deployment. See [`ARCHITECTURE.md`](ARCHITECTURE.md) and [`.env.example`](.env.example) for the full reference.
|
|
110
|
+
|
|
111
|
+
## Workflow feature configuration
|
|
112
|
+
|
|
113
|
+
Every workflow feature node takes a `config` object. The tables below are the complete
|
|
114
|
+
contract - what `didit_workflow_create`, `didit_workflow_update`, `didit_workflow_validate_graph`,
|
|
115
|
+
`didit_workflow_set_graph` and `didit_workflow_edit_graph` accept, and what the API stores.
|
|
116
|
+
A key that is not listed here is not part of the contract and is dropped silently on save.
|
|
117
|
+
|
|
118
|
+
`didit_workflow_get_feature_config_schema` returns the same data as JSON at runtime.
|
|
119
|
+
|
|
120
|
+
<!-- BEGIN GENERATED FEATURE CONFIG REFERENCE -->
|
|
121
|
+
|
|
122
|
+
_Generated from `schema/feature-config-schema.json` (contract `sha256:a2c413a50107faf3ea47fa187089a930ac17d3d04893e24176f494a58470e982`, schema version 1), which is a copy of the artifact `service-didit-verification` generates from its feature-config serializers. Do not edit by hand — run `npm run schema:readme`._
|
|
123
|
+
|
|
124
|
+
### AGE_ESTIMATION
|
|
125
|
+
|
|
126
|
+
Configuration for Age Estimation feature.
|
|
127
|
+
|
|
128
|
+
| Key | Type | Accepts | Meaning |
|
|
129
|
+
| --- | --- | --- | --- |
|
|
130
|
+
| `borderline_maximum_age_threshold` | integer \| null | integer >=1 <=100 | |
|
|
131
|
+
| `borderline_minimum_age_threshold` | integer \| null | integer >=1 <=100 | |
|
|
132
|
+
| `enable_id_verification_fallback` | boolean \| null | boolean | |
|
|
133
|
+
| `external_capture_device_action` | string \| null | 'NO_ACTION'\|'REVIEW'\|'DECLINE' | Verdict when an external capture device is detected. |
|
|
134
|
+
| `face_audio_recording_enabled` | boolean \| null | boolean | Record the microphone during the selfie capture, so a reviewer can hear the session. Off by default. |
|
|
135
|
+
| `face_liveness_duplicated_face_document_mismatch_action` | string \| null | 'NO_ACTION'\|'REVIEW'\|'DECLINE' | Verdict when a duplicate face is found on a user verified with a different date of birth. Another document of the same person (a passport after an identity card, a renewal, a document of a second country) is not flagged. |
|
|
136
|
+
| `face_liveness_duplicated_face_name_mismatch_action` | string \| null | 'NO_ACTION'\|'REVIEW'\|'DECLINE' | Verdict when a duplicate face is found under a different name. |
|
|
137
|
+
| `face_liveness_flash_mode` | string \| null | string | |
|
|
138
|
+
| `face_liveness_max_attempts` | integer \| null | integer >=1 <=3 | |
|
|
139
|
+
| `face_liveness_method` | string \| null | 'ACTIVE_3D'\|'FLASHING'\|'PASSIVE' | |
|
|
140
|
+
| `face_liveness_multiple_faces_action` | string \| null | 'NO_ACTION'\|'REVIEW'\|'DECLINE' | Verdict when more than one face is present in the capture. |
|
|
141
|
+
| `face_liveness_possible_duplicated_face_action` | string \| null | 'NO_ACTION'\|'REVIEW'\|'DECLINE' | Verdict when this face matches a previously seen user. |
|
|
142
|
+
| `face_liveness_score_decline_threshold` | number \| null | number | |
|
|
143
|
+
| `face_liveness_score_review_threshold` | number \| null | number | |
|
|
144
|
+
| `face_liveness_uncertain_retry_enabled` | boolean \| null | boolean | Native SDK active liveness only. On, a capture whose liveness score falls strictly between face_liveness_score_decline_threshold and face_liveness_score_review_threshold is never decided, whichever verdict the engine attached to it: the person is told the result was unclear and asked to capture again, every time, outside the face_liveness_max_attempts budget (which still applies to captures the engine could not score). Off by default; the web flow ignores it. |
|
|
145
|
+
| `face_liveness_video_anomaly_action` | string \| null | 'NO_ACTION'\|'REVIEW'\|'DECLINE' | Verdict when the stored liveness recording contains a repeated moving sequence consistent with a looped video feed, measured server-side from the video itself, independently of the liveness score. It deliberately does NOT flag a frozen or near-motionless capture: frame statistics cannot separate an injected still from a genuine one (a subject holding still, or a flash that clips the exposure), so acting on that would decline real users. A frozen or pre-recorded injected feed is instead defeated by strict flash liveness (set face_liveness_flash_mode to "1" for strict), which binds the capture to a per-session colour-sequence challenge a recording cannot reproduce. Defaults to NO_ACTION (evidence is recorded, the verdict is unchanged). |
|
|
146
|
+
| `face_luminance_max_action` | string \| null | 'NO_ACTION'\|'REVIEW'\|'DECLINE' | Verdict when the selfie is brighter than `face_luminance_max_threshold`. |
|
|
147
|
+
| `face_luminance_max_threshold` | integer \| null | integer >=0 <=100 | |
|
|
148
|
+
| `face_luminance_min_action` | string \| null | 'NO_ACTION'\|'REVIEW'\|'DECLINE' | Verdict when the selfie is darker than `face_luminance_min_threshold`. |
|
|
149
|
+
| `face_luminance_min_threshold` | integer \| null | integer >=0 <=100 | |
|
|
150
|
+
| `face_privacy_mode_enabled` | boolean \| null | boolean | |
|
|
151
|
+
| `face_quality_decline_threshold` | integer \| null | integer >=0 <=100 | |
|
|
152
|
+
| `face_quality_review_threshold` | integer \| null | integer >=0 <=100 | |
|
|
153
|
+
| `face_search_enabled` | boolean \| null | boolean | Run the 1:N Face Search on the selfie: match it against previously verified users, the face blocklist and allowlist, and store its biometric template for later matching. On by default. Off skips the search, keeps no face template, and leaves the duplicate-face actions with nothing to act on. |
|
|
154
|
+
| `frame_injection_action` | string \| null | 'NO_ACTION'\|'REVIEW'\|'DECLINE' | Verdict when injected video frames are detected. |
|
|
155
|
+
| `minimum_age_threshold` | integer \| null | integer >=1 <=100 | |
|
|
156
|
+
| `screen_capture_action` | string \| null | 'NO_ACTION'\|'REVIEW'\|'DECLINE' | Verdict when the selfie is a photo of a screen. |
|
|
157
|
+
| `status_rules` | array | array | |
|
|
158
|
+
| `virtual_camera_action` | string \| null | 'NO_ACTION'\|'REVIEW'\|'DECLINE' | Verdict when a virtual camera feed is detected. |
|
|
159
|
+
|
|
160
|
+
### AML
|
|
161
|
+
|
|
162
|
+
Configuration for AML feature (used for both KYC AML and KYB Company AML).
|
|
163
|
+
|
|
164
|
+
| Key | Type | Accepts | Meaning |
|
|
165
|
+
| --- | --- | --- | --- |
|
|
166
|
+
| `aml_country_weight` | integer \| null | integer >=0 <=100 | |
|
|
167
|
+
| `aml_dob_weight` | integer \| null | integer >=0 <=100 | |
|
|
168
|
+
| `aml_entity_type` | string \| null | 'company'\|'person' | Whether this node screens a `person` or a `company`. Defaults to `person` on a person (KYC) workflow and to `company` on a business (KYB) workflow. Set it to `company` to screen the business named in an uploaded document (via `aml_field_sources`) without a KYB Registry step - the provider searches company records instead of people, and the match score is scored as a company. |
|
|
169
|
+
| `aml_field_sources` | json \| null | {"full_name"\|"date_of_birth"\|"nationality"\|"document_number": {"source": "document_ai"\|"questionnaire"\|"expected_data", "key": "<docai field key>\|<questionnaire node id>\|expected_details.<expected_details field>\|metadata.<key>"}} | Where this node reads the entity it screens, when the workflow has no ID Verification or KYB Registry step to supply it - a Document AI workflow over non-standardised documents (a tax certificate, an acta constitutiva). Same contract as `database_validation_field_sources`: `source` names the producer and `key` names the value inside it - a Document AI field key for `document_ai`, a questionnaire node id for `questionnaire`, and `expected_details.<field>` or `metadata.<key>` for `expected_data`. The map's KEY is one of the four AML screening inputs: `full_name`, `date_of_birth`, `nationality`, `document_number` - read for a company as legal name, incorporation date, country and registration number. A Document AI field already keyed as one of those four maps automatically and is deliberately not persisted, so renaming it never freezes a stale mapping. An explicit mapping wins over both the auto-map and the ID document, and a mapping that resolves to nothing at runtime leaves the input empty rather than falling back. With no ID Verification and no KYB Registry upstream, `full_name` must be fillable or the graph is rejected on save: there is no search without a name. |
|
|
170
|
+
| `aml_incomplete_data_action` | string \| null | 'NO_ACTION'\|'REVIEW'\|'DECLINE' | Verdict when the screening ran on less than a full identity (name, date of birth and country). `REVIEW` is the default and the historical behaviour; `NO_ACTION` proceeds on reduced data for a workflow that knowingly holds only a name. The screening still runs either way, and the partial-data log is still recorded - this only decides what it does to the status. |
|
|
171
|
+
| `aml_match_score_threshold` | integer \| null | integer >=0 <=100 | |
|
|
172
|
+
| `aml_name_weight` | integer \| null | integer >=0 <=100 | |
|
|
173
|
+
| `aml_score_approve_threshold` | integer \| null | integer >=0 <=100 | |
|
|
174
|
+
| `aml_score_review_threshold` | integer \| null | integer >=0 <=100 | |
|
|
175
|
+
| `case_blueprint` | uuid \| null | uuid | Which case blueprint the automatically-created case is built from. Only meaningful with `create_cases_on_hit`; the account default is used when unset. |
|
|
176
|
+
| `create_cases_on_hit` | boolean \| null | boolean | Open a case automatically when the screening returns a hit, instead of leaving the hit to be triaged from the session. Off by default. |
|
|
177
|
+
| `fallback_to_native` | boolean \| null | boolean | |
|
|
178
|
+
| `is_aml_ongoing_monitoring_enabled` | boolean \| null | boolean | Keep screening the PERSON after the session is approved, raising a new hit when they later appear on a watchlist. Off by default. |
|
|
179
|
+
| `kyb_company_aml_country_weight` | integer \| null | integer >=0 <=100 | |
|
|
180
|
+
| `kyb_company_aml_dob_weight` | integer \| null | integer >=0 <=100 | |
|
|
181
|
+
| `kyb_company_aml_match_score_threshold` | integer \| null | integer >=0 <=100 | |
|
|
182
|
+
| `kyb_company_aml_name_weight` | integer \| null | integer >=0 <=100 | |
|
|
183
|
+
| `kyb_enable_ongoing_monitoring` | boolean \| null | boolean | The same, for the COMPANY on a KYB workflow. The two switches are independent. |
|
|
184
|
+
| `kyb_score_approve_threshold` | integer \| null | integer >=0 <=100 | |
|
|
185
|
+
| `kyb_score_review_threshold` | integer \| null | integer >=0 <=100 | |
|
|
186
|
+
| `provider_key` | string \| null | string | |
|
|
187
|
+
| `status_rules` | array | array | |
|
|
188
|
+
|
|
189
|
+
### BANK_VERIFICATION
|
|
190
|
+
|
|
191
|
+
Configuration for Bank Verification feature.
|
|
192
|
+
> Bank Verification confirms who owns a bank account against an identity ANOTHER step established - it is not identity proof on its own. Put ID Verification, Database Validation or a questionnaire before it; first in a graph it has nothing to compare against and can only return `unknown`. The node is opt-in and runs nothing while `bank_countries` is empty.
|
|
193
|
+
|
|
194
|
+
| Key | Type | Accepts | Meaning |
|
|
195
|
+
| --- | --- | --- | --- |
|
|
196
|
+
| `bank_account_selection` | string \| null | 'auto'\|'user' | Whether the user picks which of the connected accounts is verified (`user`) or the first eligible one is taken (`auto`). |
|
|
197
|
+
| `bank_allow_skip` | boolean \| null | boolean | Let the user skip the step instead of connecting a bank. A skip is then decided by `bank_skipped_action`. |
|
|
198
|
+
| `bank_attempts_exhausted_action` | string \| null | 'REVIEW'\|'DECLINE' | Verdict when the user spent `bank_max_attempts` without a successful connection. |
|
|
199
|
+
| `bank_business_account_action` | string \| null | 'NO_ACTION'\|'REVIEW'\|'DECLINE' | Verdict when the institution types the holder as a business rather than a person. |
|
|
200
|
+
| `bank_connection_timeout_minutes` | integer \| null | integer >=5 <=60 | How long a started connection stays open before the attempt is abandoned, 5 to 60 minutes. |
|
|
201
|
+
| `bank_consent_expired_action` | string \| null | 'NO_ACTION'\|'REVIEW'\|'DECLINE' | Verdict when the bank consent lapses after the step was already decided. Only meaningful with `bank_refresh_enabled`. |
|
|
202
|
+
| `bank_countries` | json \| null | {"<ISO3>": {"enabled": true\|false, "institutions": ["<institution_id>", ...] \| "all"}} | Which countries a user may connect a bank in - a WHITELIST, so an empty map means the node offers nothing and runs nothing. `institutions` narrows the picker to specific provider institution ids; `"all"` offers every identity-capable bank in the country. Coverage belongs to the route the node selected in `provider_key`: a country the native route or the connected marketplace provider cannot establish account ownership in is REFUSED on save rather than dropped, because connecting to a bank that returns no holder identity spends an attempt and a charge to end at `not_verifiable`. |
|
|
203
|
+
| `bank_country_mismatch_action` | string \| null | 'NO_ACTION'\|'REVIEW'\|'DECLINE' | Verdict when the institution's country differs from the expected/document country. |
|
|
204
|
+
| `bank_currency_mismatch_action` | string \| null | 'NO_ACTION'\|'REVIEW'\|'DECLINE' | Verdict when the account currency is not in `bank_expected_currencies`. |
|
|
205
|
+
| `bank_eligible_account_types` | array \| null | array | Which account types the user may pick. Credit cards, loans and investment accounts are never eligible - they do not establish ownership of a payment account. Defaults to current/checking. |
|
|
206
|
+
| `bank_expected_currencies` | array \| null | array | ISO 4217 currencies the account is expected to be in. Empty means any; a mismatch is reported through `bank_currency_mismatch_action`. |
|
|
207
|
+
| `bank_field_sources` | json \| null | {"full_name"\|"first_name"\|"last_name"\|"address": {"source": "document_ai"\|"questionnaire"\|"expected_data", "key": "<docai field key>\|<questionnaire node id>\|expected_details.<expected_details field>\|metadata.<key>"}} | Where to read a reference-identity field when no earlier step in the graph can fill it. The map's KEY is one of `full_name`, `first_name`, `last_name`, `address`; `source` names the producer and `key` names the value inside it - a Document AI field key for `document_ai`, a questionnaire node id for `questionnaire`, and `expected_details.<field>` or `metadata.<key>` for `expected_data`. An `expected_details.<field>` VALUE may only name a field the session-create payload actually carries - `address`, `country`, `date_of_birth`, `first_name`, `gender`, `id_country`, `identification_number`, `ip_address`, `last_name`, `nationality` or `poa_country`. A malformed entry is refused on save, not dropped. |
|
|
208
|
+
| `bank_joint_account_action` | string \| null | 'NO_ACTION'\|'REVIEW'\|'DECLINE' | Verdict when the account has more than one holder. |
|
|
209
|
+
| `bank_low_balance_action` | string \| null | 'NO_ACTION'\|'REVIEW'\|'DECLINE' | Verdict when the available balance is below `bank_min_balance`. Needs the `balances` scope. |
|
|
210
|
+
| `bank_max_attempts` | integer \| null | integer >=1 <=5 | How many connection attempts the user gets, 1 to 5. Spending them all without a successful connection is `bank_attempts_exhausted_action`. |
|
|
211
|
+
| `bank_min_balance` | number \| null | number >=0 | Minimum available balance, in the account's own currency. Below it `bank_low_balance_action` fires. Needs the `balances` scope and the save is refused without it. 0 is a real cutoff - it triggers the action for an overdrawn account - but the action defaults to `NO_ACTION`, so the verdict is unchanged unless another action is configured. This is not the same as leaving the key out. |
|
|
212
|
+
| `bank_name_match_threshold` | integer \| null | integer >=50 <=100 | At or above this score the holder name is a match. 50 to 100, defaults to 85. |
|
|
213
|
+
| `bank_no_match_action` | string \| null | 'REVIEW'\|'DECLINE' | Verdict when the account holder is demonstrably not the verified person (best name score below `bank_partial_match_floor`). |
|
|
214
|
+
| `bank_not_verifiable_action` | string \| null | 'NO_ACTION'\|'REVIEW'\|'DECLINE' | Verdict when the institution connected but returned no holder identity to compare. |
|
|
215
|
+
| `bank_partial_match_action` | string \| null | 'NO_ACTION'\|'REVIEW'\|'DECLINE' | Verdict when the holder name lands between `bank_partial_match_floor` and `bank_name_match_threshold`. Never approves by default. |
|
|
216
|
+
| `bank_partial_match_floor` | integer \| null | integer >=0 <=99 | Below this score the holder name is a no-match. 0 to 99, defaults to 70. The band between the floor and the threshold is the partial match, so the floor must be strictly below `bank_name_match_threshold` or the save is refused. An explicit null means "use the default" here too, which is why a threshold of 50 with no floor is refused: it is checked against the default floor of 70. |
|
|
217
|
+
| `bank_reference_identity` | string \| null | 'auto'\|'database_validation'\|'expected_details'\|'kyc'\|'questionnaire' | Which earlier step supplies the identity the account holder is compared against: `kyc` (ID Verification), `database_validation`, `expected_details` (the session-create payload), `questionnaire`, or `auto` to use whichever one the workflow produced. The step that actually supplied it is recorded on the result as `reference_identity_source`. |
|
|
218
|
+
| `bank_reference_identity_missing_action` | string \| null | 'NO_ACTION'\|'REVIEW'\|'DECLINE' | Verdict when no earlier step produced an identity to compare the holder against, so ownership can only be `unknown`. |
|
|
219
|
+
| `bank_refresh_enabled` | boolean \| null | boolean | Re-fetch the account's financial data after the step has already been decided, for as long as the bank consent lasts. Needs at least one of the `balances`, `transactions` or `income` scopes and the save is refused without one. A consent that lapses afterwards is `bank_consent_expired_action`. |
|
|
220
|
+
| `bank_require_address_match` | boolean \| null | boolean | Also require the holder's address to match. A name that reached the threshold but whose address scores below it drops to a partial match. An institution that returns no address waives the requirement; a session with no address of its own to compare against does not, and lands on a partial match. Off by default. |
|
|
221
|
+
| `bank_require_oauth_only` | boolean \| null | boolean | Offer only institutions reachable over OAuth / app-to-app, never a provider's legacy credential-capture surface. Where open banking already makes OAuth the only route, this changes nothing. |
|
|
222
|
+
| `bank_scopes` | json \| null | {"ownership": true, "identifiers": true\|false, "balances": true\|false, "transactions": true\|false, "income": true\|false} | What the user is asked to consent to sharing. `ownership` is what the product verifies and cannot be turned off. `identifiers` unmasks the IBAN / account number; `balances`, `transactions` and `income` read real financial data, are each billed separately, and are refused on save unless the application carries the `bank_financial_data` entitlement. A scope that is off is never requested from the provider, so the bank never shows it on its consent screen. |
|
|
223
|
+
| `bank_show_match_result_to_user` | boolean \| null | boolean | Show the ownership result to the user inside the verification flow. Off means it is recorded on the session but never shown to them. |
|
|
224
|
+
| `bank_skipped_action` | string \| null | 'REVIEW'\|'DECLINE' | Verdict when the user skipped the step. Only reachable with `bank_allow_skip`. |
|
|
225
|
+
| `bank_store_full_identifiers` | boolean \| null | boolean | Store the account identifiers unmasked rather than masked. Needs the `identifiers` scope and the save is refused without it. Even then the unmasked form is only served to a caller holding the bank-verification read permission. |
|
|
226
|
+
| `bank_store_raw_owner_data` | boolean \| null | boolean | Keep the holder details the institution returned next to the ownership evidence. Off means only the comparison itself is retained: scores, match method and reason codes. |
|
|
227
|
+
| `bank_transactions_history_days` | integer \| null | integer >=30 <=365 | How far back transaction history is read, 30 to 365 days, defaulting to 90. Needs the `transactions` scope and the save is refused without it. |
|
|
228
|
+
| `bank_unknown_action` | string \| null | 'NO_ACTION'\|'REVIEW'\|'DECLINE' | Verdict when the evidence could not be fetched after retries - a transient failure. |
|
|
229
|
+
| `bank_unsupported_action` | string \| null | 'NO_ACTION'\|'REVIEW'\|'DECLINE' | Verdict when the user's bank is not supported and the node does not allow skipping. |
|
|
230
|
+
| `bank_use_provider_score` | boolean \| null | boolean | Also read the institution's own holder-name score, and let it decide when it is higher than Didit's or when Didit had no holder name to score at all. A result decided that way reports `provider_only` as its match method, and a connection that returned no such score records a `provider_score_unavailable` warning. On by default. |
|
|
231
|
+
| `fallback_to_native` | boolean \| null | boolean | Whether a marketplace connection that cannot be established falls back to Didit's native route. Off by default: a silent fallback would spend your Didit balance on a session you expected to run on your own provider contract. A fallback connection is recorded as `credential_source = native` and billed at the native price. |
|
|
232
|
+
| `provider_key` | string \| null | string | Which route runs the step. Empty (the default) is Didit's native Bank Verification, a provider-independent product Didit routes to the regional open-banking vendor that serves the user's country and institution, on Didit's contracts and billing. A value names a MARKETPLACE provider whose own credentials this application has connected - the session then runs, is billed and is revoked on your provider account, and Didit charges only the marketplace platform fee. A provider that is not connected is refused on save. |
|
|
233
|
+
| `status_rules` | array | array | |
|
|
234
|
+
|
|
235
|
+
### DATABASE_VALIDATION
|
|
236
|
+
|
|
237
|
+
Configuration for Database Validation feature.
|
|
238
|
+
> The node is opt-in and does nothing while `database_validation_countries` is empty - the editor blocks publishing in that state and the compliance check reports it as a gap. Place it after the step that produces its inputs (usually OCR), and use `database_validation_field_sources` only for inputs no upstream step can fill.
|
|
239
|
+
|
|
240
|
+
| Key | Type | Accepts | Meaning |
|
|
241
|
+
| --- | --- | --- | --- |
|
|
242
|
+
| `database_validation_countries` | json \| null | {"<ISO3>": {"services": ["<service_id>", ...]}} | The databases to check, per country - this node runs NOTHING until at least one country carries at least one service id. Service ids come from the country's live catalog (e.g. `bra_cpf` for BRA); ids that do not belong to the named country, and countries with no live service, are dropped on save. The legacy `{"<ISO3>": "one_by_one"\|"two_by_two"\|"not_enabled"}` shape is still accepted and auto-expanded to that country's live services. |
|
|
243
|
+
| `database_validation_field_sources` | json \| null | {"<db_validation_input_field>": {"source": "document_ai"\|"questionnaire"\|"expected_data", "key": "<docai field key>\|<questionnaire node id>\|expected_details.<expected_details field>\|metadata.<key>"}} | Where to read a database input that no earlier step in the graph can fill. `source` names the producer and `key` names the value inside it: a Document AI field key for `document_ai`, a questionnaire node id for `questionnaire`, and `expected_details.<field>` or `metadata.<key>` for `expected_data`. The two halves speak different vocabularies: the map's KEY is a Database Validation input field (`tax_id`, `document_number`, ...), while an `expected_details.<field>` VALUE may only name a field the session-create payload actually carries - `address`, `country`, `date_of_birth`, `first_name`, `gender`, `id_country`, `identification_number`, `ip_address`, `last_name`, `nationality` or `poa_country`. Anything else under `expected_details.` is rejected on save; `metadata.<key>` takes any non-empty whitespace-free customer key. Exact-key matches against an upstream step resolve automatically and are deliberately not persisted, so renaming a Document AI field never freezes a stale mapping into the config. A malformed entry is dropped on save rather than rejected, which un-satisfies its service and drops it from the selection. |
|
|
244
|
+
| `database_validation_no_match_action` | string \| null | 'NO_ACTION'\|'REVIEW'\|'DECLINE' | Verdict when the database returns no match at all. |
|
|
245
|
+
| `database_validation_not_applicable_action` | string \| null | 'NO_ACTION'\|'REVIEW'\|'DECLINE' | Verdict when no selected database covers the holder's country or document. |
|
|
246
|
+
| `database_validation_partial_match_action` | string \| null | 'NO_ACTION'\|'REVIEW'\|'DECLINE' | Verdict when the database matches some, but not all, of the submitted fields. |
|
|
247
|
+
| `status_rules` | array | array | |
|
|
248
|
+
|
|
249
|
+
### DOCUMENT_AI
|
|
250
|
+
|
|
251
|
+
Configuration for the Document AI feature.
|
|
252
|
+
> At most 3 documents per node, field keys unique within a document, and at most one field per document may set `is_full_name` (it is optional - a document may mark none).
|
|
253
|
+
|
|
254
|
+
| Key | Type | Accepts | Meaning |
|
|
255
|
+
| --- | --- | --- | --- |
|
|
256
|
+
| `document_ai_document_tampering_action` | string \| null | 'REVIEW'\|'DECLINE' | Verdict when the document looks tampered with. |
|
|
257
|
+
| `document_ai_documents` | array | array | |
|
|
258
|
+
| `document_ai_max_attempts_exceeded_action` | string \| null | 'REVIEW'\|'DECLINE' | Verdict when the user runs out of `document_ai_max_retry_attempts`. |
|
|
259
|
+
| `document_ai_max_retry_attempts` | integer \| null | integer >=2 <=5 | |
|
|
260
|
+
| `document_ai_missing_required_fields_action` | string \| null | 'NO_ACTION'\|'REVIEW'\|'DECLINE' | Verdict when a field marked `required` could not be extracted. |
|
|
261
|
+
| `document_ai_name_match_score_threshold` | integer \| null | integer >=0 <=100 | |
|
|
262
|
+
| `document_ai_name_mismatch_action` | string \| null | 'NO_ACTION'\|'REVIEW'\|'DECLINE' | Verdict when the field flagged `is_full_name` disagrees with the verified identity's full name, scored against `document_ai_name_match_score_threshold`. |
|
|
263
|
+
| `document_ai_unreadable_document_action` | string \| null | 'NO_ACTION'\|'REVIEW'\|'DECLINE' | Verdict when the uploaded document cannot be read at all. |
|
|
264
|
+
| `document_ai_unsupported_file_action` | string \| null | 'NO_ACTION'\|'REVIEW'\|'DECLINE' | Verdict when the uploaded file type is not supported. |
|
|
265
|
+
| `status_rules` | array | array | |
|
|
266
|
+
|
|
267
|
+
### EMAIL_VERIFICATION
|
|
268
|
+
|
|
269
|
+
Configuration for Email Verification feature.
|
|
270
|
+
|
|
271
|
+
| Key | Type | Accepts | Meaning |
|
|
272
|
+
| --- | --- | --- | --- |
|
|
273
|
+
| `breached_email_action` | string \| null | 'NO_ACTION'\|'REVIEW'\|'DECLINE' | Verdict when the address appears in a known credential breach. |
|
|
274
|
+
| `cross_org_fraud_email_action` | string \| null | 'NO_ACTION'\|'REVIEW'\|'DECLINE' | Verdict when this address was flagged as fraudulent by another organization in the network. |
|
|
275
|
+
| `disposable_email_action` | string \| null | 'NO_ACTION'\|'REVIEW'\|'DECLINE' | Verdict when the address belongs to a disposable-mail provider. |
|
|
276
|
+
| `duplicated_email_action` | string \| null | 'NO_ACTION'\|'REVIEW'\|'DECLINE' | Verdict when the address was already verified for this application. |
|
|
277
|
+
| `email_alphanumeric_code` | boolean \| null | boolean | |
|
|
278
|
+
| `email_code_size` | integer \| null | integer >=4 <=8 | |
|
|
279
|
+
| `email_enrichment_enabled` | boolean \| null | boolean | |
|
|
280
|
+
| `email_intelligence_score_action` | string \| null | 'NO_ACTION'\|'REVIEW'\|'DECLINE' | Verdict when the enrichment score is worse than `email_intelligence_score_threshold`. |
|
|
281
|
+
| `email_intelligence_score_threshold` | integer \| null | integer >=0 <=100 | |
|
|
282
|
+
| `email_max_check_attempts` | integer \| null | integer >=1 <=5 | |
|
|
283
|
+
| `email_max_retries` | integer \| null | integer >=1 <=5 | |
|
|
284
|
+
| `email_no_social_presence_action` | string \| null | 'NO_ACTION'\|'REVIEW'\|'DECLINE' | Verdict when the social footprint check (`email_social_enabled`) finds the address registered on none of the platforms it covers. |
|
|
285
|
+
| `email_social_enabled` | boolean \| null | boolean | |
|
|
286
|
+
| `frequent_email_breach_action` | string \| null | 'NO_ACTION'\|'REVIEW'\|'DECLINE' | Verdict when the address appears in many breaches. |
|
|
287
|
+
| `only_corporate_emails_allowed` | boolean \| null | boolean | |
|
|
288
|
+
| `recent_email_breach_action` | string \| null | 'NO_ACTION'\|'REVIEW'\|'DECLINE' | Verdict when the address appears in a recent breach. |
|
|
289
|
+
| `status_rules` | array | array | |
|
|
290
|
+
|
|
291
|
+
### FACE_MATCH
|
|
292
|
+
|
|
293
|
+
Configuration for Face Match feature.
|
|
294
|
+
|
|
295
|
+
| Key | Type | Accepts | Meaning |
|
|
296
|
+
| --- | --- | --- | --- |
|
|
297
|
+
| `face_match_eyes_covered_action` | string | 'NO_ACTION'\|'REVIEW'\|'DECLINE' | Verdict when calibrated evidence says the eyes region is covered in the selfie. NO_ACTION records evidence without changing Face Match; REVIEW sends Face Match to review; DECLINE declines it. The signal remains shadow-only until the region reports calibrated=true. |
|
|
298
|
+
| `face_match_face_covered_action` | string | 'NO_ACTION'\|'REVIEW'\|'DECLINE' | Verdict when calibrated evidence says the face region is covered in the selfie. NO_ACTION records evidence without changing Face Match; REVIEW sends Face Match to review; DECLINE declines it. The signal remains shadow-only until the region reports calibrated=true. |
|
|
299
|
+
| `face_match_max_attempts` | integer \| null | integer >=1 <=3 | |
|
|
300
|
+
| `face_match_mouth_covered_action` | string | 'NO_ACTION'\|'REVIEW'\|'DECLINE' | Verdict when calibrated evidence says the mouth region is covered in the selfie. NO_ACTION records evidence without changing Face Match; REVIEW sends Face Match to review; DECLINE declines it. The signal remains shadow-only until the region reports calibrated=true. |
|
|
301
|
+
| `face_match_not_computed_action` | string \| null | 'REVIEW'\|'DECLINE' | Verdict when no face-match score could be produced (missing portrait or selfie). |
|
|
302
|
+
| `face_match_score_decline_threshold` | integer \| null | integer >=0 <=100 | |
|
|
303
|
+
| `face_match_score_review_threshold` | integer \| null | integer >=0 <=100 | |
|
|
304
|
+
| `status_rules` | array | array | |
|
|
305
|
+
|
|
306
|
+
### GEOLOCATION
|
|
307
|
+
|
|
308
|
+
Configuration for the Precise Location (GEOLOCATION) feature. Every threshold is bounded here rather than in the client: the browser and the native SDKs are told what to collect by the step data this config produces, and a value the server would refuse must never reach a user as a request their device cannot satisfy. The action keys all default to Review rather than Decline. A denied permission, a wide radius or a stale fix is not evidence of fraud, and a default that declined them would make the step a conversion trap.
|
|
309
|
+
|
|
310
|
+
| Key | Type | Accepts | Meaning |
|
|
311
|
+
| --- | --- | --- | --- |
|
|
312
|
+
| `geolocation_accuracy_mode` | string \| null | 'approximate_allowed'\|'precise' | |
|
|
313
|
+
| `geolocation_allow_qr_handoff` | boolean \| null | boolean | |
|
|
314
|
+
| `geolocation_allow_skip` | boolean \| null | boolean | |
|
|
315
|
+
| `geolocation_approximate_action` | string \| null | 'NO_ACTION'\|'REVIEW'\|'DECLINE' | Verdict when the user granted an approximate location while `geolocation_accuracy_mode` asks for a precise one. |
|
|
316
|
+
| `geolocation_deep_link_enabled` | boolean \| null | boolean | |
|
|
317
|
+
| `geolocation_document_distance_action` | string \| null | 'NO_ACTION'\|'REVIEW'\|'DECLINE' | Verdict when the device position is further from the document address than `geolocation_document_distance_km`. The address is geocoded coarsely, so this is a weak signal. |
|
|
318
|
+
| `geolocation_document_distance_km` | integer \| null | integer >=0 | |
|
|
319
|
+
| `geolocation_document_distance_unit` | string \| null | 'imperial'\|'metric' | The unit the console shows `geolocation_document_distance_km` in. Display only: the stored value is always kilometres and no rule depends on it. |
|
|
320
|
+
| `geolocation_geofence_undetermined_action` | string \| null | 'NO_ACTION'\|'REVIEW'\|'DECLINE' | Verdict when the position cannot be placed inside or outside the fence because its accuracy circle reaches the boundary. Uncertainty is never reported as being outside. |
|
|
321
|
+
| `geolocation_geofencing_action` | string \| null | 'NO_ACTION'\|'REVIEW'\|'DECLINE' | Verdict when the device position, and its whole uncertainty circle, falls outside `geolocation_geofencing_by_country`. |
|
|
322
|
+
| `geolocation_geofencing_by_country` | json \| null | {"<ISO3>": {"allowed": true\|false, "states"?: {"<ISO 3166-2 code>": {"allowed": true\|false}} \| null}} | Country and region allow/deny rules for the device's own position, applied only while `is_geolocation_geofencing_enabled` is true. Same shape as IP Analysis's `ip_geofencing_by_country`, except that `states` keys are ISO 3166-2 codes (`US-NJ`), not state names, because the position is resolved to a subdivision rather than to a provider's city label. A country that is not listed is allowed. Saving a region rule for a country with no published ISO 3166-2 boundaries is rejected rather than silently ignored. |
|
|
323
|
+
| `geolocation_integrity_missing_action` | string \| null | 'NO_ACTION'\|'REVIEW'\|'DECLINE' | Verdict when a native client submitted a position with no device-attestation token. Defaults to No action; web clients are recorded as unsupported rather than missing, because no browser can attest. |
|
|
324
|
+
| `geolocation_ip_distance_action` | string \| null | 'NO_ACTION'\|'REVIEW'\|'DECLINE' | Verdict when the device position and the session's IP location are further apart than `geolocation_ip_distance_km`, after both uncertainty radii are subtracted. |
|
|
325
|
+
| `geolocation_ip_distance_km` | integer \| null | integer >=0 | |
|
|
326
|
+
| `geolocation_ip_distance_unit` | string \| null | 'imperial'\|'metric' | The unit the console shows `geolocation_ip_distance_km` in. Display only: the stored value is always kilometres and no rule depends on it. |
|
|
327
|
+
| `geolocation_low_accuracy_action` | string \| null | 'NO_ACTION'\|'REVIEW'\|'DECLINE' | Verdict when no attempt established the required precision: the best position has an uncertainty radius wider than `geolocation_max_accuracy_radius_m`, or it reported no radius at all. A position without a radius is never counted as meeting the limit. |
|
|
328
|
+
| `geolocation_max_accuracy_radius_m` | integer \| null | integer | |
|
|
329
|
+
| `geolocation_max_accuracy_radius_unit` | string \| null | 'imperial'\|'metric' | The unit the console shows `geolocation_max_accuracy_radius_m` in. Display only: the stored value is always metres, no rule depends on it, and the step data only forwards it so a client can show the same unit. |
|
|
330
|
+
| `geolocation_max_age_seconds` | integer \| null | integer | |
|
|
331
|
+
| `geolocation_max_attempts` | integer \| null | integer | |
|
|
332
|
+
| `geolocation_mock_location_action` | string \| null | 'NO_ACTION'\|'REVIEW'\|'DECLINE' | Verdict when the operating system reported the position as simulated rather than measured (Android mock provider, iOS simulated-by-software). |
|
|
333
|
+
| `geolocation_permission_denied_action` | string \| null | 'NO_ACTION'\|'REVIEW'\|'DECLINE' | Verdict when the user declined or dismissed the location prompt on every allowed attempt. Defaults to Review: a refusal is a choice, not a fraud signal. |
|
|
334
|
+
| `geolocation_stale_fix_action` | string \| null | 'NO_ACTION'\|'REVIEW'\|'DECLINE' | Verdict when the position was measured more than `geolocation_max_age_seconds` before the server received it. |
|
|
335
|
+
| `geolocation_timeout_seconds` | integer \| null | integer | |
|
|
336
|
+
| `geolocation_unavailable_action` | string \| null | 'NO_ACTION'\|'REVIEW'\|'DECLINE' | Verdict when no position could be obtained - location services off or restricted, the positioning system returned nothing, the attempt timed out, the user skipped the step, or the client is too old to support it. |
|
|
337
|
+
| `is_geolocation_geofencing_enabled` | boolean \| null | boolean | |
|
|
338
|
+
| `status_rules` | array | array | |
|
|
339
|
+
|
|
340
|
+
### IP_ANALYSIS
|
|
341
|
+
|
|
342
|
+
Configuration for Device & IP Analysis feature.
|
|
343
|
+
|
|
344
|
+
| Key | Type | Accepts | Meaning |
|
|
345
|
+
| --- | --- | --- | --- |
|
|
346
|
+
| `automation_detected_action` | string \| null | 'NO_ACTION'\|'REVIEW'\|'DECLINE' | Verdict when the session looks driven by automation rather than a person. |
|
|
347
|
+
| `cross_org_fraud_device_action` | string \| null | 'NO_ACTION'\|'REVIEW'\|'DECLINE' | Verdict when this device was flagged as fraudulent by another organization in the network. |
|
|
348
|
+
| `cross_org_fraud_ip_action` | string \| null | 'NO_ACTION'\|'REVIEW'\|'DECLINE' | Verdict when this IP was flagged as fraudulent by another organization in the network. |
|
|
349
|
+
| `device_app_tampered_action` | string \| null | 'NO_ACTION'\|'REVIEW'\|'DECLINE' | Verdict when the host application binary looks tampered with. |
|
|
350
|
+
| `device_blocklist_action` | string \| null | 'NO_ACTION'\|'REVIEW'\|'DECLINE' | Verdict when the device is on the organization's block list. |
|
|
351
|
+
| `device_debugger_action` | string \| null | 'NO_ACTION'\|'REVIEW'\|'DECLINE' | Verdict when a debugger is attached to the host application. |
|
|
352
|
+
| `device_emulator_action` | string \| null | 'NO_ACTION'\|'REVIEW'\|'DECLINE' | Verdict when the device is an emulator rather than real hardware. |
|
|
353
|
+
| `device_hooking_action` | string \| null | 'NO_ACTION'\|'REVIEW'\|'DECLINE' | Verdict when runtime hooking or instrumentation is detected. |
|
|
354
|
+
| `device_integrity_missing_action` | string \| null | 'NO_ACTION'\|'REVIEW'\|'DECLINE' | Verdict when no platform device-integrity attestation was returned. |
|
|
355
|
+
| `device_rooted_action` | string \| null | 'NO_ACTION'\|'REVIEW'\|'DECLINE' | Verdict when the device is rooted or jailbroken. |
|
|
356
|
+
| `duplicated_device_action` | string \| null | 'NO_ACTION'\|'REVIEW'\|'DECLINE' | Verdict when this device was already used by another verified user. |
|
|
357
|
+
| `duplicated_ip_action` | string \| null | 'NO_ACTION'\|'REVIEW'\|'DECLINE' | Verdict when this IP was already used by another verified user. |
|
|
358
|
+
| `expected_ip_mismatch_action` | string \| null | 'NO_ACTION'\|'REVIEW'\|'DECLINE' | Verdict when the IP disagrees with the expected IP sent on the session. |
|
|
359
|
+
| `ip_geofencing_action` | string \| null | 'NO_ACTION'\|'REVIEW'\|'DECLINE' | Verdict when the connecting IP's country is not allowed by `ip_geofencing_by_country`. |
|
|
360
|
+
| `ip_geofencing_by_country` | json \| null | {"<ISO3>": {"allowed": true\|false, "states"?: {"<state_code>": {"allowed": true\|false}} \| null}} | Country allow/deny rules for the connecting IP address, applied only while `is_ip_geofencing_enabled` is true. `allowed` is required and must be a real boolean; `states` is optional and null when the country needs no per-state rule. Countries that are not valid ISO3 are dropped on save. |
|
|
361
|
+
| `ip_location_not_determined_action` | string \| null | 'NO_ACTION'\|'REVIEW'\|'DECLINE' | Verdict when no IP address identifying the end user was recorded, so the session has no IP location at all: country, city, ISP, coordinates and time zone are unavailable, and `ip_geofencing_by_country`, the document-country comparison and the VPN/data-centre checks cannot run. Defaults to `No Action`, which keeps the `IP_LOCATION_NOT_DETERMINED` warning visible on the session without changing its verdict; set `Review` or `Decline` if an unlocated session must not pass. |
|
|
362
|
+
| `ip_mismatch_action` | string \| null | 'NO_ACTION'\|'REVIEW'\|'DECLINE' | Verdict when the IP country disagrees with the document's issuing country. |
|
|
363
|
+
| `is_ip_geofencing_enabled` | boolean \| null | boolean | |
|
|
364
|
+
| `multiple_devices_action` | string \| null | 'NO_ACTION'\|'REVIEW'\|'DECLINE' | Verdict when the session was driven from more than one device. |
|
|
365
|
+
| `recovered_device_action` | string \| null | 'NO_ACTION'\|'REVIEW'\|'DECLINE' | Verdict when the device reports a recovered or restored state. |
|
|
366
|
+
| `status_rules` | array | array | |
|
|
367
|
+
| `vpn_detection_action` | string \| null | 'NO_ACTION'\|'REVIEW'\|'DECLINE' | Verdict when the connection comes through a VPN, proxy or Tor exit. |
|
|
368
|
+
|
|
369
|
+
### KYB_DOCUMENTS
|
|
370
|
+
|
|
371
|
+
| Key | Type | Accepts | Meaning |
|
|
372
|
+
| --- | --- | --- | --- |
|
|
373
|
+
| `kyb_document_age_action` | string \| null | 'NO_ACTION'\|'REVIEW'\|'DECLINE' | Verdict when a document is older than its configured freshness window. |
|
|
374
|
+
| `kyb_document_critical_mismatch_action` | string \| null | 'NO_ACTION'\|'REVIEW'\|'DECLINE' | Verdict when a document contradicts the registry on a critical company detail. |
|
|
375
|
+
| `kyb_document_max_attempts_exceeded_action` | string \| null | 'NO_ACTION'\|'REVIEW'\|'DECLINE' | Verdict when the user runs out of `kyb_document_max_retry_attempts`. |
|
|
376
|
+
| `kyb_document_max_retry_attempts` | integer \| null | integer >=1 <=5 | |
|
|
377
|
+
| `kyb_document_non_critical_mismatch_action` | string \| null | 'NO_ACTION'\|'REVIEW'\|'DECLINE' | Verdict when a document contradicts the registry on a minor detail. |
|
|
378
|
+
| `kyb_document_subtype_config` | json \| null | {"<KYB_DOCUMENT_GROUP\|KYB_DOCUMENT_SUBTYPE>": {"enabled": true\|false, "max_age_days": <0-3650>\|-1\|null}} | Per-group or per-subtype switch and freshness window. Keys must be a known KYB document group or subtype code. `max_age_days` is null for the default window, -1 for unlimited, or an integer 0-3650; anything else is rejected. |
|
|
379
|
+
| `kyb_document_tampering_action` | string \| null | 'NO_ACTION'\|'REVIEW'\|'DECLINE' | Verdict when a company document looks tampered with. |
|
|
380
|
+
| `kyb_required_document_groups` | json \| null | ["<KYB_DOCUMENT_GROUP>", ...] | The company paperwork to collect, as a list of document-GROUP codes - each group is satisfied by any one of the document types it covers. The KYB Documents feature refuses to save with an empty list: a node that requires nothing is the same as not having the node. |
|
|
381
|
+
| `status_rules` | array | array | |
|
|
382
|
+
|
|
383
|
+
### KYB_KEY_PEOPLE
|
|
384
|
+
|
|
385
|
+
> The workflow ids here point at separate KYC workflows: a KYB graph verifies the company, and the people behind it are verified by the linked person workflows.
|
|
386
|
+
|
|
387
|
+
| Key | Type | Accepts | Meaning |
|
|
388
|
+
| --- | --- | --- | --- |
|
|
389
|
+
| `kyb_corporate_ubo_verification_workflow` | uuid \| null | uuid | |
|
|
390
|
+
| `kyb_key_people_company_fields` | json \| null | [{"key": "<field key>", "label": "<label>", "type": "text"\|"number"\|"date"\|"phone"\|"email", "required": true\|false, "custom": true\|false}] | Which company details are collected for a CORPORATE key person. Same list-of-descriptors shape and same rules as `kyb_key_people_person_fields`. |
|
|
391
|
+
| `kyb_key_people_document_mismatch_action` | string \| null | 'NO_ACTION'\|'REVIEW'\|'DECLINE' | Verdict when a key person's document disagrees with the details declared for them. |
|
|
392
|
+
| `kyb_key_people_ownership_required` | boolean \| null | boolean | |
|
|
393
|
+
| `kyb_key_people_person_fields` | json \| null | [{"key": "<field key>", "label": "<label>", "type": "text"\|"number"\|"date"\|"phone"\|"email", "required": true\|false, "custom": true\|false}] | Which personal details are collected for an individual key person, as an ORDERED LIST of field descriptors (not a map). `key` is required and non-empty; `type` must be one of text, number, date, phone or email; `custom` marks a field the customer added rather than one of the built-ins. |
|
|
394
|
+
| `kyb_key_people_prefill_from_registry` | boolean \| null | boolean | Pre-fill the key-people list from the company registry result, so the customer confirms and corrects rather than typing every officer and shareholder in. |
|
|
395
|
+
| `kyb_notify_parties_by_email` | boolean \| null | boolean | |
|
|
396
|
+
| `kyb_officer_verification_workflow` | uuid \| null | uuid | |
|
|
397
|
+
| `kyb_reject_if_ubo_rejected` | boolean \| null | boolean | |
|
|
398
|
+
| `kyb_require_corporate_ubo_kyb` | boolean \| null | boolean | |
|
|
399
|
+
| `kyb_require_officer_kyc` | boolean \| null | boolean | |
|
|
400
|
+
| `kyb_require_ubo_kyc` | boolean \| null | boolean | |
|
|
401
|
+
| `kyb_reuse_verified_individuals` | boolean \| null | boolean | |
|
|
402
|
+
| `kyb_role_config` | json \| null | {"<role_key>": {"enabled"?: true\|false, "require_kyc"?: true\|false, "verification_workflow"?: "<workflow uuid>"\|null, "allow_skip"?: true\|false}} | Per-role rules for the people behind the company. Role keys come from the existing config - never invent one. A role with `require_kyc: true` MUST also carry a `verification_workflow` (the uuid of a separate KYC workflow) or the save is rejected. A list of `{"role": ..., ...}` entries is accepted as an alternative to the map. |
|
|
403
|
+
| `kyb_shareholder_ownership_threshold` | integer \| null | integer >=0 <=100 | |
|
|
404
|
+
| `kyb_shareholder_verification_workflow` | uuid \| null | uuid | |
|
|
405
|
+
| `kyb_ubo_ownership_threshold` | integer \| null | integer >=0 <=100 | |
|
|
406
|
+
| `kyb_ubo_verification_workflow` | uuid \| null | uuid | |
|
|
407
|
+
| `kyb_wait_for_all_ubos` | boolean \| null | boolean | |
|
|
408
|
+
| `status_rules` | array | array | |
|
|
409
|
+
|
|
410
|
+
### KYB_REGISTRY
|
|
411
|
+
|
|
412
|
+
| Key | Type | Accepts | Meaning |
|
|
413
|
+
| --- | --- | --- | --- |
|
|
414
|
+
| `kyb_accepted_countries` | json \| null | ["<ISO2>", ...] | Which company-registry countries the business may be incorporated in, as a list of ISO-2 codes (note: ISO-2 here, unlike the ISO-3 used by the OCR and IP allow-lists). An empty list or null accepts every supported registry. |
|
|
415
|
+
| `kyb_manual_company_action` | string \| null | 'NO_ACTION'\|'REVIEW'\|'DECLINE' | Verdict when the company could not be found in a registry and was entered by hand. |
|
|
416
|
+
| `kyb_registry_countries_config` | json \| null | {"<ISO2>": {"enabled": true\|false, "tier": "basic"\|"shareholders"\|"ubo"}} | Per-country registry routing configuration. Each enabled country selects the data tier charged when a company is selected. Only tiers marked available by the pricing endpoint can be enabled. At least one country must be enabled: a registry check that searches nowhere is rejected. Manual company entry does not use this configuration and is billed at its own flat fee of USD 0.75 per company. |
|
|
417
|
+
| `kyb_registry_fields_config` | json \| null | {"<registry_field>": {"enabled"?: true\|false, "required"?: true\|false}} | Per-registry-field overrides controlling which company details are collected and which of them are mandatory. Field keys come from the backend's configurable-field catalog (registration_number, incorporation_date, legal_address, vat_number, alternative_names, tax_number, company_type, legal_entity_identifier, location_of_registration, nature_of_business, registered_capital_amount, registered_capital_currency, website, email, phone, ...); an unknown key, or any sub-key other than `enabled` / `required`, is rejected. |
|
|
418
|
+
| `kyb_registry_monitoring_enabled` | boolean \| null | boolean | Keep the COMPANY's registry record under continuous monitoring after a Shareholders or UBO result: changes of status, officers, ownership or address move the session back to review and fire a webhook. Only where the registry provider offers monitoring; USD 2.00 per company per year, cancellable at any time. Off by default. |
|
|
419
|
+
| `kyb_vat_invalid_action` | string \| null | 'NO_ACTION'\|'REVIEW'\|'DECLINE' | Verdict when the VAT number is rejected by the tax authority. |
|
|
420
|
+
| `kyb_vat_unverified_action` | string \| null | 'NO_ACTION'\|'REVIEW'\|'DECLINE' | Verdict when the VAT number could not be checked at all. |
|
|
421
|
+
| `status_rules` | array | array | |
|
|
422
|
+
|
|
423
|
+
### LIVENESS
|
|
424
|
+
|
|
425
|
+
Configuration for Liveness feature.
|
|
426
|
+
|
|
427
|
+
| Key | Type | Accepts | Meaning |
|
|
428
|
+
| --- | --- | --- | --- |
|
|
429
|
+
| `cross_org_fraud_face_action` | string \| null | 'NO_ACTION'\|'REVIEW'\|'DECLINE' | Deprecated and no longer applied. It treated a face as if it carried a fraud verdict. Use `cross_org_identity_claim_pattern_action`. |
|
|
430
|
+
| `cross_org_identity_claim_pattern_action` | string \| null | 'NO_ACTION'\|'REVIEW'\|'DECLINE' | Verdict when other organizations in the network recorded identity-claim events for this same person in which the claimed identity did not match. Review or no action only - a decline set here is downgraded to review. |
|
|
431
|
+
| `external_capture_device_action` | string \| null | 'NO_ACTION'\|'REVIEW'\|'DECLINE' | Verdict when an external capture device is detected. |
|
|
432
|
+
| `face_audio_recording_enabled` | boolean \| null | boolean | Record the microphone during the selfie capture, so a reviewer can hear the session. Off by default. |
|
|
433
|
+
| `face_liveness_duplicated_face_document_mismatch_action` | string \| null | 'NO_ACTION'\|'REVIEW'\|'DECLINE' | Verdict when a duplicate face is found on a user verified with a different date of birth. Another document of the same person (a passport after an identity card, a renewal, a document of a second country) is not flagged. |
|
|
434
|
+
| `face_liveness_duplicated_face_name_mismatch_action` | string \| null | 'NO_ACTION'\|'REVIEW'\|'DECLINE' | Verdict when a duplicate face is found under a different name. |
|
|
435
|
+
| `face_liveness_flash_mode` | string \| null | string | |
|
|
436
|
+
| `face_liveness_max_attempts` | integer \| null | integer >=1 <=3 | |
|
|
437
|
+
| `face_liveness_method` | string \| null | 'ACTIVE_3D'\|'FLASHING'\|'PASSIVE' | |
|
|
438
|
+
| `face_liveness_mode` | string \| null | string | |
|
|
439
|
+
| `face_liveness_multiple_faces_action` | string \| null | 'NO_ACTION'\|'REVIEW'\|'DECLINE' | Verdict when more than one face is present in the capture. |
|
|
440
|
+
| `face_liveness_possible_duplicated_face_action` | string \| null | 'NO_ACTION'\|'REVIEW'\|'DECLINE' | Verdict when this face matches a previously seen user. |
|
|
441
|
+
| `face_liveness_score_decline_threshold` | integer \| null | integer >=0 <=100 | |
|
|
442
|
+
| `face_liveness_score_review_threshold` | integer \| null | integer >=0 <=100 | |
|
|
443
|
+
| `face_liveness_uncertain_retry_enabled` | boolean \| null | boolean | Native SDK active liveness only. On, a capture whose liveness score falls strictly between face_liveness_score_decline_threshold and face_liveness_score_review_threshold is never decided, whichever verdict the engine attached to it: the person is told the result was unclear and asked to capture again, every time, outside the face_liveness_max_attempts budget (which still applies to captures the engine could not score). Off by default; the web flow ignores it. |
|
|
444
|
+
| `face_liveness_video_anomaly_action` | string \| null | 'NO_ACTION'\|'REVIEW'\|'DECLINE' | Verdict when the stored liveness recording contains a repeated moving sequence consistent with a looped video feed, measured server-side from the video itself, independently of the liveness score. It deliberately does NOT flag a frozen or near-motionless capture: frame statistics cannot separate an injected still from a genuine one (a subject holding still, or a flash that clips the exposure), so acting on that would decline real users. A frozen or pre-recorded injected feed is instead defeated by strict flash liveness (set face_liveness_flash_mode to "1" for strict), which binds the capture to a per-session colour-sequence challenge a recording cannot reproduce. Defaults to NO_ACTION (evidence is recorded, the verdict is unchanged). |
|
|
445
|
+
| `face_luminance_max_action` | string \| null | 'NO_ACTION'\|'REVIEW'\|'DECLINE' | Verdict when the selfie is brighter than `face_luminance_max_threshold`. |
|
|
446
|
+
| `face_luminance_max_threshold` | integer \| null | integer >=0 <=100 | |
|
|
447
|
+
| `face_luminance_min_action` | string \| null | 'NO_ACTION'\|'REVIEW'\|'DECLINE' | Verdict when the selfie is darker than `face_luminance_min_threshold`. |
|
|
448
|
+
| `face_luminance_min_threshold` | integer \| null | integer >=0 <=100 | |
|
|
449
|
+
| `face_privacy_mode_enabled` | boolean \| null | boolean | |
|
|
450
|
+
| `face_quality_decline_threshold` | integer \| null | integer >=0 <=100 | |
|
|
451
|
+
| `face_quality_review_threshold` | integer \| null | integer >=0 <=100 | |
|
|
452
|
+
| `face_search_enabled` | boolean \| null | boolean | Run the 1:N Face Search on the selfie: match it against previously verified users, the face blocklist and allowlist, and store its biometric template for later matching. On by default. Off skips the search, keeps no face template, and leaves the duplicate-face actions with nothing to act on. |
|
|
453
|
+
| `frame_injection_action` | string \| null | 'NO_ACTION'\|'REVIEW'\|'DECLINE' | Verdict when injected video frames are detected. |
|
|
454
|
+
| `race_map_similarity_thresholds` | json | {"<race>": {"possible": 0-100, "high": 0-100}} | Per-demographic overrides of the face-similarity bands used against the allow-list and duplicate-face sets, so match rates stay even across groups. `possible` is the lower band (defaults to 62) and `high` the upper (68); a group with no entry uses those defaults. |
|
|
455
|
+
| `screen_capture_action` | string \| null | 'NO_ACTION'\|'REVIEW'\|'DECLINE' | Verdict when the selfie is a photo of a screen. |
|
|
456
|
+
| `status_rules` | array | array | |
|
|
457
|
+
| `virtual_camera_action` | string \| null | 'NO_ACTION'\|'REVIEW'\|'DECLINE' | Verdict when a virtual camera feed is detected. |
|
|
458
|
+
|
|
459
|
+
### NFC
|
|
460
|
+
|
|
461
|
+
Configuration for NFC/ePassport feature.
|
|
462
|
+
|
|
463
|
+
| Key | Type | Accepts | Meaning |
|
|
464
|
+
| --- | --- | --- | --- |
|
|
465
|
+
| `allow_nfc_skip` | boolean \| null | boolean | |
|
|
466
|
+
| `skip_nfc_action` | string \| null | 'NO_ACTION'\|'REVIEW'\|'DECLINE' | Verdict when the user skips the NFC chip read (only reachable with `allow_nfc_skip`). |
|
|
467
|
+
| `status_rules` | array | array | |
|
|
468
|
+
| `trust_anchor_missing_action` | string \| null | 'NO_ACTION'\|'REVIEW'\|'DECLINE' | Verdict when chip data-group hashes are intact but the certificate chain cannot be verified because the issuing country's CSCA trust anchor is not loaded. |
|
|
469
|
+
| `unverified_chip_action` | string \| null | 'NO_ACTION'\|'REVIEW'\|'DECLINE' | Verdict when the chip is read but its signature cannot be verified. |
|
|
470
|
+
|
|
471
|
+
### OCR
|
|
472
|
+
|
|
473
|
+
Configuration for OCR/ID Verification feature.
|
|
474
|
+
> Omitting `documents_allowed` stores the full country/document catalog, so the node accepts everything. Put OCR before any feature that reads identity data from the document (FACE_MATCH, NFC, DATABASE_VALIDATION).
|
|
475
|
+
|
|
476
|
+
| Key | Type | Accepts | Meaning |
|
|
477
|
+
| --- | --- | --- | --- |
|
|
478
|
+
| `age_restrictions_by_country` | json \| null | {"<ISO3>": {"minimum_age": 1-120, "maximum_age": 1-120\|null, "states"?: {"<STATE_CODE>": {"minimum_age": 1-120, "maximum_age": 1-120\|null}}}} | Per-country (and optionally per-state) age gate. `minimum_age` is required for every country listed; `maximum_age` may be null. |
|
|
479
|
+
| `critical_field_occlusion_action` | string \| null | 'NO_ACTION'\|'REVIEW'\|'DECLINE' | Verdict when a critical printed field - an identity number, a name, the date of birth or the expiry date - was physically covered on the captured document. Defaults to REVIEW. |
|
|
480
|
+
| `cross_org_fraud_document_action` | string \| null | 'NO_ACTION'\|'REVIEW'\|'DECLINE' | Verdict when this document was flagged as fraudulent by another organization in the network. |
|
|
481
|
+
| `document_audio_recording_enabled` | boolean \| null | boolean | Record the microphone during document capture, so a reviewer can hear the session. Off by default. |
|
|
482
|
+
| `document_blur_fields_by_country` | json \| null | {"<ISO3>": ["<blur_field_name>", ...]} | Fields to blur out of the stored document image, per country. Only fields the country's document layout supports are accepted. |
|
|
483
|
+
| `document_liveness_portrait_replace_decline_threshold` | integer \| null | integer >=0 <=100 | |
|
|
484
|
+
| `document_liveness_portrait_replace_review_threshold` | integer \| null | integer >=0 <=100 | |
|
|
485
|
+
| `document_liveness_printed_copy_decline_threshold` | integer \| null | integer >=0 <=100 | |
|
|
486
|
+
| `document_liveness_printed_copy_review_threshold` | integer \| null | integer >=0 <=100 | |
|
|
487
|
+
| `document_liveness_screen_replay_decline_threshold` | integer \| null | integer >=0 <=100 | |
|
|
488
|
+
| `document_liveness_screen_replay_review_threshold` | integer \| null | integer >=0 <=100 | |
|
|
489
|
+
| `document_or_personal_number_format_mismatch_action` | string \| null | 'NO_ACTION'\|'REVIEW'\|'DECLINE' | Verdict when the document or personal number does not match the country's expected format. |
|
|
490
|
+
| `document_selfie_duplicated_face_action` | string \| null | 'NO_ACTION'\|'REVIEW'\|'DECLINE' | Verdict when the document-capture selfie matches, or possibly matches, the face of a user already verified in this application. |
|
|
491
|
+
| `document_selfie_duplicated_face_document_mismatch_action` | string \| null | 'NO_ACTION'\|'REVIEW'\|'DECLINE' | Verdict when the document-capture selfie matches a user already verified with a different date of birth. Another document of the same person (a passport after an identity card, a renewal, a document of a second country) is not flagged. Can only escalate document_selfie_duplicated_face_action. |
|
|
492
|
+
| `document_selfie_duplicated_face_name_mismatch_action` | string \| null | 'NO_ACTION'\|'REVIEW'\|'DECLINE' | Verdict when the document-capture selfie matches a user already verified under a different name. Can only escalate document_selfie_duplicated_face_action. |
|
|
493
|
+
| `document_selfie_face_search_enabled` | boolean \| null | boolean | Run the 1:N Face Search on the selfie taken during document capture (needs is_document_selfie_portrait_match_enabled): match it against the face blocklist and previously verified users. The selfie is a probe only, its template is never stored. On by default. Off skips the search and leaves the document-selfie duplicate-face actions with nothing to act on; face_search_enabled off on the LIVENESS step skips it too, since that opt-out covers every selfie of the session. |
|
|
494
|
+
| `document_selfie_portrait_match_decline_threshold` | integer \| null | integer >=0 <=100 | |
|
|
495
|
+
| `document_selfie_portrait_match_review_threshold` | integer \| null | integer >=0 <=100 | |
|
|
496
|
+
| `document_without_portrait_action` | string \| null | 'NO_ACTION'\|'REVIEW'\|'DECLINE' | Verdict when the scanned document family carries no portrait on any side. Node-config only - there is no account-level setting; the runtime default is REVIEW. |
|
|
497
|
+
| `documents_allowed` | json \| null | {"<ISO3>": {"<DOC_CODE>": {"enabled": 0\|1, "sides"?: 1\|2, "subtypes"?: ["<SUBTYPE_CODE>", ...]}}} | Which identity documents are accepted, per issuing country. Omit the key entirely to accept the full catalog; an empty object means the same thing. At least one document must end up enabled or the save is rejected. |
|
|
498
|
+
| `duplicated_user_action` | string \| null | 'NO_ACTION'\|'REVIEW'\|'DECLINE' | Verdict when the identity was already verified for this application. |
|
|
499
|
+
| `expected_details_mismatch_action` | string \| null | 'NO_ACTION'\|'REVIEW'\|'DECLINE' | Verdict when the extracted identity contradicts the `expected_details` sent with the session. |
|
|
500
|
+
| `expiration_date_not_detected_action` | string \| null | 'NO_ACTION'\|'REVIEW'\|'DECLINE' | Verdict when no expiry date could be read from the document. |
|
|
501
|
+
| `id_document_quality_threshold` | integer \| null | integer >=0 <=100 | |
|
|
502
|
+
| `id_verification_max_retry_attempts` | integer \| null | integer >=2 <=5 | |
|
|
503
|
+
| `id_verification_name_match_score_threshold` | integer \| null | integer >=0 <=100 | |
|
|
504
|
+
| `image_capture_methods_allowed` | array \| null | ["CAMERA_SCAN" \| "UPLOAD", ...] | Capture methods the end user may use for the document photo. Declared as a list of free strings, so the vocabulary is not in the field itself: CAMERA_SCAN (live capture) and UPLOAD (pick an existing file). An empty list falls back to the account default. |
|
|
505
|
+
| `image_quality_too_low_action` | string \| null | 'NO_ACTION'\|'REVIEW'\|'DECLINE' | Verdict when overall document image quality is below the bar. |
|
|
506
|
+
| `image_too_blurry_action` | string \| null | 'NO_ACTION'\|'REVIEW'\|'DECLINE' | Verdict when the captured document image is too blurry to trust. |
|
|
507
|
+
| `image_too_bright_action` | string \| null | 'NO_ACTION'\|'REVIEW'\|'DECLINE' | Verdict when the captured document image is overexposed. |
|
|
508
|
+
| `image_too_dark_action` | string \| null | 'NO_ACTION'\|'REVIEW'\|'DECLINE' | Verdict when the captured document image is underexposed. |
|
|
509
|
+
| `inconsistent_data_action` | string \| null | 'NO_ACTION'\|'REVIEW'\|'DECLINE' | Verdict when the document's own fields contradict each other. |
|
|
510
|
+
| `invalid_code_action` | string \| null | 'NO_ACTION'\|'REVIEW'\|'DECLINE' | Verdict when a document check digit or barcode fails validation. |
|
|
511
|
+
| `invalid_mrz_action` | string \| null | 'NO_ACTION'\|'REVIEW'\|'DECLINE' | Verdict when the machine-readable zone is missing or inconsistent. |
|
|
512
|
+
| `invalid_validation_action` | string \| null | 'NO_ACTION'\|'REVIEW'\|'DECLINE' | Verdict when a document authenticity validation fails. |
|
|
513
|
+
| `is_age_restrictions_enabled` | boolean \| null | boolean | |
|
|
514
|
+
| `is_document_selfie_portrait_match_enabled` | boolean \| null | boolean | |
|
|
515
|
+
| `is_image_capture_review_screen_enabled` | boolean \| null | boolean | Show the user a review screen after each document capture, letting them retake the photo before it is submitted. Off by default. |
|
|
516
|
+
| `is_ocr_id_verification_data_review_enabled` | boolean \| null | boolean | Let the user review and correct the extracted identity data before the step completes. Off by default. A correction is scored against `ocr_id_verification_data_review_critical_fields`, and a disagreement takes the critical or the minor action accordingly. The review still runs when the workflow includes NFC - a later chip read simply supersedes it. |
|
|
517
|
+
| `maximum_age` | integer \| null | integer >=1 <=120 | |
|
|
518
|
+
| `maximum_age_action` | string \| null | 'NO_ACTION'\|'REVIEW'\|'DECLINE' | Verdict when the holder is older than `maximum_age`. |
|
|
519
|
+
| `methods` | json \| null | {"<ISO3>": {"document": {"enabled": bool}, "id_lookup": {"enabled": bool, "source"?: "<source_id>"\|null, "max_attempts": 1-5, "skip_liveness_and_face_match": bool, "on_partial_match": "fallback_to_document"\|"decline", "on_no_match": "fallback_to_document"\|"decline", "on_provider_error": "fallback_to_document"\|"decline", "response_fields"?: ["<field_key>", ...]}, "wallet": {"enabled": bool, "providers": ["<wallet_id>", ...], "on_failure": "fallback_to_document"\|"decline"}}} | Which ID verification methods each country may use: document capture (today's behaviour), non-doc lookup against a government or other authoritative source, and digital identity wallets. Omit the key, or a country, or a method, and that country is document only. Every method must be available for the country in the capability catalog (GET workflow-graph/id-verification-methods-catalog/); wallets are an accept-list with no ordering. Each fallback is `fallback_to_document` or `decline`; `max_attempts` (1-5, default 1) counts only lookups the registry answered. Where the catalog lists several lookup `sources` for a country, `source` picks exactly one by id; omitted means the country's default (the first listed). |
|
|
520
|
+
| `minimum_age` | integer \| null | integer >=1 <=120 | |
|
|
521
|
+
| `minimum_age_action` | string \| null | 'NO_ACTION'\|'REVIEW'\|'DECLINE' | Verdict when the holder is younger than `minimum_age`. |
|
|
522
|
+
| `ocr_id_verification_data_review_critical_fields` | array \| null | ["first_name" \| "last_name" \| "date_of_birth" \| ...] | Which extracted identity fields count as critical when the user edits the OCR result, so a mismatch takes the critical action rather than the minor one. |
|
|
523
|
+
| `ocr_id_verification_data_review_critical_mismatch_action` | string \| null | 'REVIEW'\|'DECLINE' | Verdict when the user's edit disagrees with OCR on a critical field. |
|
|
524
|
+
| `ocr_id_verification_data_review_minor_mismatch_action` | string \| null | 'NO_ACTION'\|'REVIEW'\|'DECLINE' | Verdict when the user's edit disagrees with OCR on a non-critical field. |
|
|
525
|
+
| `status_rules` | array | array | |
|
|
526
|
+
| `unparsed_address_action` | string \| null | 'NO_ACTION'\|'REVIEW'\|'DECLINE' | Verdict when the document address could not be parsed into components. |
|
|
527
|
+
|
|
528
|
+
### PHONE_VERIFICATION
|
|
529
|
+
|
|
530
|
+
Configuration for Phone Verification feature.
|
|
531
|
+
|
|
532
|
+
| Key | Type | Accepts | Meaning |
|
|
533
|
+
| --- | --- | --- | --- |
|
|
534
|
+
| `code_size` | integer \| null | integer >=4 <=8 | |
|
|
535
|
+
| `cross_org_fraud_phone_action` | string \| null | 'NO_ACTION'\|'REVIEW'\|'DECLINE' | Verdict when this number was flagged as fraudulent by another organization in the network. |
|
|
536
|
+
| `disposable_number_action` | string \| null | 'NO_ACTION'\|'REVIEW'\|'DECLINE' | Verdict when the number belongs to a disposable-number provider. |
|
|
537
|
+
| `duplicated_phone_number_action` | string \| null | 'NO_ACTION'\|'REVIEW'\|'DECLINE' | Verdict when the number was already verified for this application. |
|
|
538
|
+
| `fallback_to_native` | boolean \| null | boolean | |
|
|
539
|
+
| `high_risk_phone_action` | string \| null | 'REVIEW'\|'DECLINE' | Verdict when the number carries a high risk signal. |
|
|
540
|
+
| `low_phone_trust_action` | string \| null | 'NO_ACTION'\|'REVIEW'\|'DECLINE' | Verdict when the trust index is below `phone_trust_index_threshold`. |
|
|
541
|
+
| `phone_enrichment_enabled` | boolean \| null | boolean | |
|
|
542
|
+
| `phone_intelligence_score_action` | string \| null | 'NO_ACTION'\|'REVIEW'\|'DECLINE' | Verdict when the enrichment score is worse than `phone_intelligence_score_threshold`. |
|
|
543
|
+
| `phone_intelligence_score_threshold` | integer \| null | integer >=0 <=100 | |
|
|
544
|
+
| `phone_max_check_attempts` | integer \| null | integer >=1 <=5 | |
|
|
545
|
+
| `phone_max_retries` | integer \| null | integer >=1 <=5 | |
|
|
546
|
+
| `phone_no_social_presence_action` | string \| null | 'NO_ACTION'\|'REVIEW'\|'DECLINE' | Verdict when the social footprint check (`phone_social_enabled`) finds the number registered on none of the platforms it covers. |
|
|
547
|
+
| `phone_shared_device_mode` | boolean \| null | boolean | |
|
|
548
|
+
| `phone_social_enabled` | boolean \| null | boolean | |
|
|
549
|
+
| `phone_trust_index_threshold` | integer \| null | integer >=0 <=100 | |
|
|
550
|
+
| `phone_type_risk_action` | string \| null | 'NO_ACTION'\|'REVIEW'\|'DECLINE' | Verdict when the line type itself is considered risky. |
|
|
551
|
+
| `phone_verification_countries` | json \| null | {"<ISO2>": {"<channel: sms\|whatsapp\|telegram\|rcs\|viber\|zalo>": {"enabled": true\|false, "max_retries": <int>} \| true\|false}} | Which countries and delivery channels the one-time code may be sent through. It is a WHITELIST: a country absent from the map is not offered at all, and a channel absent from a listed country is skipped. `max_retries` overrides the node-level retry cap for that one channel. A bare boolean is the legacy form and still means enabled/disabled with the node-level cap. |
|
|
552
|
+
| `provider_key` | string \| null | string | |
|
|
553
|
+
| `recent_port_action` | string \| null | 'NO_ACTION'\|'REVIEW'\|'DECLINE' | Verdict when the number was ported to a new carrier recently. |
|
|
554
|
+
| `status_rules` | array | array | |
|
|
555
|
+
| `voip_number_action` | string \| null | 'NO_ACTION'\|'REVIEW'\|'DECLINE' | Verdict when the number is VoIP rather than a real subscriber line. |
|
|
556
|
+
|
|
557
|
+
### PROOF_OF_ADDRESS
|
|
558
|
+
|
|
559
|
+
Configuration for Proof of Address feature.
|
|
560
|
+
|
|
561
|
+
| Key | Type | Accepts | Meaning |
|
|
562
|
+
| --- | --- | --- | --- |
|
|
563
|
+
| `poa_document_authenticity_action` | string \| null | 'NO_ACTION'\|'REVIEW'\|'DECLINE' | Verdict when the document fails authenticity checks. |
|
|
564
|
+
| `poa_document_issues_action` | string \| null | 'NO_ACTION'\|'REVIEW'\|'DECLINE' | Verdict when the document is damaged, cropped or otherwise unusable. |
|
|
565
|
+
| `poa_documents_allowed` | json \| null | {"<ISO3>": {"<DOC_CODE>": {"enabled": 0\|1, "sides"?: 1\|2, "subtypes"?: ["<SUBTYPE_CODE>", ...]}}} | Which proof-of-address documents are accepted, per issuing country. Same shape as OCR's `documents_allowed`; omit to accept the full catalog. |
|
|
566
|
+
| `poa_issue_date_not_detected_action` | string \| null | 'NO_ACTION'\|'REVIEW'\|'DECLINE' | Verdict when no issue date could be read from the document. |
|
|
567
|
+
| `poa_issuer_not_identified_action` | string \| null | 'NO_ACTION'\|'REVIEW'\|'DECLINE' | Verdict when the issuing company or authority cannot be identified. |
|
|
568
|
+
| `poa_languages_allowed` | json \| null | {"<language_code>": 0\|1} | Languages the proof-of-address document may be written in, as a flag per language code. Omit to accept every supported language. |
|
|
569
|
+
| `poa_max_attempts_exceeded_action` | string \| null | 'NO_ACTION'\|'REVIEW'\|'DECLINE' | Verdict when the user runs out of `poa_max_retry_attempts`. |
|
|
570
|
+
| `poa_max_retry_attempts` | integer \| null | integer >=2 <=5 | |
|
|
571
|
+
| `poa_name_match_score_threshold` | integer \| null | integer >=0 <=100 | |
|
|
572
|
+
| `poa_name_or_address_mismatch_action` | string \| null | 'NO_ACTION'\|'REVIEW'\|'DECLINE' | Verdict when the name or address on the document disagrees with the verified identity. |
|
|
573
|
+
| `poa_unparsable_or_invalid_address_action` | string \| null | 'NO_ACTION'\|'REVIEW'\|'DECLINE' | Verdict when the address on the document cannot be parsed or is not a real address. |
|
|
574
|
+
| `poa_unsupported_document_type_action` | string \| null | 'NO_ACTION'\|'REVIEW'\|'DECLINE' | Verdict when the uploaded document is not one of `poa_documents_allowed`. |
|
|
575
|
+
| `poa_unsupported_language_action` | string \| null | 'NO_ACTION'\|'REVIEW'\|'DECLINE' | Verdict when the document language is not one of `poa_languages_allowed`. |
|
|
576
|
+
| `status_rules` | array | array | |
|
|
577
|
+
|
|
578
|
+
### QUESTIONNAIRE
|
|
579
|
+
|
|
580
|
+
Configuration for Questionnaire feature.
|
|
581
|
+
|
|
582
|
+
| Key | Type | Accepts | Meaning |
|
|
583
|
+
| --- | --- | --- | --- |
|
|
584
|
+
| `questionnaire_uuid` | uuid \| null | uuid | |
|
|
585
|
+
| `review_questionnaire_manually` | boolean \| null | boolean | |
|
|
586
|
+
| `status_rules` | array | array | |
|
|
587
|
+
|
|
588
|
+
<!-- END GENERATED FEATURE CONFIG REFERENCE -->
|
|
589
|
+
|
|
590
|
+
## Contributing
|
|
591
|
+
|
|
592
|
+
The feature-config contract above is generated - never hand-write a config key into a tool description. See [`CONTRIBUTING.md`](CONTRIBUTING.md) for the regeneration workflow and the checks that enforce it.
|
|
593
|
+
|
|
594
|
+
Issues and PRs welcome — see [`CONTRIBUTING.md`](CONTRIBUTING.md). Run the hosted server at [`mcp.didit.me/mcp`](https://mcp.didit.me/mcp), or self-host from this repo (Docker / Node) — see [**Run it yourself**](#run-it-yourself).
|
|
239
595
|
|
|
240
596
|
## License
|
|
241
597
|
|
|
242
|
-
MIT
|
|
598
|
+
[MIT](LICENSE) © Didit Protocol
|