Skip to main content
POST

Verification configuration

Screening settings are optional. Omit them to use the documented defaults.

datasets

Selects which watchlist and risk datasets to screen against. Include one or more of the following codes: Defaults to all listed datasets: PEP, SAN, RRE, INS, DD, POI, and REL.

countries

Two-character country codes that narrow the geographic scope of the search. Defaults to ID, PL, MY, US, AU, and SG.

pepTiers

Selects which PEP classification tiers to include when PEP screening is enabled. Choose one or more of PEP Tier 1, PEP Tier 2, and PEP Tier 3. Defaults to all three tiers.

threshold

Minimum match strength from 75 to 100 before a hit is treated as material. Defaults to 75. Raise this value to reduce false positives.

matchingPolicy

Controls how name matching is performed. Set to fuzzy (default) or strict.

gender

Optionally filters matches by gender. Set to any (default), male, or female.

amlMatchDefaultAction

Sets the verification status when matches exist but there is no exact name and date-of-birth match. An exact name and date-of-birth match is always REJECTED.

Example configuration

This configuration screens PEP and sanctions lists for the Philippines and Singapore, raises the match threshold, and keeps non-exact matches in manual review.

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