Aadhaar UID Masking
Introduction
The Aadhaar masking API provides a simple way to mask the Aadhaar number in Aadhaar documents. This is achieved by replacing the first 8 digits of the Aadhaar number with a white stripe, which effectively hides the unique identification number or UID.
This API enables seamless integration into applications, ensuring the protection of personally identifiable information (PII) while maintaining the utility of Aadhaar documents.
The masked Aadhaar images generated by the API maintain the structural and visual aspects of the original document, making it suitable for display or storage while ensuring compliance with privacy regulations. The API response includes URLs of the masked images, which can be retrieved and used within applications or systems.
By incorporating the Aadhaar Masking API into your applications, you can enhance data protection, privacy, and compliance measures. This is particularly beneficial for applications that handle Aadhaar documents and require secure handling of sensitive information.

Pre-requisite:
You would be required to create an item object to use this API. You can reference the documentation for the same here. If you want to avoid this setup complexity, you can use this API using our new implementation.
Endpoint details:
POST https://signzy.tech/api/v2/snoopsPOST https://preproduction.signzy.tech/api/v2/snoopsRequest body parameters:
Parameter | Data Type | Description | Required |
|---|---|---|---|
service | String (e.g., "Identity") | Defines the operation that you want to perform on this API. For identity card related APIs the value of this field would be "Identity". | Yes |
itemId | String | Every identity card will get an item id assigned to them. You can create one using the Create Identity card object API call. Use the id field from the response here. | Yes |
accessToken | String | The access token for the identity object. You can get this access token from Create Identity card object API call. It's different from the access token received from the Authentication call. | Yes |
task | String | The specific task to be performed. The value here would be "aadhaarMasker". | Yes |
essentials | Object | Additional essential parameters for the task. | Yes |
essentials.url | String | URL where the document to be masked is hosted. You can use Signzy's Persist API to do the same as well. | Yes |
{
"service": "Identity",
"itemId": "...get_from_create_identity_card_api...",
"accessToken": "..get_from_create_identity_card_api...",
"task": "aadhaarMasker",
"essentials": {
"url": "https://xyz.signzy.tech/api/files/38073187/download/abc.jpg"
}
}Request headers:
Name | Value |
|---|---|
Content-Type | application/json |
Code samples:
import http.client
import json
conn = http.client.HTTPSConnection("preproduction.signzy.tech")
payload = json.dumps({
"service": "Identity",
"itemId": "...get_from_create_identity_card_api...",
"accessToken": "...get_from_create_identity_card_api...",
"task": "aadhaarMasker",
"essentials": {
"url": "https://xyz.signzy.tech/api/files/38073187/download/abc.jpg"
}
})
headers = {
'Content-Type': 'application/json'
}
conn.request("POST", "/api/v2/snoops", payload, headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))Response body parameters:
Parameter | Data type | Description |
|---|---|---|
service | String | For identity card related APIs the value of this field would be "Identity". |
itemId | String | Every identity card will get an item id assigned to them. You can create one using the Create Identity card object API call. Use the id field from the response here. |
task | String | The specific task performed. Value here would be "aadhaarMasker". |
essentials | Object | Additional essential parameters for the task. |
essentials.url | String | URL where the document to be masked is hosted. |
accessToken | String | The access token or API key used for authentication. |
id | String | The unique identifier for the API response. |
response | Object | The response data for the API call. |
response.result | Object |  |
response.result.isMasked | String | Value will define whether the Aadhaar is masked or not. Possible response values are "yes" or "no". |
response.result.maskedImages | Array | Masked document URLs. |
{
"service": "Identity",
"itemId": "...itemId...",
"task": "aadhaarMasker",
"essentials": {
"url": "https://xyz.signzy.tech/api/files/38073187/download/abc.jpg"
},
"accessToken": "...access_token...",
"id": "6467524255677d0011ea54c7",
"response": {
"urls": [
"https://xyz.signzy.tech/api/files/38073187/download/image.jpg"
],
"id": 16311,
"callOcrOnFallback": [
null
],
"instance": {
"id": "6467398e55677d0011ea5023",
"callbackUrl": "https://your-domain.com/your-callback-system"
},
"result": {
"isMasked": "yes",
"maskedImages": [
"https://xyz.signzy.tech/api/files/566886229/download/masked-image.jpg"
]
}
}
}Document(to be masked) related Constraints:
- Our API supports masking of the following types of Aadhar documents: Aadhaar Letter, eAadhaar, and Aadhaar PVC card.
- The document being shared as part of the API payload needs to be a single page.
- Size should not exceed 2MB.
- Supported document types:
- Image - JPEG, JPG, PNG, and TIFF.
- For best results, please make sure that the image you use fits tightly in the camera view and is horizontally aligned.
API Performance
Latency | Defines the time it takes for a request to travel from one place to another and get a response back. | Approx 3 seconds |
|---|---|---|
Success rate | Defines how often the API performs its intended function without any errors or problems. | 99.9%(Processing valid Aadhaar documents) |
Contact Us for Any Assistance
If you have any questions or need assistance, please reach out to our customer support team. You can contact us via email at [email protected]. We strive to provide prompt and reliable assistance, ensuring your queries are addressed effectively.
We value your feedback and are committed to making your experience smooth and enjoyable. Our team is dedicated to assisting you with any needs you may have. Thank you for choosing our services. We look forward to helping you!