Skip to main content
POST
identity.number.verify

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
documentType
enum<string>
required

Kind of identity number.

Available options:
tax_id,
national_id,
voter_id,
driving_licence,
passport
number
string
required

Identity number to verify.

Required string length: 1 - 512
country
string
required

Country code, for example IN.

Pattern: ^[A-Z]{2}$

The person has approved this check.

reason
string
required

Reason for the check, at least 20 characters.

Required string length: 20 - 512

Response

The result

valid
boolean
required

Whether this identity number is valid.

name
string

Registered holder name.

Required string length: 1 - 512
category
string

Holder category.

Required string length: 1 - 512
ageBand
string

Approximate age band.

Required string length: 1 - 512
gender
string

Recorded gender.

Required string length: 1 - 512
region
string

Registered region.

Required string length: 1 - 512
maskedPhone
string

Masked registered phone.

Required string length: 1 - 512
nationalIdLinked
boolean

Whether the tax record is linked to a national identifier.