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

WatchlistSync-AI

Coming soon

Automated sanctions list ingestion and retroactive customer screening. Triggers re-screening of your existing customer base when lists are updated — OFAC, UN, HMT, CBUAE, SAMA. Notifies on new matches against previously onboarded customers with a compliance action recommendation.

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/watchlistsync/run

Request parameters

ParameterTypeRequiredDescription
jurisdictionstringYesOne of: CA, AE, SA, GB. Determines which lists to sync.
listsarrayNoSpecific lists to sync: OFAC_SDN, UN_SC, UK_HMT, CBUAE, SAMA. Default: all for jurisdiction.
customer_scopestringNoOne of: all, active, high_risk. Which customers to re-screen (default: all).
notify_on_matchbooleanNoWhether to add new matches to the compliance review queue (default: true).

Response fields

ParameterTypeRequiredDescription
data.lists_syncedarrayYesLists successfully synced with update timestamps.
data.customers_screenedintegerYesNumber of customers re-screened against updated lists.
data.new_matchesintegerYesNumber of new matches found against previously onboarded customers.
data.match_detailsarrayYesArray of new matches with customer_id, list, match_score, and recommended action.
data.next_sync_recommendedstringYesISO 8601 timestamp for recommended next sync based on list update frequency.

cURL

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

Code examples available when plugin launches