Skip to main content
POST

Authorizations

Authorization
string
header
required

Use your API token as a Bearer token in the Authorization header.

Headers

Authorization
string
required
Example:

"Bearer {your_api_token}"

Accept
string
default:application/json
Content-Type
string
default:application/json

Body

application/json
name
string
required

Full name of the individual to screen.

Maximum string length: 255
Example:

"Example Person"

dob
string<date> | null

Optional date of birth.

datasets
enum<string>[]
Minimum array length: 1
Available options:
PEP,
SAN,
RRE,
INS,
DD,
POI,
REL
countries
string[]

Two-character country codes used to narrow the search.

Minimum array length: 1
Required string length: 2
pepTiers
enum<string>[]
Minimum array length: 1
Available options:
PEP Tier 1,
PEP Tier 2,
PEP Tier 3
threshold
integer
default:75
Required range: 75 <= x <= 100
matchingPolicy
enum<string>
default:fuzzy
Available options:
fuzzy,
strict
gender
enum<string>
default:any
Available options:
any,
male,
female
amlMatchDefaultAction
enum<string>
default:manual

Status applied when matches exist but there is no exact name and date-of-birth match.

Available options:
manual,
rejected
metadata
object

Optional client-defined values echoed in completed and source-error responses.

Response

Screening completed. No match, review-needed match, and rejected match outcomes all use HTTP 200.

success
boolean
required
Example:

true

message
string
required
data
object
required
verificationStatus
enum<string>
required
Available options:
VERIFIED,
REVIEW_NEEDED,
REJECTED
verificationStatusCode
enum<integer>
required

3 = Verified, 2 = Review Needed, 1 = Rejected.

Available options:
3,
2,
1
transactionId
string<uuid>
required
verificationType
string
required
Example:

"aml"

createdAt
string
required
Example:

"2026-09-03 08:00:00+0000"

metadata
object | null