Skip to main content
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=testverificationid
{
  "image_link": "https://image.url.link",
  "reference_id": 354768,
  "verification_id": "testverificationid",
  "status": "VALID"
}
Sub codeStatusMessageNext action
200SUCCESSVALID-
200SUCCESSINVALID_DOCUMENTUpload a valid copy of the aadhaar.
400ERRORx-client-id is missing in the requestEnter all the header information in the API request.
400ERRORimage is missing in the requestUpload the image file of the aadhaar card that needs masking.
400ERRORverification_id can include only alphanum, dot, hyphen and underscoresOnly alphanumeric, period (.), hyphen (-), and underscore ( _ ) are allowed.
400ERRORClient secret belongs to test environmentEnter the correct environment credentials in the request.
401ERRORInvalid clientId and clientSecret combinationEnter valid client ID and secret key in the request.
403ERRORIP not whitelisted your current IP is 106.51.91.104. For IP whitelisting assistance, visit our IP Whitelisting guideWhitelist the IP address.
409ERRORverification ID already existsEnter a unique verification ID.
413ERRORfile size exceededThe maximum file size should be 10 MB.
422ERRORInsufficient balance to process this request.Ensure you have sufficient balance and then process the request.
500ERRORsomething went wrongTry after some time.

Authorizations

ā€‹
x-client-id
string
header
required

Your unique client identifier issued by Cashfree. You can find this in your Merchant Dashboard.

ā€‹
x-client-secret
string
header
required

The secret key associated with your client ID. Use this to authenticate your API requests. You can find this in your Merchant Dashboard.

Headers

ā€‹
x-cf-signature
string

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

ā€‹
image
file
required

It is the image file of the aadhaar card that needs masking. Accepted formats - short, long, and PVC. Allowed file type - JPEG/JPG/PNG. The maximum file size should be 10 MB.

Example:

"image"

ā€‹
verification_id
string
default:testverificationid
required

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

ā€‹
status
string

It displays the status of the aadhaar information.

Example:

"VALID"

ā€‹
reference_id
integer

It displays the unique ID created by Cashfree Payments for reference purposes. format: int64

Example:

35476

ā€‹
verification_id
string

It displays the unique ID you created to identify the verification request

Example:

"testverificationid"

ā€‹
image_link
string

It displays the URL of the image.

Example:

"https://image.url.here"