v1

latestOpenAPI 3.1.02026-07-2418201.6 MB

Aadhaar UID Masking

post/v2/kyc/identities/mask_aadhaar_uid

Headers

client_idstring required

ID/identifier that is provided by Decentro to a specific client and environment. Please note, this may change based on the environment you are on.

client_secretstring required

The confidential credential provided by Decentro that is associated with the client_id

content-typestring

Request body

reference_idstring required

Any unique ID assigned by you for this API request.

consentstring required

true/false based on the consent given by the customer. Mandatory as per regulation.

consent_purposestring required

The purpose of taking this consent from your customer. Mandatory as per regulation

imagestring binary

Upload the image of Aadhaar to Mask UID

image_urlstring

URL of the Aadhaar Image

Response

200

decentroTxnIdstring

statusstring

responseCodestring

messagestring

responseKeystring

Example response

{
  "decentroTxnId": "DECXXXXXXXXXXXXXXXXXXXXXXXXXXX",
  "status": "SUCCESS",
  "responseCode": "S00000",
  "message": "Successfully completed Aadhaar UID Masking",
  "data": {
    "isMasked": true,
    "maskedImages": [
      "<Base64 Image>"
    ]
  },
  "responseKey": "success_aadhaar_masking"
}