PROOViD AML Docs
Developer documentation

Screen anyone against sanctions, PEP & adverse media — in one call.

PROOViD AML is a multi-tenant screening API. Send a subject; get back a decision (Pass / Review / Fail), a risk band, and the matched watchlist entities — with ongoing monitoring and signed webhooks built in.

Production · https://aml-screening.dloizides.com
# Screen a subject (authenticate as a tenant with your API key)
curl -X POST https://aml-screening.dloizides.com/v1/screenings/check \
  -H "X-Api-Key: aml_live_…" \
  -H "Content-Type: application/json" \
  -d '{ "fullName": "Vladimir Petrov", "nationality": "ru", "threshold": 0.85 }'

201 Created with decision, riskScore, riskBand and matchedEntities[].

Quickstart in five steps

  1. Get a token Authenticate to PROOViD's IdP — client_credentials for machines, hosted login (PKCE) for humans. Authentication →
  2. Onboard a tenant One call (POST /v1/tenants) provisions the tenant, its first API key, a risk profile and an optional webhook. The API key + webhook secret are returned once.
  3. Screen a subject POST /v1/screenings/check with the API key. Act on decision.
  4. Bulk & monitor Screen up to 1,000 subjects per request (JSON or CSV) and set monitor: true to be alerted when a subject's outcome changes.
  5. Receive webhooks Verify the HMAC-SHA256 signature on screening.completed / monitoring.alert deliveries. Webhooks →
Prefer to click? The onboarding wizard walks an admin through tenant provisioning in the browser, and the stats dashboard shows live screening volume.

Explore the docs

The screening model

Every screen returns a decision you can act on directly:

decisionMeaningTypical action
FailStrong sanctions / criminal hit.Block / escalate.
ReviewPEP or a possible match.Route to a human reviewer.
PassClean — no relevant matches.Proceed.

Each result also carries a numeric riskScore (0–100) and a riskBand (Low/Medium/High) computed by the risk engine, plus the matchedEntities[] that drove it.

© PROOViD AML · Developer Docs API reference · Changelog