HIT, REVIEW, or CLEAR risk signal alongside matched records, match confidence levels, and source URLs for your compliance audit trail.
What this endpoint screens
- Sanctions lists — OFAC (US), UN Security Council Consolidated List, EU Consolidated List, UK HMT, and other national sanctions authorities
- PEP registers — Politically exposed persons and their known associates
- Adverse media / crime and conviction records — Where available per jurisdiction
- Local watchlists — Nigeria, Kenya, Ghana, South Africa, and other supported jurisdictions
Endpoint
Headers
Request body
string
required
Full name of the individual or business to screen.
string
required
Entity type. Accepted values:
individual or business.array
One or more countries associated with the entity. Providing this field improves match precision and reduces false positives.
string
Gender of the individual. Accepted values:
male or female. Narrows candidate matches for individuals and reduces false positives.string
Date of birth in
YYYY-MM-DD format. Improves match precision and reduces false positives significantly.string
A unique client-generated key for this request. Reuse the same key when retrying a failed request to prevent duplicate billing or re-screening.
Example request
cURL
Success response
Response fields
boolean
Indicates whether the screening request completed successfully.
string
Machine-readable result code. See Response codes below.
string
Human-readable result message.
object
High-level screening summary.
object
Full screening result.
object
Request metadata.
overall_risk values
Response codes
Best practices
- When
review_requiredistrueon aREVIEWresult, trigger your manual review workflow rather than proceeding automatically. - Use
idempotency_keyevery time you retry a failed request to avoid double billing or duplicate screening records. - Store
screening_id,request_id,lists_screened, andsource_urlvalues from each response to build a defensible compliance audit trail. - Run AML screening not only at onboarding but also before high-value transactions and as part of scheduled periodic re-screening of your existing customer base.