Filter screening results to specific source lists

Updated

Every /screen/* endpoint accepts an optional ?lists= query parameter that lets you limit screening to a specific subset of source lists. By default, a screening call checks every enabled list at once and reports lists_checked in the response. When you only need to satisfy a particular regulatory requirement — for example, checking only against OFAC and the EU consolidated list — you can pass those list slugs explicitly and skip the rest.

How to use it

  1. Retrieve the available list slugs by calling GET /api/v1/screen/lists (unauthenticated and free). Each entry includes a slug, its display_name, list_type, and whether it is currently enabled.
  2. Choose the slugs relevant to your use case.
  3. Append ?lists= followed by your chosen slugs as a comma-separated string to any screening request.
curl "https://api.compliapi.com/api/v1/screen/crypto/0x94f1b9b64e2932f6a2db338f616844400cd58e8a?lists=ofac,eu_fsf" \  -H "Authorization: Bearer capi_..."

The response lists_checked field will reflect only the lists you specified, and matches will contain only hits from those lists.

Tips and limits

  • Unknown slugs return 400. Double-check your slug spelling against the values returned by GET /screen/lists. If you pass a slug for a list that exists but is currently disabled, it also returns 400.
  • One credit per request. Filtering to fewer lists does not reduce the per-request cost — each metered call costs one credit regardless of how many lists are checked.
  • The ?lists= filter works identically across all screening endpoints: /screen/crypto, /screen/email, /screen/website, /screen/id, and /screen/country.
  • The same filter is available on the MCP screening tools as the optional lists argument, accepting the same comma-separated slug syntax.
  • If you are unsure which lists to include, omit the parameter entirely and let CompliAPI check all enabled lists — this is the safest default for most compliance workflows.

← All articles

Powered by Shipstar