Make your first sanctions screening call

Updated

CompliAPI lets you check any crypto address, email, website, government ID, or country against multiple global sanctions lists in a single API call. This guide walks you through getting set up and running your first screening request in just a few minutes.

Steps

  1. Sign up and verify your email address.
  2. Go to the Tokens page and create an API token. Copy the token immediately — the plaintext value is shown only once.
  3. Run the following curl command, replacing $COMPLIAPI_TOKEN with your token:
curl https://api.compliapi.com/api/v1/screen/crypto/0x098B716B8Aaf21512996dC57EB0615e2383E2f96 \  -H "Authorization: Bearer $COMPLIAPI_TOKEN"
  1. Review the response. A sanctioned address returns a result like this:
{  "value": "0x098b716b8aaf21512996dc57eb0615e2383e2f96",  "flagged": true,  "sanctioned": true,  "lists_checked": ["ofac", "ofac_consolidated", "us_fbi_lazarus_crypto", "il_mod_crypto", "fr_tresor", "jp_mof_sanctions", "uk_fcdo_sanctions"],  "matches": [    {      "list": "ofac",      "list_name": "US OFAC SDN",      "list_type": "sanctions",      "match": "exact",      "value": "0x098B716B8Aaf21512996dC57EB0615e2383E2f96",      "source_url": "https://sanctionssearch.ofac.treas.gov/Details.aspx?id=27307",      "metadata": { "symbol": "ETH", "name": "Ethereum", "sdn_name": "LAZARUS GROUP" }    }  ]}

Understanding the response

Every screening response shares the same envelope. sanctioned: true means the value matched a government sanctions list — this is the field to gate on for compliance decisions. flagged: true means there was any kind of match, including crime-intelligence or risk-exposure lists. lists_checked tells you exactly which lists were searched, and matches gives you one entry per hit, naming the specific list, match type, and source URL so you have a full audit trail.

If the address is clean, you get flagged: false, sanctioned: false, and an empty matches array. Each request costs one credit against your organization's monthly quota, regardless of how many lists match.

← All articles

Powered by Shipstar