Create Journey URL API

Overview

Creates a secure, one-time use verification URL that can be shared with end-users via email, SMS, WhatsApp, or any communication channel. The API returns a remoteVerificationId to track the verification status and a URL path that users can access to complete their KYC verification on any device with a browser.

Request Headers

Header	Required	Description
`Content-Type`	Yes	Must be `application/json`
`x-transaction-key`	Yes	Your API key

Request Parameters

journeyType (Required)

Value	Description
`REMOTE_ONBOARDING`	KYC verification for new customers
`REMOTE_REKYC`	Re-verification for existing customers

identificationDetails (Optional)

Pre-populate verification with known customer information. Only one of these should be provided:

Document Type	Fields
Emirates ID	`emiratesIdNumber`
Passport	`passportDetails.passportNumber`, `passportDetails.passportType`, `passportDetails.nationality`
GCC ID	`gccDetails.idNumber`, `gccDetails.nationality`
UAE KYC ID	`uaeKycId`

linkExpiry (Optional)

Field	Type	Default	Description
`linkExpiry`	Integer	`86400`	URL expiry time in seconds (600-2592000)

sdkConfig (Optional)

Field	Type	Default	Options	Description
`verificationDomain`	String	-	Valid domain	Required. Your verification domain
`gestures`	Array	`-`	`["blink","smile"]`	Liveness detection gestures
`documentsAllowed`	Array	Org defaults	`["emirates_id", "passport", "gcc_id"]`	Allowed document types
`skipConsent`	Boolean	`false`	-	Skip consent screen
`skipResultPage`	Boolean	`false`	-	Skip result page
`accentColor`	String	`#CFB16C`	Hex color	Brand accent color
`theme`	String	`system`	`light`, `dark`, `system`	UI theme
`docCaptureCamFacingMode`	String	`user`	`user`, `environment`	Camera facing mode
`language`	String	`en`	`en`, `ar`, `ru`, `fr`, `zh`, `it`, `tr`, `uk`	Interface language
`logoUrl`	String	-	Valid URL	Organization logo
`privacyPolicyUrl`	String	-	Valid URL	Privacy policy link

Request Body

Choose the request body based on your document verification requirement:

No Document Passed
Emirates ID
Passport
GCC ID
UAE KYC ID

When documentsAllowed is not specified or contains multiple options, the end-user will see a document selection screen.

{
  "journeyType": "REMOTE_ONBOARDING",
  "linkExpiry": 3600,
  "sdkConfig": {
    "verificationDomain": "example.com",
    "gestures": ["blink"],
    "documentsAllowed": ["emirates_id"],
    "accentColor": "#000000",
    "theme": "system",
    "language": "en",
    "logoUrl": "https://example.com/logo.png",
    "privacyPolicyUrl": "https://example.com/privacy"
  }
}

User Experience: The end-user will be presented with a document selection screen where they can choose from Emirates ID, Passport, or GCC ID based on your organization’s enabled document types.

Restrict verification to Emirates ID only. Optionally pre-fill the Emirates ID number.

{
  "journeyType": "REMOTE_ONBOARDING",
  "identificationDetails": {
    "emiratesIdNumber": "784xxxxxxxxxxx"
  },
  "linkExpiry": 3600,
  "sdkConfig": {
    "verificationDomain": "example.com",
    "gestures": ["blink"],
    "accentColor": "#000000",
    "theme": "system",
    "language": "en",
    "logoUrl": "https://example.com/logo.png",
    "privacyPolicyUrl": "https://example.com/privacy"
  }
}

User Experience: The end-user will be taken directly to face verification.

Restrict verification to Passport only. Optionally pre-fill passport details.

{
  "journeyType": "REMOTE_ONBOARDING",
  "identificationDetails": {
    "passportDetails": {
      "passportNumber": "AB1234567",
      "passportType": "P",
      "nationality": "ARE"
    }
  },
  "linkExpiry": 3600,
  "sdkConfig": {
    "verificationDomain": "example.com",
    "gestures": ["blink"],
    "accentColor": "#000000",
    "theme": "system",
    "language": "en",
    "logoUrl": "https://example.com/logo.png",
    "privacyPolicyUrl": "https://example.com/privacy"
  }
}

User Experience: The end-user will be taken directly to face verification.

Restrict verification to GCC ID only. Optionally pre-fill GCC ID details.

{
  "journeyType": "REMOTE_ONBOARDING",
  "identificationDetails": {
    "gccDetails": {
      "idNumber": "123456789",
      "nationality": "SAU"
    }
  },
  "linkExpiry": 3600,
  "sdkConfig": {
    "verificationDomain": "example.com",
    "gestures": ["blink"],
    "accentColor": "#000000",
    "theme": "system",
    "language": "en",
    "logoUrl": "https://example.com/logo.png",
    "privacyPolicyUrl": "https://example.com/privacy"
  }
}

User Experience: The end-user will be taken directly to face verification.

Use a previously completed UAE KYC verification ID to link the new journey.

{
  "journeyType": "REMOTE_REKYC",
  "identificationDetails": {
    "uaeKycId": "1234"
  },
  "linkExpiry": 3600,
  "sdkConfig": {
    "verificationDomain": "example.com",
    "gestures": ["blink"],
    "accentColor": "#000000",
    "theme": "system",
    "language": "en",
    "logoUrl": "https://example.com/logo.png",
    "privacyPolicyUrl": "https://example.com/privacy"
  }
}

User Experience: The end-user will be taken directly to face verification using the previously verified identity.

Response Fields

Field	Type	Description
`url`	String	Verification URL path
`remoteVerificationId`	String	Unique identifier for status tracking
`expiresAt`	Number	Expiration timestamp in milliseconds

Use the remoteVerificationId to track the verification status. Call the Get Verification Status API to monitor progress and retrieve the journeyToken once the user completes verification.

For more error codes, see Error Codes.

Authorizations

x-transaction-key

string

header

required

Body

application/json

No Document Passed
Emirates ID
Passport
GCC ID
UAE KYC ID

journeyType

enum<string>

default:REMOTE_ONBOARDING

required

Journey type: REMOTE_ONBOARDING for new customers, REMOTE_REKYC for re-verification.

Available options:

REMOTE_ONBOARDING,

REMOTE_REKYC

sdkConfig

object

required

Show child attributes

linkExpiry

integer

default:86400

URL expiry time in seconds (600-2592000). Default: 86400 (24 hours).

Response

Remote verification URL created successfully

status

string

Example:

"success"

message

string

Example:

"Remote verification URL created successfully"

data

object

Show child attributes

Overview

API Key Management

Journey APIs

Remote Verification

Certificate APIs

Validation APIs

Response Integrity

Create Journey URL API

Overview

Request Headers

Request Parameters

journeyType (Required)

identificationDetails (Optional)

linkExpiry (Optional)

sdkConfig (Optional)

Request Body

Response Fields

Authorizations

Body

Response

Overview

API Key Management

Journey APIs

Remote Verification

Certificate APIs

Validation APIs

Response Integrity

​Overview

​Request Headers

​Request Parameters

​journeyType (Required)

​identificationDetails (Optional)

​linkExpiry (Optional)

​sdkConfig (Optional)

​Request Body

​Response Fields

Authorizations

Body

Response

Overview

Request Headers

Request Parameters

journeyType (Required)

identificationDetails (Optional)

linkExpiry (Optional)

sdkConfig (Optional)

Request Body

Response Fields