KYC Identification URL

KYC Identification URL (GET)

/gateway/threat-assessment/{version}/kyc/{brand_id}/identification/url

Parameters:

Name In Type Required Description
version path string true The API version to use
brand_id path int true Brand identifier
Identification-token header string true MD5 hash token for identification(return on login response or on identification status response)
lang query string false Language code (default: en)

Note: There are 20 attempts allowed per identification journey within 24 hours, counted from the time of the first attempt.

Response

Name Type Description
journey_id string Unique identifier for the KYC journey
url string URL for KYC identification session
qr_code string QR code for KYC identification session (Base64 encoded)
session_id string Unique session identifier for KYC identification

Status 200

{
  "status": "Success",
  "data": {
    "journey_id": "test-journey-id",
    "url": "http://example.com/APIHandler/idshostSession/?sessionID=test-session-id&lang=en",
    "qr_code": "uhisdgfjasgjhgd",
    "session_id": "test-session-id"
  }
}

Status 400

{
  "status": "Error",
  "message": "Bad Request",
  "user_friendly_message": "token parameter is required for identification token validation"
}

> Status 403

```json
{
  "status": "Error",
  "message": "Journey is not allowed",
  "user_friendly_message": "Journey is not allowed for this player"
}

Status 429

{
  "status": "Error",
  "message": "Attempt limit reached",
  "user_friendly_message": "Attempt limit reached, please try again later"
}

Status 500

{
  "status": "Error",
  "data": null,
  "message": "Internal server error",
  "user_friendly_message": "Failed to get KYC ID scan URL"
}