Skip to main content
POST
identity.identifier.lookup

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

Kind of Indian identity document.

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

Identity document number.

Required string length: 1 - 100

The person approved this lookup.

reason
string
required

Reason for the identity lookup.

Required string length: 20 - 500
name
string

Holder name when required.

Required string length: 1 - 100
dateOfBirth
string

Birth date, YYYY-MM-DD.

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

Passport application file number.

Required string length: 1 - 100
advanced
boolean
default:false

Request advanced details; unsupported choices are refused.

Response

The result

found
boolean
required

Whether a matching identity record was returned; not a validity verdict.

name
string

Holder name on the selected record.

Required string length: 1 - 500
status
string

Status reported for this document or application.

Required string length: 1 - 500
category
string

Tax holder category.

Required string length: 1 - 500
region
string

Voter registration region.

Required string length: 1 - 500
issuedOn
string

Document issue date.

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