Configuration Options
| Parameter | Type | Required | Description | Default |
|---|---|---|---|---|
journeyToken | string | Yes | Token from Create Journey API | — |
language | string | No | UI language: en, ar, ru, fr, zh, it, tr, uk | "en" |
theme | string | No | UI theme: light, dark, system | "system" |
apiDomain | string | No | API domain for the journey | Window origin |
privacyPolicyUrl | string | No | URL to your privacy policy | null |
logoUrl | string | No | URL to your logo | UAE KYC logo |
accentColor | string | No | Hex color code for UI accent | — |
docCaptureCamFacingMode | string | No | Camera mode: user, environment | undefined |
Status Codes
| Status | Value | Description |
|---|---|---|
Cancelled | 0 | User cancelled the journey |
DocumentVerificationFailed | 1 | Document verification failed |
FaceVerificationFailed | 2 | Face verification failed |
Expired | 3 | Journey token or session expired |
Error | 4 | An error occurred |
Success | 5 | Journey completed successfully |
Unknown | 6 | Unknown status |
Blocked | 7 | Journey blocked due to multiple failed attempts — see Journey Blocking |
Error Codes
| Error Code | Value | Description |
|---|---|---|
LoggerInit | 1 | Logger initialization failed |
Init | 2 | SDK initialization error |
Consent | 3 | Error during consent step |
DocumentSelection | 4 | Error during document selection |
EidFrontSideUpload | 5 | Emirates ID front upload failed |
EidBackSideUpload | 6 | Emirates ID back upload failed |
GccIdFrontSideUpload | 7 | GCC ID front upload failed |
GccIdBackSideUpload | 8 | GCC ID back upload failed |
PassportUpload | 9 | Passport upload failed |
DocumentVerification | 10 | Document verification error |
FaceUpload | 11 | Face image upload failed |
Finalize | 12 | Journey finalization error |
Unknown | 13 | Unknown error |
Internal | 14 | Internal SDK error |
FormSubmission | 15 | Form submission error |
EmiratesIdSubmission | 16 | Emirates ID submission error |
Panic | 17 | SDK internal error — message contains panic details |
LivenessInit | 18 | Face capture / liveness service initialization failed — message contains error details |
Troubleshooting
- Journey token invalid or expired: Generate a new token from the Create Journey API
- Container not found: Ensure
<div id="uae-kyc-container"></div>exists in the DOM before callingstartJourney - SDK fails to load: Confirm the script URL is correct and the file is served over HTTPS
- CORS errors: Ensure proper CORS headers are configured on your CDN or server
- Self-hosting: Mirror all files in the SDK version directory — not just the main JS file — with correct relative paths
- Camera not working: The SDK requires HTTPS in production for camera access