Skip to main content
POST/api/v2/aml/screening
Screen a business against sanctions, watchlists, PEP and adverse-media sources. The response includes every match. This is the same endpoint as AML screening. Set schema to "organization" here, and to "individual" when you are screening a person.

Headers

Body parameters

What gets screened

Every result carries a source_type identifying which kind of list it came from: The overall record is graded with a risk_level (e.g. Low / Medium / High) and a match_status β€” one of No Match, Partially Matched, Potential Match or Confirmed Match.

Watchlist codes

Pass these values in screening_options.watchlists. Omit the field or send [] to search every list.

Response

Returns an entity with the search_query, total_results / total_articles counts, an overall risk_level and match_status, a match_level, a weak_results count, and a results array. Adverse-media hits are grouped by source_type: "ADVERSE_MEDIA" and media_category. Each article has a timestamp, headline, source, and HTML body. The example opposite is trimmed; the live response includes every article and the full body.

Errors