Risk Layer
Onboard-AI
Coming soonFull 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/startRequest parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
customer_id | string | Yes | Your internal customer reference. |
jurisdiction | string | Yes | One of: CA, AE, SA. |
entity_type | string | Yes | individual or business. |
document_data | string | Yes | Base64-encoded identity document. |
plugins | array | No | Plugins to run: [kyc, sanctions, aml]. Defaults to all. |
Response fields
| Parameter | Type | Required | Description |
|---|---|---|---|
data.onboarding_status | string | Yes | approved, rejected, or review_required. |
data.plugin_results | object | Yes | Results from each plugin run: kyc, sanctions, aml. |
data.overall_risk | string | Yes | Combined risk level across all checks. |
data.audit_id | string | Yes | Immutable 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