Skip to main content
POST
Screen individual or entity

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