Your First Call

Screen your first entity.
One request away.

A hands-on walkthrough: send a name to SmartSanction and read back the verdict (isClear) and every match with its score and source records, in a single POST.

1

Send the request

Call POST /api/v1/screening/sanctions with the name to screen. The only required field is query; add schemaType, mode and threshold to tighten the match.

first-call.sh
curl --request POST \
  --url 'https://api.on8.ai/api/v1/screening/sanctions' \
  --header 'Authorization: ApiKey on8_3f9a12bc_••••••••' \
  --header 'Content-Type: application/json' \
  --data '{
    "query": "Vladimir Petrov",
    "schemaType": "Person",
    "mode": "fuzzy"
  }'
2

Read the response

Every response is an envelope: success plus data. For a sanctions search, data carries the subject, totalHits, isClear and the matched records with their source datasets and scores.

200 OKapplication/json
{
  "success": true,
  "data": {
    "subject": "Vladimir Petrov",
    "totalHits": 2,
    "isClear": false,
    "hits": [
      { "entity_id": "...", "name": "Vladimir Petrov", "entity_type": "person",
        "countries": ["ru"], "datasets": ["smartsanction"], "source_records": ["gb-hmt-17169", "eu-sancmap-..."],
        "risk_tags": ["Sanctioned Entity"], "score": 0.93, "match": true, "score_band": "strong", "match_confidence": "HIGH" }
    ]
  }
}
3

Act on the result

Branch on data.isClear to auto-pass clean names and route hits into a review queue. Then move on to PEP (/screening/pep), KYB and the onboarding guard, all with the same key.

Explore all endpoints

Need a key first?

Create a free account to generate API keys, no credit card required.

Get your API key