Discover and query available source lists
Updated
The GET /screen/lists endpoint returns the full registry of source lists that CompliAPI tracks — including their slugs, display names, types, maintenance schedules, entity counts, and whether each list is currently enabled. The endpoint is free and unauthenticated, so you can query it without an API token at any time.
What each list entry includes
Each object in the response array describes one source list:
slug— the machine-readable identifier used in the?lists=filter on every screening endpoint (for example,ofacoreu_fsf).display_name— the human-readable list name (for example,US OFAC SDN).list_type— one ofsanctions,crime, orrisk. Onlysanctionslists can setsanctioned: truein a screening response.kind— how the list is maintained:fetched(pulled from an upstream source on a schedule) orcurated(manually maintained and reconciled).cadence— the refresh frequency in plain language, for exampleevery 15 minutesordaily.enabled— whether the list is currently included in screening calls. Disabled lists appear in this response with"enabled": falsebut are not checked during screening.total— the current entity count on the list.last_updated— when the list was last successfully ingested, in UTC ISO-8601 format.
How to use it
- Call
GET https://api.compliapi.com/api/v1/screen/lists— no authorization header required. - Note the
slugvalues for any lists relevant to your use case. - Pass those slugs as a comma-separated
?lists=query parameter on any screening endpoint to limit checks to only those lists — for example,GET /screen/crypto/0x94f1...?lists=ofac,eu_fsf. - If you pass an unknown or misspelled slug in a
?lists=filter, the API returns a400error, so use the slugs from this endpoint as your source of truth.
Tips
- Lists with
"enabled": falseare excluded from screening automatically — you do not need to filter them out yourself, but they appear here so you can see the full picture of what CompliAPI tracks. - The
list_typefield is the key distinction for compliance logic: a match on asanctionslist setssanctioned: true, while a match on acrimeorrisklist sets onlyflagged: true. - For a richer freshness view that also includes the OFAC ingestion schedule and per-entity-type breakdowns, pair this endpoint with
GET /stats.