API
Screen from the systems you already run.
A REST API for Watchlist, PEP and Sanctions Screening from onboarding, KYC and transaction systems. Results that need a person go to the same review and case workflow as everything else.
Example request
POST /api/v1/screen
Authorization: Bearer <api_key>
Content-Type: application/json
{
"screening_type": "individual",
"name": "James T Kirk",
"reference_id": "cus_0001",
"id_number": "8001015009087",
"country": "ZA"
}What comes back
Each response carries enough to act automatically and to trace the result later.
- screening_id
- Identifier for retrieval and audit
- overall_risk_level
- Risk result for your decision logic
- sanctions_match_count
- Potential sanctions matches
- pep_match_count
- Potential PEP matches
- case_id
- Case opened for review, if any
- warnings
- Conditions to be aware of
Capabilities
Single subject screening
Screen one individual or organisation
Bulk screening
Screen many subjects in one job
Screening retrieval
Fetch a previous screening and its result
Subject search
Find subjects already screened
Case lookup
Read the case opened from a screening
Watchlist status / freshness
Check list import status before relying on results
Authentication
All requests are authenticated using a Bearer API key.
Authorization: Bearer <api_key>
Key and traffic controls
- Hashed API keys
- Revocable keys
- Rate limits
- Usage quotas
- Request logging
API or bulk?
Use the API when a decision is needed in the moment, such as at onboarding. Use bulk screening for portfolio refreshes and batches. Both feed the same review, case and reporting records.