Screen one name against all four sanctions lists

get/screen

Request

  • Base URL: https://api.stratumapis.com/v1/sanctions
  • URL: https://api.stratumapis.com/v1/sanctions/screen
  • Auth: API key in header X-Stratum-Key

Query parameters

namestring required

Person or organisation name to screen

type'person' | 'entity' | 'any'

Match person listings only, organisation listings only (entity; organisation and company also accepted), or both

dateOfBirthstring

YYYY-MM-DD, or YYYY-MM / YYYY if only the month or year is known. Compared with every date of birth the lists publish for a person; see dateOfBirthMatch.

nationalitystring

Two-letter ISO 3166 country code. Compared with the listed nationalities; see nationalityMatch.

referencestring

Your own reference (for example an applicant id). Echoed back in the result, never stored.

minScorenumber

Candidates scoring below this are left out

pepAndAdverseMediaboolean

Also screen for politically exposed persons (PEP) and adverse media. Paid per name from your Stratum credit (25p, 15p once your account has run 1,000 this month), taken before the check and given back if it doesn't run or reuses an answer you already paid for today; the reply's credit says what was charged. Not in a free trial. One name at a time (not on /bulk). Without enough credit: HTTP 402.

Response

Screening result. count 0 means no listing matched at the threshold.

checkIdstring required

Unique id for this screen. Keep it with your record; we keep no copy of the result.

screenedAtstring date-time required

When the screen ran (UTC)

referencestring

Your reference

querystring required

The name as screened

countinteger required

Number of possible matches at or above minScore

listsScreenedstring[] required

Each list screened, with the date it was last updated. Keep this with your record of the check.

screenProvenancestring required

One sentence naming the lists screened, suitable for an audit record

listsSnapshotAtstring date-time

When our copy of the lists was built from the publishers' files

Changes

No recorded changes to this operation across all 1 revision of this API.