Name screening

Screen a single name against every list at once.

POST /api/v2/search

Auth x-api-key

Screens one name against the aggregated list, which is every sanctions, PEP, wanted, debarment, regulator warning and shadow fleet list we carry, merged into a single index. Because there is one index, there is one result shape: every match has the same five fields whichever list it came from.

Matching is fuzzy by default, so results are candidates for review rather than confirmed identities. Use entry details to pull the full published record for a name before acting on it.

Request

Field	Type	Required	Description
`prompt`	string	Yes	The name to screen. Leading and trailing whitespace is trimmed.
`search_type`	string	No	One of `fuzzy_search`, `permissive_match`, `standard_match` or `strict_match`. Defaults to `fuzzy_search`.
`additional_call_info`	object	No	Your own reference data, stored with the usage record and returned in your screening history. Must be an object.

Body

{
  "prompt": "John Smith",
  "search_type": "standard_match"
}

Response

200 with the matches under the search results key. An empty array means the name is not on any list we carry.

Field	Type	Description
`search results`	array	One object per matching entity, described below.
`api_usage_id`	string \| null	The usage record written for this call.

Match object

Field	Type	Description
`id`	string \| number \| null	Identifier of the entity in the aggregated list.
`name`	string \| null	The matched name as published.
`list`	string \| null	Which list the entity is on, as a slug such as `ofac_sdn` or `possible_pep`. See what we screen against.
`source_uid`	string \| null	The publisher's own reference for the entry, where the list has one.
`match_score`	number \| null	How closely the name matched. Higher is closer.

Body

{
  "search results": [
    {
      "id": 27718,
      "name": "PUTIN",
      "list": "uk_sanctions",
      "source_uid": "RUS1461",
      "match_score": 100
    },
    {
      "id": 26952,
      "name": "Vladimir Putin",
      "list": "possible_pep",
      "source_uid": null,
      "match_score": 92.4
    }
  ],
  "api_usage_id": "8f0d1c2e-5b7a-4a1e-9c33-0a4b6d2f1e77"
}

Example

curl -X POST https://api.amlscreen.io/api/v2/search \
  -H "Content-Type: application/json" \
  -H "x-api-key: YOUR_API_KEY" \
  -d '{
    "prompt": "John Smith",
    "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.