Aadhaar Masking
curl --request POST \
--url https://sandbox.cashfree.com/verification/aadhaar-masking \
--header 'Content-Type: multipart/form-data' \
--header 'x-client-id: <api-key>' \
--header 'x-client-secret: <api-key>' \
--form image='@example-file' \
--form verification_id=testverificationidimport requests
url = "https://sandbox.cashfree.com/verification/aadhaar-masking"
files = { "image": ("example-file", open("example-file", "rb")) }
payload = { "verification_id": "testverificationid" }
headers = {
"x-client-id": "<api-key>",
"x-client-secret": "<api-key>"
}
response = requests.post(url, data=payload, files=files, headers=headers)
print(response.text)const form = new FormData();
form.append('image', 'image');
form.append('verification_id', 'testverificationid');
const options = {
method: 'POST',
headers: {'x-client-id': '<api-key>', 'x-client-secret': '<api-key>'}
};
options.body = form;
fetch('https://sandbox.cashfree.com/verification/aadhaar-masking', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://sandbox.cashfree.com/verification/aadhaar-masking",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => "-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"image\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\nimage\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"verification_id\"\r\n\r\ntestverificationid\r\n-----011000010111000001101001--",
CURLOPT_HTTPHEADER => [
"Content-Type: multipart/form-data",
"x-client-id: <api-key>",
"x-client-secret: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://sandbox.cashfree.com/verification/aadhaar-masking"
payload := strings.NewReader("-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"image\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\nimage\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"verification_id\"\r\n\r\ntestverificationid\r\n-----011000010111000001101001--")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("x-client-id", "<api-key>")
req.Header.Add("x-client-secret", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://sandbox.cashfree.com/verification/aadhaar-masking")
.header("x-client-id", "<api-key>")
.header("x-client-secret", "<api-key>")
.body("-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"image\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\nimage\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"verification_id\"\r\n\r\ntestverificationid\r\n-----011000010111000001101001--")
.asString();require 'uri'
require 'net/http'
url = URI("https://sandbox.cashfree.com/verification/aadhaar-masking")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["x-client-id"] = '<api-key>'
request["x-client-secret"] = '<api-key>'
request.body = "-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"image\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\nimage\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"verification_id\"\r\n\r\ntestverificationid\r\n-----011000010111000001101001--"
response = http.request(request)
puts response.read_body{
"image_link": "https://image.url.link",
"reference_id": 354768,
"verification_id": "testverificationid",
"status": "VALID"
}Aadhaar
Aadhaar Masking
Use this API to protect customer privacy by masking sensitive Aadhaar information. It masks the first 8 digits and disables QR codes, making Aadhaar cards safe to store in your database while maintaining compliance with data protection regulations.
View the test data and use the information to trigger the validations. The test data can be used only in the sandbox environment.
POST
/
aadhaar-masking
Aadhaar Masking
curl --request POST \
--url https://sandbox.cashfree.com/verification/aadhaar-masking \
--header 'Content-Type: multipart/form-data' \
--header 'x-client-id: <api-key>' \
--header 'x-client-secret: <api-key>' \
--form image='@example-file' \
--form verification_id=testverificationidimport requests
url = "https://sandbox.cashfree.com/verification/aadhaar-masking"
files = { "image": ("example-file", open("example-file", "rb")) }
payload = { "verification_id": "testverificationid" }
headers = {
"x-client-id": "<api-key>",
"x-client-secret": "<api-key>"
}
response = requests.post(url, data=payload, files=files, headers=headers)
print(response.text)const form = new FormData();
form.append('image', 'image');
form.append('verification_id', 'testverificationid');
const options = {
method: 'POST',
headers: {'x-client-id': '<api-key>', 'x-client-secret': '<api-key>'}
};
options.body = form;
fetch('https://sandbox.cashfree.com/verification/aadhaar-masking', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://sandbox.cashfree.com/verification/aadhaar-masking",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => "-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"image\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\nimage\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"verification_id\"\r\n\r\ntestverificationid\r\n-----011000010111000001101001--",
CURLOPT_HTTPHEADER => [
"Content-Type: multipart/form-data",
"x-client-id: <api-key>",
"x-client-secret: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://sandbox.cashfree.com/verification/aadhaar-masking"
payload := strings.NewReader("-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"image\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\nimage\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"verification_id\"\r\n\r\ntestverificationid\r\n-----011000010111000001101001--")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("x-client-id", "<api-key>")
req.Header.Add("x-client-secret", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://sandbox.cashfree.com/verification/aadhaar-masking")
.header("x-client-id", "<api-key>")
.header("x-client-secret", "<api-key>")
.body("-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"image\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\nimage\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"verification_id\"\r\n\r\ntestverificationid\r\n-----011000010111000001101001--")
.asString();require 'uri'
require 'net/http'
url = URI("https://sandbox.cashfree.com/verification/aadhaar-masking")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["x-client-id"] = '<api-key>'
request["x-client-secret"] = '<api-key>'
request.body = "-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"image\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\nimage\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"verification_id\"\r\n\r\ntestverificationid\r\n-----011000010111000001101001--"
response = http.request(request)
puts response.read_body{
"image_link": "https://image.url.link",
"reference_id": 354768,
"verification_id": "testverificationid",
"status": "VALID"
}Response codes
Response codes
| Sub code | Status | Message | Next action |
|---|---|---|---|
| 200 | SUCCESS | VALID | - |
| 200 | SUCCESS | INVALID_DOCUMENT | Upload a valid copy of the aadhaar. |
| 400 | ERROR | x-client-id is missing in the request | Enter all the header information in the API request. |
| 400 | ERROR | image is missing in the request | Upload the image file of the aadhaar card that needs masking. |
| 400 | ERROR | verification_id can include only alphanum, dot, hyphen and underscores | Only alphanumeric, period (.), hyphen (-), and underscore ( _ ) are allowed. |
| 400 | ERROR | Client secret belongs to test environment | Enter the correct environment credentials in the request. |
| 401 | ERROR | Invalid clientId and clientSecret combination | Enter valid client ID and secret key in the request. |
| 403 | ERROR | IP not whitelisted your current IP is 106.51.91.104. For IP whitelisting assistance, visit our IP Whitelisting guide | Whitelist the IP address. |
| 409 | ERROR | verification ID already exists | Enter a unique verification ID. |
| 400 | ERROR | Provide a valid file or file_url | Upload a valid file type. |
| 413 | ERROR | file size exceeded | The maximum file size should be 10 MB. |
| 422 | ERROR | Insufficient balance to process this request. | Ensure you have sufficient balance and then process the request. |
| 500 | ERROR | something went wrong | Try after some time. |
Authorizations
Your unique client identifier issued by Cashfree. You can find this in your Merchant Dashboard.
The secret key associated with your client ID. Use this to authenticate your API requests. You can find this in your Merchant Dashboard.
Headers
Send the signature if two-factor authentication is selected as Public Key. More details.
Body
multipart/form-data
Find the request parameters to mask aadhaar number.
Upload the Aadhaar card image to mask. The API accepts short, long, and PVC card formats in JPEG, JPG, PNG, or PDF file types. The file size must not exceed 10 MB.
It is the unique ID you create to identify the verification request. The maximum character limit is 50. Only alphanumeric, period (.), hyphen (-), and underscore ( _ ) are allowed.
Example:
"testverificationid"
Response
Success response for masking aadhaar number.
It displays the status of the aadhaar information.
Example:
"VALID"
It displays the unique ID created by Cashfree Payments for reference purposes.
format: int64
Example:
35476
It displays the unique ID you created to identify the verification request.
Example:
"testverificationid"
It displays the URL of the image.
Example:
"https://image.url.here"
Was this page helpful?
⌘I