Skip to main content
POST
fraud.identity.check

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-Account
string

Optional. One of your account ids (GET /v1/accounts): run on that account, whatever your routing rules say. The response header X-Pramaan-Account names the account that ran.

Pramaan-End-User
string

Optional. Your own tag for your end user: a sticky: end_user rule keeps them on the account that first served them.

Maximum string length: 256
Pramaan-End-User-Group
string

Optional. Your end user's group, matched by rules with endUserGroup.

Maximum string length: 64

Body

application/json
eventKey
string
required

Your stable event key.

Required string length: 1 - 255
subjectKey
string
required

Your stable subject key.

Required string length: 1 - 256
countryCode
string
required

Two-letter country code.

Pattern: ^[A-Za-z]{2}$
method
enum<string>
required

Country-specific factual identity check.

Available options:
citizen-register,
credit-header,
credit-header-regulated,
residential,
tax-identity,
tax-identity-expanded,
foreigner-identity,
temporary-protection,
national-identity,
bank-identity,
social-security,
driving-document,
identity-prefill
firstName
string

First name.

Required string length: 1 - 100
middleName
string

Middle name.

Required string length: 1 - 100
lastName
string

Last name.

Required string length: 1 - 100
fullName
string

Full name.

Required string length: 1 - 100
dateOfBirth
string

Calendar date, YYYY-MM-DD.

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

Identity value.

Required string length: 1 - 100
gender
enum<string>

Gender where required by the chosen register.

Available options:
MALE,
FEMALE
phone
string

International phone number with country code, without spaces.

Maximum string length: 19
Pattern: ^\+?[0-9]{7,18}$
email
string
Required string length: 1 - 320
address
object

Postal address; country and street are required.

issuingRegion
string

Driving-document issuing region.

Required string length: 1 - 100
includePerson
boolean

Return name, birth date and gender facts; default off.

includeContacts
boolean

Return contact facts; default off.

includeAddresses
boolean

Return address facts; default off.

Response

Job started; poll GET /v1/jobs/{id}

job_id
string
required
status
enum<string>
required
Available options:
running
held_micro
integer
required

The credit set aside for the job (its estimate), micro-USD; 0 when it takes none. Not a price: what the job is charged reads on GET /v1/jobs/{id} once it is settled.