Screen a name against sanctions / PEP lists
POST/v2/aml/screen
Advisory AML/PEP screening via the self-hosted OpenSanctions/yente
instance. Never hard-blocks — a match returns review_required for a
human to clear; a clean result returns clear; if the screening provider
is unavailable it returns screening_unavailable (treat as not-yet-screened,
retry). The result is persisted and linked to customer_id.
Status: in progress. The sanctions index is live (≈292k entities — UN, EU, US OFAC and more), but the full PEP/legislator collection is not loaded yet (the data server lacks the resources to index the entire OpenSanctions dataset), so screening may miss politically exposed persons. Treat output as a work-in-progress signal, not a complete compliance check.
Request
Responses
- 200
- 403
Screening result (advisory)
The endpoint requires an account-scoped API key. Legacy keys without an account identity cannot access tenant data. Also returned when the requested resource (loan, schedule) is registered to another account.