Skip to main content

e-KYC

Generate H5 e-KYC link

POST

API_URL/api/ekyc/verifications

HEADERS

client_id   9b16ae5638534ae1961fb370f874b6cc*

client_secret   sk_9b16ae5638534ae1961fb370f874b6cc*

Params

NameRequiredDescription
typeYes00 (OCR + FACE + LIVENESS ) or 01 (OCR Only)
id_countryYesCountry Code ( ISO-3166 alpha-3 format)
id_typeYesID_CARD or PASSPORT
redirect_urlYeslink to redirect after completion
wallet_addressNoTo update user wallet ekyc

Note: The maximum number of retry attempts is limited to 2 for OCR and 1 for Face Recognition.

Sample result
{
{
"status": 200,
"result": {
"url": "http://localhost:3001?token=4KK6FYHVZ...",
"token": "4KK6FYHVZ..."
}
}
}

Get e-KYC Verification

Get the e-KYC Details

GET

API_URL/api/ekyc/verifications/{token}

HEADERS

client_id   9b16ae5638534ae1961fb370f874b6cc*

client_secret   sk_9b16ae5638534ae1961fb370f874b6cc*

Sample result
{
"status": 200,
"result" : {
"id": 8,
"organisation_id": 31,
"type": "00",
"token": "4KK6FYHVZVN1OD9ZZK219XM0W57UD6",
"url": "http://localhost:3001?token=4KK6FYHVZVN1OD9ZZK219XM0W57UD6",
"redirect_url": "https://localhost",
"medias": null,
"ocr_country": "MYS",
"ocr_type": "ID_CARD",
"ocr_success": 0,
"ocr_result": null,
"face_id_success": 0,
"face_id_result": null,
"is_success": 0,
"latest_error": null,
"retries": 0,
"expire_at": "2024-09-10T08:16:31.000Z",
"created_at": "2024-09-10T08:01:31.000Z",
"updated_at": "2024-09-10T08:01:31.000Z"
}
}