Aadhaar Masking
Use this API to mask the first 8 digits of your customer’s aadhaar number and block the QR code (if it exists). Masking aadhaar card of your customers ensures privacy and makes it storable in your database. View the test data and use the information to trigger the validations. The test data are usable only in test environments such as gamma and sandbox.
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 guide at https://www.cashfree.com/docs/secure-id/get-started/integration/ip-whitelisting-verification | Whitelist the IP address. |
409 | ERROR | verification ID already exists | Enter a unique verification ID. |
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. |
POST
Authorizations
Client ID. You can find your ID in the Merchant Dashboard.
Client secret key. You can find your secret key in the Merchant Dashboard.
Headers
Send the signature if IP is not whitelisted.
Body
multipart/form-data
Find the request parameters to mask aadhaar number
The body is of type object
.
Response
200
application/json
Success response for masking aadhaar number
The response is of type object
.