Skip to main content
POST
identity.document.qr.decode

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
country
string
required

Document country.

Allowed value: "IN"
securedQrText
string
required

Secure QR contents encoded as base64; never returned.

Required string length: 4 - 200000
Pattern: ^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$
requestedFields
enum<string>[]

Only these personal fields are returned.

Required array length: 1 - 6 elements

Requested identity fact.

Available options:
name,
dateOfBirth,
gender,
careOf,
address,
lastFour

Response

The result

name
string

Decoded name; this is not authenticated source verification.

Required string length: 1 - 1024
dateOfBirth
string

Date in YYYY-MM-DD format.

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

Decoded gender; this is not authenticated source verification.

Required string length: 1 - 1024
careOf
string

Decoded careOf; this is not authenticated source verification.

Required string length: 1 - 1024
address
string

Decoded address; this is not authenticated source verification.

Required string length: 1 - 1024
lastFour
string

Last four identity-number digits.

Pattern: ^\d{4}$