Search PEP and sanctions lists

Screens people and organisations against PEP and sanctions lists. Unlike the screening endpoints on companies and persons, the subject does not need to exist as a record in the platform - you supply the name and/or identity number yourself.

The Screening overview explains how matching and hit ratings work, Results describes every property of a hit, and Lists covers which lists are screened.

Subjects

Up to 50 subjects can be screened in one call. Each is returned separately, in the order it was submitted, and each needs a name, an identity number, or both.

• identityNumber - personnummer or samordningsnummer (10 or 12 digits), or organisationsnummer (10 digits). Matched exactly, and a match here outweighs the name. A list entry carrying a different identity number is left out, also from name matching.
• name - every word must be on the list entry (any order, case and accents ignored), so send the given name the person uses and the family name rather than every given name. With an identity number as well, the name finds entries that carry no identity number of their own.
• birthDate - yyyy-MM-dd, yyyy-MM or yyyy. List entries with no known birth date always match, whatever you supply.
• countries - ISO 3166-1 alpha-3 codes, e.g. ["SWE", "NOR"]. Narrowing by country cuts false positives, but can also drop true hits where the list entry has poor country data.
• reference - your own reference, echoed back on the matching result so you can pair them up. Generated for you if omitted.

Matching

nameMatching defaults to Regular, which matches exact aliases. Phonetic also matches similar-sounding names - it finds more true hits and considerably more false ones. Phonetic matching requires minimumNameMatchScore (0.6 to 0.99) to trim the tail; a value between 0.75 and 0.9 is recommended, and the score is ignored for regular matching.

serviceScope selects which lists to screen against, for example SANCTION or PEP_Edge, or a comma-separated combination. Leave it empty for every sanctions and PEP list. Adverse media is not screened.

Test mode

Set testMode to true to run the screening against the test environment. The response has the same shape, the order is placed free of charge, and hits come from test data rather than the live lists. See Test mode.

Stored screening

Every search is stored like a company or person screening. screeningId fetches it again with Get a screening, each result has a subjectId, and each hit a hitId, isNew (not seen before for the same person or organisation) and the team’s resolution. See Reviewing hits. Like all screening endpoints, search requires the pep scope on the API key.

Partial failures

A screening can succeed overall while individual subjects fail. warnings reports subjects that were ignored, and errors reports per-subject failures; the rest of the screening still runs. A subject that failed has notScreenedReason screeningError on its result. Check both before treating a subject as clear.