KodexakodéxaShieldAPI Reference
https://shield.kodexa.systems/apiPortal →
Identity Layer

eKYC-AI

Coming soon

Digital-only identity verification with no human touch required. Liveness detection, NFC chip reading and government database verification for fully automated onboarding.

This plugin is in development. The API schema below is planned and subject to change. You can design your integration now using this reference.

Endpoint

POST/api/ekyc/verify

Request parameters

ParameterTypeRequiredDescription
customer_idstringYesYour internal reference for this customer.
jurisdictionstringYesOne of: CA, AE, SA.
document_datastringYesBase64-encoded identity document.
liveness_datastringYesBase64-encoded liveness video or image sequence.
nfc_dataobjectNoNFC chip data from ePassport if available.

Response fields

ParameterTypeRequiredDescription
data.statusstringYesapproved, rejected, or review_required.
data.liveness_passedbooleanYesWhether liveness detection passed.
data.government_verifiedbooleanYesWhether verified against government database.
data.confidence_scoreintegerYesAI confidence 0–100.

cURL

# Coming soon
curl -X POST \
  https://shield.kodexa.systems/api/ekyc/verify \
  -H "Content-Type: application/json" \
  -d '{...}'

Code examples available when plugin launches