Cashfree Payments Developer Documentation home pagelight logodark logo
  • Discord
  • Create Account
  • Create Account
Payments
Payouts
Secure ID
Partners and Platforms
Payments APIs
Payouts APIs
Secure ID APIs
Partners APIs
Additional APIs
API Reference
AI and Tools
Help Center
Secure ID APIs
  • Overview
  • Getting Started
  • SDK
  • API Rate Limits
  • Data to Test Integration
  • Webhook Signature Verification
V2
  • Bank Account Verification
  • Video KYC
  • Digilocker
  • PAN
  • 1-Click onboarding
  • AI Native Digital KYC
    • Smart OCR
    • Face Match
    • Aadhaar Masking
      • POST
        Aadhaar Masking
    • Face Liveness
    • Name Match
    • Reverse Geocoding
    • Geocoding
  • Officially Valid Documents(OVDs)
  • E-sign
  • KYC Links
  • Account Aggregator
  • Know Your Business(KYBs)
V1 (Depricated API's)
  • Bank Account Verification
Aadhaar Masking

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 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 guide at https://www.cashfree.com/docs/secure-id/get-started/integration/ip-whitelisting-verificationWhitelist 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.

Was this page helpful?

Face MatchFace Liveness Check
githubyoutubewebsite
Assistant
Responses are generated using AI and may contain mistakes.