Bulk sanctions screening
sanctions_screen_batchScreen up to 50 names against the sanctions lists in ONE call (POST /sanctions/screen). Requires the sanctions scope (batch calls do not use the free trial allowance); every item costs 3 credits. Per-item status: match / clear / error / timeout. "clear" means no hit at or above the threshold on the active lists, not a certification. Optional idempotency_key: replaying the same key with the same items within 24h returns the original response for free (409 if still running, 422 if the items differ).
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| list | No | Comma-separated source lists to restrict to, e.g. OFAC,EU,UN. | |
| group | No | entity: one row per listed person/company with lists[] and sources[] instead of one row per source list. | |
| limit | No | Hits returned per name (default 10). | |
| names | Yes | Names to screen (people, companies, vessels). | |
| threshold | No | Minimum similarity 30-100 (default 80). | |
| active_only | No | Only currently listed entries (default true). | |
| idempotency_key | No | Optional. Safe-replay key for this exact batch (1-255 printable ASCII); a repeat within 24h is free and returns the stored result. |