Skip to main content
POST
/
watchlist
/
screen
Screen individual or entity
curl --request POST \
  --url https://api.txcloud.io/v1/watchlist/screen \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "entity": {
    "type": "individual",
    "name": "<string>",
    "date_of_birth": "2023-12-25",
    "nationality": "<string>",
    "country_of_residence": "<string>",
    "document_number": "<string>",
    "registration_number": "<string>"
  },
  "lists": [
    "sanctions"
  ],
  "threshold": 0.85,
  "include_aliases": true,
  "fuzziness": "exact"
}
'
{
  "id": "<string>",
  "object": "<string>",
  "status": "clear",
  "hits": 123,
  "entity": {},
  "matches": [
    {
      "id": "<string>",
      "list": "<string>",
      "score": 123,
      "status": "<string>",
      "matched_entity": {},
      "match_details": {}
    }
  ],
  "screened_against": [
    {}
  ],
  "risk_level": "<string>",
  "processing_time_ms": 123
}

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
entity
object
required
lists
enum<string>[]
Available options:
sanctions,
pep,
adverse_media
threshold
number
default:0.85
include_aliases
boolean
fuzziness
enum<string>
Available options:
exact,
moderate,
fuzzy

Response

200 - application/json

Screening result

id
string
object
string
status
enum<string>
Available options:
clear,
potential_match,
confirmed_hit
hits
integer
entity
object
matches
object[]
screened_against
object[]
risk_level
string
processing_time_ms
integer