Skip to main content
POST
identity.screening.check-advanced

Authorizations

Authorization
string
header
required

API key: sk_live_…

Headers

Idempotency-Key
string
required

Required: this capability has an external effect.

Maximum string length: 255
Pramaan-Max-Price-Micro
string

Optional. The most this request may be priced at, in micro-USD (a whole number above 0). It replaces the capability's own price ceiling for this request, lower or higher. Sources that could cost more are left out; when none is left the answer is 400 with the lowest limit that would work.

Pattern: ^[1-9]\d{0,14}$

Body

application/json
fullName
string
required

Person or company name.

Required string length: 1 - 256
subjectKey
string
required

Your stable subject key.

Required string length: 1 - 256
entityType
enum<string>
default:person

Subject kind.

Available options:
person,
company
dateOfBirth
string

Calendar date, YYYY-MM-DD.

Pattern: ^\d{4}-\d{2}-\d{2}$
countryCode
string

Two-letter country code.

Pattern: ^[A-Za-z]{2}$
documentNumber
string

Identity document; needed for local checks.

Required string length: 1 - 50
adverseMedia
boolean

Screen adverse media; paid extra, default off.

localChecks
enum<string>[]

Explicit local register checks; paid extras, default none.

Maximum array length: 9
Available options:
gaming-exclusion,
family-benefit,
politically-exposed,
political-exposure,
public-position,
fishing-benefit,
crop-benefit,
emergency-benefit,
continuous-benefit
matchingMode
enum<string>
default:fuzzy

Name matching mode; default fuzzy.

Available options:
exact,
fuzzy,
phonetic,
edit-distance
threshold
number
default:0.585

Entry-match threshold, 0 to 1; default 0.585.

Required range: 0 <= x <= 1
limit
integer
default:10

Maximum hits per source, 1 to 50; default 10.

Required range: 1 <= x <= 50
includeEvidence
boolean

Include list titles, aliases, country and birth date; default off.

filterMissingBirthDate
boolean

Exclude entries with no birth date; default off.

filterMissingCountry
boolean

Adverse media: exclude entries with no country; default off.

Response

The result

status
enum<string>
required

Screening outcome; matches require human review.

Available options:
clear,
review,
hit
totalHits
integer
required

Number of returned entries.

Required range: 0 <= x <= 9007199254740991
hits
object[]
required

Matched entries; no person rating.

localMatches
object[]

Requested local register facts; no person rating.

screenedAt
string

Screening timestamp in UTC.

Required string length: 1 - 100
ref
string

Reference to what this call created. Pass it as ref to Follow-up calls for fraud_screening..