Skip to main content
POST/api/v2/aml/screening
Screen an individual against global PEP, sanctions, warning and adverse-media lists β€” across 200+ countries and 40,000+ databases. The response includes every match. This is the same endpoint as Business AML screening. Set schema to "individual" here, and to "organization" when you are screening a business.

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. A profile match (source_type such as "PEP" or "OTHER") can include name, titles, alias_names, given_names, last_names, gender, date_of_birth, place_of_birth, country, address, positions, education, other_information, urls, and relations. Each profile has match and match_strength (e.g. "confirmed"). 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 profile, every article, and the full body.

Errors