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

Onboard-AI

Coming soon

Full onboarding orchestration — runs KYC, KYB, Sanctions and AML checks in sequence and returns a single onboarding decision with full audit trail.

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/onboard/start

Request parameters

ParameterTypeRequiredDescription
customer_idstringYesYour internal customer reference.
jurisdictionstringYesOne of: CA, AE, SA.
entity_typestringYesindividual or business.
document_datastringYesBase64-encoded identity document.
pluginsarrayNoPlugins to run: [kyc, sanctions, aml]. Defaults to all.

Response fields

ParameterTypeRequiredDescription
data.onboarding_statusstringYesapproved, rejected, or review_required.
data.plugin_resultsobjectYesResults from each plugin run: kyc, sanctions, aml.
data.overall_riskstringYesCombined risk level across all checks.
data.audit_idstringYesImmutable audit trail ID for this onboarding.

cURL

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

Code examples available when plugin launches