Appendix
Reference tables that apply across the API.
Glossary
| Term | Description |
apiKey | Public credential, sent in every API request URL. |
apiSecret | Private signing key. Never expose publicly. |
executionId | Unique workflow execution identifier. |
callbackKey | Identifies a node waiting for input. Drives idempotency. |
requestId | Per-call tracking ID. |
referenceId | Your custom tracking ID. |
domainId | Business-unit identifier, sent in x-domain header. |
nodeType | Workflow node type. Determines which API to call. |
crpPid | Connected Related Party identifier (KYB). |
| JSON string field | Field expecting a JSON-encoded string, not a nested object. |
Execution statuses
| 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
eventType | Mode | Description |
KYC_EVENT | Async | Individual customer onboarding |
KYB_EVENT | Async | Corporate customer onboarding |
TRANSACTION_EVENT | Sync / Async | Transaction screening |
PERIODIC_FLOW_EVENT | Async | Continuous monitoring |
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-05-14 | Web SDK: appKey renamed to apiKey; npm package renamed to @width/web-sdk; UMD build removed; browser minimums raised. Android: single dependency; added log forwarding. iOS: added onnxruntime.xcframework; added event logging. |
| 1.1 | 2026-05-12 | Added Web SDK guide; updated Android & iOS to v1.0.0; added per-block copy buttons. |
| 1.0 | 2026-04-17 | Initial release — OpenAPI, Android, iOS. |