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

Sanctions-AI

Active

Screen individuals and businesses against real OFAC and UN Security Council data. 19,780+ government records updated daily. Fuzzy name matching handles transliteration variants. PEP detection runs separately via AI.

Endpoint

POST/api/sanctions/screen

Sanctions lists

ListSourceRecordsUpdated
OFAC_SDNUS Treasury19,050Daily
UN_SCUN Security Council730Daily
PEPAI detectionGlobalReal-time

Match scoring

Each potential match is scored 0–100. Provide date_of_birth and nationality to boost accuracy.

ScoreMatch typeAction
95–100Exact matchReject immediately
70–94Fuzzy matchHuman review required
60–69Possible matchFlag for review
0–59No matchNot returned

Request parameters

ParameterTypeRequiredDescription
entity_idstringYesYour internal reference for this entity.
jurisdictionstringYesOne of: CA, AE, SA. Determines which lists are screened.
entity_typestringYesindividual or business.
full_namestringYesFull name to screen. For Arabic names, any common transliteration is accepted.
date_of_birthstringNoDate of birth in YYYY-MM-DD format. Strongly recommended — improves accuracy and reduces false positives.
nationalitystringNo2-letter ISO country code. Helps narrow matches.
countrystringNo2-letter ISO country code of residence or operation.

Response fields

ParameterTypeRequiredDescription
data.statusstringYesapproved, rejected, or review_required.
data.risk_levelstringYeslow, medium, high, or critical.
data.is_pepbooleanYesWhether the entity is a Politically Exposed Person.
data.pep_detailsstringNoExplanation of PEP status if is_pep is true.
data.matchesarrayYesSanctions list matches. Each has: list, match_score (0–100), matched_name, match_type (exact/fuzzy/alias), uid, program, details.
data.highest_match_scoreintegerYesHighest match score across all lists, 0–100.
data.lists_screenedarrayYesLists checked: OFAC_SDN, UN_SC, PEP.
data.records_screenedintegerYesTotal records searched across all lists.
data.ai_recommendationstringYesPlain-English assessment and recommended action.
data.requires_human_reviewbooleanYesTrue for matches above 70% or any PEP detection.

Code example

curl -X POST \
  https://shield.kodexa.systems/api/sanctions/screen \
  -H "Content-Type: application/json" \
  -d '{
    "entity_id": "CUST-AE-017",
    "jurisdiction": "AE",
    "entity_type": "individual",
    "full_name": "Mohammed Al Rashidi",
    "date_of_birth": "1975-08-15",
    "nationality": "AE"
  }'

Example response

json
{
  "success": true,
  "data": {
    "status": "approved",
    "risk_level": "low",
    "is_pep": false,
    "pep_details": null,
    "matches": [],
    "highest_match_score": 0,
    "lists_screened": ["OFAC_SDN", "UN_SC", "PEP"],
    "records_screened": 19780,
    "ai_recommendation": "Mohammed Al Rashidi cleared. No matches found across 19,780 records (OFAC SDN + UN Security Council). No PEP indicators detected.",
    "compliance_flags": [],
    "requires_human_review": false,
    "review_reasons": [],
    "request_id": "sanc_1716000000_def456",
    "created_at": "2026-05-22T04:00:00.000Z"
  },
  "processing_time_ms": 4398,
  "jurisdiction": "AE",
  "plugin": "sanctions"
}