PROOViD AML Docs
Get started

Your first screening result in under a minute.

PROOViD AML screens a name against sanctions, PEP and adverse-media watchlists and returns a clear decision — Pass / Review / Fail — with a risk band and the matched entities.

Just want to see it? Open the no-code playground and hit “Try a sample” — a real screening result with zero setup.

1 · Run your first screen

Copy-paste this — it works right now. It uses a shared public demo key, so you can try before you sign up:

curl -X POST https://aml-screening.dloizides.com/v1/screenings/check \
  -H "X-Api-Key: aml_live_<demo-key>" \
  -H "Content-Type: application/json" \
  -d '{ "fullName": "Joseph Kony" }'

201 with "decision": "Fail", a riskScore / riskBand, and the matchedEntities[] that matched. Swap in a clean name like "Jane Smith" to see a Pass.

2 · Get your own API key

For real use, provision a tenant — no code needed:

  1. Open the onboarding wizard Sign in, create a tenant, and copy your API key + webhook secret (shown once).
  2. Swap in your key Replace the demo key above with X-Api-Key: aml_live_<yours> — the same call now runs on your own tenant.
Automating instead of clicking? POST /v1/tenants (admin) provisions the tenant, API key, risk profile and webhook in one call — see Authentication for tokens.

3 · Act on the decision

Every screen returns one decision you can branch on directly:

decisionMeaningDo this
FailSanctions / criminal hit.Block & escalate.
ReviewPEP or a possible match.Send to a human reviewer.
PassNo relevant match.Proceed.

Each result also carries a numeric riskScore (0–100) and a riskBand. Add "monitor": true to be alerted by a signed webhook if that subject's outcome later changes. Webhooks →

Explore the docs

© PROOViD AML · Developer Docs API reference · Changelog