KYC Identification

KYC Identification Endpoints

This section will display all available endpoints to get KYC data (Identification URL, Status).

Subsections of KYC Identification

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"
}

KYC Identification Status

KYC Identification Status (GET)

/gateway/threat-assessment/:version/kyc/:brand_id/identification/status

Parameters:

Name In Type Required Description
brand_id path int true Brand identifier
version path string true The API version to use.
x-auth-token header string false Player auth token from Login response
Identification-token header string false Identification token returned by Login or Identification Status

Note: Provide exactly one of the headers x-auth-token or Identification-token per request. Only one is required.

Response

Name Type Description
brand_id int The ID of the brand.
player_id int The ID of the player.
initialization_date string The date when the KYC process was initialized (YYYY-MM-DD HH:MM:SS).
initialized boolean Indicates if the KYC process has been initialized.
remaining_days int The number of days remaining for KYC completion. If 0, KYC is complete or expired.
id_status string The status of the identification (Approved, Pending, N/A, Rejected, Expired, Under Review).
poa_status string The status of the proof of address (Approved, Pending, N/A, Rejected, Expired, Under Review).
documents_required boolean Indicates if additional documents are required for KYC completion.
token string token to send as header Identification-token to the KYC Identification URL; empty string when documents_required is false

Status 200

{
  "status": "Success",
  "data": {
    "brand_id": 2,
    "player_id": 100,
    "initialization_date": "2024-01-15 10:30:00",
    "initialized": true,
    "remaining_days": 0,
    "id_status": "Approved",
    "poa_status": "Approved",
    "documents_required": false,
    "identification-token": ""
  }
}

Status 200 (Documents Required)

{
  "status": "Success",
  "data": {
    "brand_id": 2,
    "player_id": 102,
    "initialization_date": "2024-01-15 10:30:00",
    "initialized": true,
    "remaining_days": 12,
    "id_status": "Approved",
    "poa_status": "N/A",
    "documents_required": true,
    "identification-token": "35401810700b872c0ac8ccc3a8686291"
  }
}

Status 400

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

Status 401 - x-auth-token used

{
    "status": "Error",
    "data": {
        "errMsg": "invalid input - invalid token"
    },
    "message": "authentication failed",
    "userFriendlyMessage": "Authentication failed"
}

Status 401 - Identification-token used

{
    "status": "Error",
    "data": "",
    "message": "Unauthorized",
    "userFriendlyMessage": "token is not associated with any player"
}

Status 500

{
  "status": "Error",
  "data": null,
  "message": "Internal server error",
  "user_friendly_message": "Failed to get player identification status"
}