Skip to main content
POST
identity.document.mask

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

The person agreed to process this document.

file
string

Id of an uploaded file holding Aadhaar image or PDF, at most 5 MB, in place of a public link.

Pattern: ^file_[0-9A-HJKMNP-TV-Z]{26}$
url
string

Public image or PDF URL, safely fetched with a 5 MB limit; do not send a private link.

base64
string

Base64-encoded PNG, JPEG or PDF, at most 1 MB decoded; requires base64 transport.

Required string length: 1 - 1333336
fileName
string

Optional output PNG filename.

Required string length: 1 - 200
Pattern: ^[^/\\]+\.png$
transport
enum<string>
default:file

File upload, or a base64 submission limited to 1 MB.

Available options:
file,
base64
maskQr
boolean
default:false

Also conceal the QR code; requires base64 submission.

validateDocument
boolean
default:false

Explicitly validate that the image is an Aadhaar document; requires base64 submission and adds one estimated unit.

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.