Screen up to 500 names in one call
screen_batchEach subject may carry dob, nationality, entity_type, id_number and your reference. Identical rows are screened once (charged once). Returns per-subject decision_hint, hit_count, top_score and the top 5 hits, plus summary counts (clear / review / likely_match). Charged per unique name. Example: subjects [{name:'Ali Kony', reference:'C-17'}, {name:'شركة الأمل للتجارة', entity_type:'entity'}], default_nationality 'AE'. Response: result plus data_confidence, estimated_items[], sources[] (official list pages), data_version (snapshot id), warnings[] (e.g. a list snapshot older than 7 days) and a disclaimer. Lists: ofac_sdn, ofac_cons, un, eu, uk, uae. Names are never logged; matching is deterministic (no AI) and runs offline against the bundled snapshot.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| lists | No | Subset of lists to screen (default all): ofac_sdn, ofac_cons, un, eu, uk, uae. | |
| subjects | Yes | Up to 500 subjects (name + optional dob / nationality / entity_type / id_number / reference). Identical rows are screened once. | |
| min_score | No | Minimum score (0–100) for a hit to be returned; default 85. 80 widens the net for onboarding, 92 for alert review. | |
| default_nationality | No | ISO2 applied to rows without a nationality. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
No arguments | |||