Screen up to 50 names in one call
Batch form of GET /sanctions/screen. Send items (name plus optional dob, entity_type, country) or the shorthand names. Shared options threshold, list, active_only, group and limit (hits per name, default 10) apply to every item. Requires the sanctions scope: batch calls do not draw on the free trial allowance. Every item costs what the same single call costs (3 credits for a screened name) against the plan's per-minute, daily and monthly limits; a batch that does not fit is refused up front with 429 batch_exceeds_quota and max_items_now. Supports an optional Idempotency-Key header (see the parameter) for safe replay of the whole batch.
Request
- Base URL: https://api.prometiam.com/functions/v1/risk-api
- URL: https://api.prometiam.com/functions/v1/risk-api/sanctions/screen
- Auth: HTTP bearer
Headers
Optional, per draft-ietf-httpapi-idempotency-key-header. 1-255 printable ASCII characters, else 400 validation_error. Scoped to the API key. A replay of the same key with the same request (method + path + a canonical, sorted-key hash of the body) within 24 hours returns the original 2xx response with Idempotent-Replayed: true and writes no new usage row (it costs no credits). The same key with a different body is 422 idempotency_key_reuse. A replay while the first attempt is still running is 409 idempotency_key_in_progress with Retry-After. Only 2xx results are stored — a 4xx/5xx (or an internal timeout) releases the key so the client can retry; a 2xx body over ~200 KB also releases the key (nothing is stored) rather than fail the request. Omitting the header changes nothing about the request.
Request body
Response
Results in request order
Changes
No recorded changes to this operation across all 2 revisions of this API.