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, ofac or eu_fsf).
  • display_name — the human-readable list name (for example, US OFAC SDN).
  • list_type — one of sanctions, crime, or risk. Only sanctions lists can set sanctioned: true in a screening response.
  • kind — how the list is maintained: fetched (pulled from an upstream source on a schedule) or curated (manually maintained and reconciled).
  • cadence — the refresh frequency in plain language, for example every 15 minutes or daily.
  • enabled — whether the list is currently included in screening calls. Disabled lists appear in this response with "enabled": false but 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

  1. Call GET https://api.compliapi.com/api/v1/screen/lists — no authorization header required.
  2. Note the slug values for any lists relevant to your use case.
  3. 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.
  4. If you pass an unknown or misspelled slug in a ?lists= filter, the API returns a 400 error, so use the slugs from this endpoint as your source of truth.

Tips

  • Lists with "enabled": false are 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_type field is the key distinction for compliance logic: a match on a sanctions list sets sanctioned: true, while a match on a crime or risk list sets only flagged: true.
  • For a richer freshness view that also includes the OFAC ingestion schedule and per-entity-type breakdowns, pair this endpoint with GET /stats.

← All articles

Powered by Shipstar