POST
/
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=image \
  --form verification_id=testverificationid
{
  "image_link": "https://image.url.link",
  "reference_id": 354768,
  "verification_id": "testverificationid",
  "status": "VALID"
}

Authorizations

​
x-client-id
string
header
required

Client ID. You can find your ID in the Merchant Dashboard.

​
x-client-secret
string
header
required

Client secret key. You can find your secret key in the Merchant Dashboard.

Headers

​
x-cf-signature
string

Send the signature if IP is not whitelisted

Body

multipart/form-data
Find the request parameters to mask aadhaar number

Find the request parameters to mask Aadhaar information.

​
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.

​
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

200
application/json
Success response for masking aadhaar number

Success response for Aadhaar Masking API

​
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"

Was this page helpful?