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": {
"name": "<string>",
"date_of_birth": "2023-12-25",
"nationality": "<string>",
"country_of_residence": "<string>",
"document_number": "<string>",
"registration_number": "<string>"
},
"lists": [],
"threshold": 0.85,
"include_aliases": true
}
'{
"id": "<string>",
"object": "<string>",
"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
}Screening
Screen individual or entity
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": {
"name": "<string>",
"date_of_birth": "2023-12-25",
"nationality": "<string>",
"country_of_residence": "<string>",
"document_number": "<string>",
"registration_number": "<string>"
},
"lists": [],
"threshold": 0.85,
"include_aliases": true
}
'{
"id": "<string>",
"object": "<string>",
"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
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Body
application/json
⌘I