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 URL | https://kleerance.com/api/v1 |
|---|---|
| Endpoint | POST /screen — reference |
| Authentication | Authorization: Bearer klr_live_… — keys |
| Format | JSON request and response, UTF-8 |
| Plans | Pro ($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 limit | 60 requests per minute per account |
| Calls from | Your server only. Browser (CORS) requests are refused so keys are never exposed in a web page. |
| Spec | OpenAPI 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"]}'// Node 18+ (built-in fetch). Run on your server: never put the key in browser code.
const res = await fetch("https://kleerance.com/api/v1/screen", {
method: "POST",
headers: {
Authorization: `Bearer ${process.env.KLEERANCE_API_KEY}`,
"Content-Type": "application/json",
},
body: JSON.stringify({
"query": "Rosneft Trading",
"limit": 3,
"lists": [
"OFAC-SDN",
"UK-HMT"
]
}),
});
const data = await res.json();
if (!res.ok) {
// data.error.code is stable: branch on it (see the errors table).
throw new Error(`${res.status} ${data.error.code}: ${data.error.message}`);
}
console.log(data.result, data.top_score, data.matches.length);
console.log("calls left this period:", res.headers.get("X-RateLimit-Remaining"));import os
import requests
resp = requests.post(
"https://kleerance.com/api/v1/screen",
headers={"Authorization": f"Bearer {os.environ['KLEERANCE_API_KEY']}"},
json={
"query": "Rosneft Trading",
"limit": 3,
"lists": ["OFAC-SDN", "UK-HMT"],
},
timeout=30,
)
data = resp.json()
if not resp.ok:
# data["error"]["code"] is stable: branch on it (see the errors table).
raise RuntimeError(f"{resp.status_code} {data['error']['code']}: {data['error']['message']}")
print(data["result"], data["top_score"], len(data["matches"]))
print("calls left this period:", resp.headers.get("X-RateLimit-Remaining"))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
- Quickstart: from a new key to a stored result in five steps.
- Screen a name: every request and response field.
- Errors: every status and code, and which ones to retry.
- Rate limits and quotas: allowances per plan, what counts, when it resets, and how to see usage.
- Lists and freshness: list codes, refresh times and what "behind" means.
- Data handling: what we keep about your requests (not the names).
- Changelog and versioning.
Next: Quickstart