Skip to main content
POST
identity.pep.check

Authorizations

Authorization
string
header
required

API key: sk_live_…

Headers

Idempotency-Key
string

Optional. A retry with the same key returns the stored result.

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

Full name of the person or company to check.

Required string length: 1 - 512
country
string

Optional two-letter country filter.

Pattern: ^[a-z]{2}$
dateOfBirth
string

Optional birth date, YYYY-MM-DD.

Required string length: 1 - 256
Pattern: ^(?:^\d{4}-\d{2}-\d{2}$)$

Response

The result

politicallyExposed
boolean

Whether the source found a politically exposed person match.

matchCount
number

Number of matching public entries.

matches
object[]

Possible name matches in public records.