Screen up to 100 names in one request (one check per name)

Each name can be a plain string, or an object with its own country, type, minScore and reference. Top-level type and minScore are defaults for names that don't set their own; country goes on each name. If the request would take you past your monthly limit it is refused whole (429), with how many checks remain. A request answers within about 20 seconds: if names are left when time runs out, the response has incomplete: true and lists them in notScreened; send those again. Only screened names are charged.

post/bulk

Request

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

Request body

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

Response

One screening result per name, in request order, each with its own checkId

countinteger required

Names screened in this response

incompleteboolean

Present and true when time ran out before every name was screened

messagestring

Example response

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

Changes

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