Bulk name screening

Screen many names in a single request.

POST /api/v2/bulk-search

Auth x-api-key, or a signed-in user's bearer token

Screens a list of names in one call, against the same aggregated list as single-name screening. Each name is screened independently and the results are returned together.

fuzzy_search is not available here. It works one name at a time only, so a bulk request asking for it is rejected with a 400. Use permissive_match, standard_match or strict_match.

Request

Field	Type	Required	Description
`names`	string	Yes	The names to screen, as one comma-separated string. Not an array.
`search_type`	string	No	`permissive_match`, `standard_match` or `strict_match`. Defaults to `permissive_match`.
`additional_call_info`	object	No	Your own reference data, stored with the usage record.

Body

{
  "names": "John Smith, Jane Doe, Acme Corp",
  "search_type": "standard_match"
}

Response

One flat results array holding two kinds of row, told apart by row_type. Every name submitted gets a summary row, even when it matched nothing, followed by a match row for each hit. Group on search_term to reassemble them.

Summary row

Field	Type	Description
`row_type`	"summary"	Marks this as the per-name summary.
`search_term`	string	The name this row is about.
`total_matches`	number	How many match rows follow for this name. Zero means clear.

Match row

Field	Type	Description
`row_type`	"match"	Marks this as a match.
`search_term`	string	The submitted name this match belongs to.
`id, name, list, source_uid, match_score`	mixed	The same five match fields as single-name screening.

Body

{
  "param": "search_terms",
  "results": [
    { "row_type": "summary", "search_term": "John Smith", "total_matches": 1 },
    { "row_type": "summary", "search_term": "Jane Doe", "total_matches": 0 },
    {
      "row_type": "match",
      "search_term": "John Smith",
      "id": 10482,
      "name": "SMITH, John",
      "list": "ofac_sdn",
      "source_uid": "12345",
      "match_score": 96.1
    }
  ],
  "api_usage_id": "0b91f7a4-1d8c-4f2b-8f1a-77c2b6de4a05"
}

param reports which RPC parameter name the database accepted. It is diagnostic, and safe to ignore.

Example

curl -X POST https://api.amlscreen.io/api/v2/bulk-search \
  -H "Content-Type: application/json" \
  -H "x-api-key: YOUR_API_KEY" \
  -d '{
    "names": "John Smith, Jane Doe, Acme Corp",
    "search_type": "standard_match"
  }'

We use cookies to improve your experience on our website. By browsing this website, you agree to our use of cookies.