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.
API Details
Endpoint:
POST https://api.signzy.app/api/v3/aadhaar/maskersPOST https://api-preproduction.signzy.app/api/v3/aadhaar/maskersRequest body parameters:
Parameter | Data Type | Description | Required |
|---|---|---|---|
urls | Array | URLs where the document to be masked is hosted. You can use Signzy's Persist API to do the same as well. | Yes |
requestType | Boolean | Defines whether the document passed in the request should be checked for masking status. Masking status can have one of the following values: M (masked), I (Invalid), P (Partial), and U (Unmasked). | Optional |
{
"urls": [
"https://domain/...hosted_image.../image.jpg"
],
"requestType": true
}Request headers:
Name | Value | Required | Description |
|---|---|---|---|
Content-Type | application/json | Yes | An authentication token to authorize the request. Reach out to the Signzy support team to get one created. |
Authorization | XXXXXXXXXXX | Yes | The type of content that the request body contains. |
Code samples:
curl --location 'https://api-preproduction.signzy.app/api/v3/aadhaar/maskers' \
--header 'Content-Type: application/json' \
--header 'Authorization: {{kong_access_token}}' \
--data '{
"urls": [
"https://domain/...hosted_image.../image.jpg"
],
"requestType": true
}'Response body parameters:
Parameter | Data type | Description |
|---|---|---|
result | Object | The response returned by the API. |
result.isMasked | String | Value will define whether the Aadhaar is masked or not. Possible respone values are "yes" or "no". |
result.maskedImages | Array | Masked document URLs. |
result.requestType | String | Defines the masking status of the document passed in the request and can have one of the following values: M (masked), I (Invalid), P (Partial), U (Unmasked), and E(failed to identify the status of the document passed). |
{
"result": {
"isMasked": "yes",
"maskedImages": [
"https://domain/...hosted_image.../masked_image.jpg"
],
"requestType": "U"
}
}Document(to be masked) related Constraints:
- Our API supports masking of the following types of Aadhar documents: Aadhaar Letter, eAadhaar, and Aadhaar PVC card.
Types of Aadhaar documents
- 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.
- PDF
- 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!