Skip to main content
POST
Unmask one PII field

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

id
string
required

Body

application/json

Field + actor

actor
string
required

Required. Identifier of the person or system on whose behalf this unmask is requested — e.g. the downstream end-user id, since the API caller may be an intermediary auth system.

field
string
required

Dotted path of the single field to reveal: pan | contact.email | contact.mobile | joint_holders..pan | joint_holders..email | joint_holders..mobile | guardian.pan | nominees..pan | bank_accounts.<account_id>.account_no.

reason
string

Optional free-text justification, stored on the audit record.

Response

200 - application/json

Plaintext value

success
boolean
required
data
object