Screen a website or domain against sanctions lists

Updated

The GET /screen/website endpoint checks a website or domain against every enabled sanctions list in a single call. Unlike the other screening endpoints, the value to screen is passed as a query parameter rather than a path segment. Matching is exact after normalization: the scheme (https://, http://) and a leading www. are stripped before comparison, so https://www.example.com/ will match a listed example.com.

How to screen a website

  1. Obtain your API token from the Tokens page.
  2. Send a GET request with the domain or URL as the address query parameter:
   GET https://api.compliapi.com/api/v1/screen/website?address=example.com
  1. Include your token as a bearer header:
   Authorization: Bearer capi_...
  1. Read sanctioned and flagged in the response, and check matches for the specific list and entry behind any hit.

Normalization details

Before matching, CompliAPI strips the URL scheme and removes a leading www. subdomain. This means you can pass a full URL from your application without pre-processing it — https://www.example.com/ and example.com resolve to the same comparison value. The normalized form that was actually matched is reflected in value in the response.

Filtering by list and monitoring changes

Add ?lists= with a comma-separated set of slugs from GET /screen/lists to restrict which lists are checked:

GET /api/v1/screen/website?address=example.com&lists=ofac,uk_fcdo_sanctions

An unknown slug returns 400. If you want to be notified automatically when a website you care about is added to or removed from a list — rather than polling on a schedule — consider registering it as a monitored entity on the Webhooks page. Monitoring webhooks are available on Developer and Team plans and will POST an event to your endpoint whenever the sanctions status of a registered domain changes.

← All articles

Powered by Shipstar