Screen one name against the six US export-control lists and the four sanctions lists

get/screen

Request

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

Query parameters

namestring required

Person or organisation name to screen

countrystring

The party's country as a two-letter ISO 3166 code. Compared with the countries of a listing's addresses and reported as countryMatch on export-list matches. It never hides a match.

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

On the sanctions lists, match person listings only, organisation listings only (entity; organisation and company also accepted), or both. The US export lists do not mark people and organisations apart, so every export listing is screened whatever the type.

minScorenumber

Candidates scoring below this are left out

referencestring

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

Response

Screening result. result is no_match when nothing matched at the threshold on any list screened.

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

result'no_match' | 'possible_match' required
countinteger required

Number of possible matches at or above minScore

noticestring required

The screening-record notice, for your record

Example response

{
  "matches": [
    {
      "listLabel": "US Entity List (BIS)"
    }
  ]
}

Changes

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