Skip to content

CirclesCheck · Sanctions screening API

Build an OFAC screening workflow you can review.

Confirm the sources your business needs, screen customer identifiers, and connect potential matches to a documented reviewer decision.

Explore the API example →Inspect source coverage

Start with the source requirement.

If your workflow requires OFAC data, check the relevant datasets and their recorded freshness in the source inventory. Evaluate known test cases and identity conflicts before using the integration for customer decisions.

screeningType: sanctions requests sanctions screening across the configured sources. It is not an OFAC-only dataset selector. Use combined when your review also needs PEP candidates.

Keep the required source scope, the returned evidence, and the reviewer's assessment together. A name-similarity score does not establish the customer's identity.

Integration example

Test the request before connecting live data.

Use a cc_test_ key from your account for simulated sandbox responses. Keep credentials in server-side code. The shared quick start below runs the combined workflow and shows how to check completion before reading result.matches.

curl https://api.circlescheck.com/api/v1/screenings \
  -H 'Authorization: Bearer cc_test_your_api_key' \
  -H 'Content-Type: application/json' \
  -d '{"fullName":"Alex Sample","type":"individual","dateOfBirth":"1980-01-15","country":"GB","screeningType":"combined"}'

Request sanctions candidates

Replace the example JSON body with these fictional identifiers and screeningType: sanctions. A live key uses live data and the account's monthly screening allowance.

Read the response envelope →
{
  "fullName": "Alex Sample",
  "type": "individual",
  "dateOfBirth": "1980-01-15",
  "country": "GB",
  "screeningType": "sanctions"
}

Build three explicit outcomes.

01Completed, candidates returned

Open the source evidence and compare available identifiers. Record a disposition and the reasons for it; retain the screening and match UUIDs with the reviewer notes.

02Completed, no candidates returned

Store the completed check and its source scope. No candidates is a point-in-time result for the submitted identifiers; your team still owns the customer decision.

03Failed or unavailable

Keep the check incomplete. Handle HTTP errors and response status explicitly, then retry with backoff. An allowance error requires an upgrade or a reset; an engine error must never produce an approval.

Review error and usage handling →

Keep the record connected.

Export a completed screening with recorded review evidence, then add the customer to monitoring when recurring checks fit your workflow.

Explore the screening report →Plan daily or weekly monitoring →

Evaluating a customer portfolio?

Use the sample batch CSV to test row validation and separate completed checks from unfinished work before processing a larger list.

Try the batch screening workflow →

Evaluate the integration on your cases.

Start with sandbox requests, then verify live sources and matching against a representative test set. Review current pricing before enabling recurring production monitoring.

Evaluate free →Compare production plans

Prepared by CirclesCheck · Updated . Product evaluation guidance; independent regulatory review is not claimed.