---
title: "Aadhaar Masking"
method: POST
path: "/v1/documents/aadhaar-masking"
tags: ["Document Forensics"]
---

# Aadhaar Masking

`POST /v1/documents/aadhaar-masking`

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.

## Request body

- AadhaarMaskingPayload
  - `document` string, required
  - `consent` string, required

## Response `200`

Successful Response

- union
  - RESPONSEAADHAARMASKINGSUCCESSFUL
    - `code` integer
    - `timestamp` integer, required
    - `transaction_id` string, required
    - `sub_code` string
    - `message` string
    - `data` AadhaarMaskingData, required
      - `masked_document` string, required
  - RESPONSEAADHAARMASKINGNOIDFOUND
    - `code` integer
    - `timestamp` integer, required
    - `transaction_id` string, required
    - `sub_code` string
    - `message` string

## Other responses

- `400` — Bad Request
- `401` — Unauthorized
- `403` — Forbidden
- `422` — Unprocessable Entity
- `500` — Internal Server Error

---

[API](https://skmtc.dev/deepvue/apis/deepvue-tech-developers-guide.md) · [All operations](https://skmtc.dev/deepvue/apis/deepvue-tech-developers-guide/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/deepvue/deepvue-tech-developers-guide/revisions/c1b0558e7d77/schema)