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

Credit-AI

Coming soon

AI-powered credit risk scoring for individuals and businesses. Analyzes transaction history, behavioral patterns and jurisdictional credit bureau data.

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/credit/score

Request parameters

ParameterTypeRequiredDescription
customer_idstringYesYour internal customer reference.
jurisdictionstringYesOne of: CA, AE, SA.
entity_typestringYesindividual or business.
requested_amountnumberNoLoan or credit amount requested.
purposestringNoPurpose of credit: mortgage, business, personal, auto.

Response fields

ParameterTypeRequiredDescription
data.credit_scoreintegerYesCredit score on jurisdiction-standard scale.
data.risk_bandstringYesprime, near_prime, subprime, or declined.
data.recommended_limitnumberNoRecommended credit limit.
data.risk_factorsarrayYesFactors contributing to the score.

cURL

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

Code examples available when plugin launches