Screen an email address against sanctions lists

The GET /screen/email/{email} endpoint checks an email address against every enabled sanctions and crime list in one request. Matching is exact and case-insensitive, so Test@Example.com and test@example.com are treated as the same value. This endpoint is useful for screening users at signup or during periodic reviews of your customer base.

How to screen an email

1. Obtain your API token from the Tokens page.
2. Send a GET request with the email address in the path:

   GET https://api.compliapi.com/api/v1/screen/email/{email}

3. Include your token as a bearer header:

   Authorization: Bearer capi_...

4. Check sanctioned in the response — true means a government sanctions list matched. flagged: true means any list matched.
5. If matches is empty and both flags are false, the email is clean across all checked lists.

Example clean response

When no list matches, the response looks like this:

{  "value": "example@protonmail.com",  "flagged": false,  "sanctioned": false,  "lists_checked": ["ofac"],  "matches": []}

lists_checked confirms which lists were evaluated for that request.

Filtering by list

You can limit screening to specific lists with the optional ?lists= query parameter:

GET /api/v1/screen/email/user@example.com?lists=ofac,eu_fsf

Pass a comma-separated set of slugs from GET /screen/lists. An unknown slug returns a 400 error. Each metered request costs one credit regardless of how many lists are checked or how many matches are returned.