Skip to main content

Appendix

Reference tables that apply across the API.

Glossary

TermDescription
apiKeyPublic credential, sent in every API request URL.
apiSecretPrivate signing key. Never expose publicly.
executionIdUnique workflow execution identifier.
callbackKeyIdentifies a node waiting for input. Drives idempotency.
requestIdPer-call tracking ID.
referenceIdYour custom tracking ID.
domainIdBusiness-unit identifier, sent in x-domain header.
nodeTypeWorkflow node type. Determines which API to call.
crpPidConnected Related Party identifier (KYB).
JSON string fieldField expecting a JSON-encoded string, not a nested object.

Execution statuses

StatusTerminalDescription
CREATEDNoCreated, not yet started
RUNNINGNoCurrently executing
WAITINGNoWaiting for external input
COMPLETEDYesSuccessfully completed
FAILEDYesExecution failed
TIMEOUTYesExecution timed out
CANCELLEDYesExecution cancelled

Event types

eventTypeModeDescription
KYC_EVENTAsyncIndividual customer onboarding
KYB_EVENTAsyncCorporate customer onboarding
TRANSACTION_EVENTSync / AsyncTransaction screening
PERIODIC_FLOW_EVENTAsyncContinuous monitoring

Document types

CodeDescription
NATIONAL_IDNational identity card
INTERNATIONAL_PASSPORTInternational passport
DRIVING_LICENCEDriving licence
RESIDENCE_PERMITResidence permit
UTILITY_TELEPHONE_BILLUtility / telephone bill
BANK_STATEMENTBank statement
CUSTOMER_ACCEPTANCE_FORMCustomer acceptance form
SELF_IMAGESelf-portrait / selfie

Changelog

VersionDateChanges
1.22026-05-14Web 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.12026-05-12Added Web SDK guide; updated Android & iOS to v1.0.0; added per-block copy buttons.
1.02026-04-17Initial release — OpenAPI, Android, iOS.