Skip to content

Screening API

Screen a party from your TMS, booking system or ERP. One POST searches 24 official lists, including US, UN, EU, UK, Canada, Switzerland and Japan sanctions and export lists and returns each candidate with its list, a similarity score, a label and a link to the record.

At a glance

Base URLhttps://kleerance.com/api/v1
EndpointPOST /screen — reference
AuthenticationAuthorization: Bearer klr_live_… — keys
FormatJSON request and response, UTF-8
PlansPro ($149/month): 2,000 calls per billing period; Business ($399/month): 10,000 calls per billing period. Free and Starter do not include API access. Pricing
Burst limit60 requests per minute per account
Calls fromYour server only. Browser (CORS) requests are refused so keys are never exposed in a web page.
SpecOpenAPI 3.1 document (generated from the same schemas the endpoint validates with)

Your first call

Put your key in an environment variable named KLEERANCE_API_KEY, then:

curl -sS -X POST https://kleerance.com/api/v1/screen \
  -H "Authorization: Bearer $KLEERANCE_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"query":"Rosneft Trading","limit":3,"lists":["OFAC-SDN","UK-HMT"]}'

The response lists every candidate scoring 55 or more, the lists searched with their last refresh time, and how many calls you have left. See Reading results before you act on one.

A score measures how similar two names are. It is never a determination that a party is or isn't the listed person or company, and "No match in the lists searched" is not a clearance. Review candidates against the official record. Name screening does not detect ownership-based restrictions (for example OFAC's 50 percent rule).

What's covered

Next: Quickstart