Appendix
Reference tables that apply across the API.
Glossary
| Term | Description |
|---|---|
| apiKey | Public credential identifying your tenant. Included in every API request URL. |
| apiSecret | Private signing key for HMAC-SHA256 signatures. Never expose publicly. |
| executionId |
Unique workflow execution instance identifier. Generated by
workflow.apply.submit.
|
| callbackKey | Identifies a specific node waiting for input. Each node has a unique callbackKey. |
| requestId | Per-API-call tracking ID for support and debugging. |
| referenceId | Your own tracking ID, passed through for audit trail and correlation. |
| domainId |
Business unit identifier within your tenant (via
x-domain header).
|
| nodeType | Type of workflow node waiting for input. Determines which submission API to call. |
| crpPid | Connected Related Party identifier in KYB workflows. Links liveness, docs, forms to a CRP. |
| JSON string field |
Fields like personData, scores,
images, formData expect a JSON-encoded
string, not a nested object.
|
Execution Statuses
Engineering confirmation pending: the source KYC and appendix tables use
CANCELLED, while the Workflow Lifecycle reference uses CANCELED. The cancellation row below preserves the appendix spelling and does not establish the exact API enum. Confirm the returned value with WIDTH engineering before implementing cancellation-specific comparisons.
These are the execution-level statuses. For server-side integrations the
Case-level decision dimension (caseStatus) is documented in
Workflow Lifecycle API → Status & Case Decision.
| Status | Terminal? | Description |
|---|---|---|
CREATED |
No | Created, not yet started |
RUNNING |
No | Currently executing |
WAITING |
No | Waiting for external input |
COMPLETED |
Yes | Successfully completed |
FAILED |
Yes | Execution failed |
TIMEOUT |
Yes | Execution timed out |
CANCELLED |
Yes | Execution cancelled |
Event Types
Engineering confirmation pending: the guide lists
PERIODIC_FLOW_EVENT here and in continuous monitoring, but omits it from the workflow submission event list. This row preserves the documented monitoring event; acceptance by workflow.apply.submit remains unconfirmed.| eventType | Mode | Description |
|---|---|---|
KYC_EVENT |
Async | Individual customer onboarding. Shown as KYC in the Console. |
KYB_EVENT |
Async | Corporate customer onboarding. Shown as KYB in the Console. |
TRANSACTION_EVENT |
Sync / Async | Transaction screening |
WEB3_TRANSACTION_EVENT |
Sync / Async | Web3 / on-chain transaction screening (KYT) |
PERIODIC_FLOW_EVENT |
Async | Continuous monitoring |
MANUAL_CASE_EVENT |
Async | Name screening — submits a subject to the workflow, raising alerts and creating a case for manual review. Shown as Manual in the Console. |
Document Types
| Code | Description |
|---|---|
NATIONAL_ID |
National identity card |
INTERNATIONAL_PASSPORT |
International passport |
DRIVING_LICENCE |
Driving licence |
RESIDENCE_PERMIT |
Residence permit |
UTILITY_TELEPHONE_BILL |
Utility / telephone bill |
BANK_STATEMENT |
Bank statement |
CUSTOMER_ACCEPTANCE_FORM |
Customer acceptance form |
SELF_IMAGE |
Self-portrait / selfie |
Changelog
| Version | Date | Changes |
|---|---|---|
| 1.2 | 2026-09-11 |
Mobile SDK versions aligned to the production release: iOS
1.0.11 / Android 1.0.11 / Flutter 1.0.2. Credentials reduced to
domain + sdkToken
(appId / apiKey are now encoded inside
the token). iOS requires
NSSpeechRecognitionUsageDescription. Android requires
minSdk 26, compileSdk 36, core library
desugaring, and
android.uniquePackageNames=false on AGP 9. New
optional language parameter on all three platforms,
and an optional eventType parameter on Android and
Flutter.
|
| 1.1.1 | 2026-06-14 |
Android Permissions section corrected: the bundled OCR engines
(Veriff, Regula) transitively merge RECORD_AUDIO,
NFC, WAKE_LOCK, VIBRATE and
FLASHLIGHT. Runtime (dangerous) permissions are now
CAMERA and RECORD_AUDIO; every
permission must be reflected in the Google Play Data Safety
disclosure.
|
| 1.1 | 2026-06-14 |
Added Flutter SDK chapter. iOS public type names
Width* → WIDTH* (1.0.5) and
microphone (NSMicrophoneUsageDescription) now
required. SDK versions aligned: iOS 1.0.5 / Android 1.0.2 /
Flutter 1.0.1.
|
| 1.0 | 2026-04-17 | Initial release — OpenAPI Reference, Android SDK, iOS SDK |