The API is used to Mask Aadhaar Number of an individual. It mask the first eight digits of the Aadhaar number on a copy of the Aadhaar card, leaving only the last four digits visible. Digio Aadhaar masking API can be used to mask the aadhaar image file in JPG/JPEG/PNG or pdf format. It can also be used to mask Base64 encoded Aadhaar image files.
Getting started with Digio Rest Apis
|
HTTP Basic
Send
Authorization in header containing the word Basic followed by a space and a base64 encoded string of username:password.
|
Call this API to get masked image of the Aadhaar Card
|
file*
binary
|
||
|
Aadhaar image file in JPEG/JPG/PNG or PDF format |
||
|
consent*
string
|
||
|
yes/no. Positive consent is mandatory to perform this action. |
||
|
file_name
string
|
||
|
Response file name if it has to be a specific one. Output given will always be in .png |
||
|
unique_request_id
string
|
||
|
Unique request id for traceability of request and recon purpose. Businesses are required to pass unique id for every request. |
||
curl -X POST "https://api.digio.in/v4/client/kyc/aadhaar/file/mask" \
-H 'accept: application/json' Base64 encoded image of Masked Aadhaar Card
Error message indicating cause of error.
Masking Details
Number of instances where detail was already masked. eg. If a document has 3 instances of Aadhaar number where 2 instances are already masked, then this count will bet 2
Number of instances where the masking is done eg. In a document if Aadhaar number appears 4 times in a document then this count will be 4
Details about the exception. Usually contains the exception id for reference.
Error code
Description of the error
Custom errors
Getting started with Digio Rest Apis
|
HTTP Basic
Send
Authorization in header containing the word Basic followed by a space and a base64 encoded string of username:password.
|
Call this API to get Masked Image of the Aadhaar Card Please Note: Try to keep the file size as small as possible for faster results and not more than 1 MB as a good practice.
{
"reference_id": "",
"unique_request_id": "",
"data": "string",
"file_name": "string",
"data_content_type": "PNG",
"is_validate": false,
"consent": "yes",
"mask_qr": false
}
➔ Reference ID
➔ Unique request id for traceability of request and recon purpose. Businesses are required to pass unique id for every request.
Base64 encoded Aadhaar image file in JPEG/JPG or PNG format. If you want to use PDF pass another attribute “data_content_type”:”PDF”
Response file name if it has to be a specific one. Always given with .png
➔ It is the type of file upload supported for masking.
Pass True if you wish to get the document validated (whether it is an Aadhaar or not)
➔ yes/no
true/false
curl -X POST "https://api.digio.in/v4/client/kyc/aadhaar/mask" \
-H 'accept: application/json' Base64 encoded image of Masked Aadhaar Card
Error message indicating cause of error.
Masking Details
Number of instances where detail was already masked. eg. If a document has 3 instances of Aadhaar number where 2 instances are already masked, then this count will bet 2
Number of instances where the masking is done eg. In a document if Aadhaar number appears 4 times in a document then this count will be 4
Details about the exception. Usually contains the exception id for reference.
Error code
Description of the error
Custom errors
Was this page helpful?