Screening Overview

The /screen/* endpoints check all enabled source lists at once. Each match names the list that produced it, so one call replaces separate per-list lookups.

Endpoint	Screens
`GET /screen/crypto/{address}`	A crypto address on any chain, or an ENS name
`GET /screen/email/{email}`	An email address
`GET /screen/website?address=`	A website or domain
`GET /screen/id/{government_id}`	A government-issued ID (fuzzy-matched)
`GET /screen/country/{country}`	A country or region’s sanctions designations
`GET /screen/name?name=`	A person, company, vessel or aircraft name (fuzzy, scored; OFAC, UN, EU, UK, SECO, Canada, Australia, Trésor and Japan MOF) — the envelope plus a `score` and `reasons` per match
`GET /screen/vessel/{identifier}`	A ship by IMO number or MMSI
`GET /screen/aircraft/{identifier}`	An aircraft by registration, serial number or Mode S code
`POST /screen/batch`	Up to 50 of the above, mixed, in one call — one request per screened item

All of them accept an optional ?lists= filter — a comma-separated set of list slugs from /screen/lists (unknown slugs return 400):

GET /api/v1/screen/crypto/0x94f1...?lists=ofac,eu_fsf

They also accept an optional ?ref= — your own reference for the subject (a customer, invoice or wallet id, up to 200 characters). It is echoed as ref in the response and recorded on every audit row the call writes, so an entry in your audit trail can be matched back to your record:

GET /api/v1/screen/email/jane@example.com?ref=cust-1042

The response envelope

sanctioned is true only when a government sanctions list matched; flagged is true for any match, including crime-intelligence and risk-exposure lists (a Tornado Cash association hit is list_type: "risk" and never sets sanctioned):

{
  "value": "0x94f1b9b64e2932f6a2db338f616844400cd58e8a",
  "flagged": true,
  "sanctioned": true,
  "lists_checked": ["ofac", "ofac_consolidated", "us_fbi_lazarus_crypto", "fr_tresor", "jp_mof_sanctions", "uk_fcdo_sanctions"],
  "matches": [
    {
      "list": "us_fbi_lazarus_crypto",
      "list_name": "FBI Lazarus Group crypto addresses",
      "list_type": "sanctions",
      "match": "exact",
      "value": "0x94f1b9b64e2932f6a2db338f616844400cd58e8a",
      "source_url": "https://www.fbi.gov/news/press-releases/fbi-identifies-lazarus-group-cyber-actors-as-responsible-for-theft-of-41-million-from-stakecom",
      "metadata": { "symbol": "ETH", "network": "Ethereum", "name": "Lazarus Group (APT38)" }
    },
    {
      "list": "tornado_cash",
      "list_name": "Tornado Cash depositors & relayers",
      "list_type": "risk",
      "match": "exact",
      "value": "0x94F1b9B64E2932F6A2Db338F616844400cd58e8a",
      "source_url": "https://etherscan.io/tx/0x5c8b...",
      "metadata": {
        "name": "Tornado Cash",
        "role": "depositor",
        "network": "ethereum",
        "symbol": "ETH",
        "pool": "10 ETH",
        "block": 15530443,
        "tx_hash": "0x5c8b..."
      }
    }
  ]
}

No match returns { "value": "...", "flagged": false, "sanctioned": false, "lists_checked": [...], "list_versions": {...}, "matches": [] }.

List versions

Every response also carries list_versions: for each list in lists_checked, the version of the data the result was checked against — keep it with the result as evidence of exactly what was screened.

"list_versions": {
  "ofac": { "updated_at": "2026-11-07T06:22:41Z", "publication_id": 4321, "checked_at": "2026-11-07T06:52:03Z" },
  "uk_fcdo_sanctions": { "updated_at": "2026-11-07T04:30:12Z", "publication_id": null, "checked_at": null }
}

updated_at — when CompliAPI last successfully refreshed the list from its publisher.
publication_id — for ofac and ofac_consolidated, the US Treasury publication the data reflects (OFAC’s own sequential publication number); null for lists whose publishers don’t number releases.
checked_at — for the OFAC lists, when CompliAPI last confirmed there was no newer Treasury publication (every 15 minutes).

A list that has not been ingested yet — for example in the hours after a new list is added — is checked but has no version entry. Versions can lag a refresh by up to a minute. One request costs one credit regardless of how many lists match. Every match is written to your audit trail attributed to its list.

API Reference

Screening

IP Intelligence

Data Feeds

Screening Overview

The response envelope

List versions

​The response envelope

​List versions

The response envelope

List versions