Aadhaar Masking

These are set of APIs that help with document forensic checks like template validation, image quality, photocopy, and spoof checks.

POST /v1/documents/aadhaar-masking

Aadhaar Masking

cURL

curl --request POST \
  --url https://production.deepvue.tech/v1/documents/aadhaar-masking \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "document": "<string>",
  "consent": "<string>"
}
'

200

200 - Success

{
  "code": 200,
  "timestamp": null,
  "transaction_id": "string",
  "sub_code": "SUCCESS",
  "message": "Document Masked Successfully",
  "data": {
    "masked_document": "string"
  }
}

Aadhaar masking hides the QR code and first 8 digits of the Aadhaar number on official documents, safeguarding privacy and minimizing identity theft risk. This practice enables verifications while limiting access to personal information, ensuring privacy and data security.

Aadhaar masking API takes base64 or publically accessible URL of the aadhaar document as input and returns back the masked Aadhaar Document in response.

Authorizations

Authorization · string · header · required

ACCESS_TOKEN generated from the authorize endpoint. Should be included in the header as Bearer .

x-api-key · string · header · required

The CLIENT_SECRET provided to you. This header parameter is required for authentication purposes.

Body

application/json

document · string · required

consent · string · required

Response

200

application/json

Successful Response

Document Masked Successfully

Invalid Document

code · integer · default: 200

timestamp · integer | null

transaction_id · string

sub_code · string · default: SUCCESS

message · string · default: Document Masked Successfully

data · Data · object

Show child attributes