How To Do Aadhaar Verification With Zwitch API

Confirming a customer’s Aadhaar is essential for regulatory compliance and fraud prevention. This verification is vital in sectors such as finance and e-commerce, where online Aadhaar checks facilitate smooth Know Your Customer (KYC) processes. As businesses increasingly depend on digital solutions, incorporating an Aadhaar Verification API is essential for effective customer onboarding and secure operations.

Why Aadhaar Verification is Essential

• Regulatory compliance: Aadhaar verification ensures adherence to government-mandated KYC norms, protecting businesses from legal repercussions.
• Fraud prevention: Validating Aadhaar helps prevent identity theft and ensures customer authenticity.
• Trust building: Demonstrates a business’s commitment to transparency, fostering trust with customers and stakeholders.
• Operational efficiency: Aadhaar verification streamlines processes, reducing manual errors and expediting decision-making.

By incorporating Aadhaar verification into your processes, your business can ensure compliance, improve security, and enhance customer trust.

Benefits of Aadhaar Verification API

• Automation: The API automates Aadhaar verification, saving time and reducing manual errors.
• Scalability: Handle high-volume verifications effortlessly as your business grows.
• Flexibility: Easy integration into existing systems enables customized verification workflows.
• Data security: Ensures compliance with privacy regulations while securing sensitive customer information.

Automating Aadhaar Verification with Zwitch API

Zwitch’s Aadhaar Verification API simplifies and automates the process, offering businesses a reliable way to validate Aadhaar details. Below is a step-by-step guide for integrating Zwitch’s Aadhaar Verification API.

Step 1: Setting Up Your Zwitch Account

To begin, create an account with Zwitch. Once your account is set up and the required services are activated on your Zwitch dashboard, you’ll receive API keys specific to your account. These keys act as your credentials for accessing the API.

Step 2: Authentication and Authorization

Each API request must include a Bearer Token in the request header for secure access.

Authorization: Bearer <access-key:secret-key>

This ensures that only authorized users can interact with the API.

Step 3: Sending an OTP for Aadhaar Verification

To initiate Aadhaar verification, you’ll send a POST request to the Aadhaar OTP endpoint.

POST <https://api.zwitch.io/v1/kycs/aadhaar/otp>

Required Parameters

• aadhaar_number: The 12-digit Aadhaar number of the individual.
• merchant_reference_id: A unique identifier for your reference.
• consent: Consent of the individual to get their details from the Aadhaar database.
• metadata (optional): Additional key-value pairs for tracking or analytics.

Here’s an example request:

{
  "consent": true,
  "aadhaar_number": "395996370872",
  "name": "John Doe",
  "merchant_reference_id": "1000872"
}

This is the data you’ll send to the API for verification. This triggers an OTP to the Aadhaar-linked mobile number and gives a response.

{
  **"id": "adh_51dBvuiuTJXtkx7rmj8iUbf3p"**,
  "type": "otp",
  "object": "aadhaar_verification",
  "aadhaar_number": "XXXXXXXX0872",
  "name": "John Doe",
  "message": "OTP sent to registered mobile number",
  "status": "success",
  "remark": null,
  "merchant_reference_id": "1000872",
  "consent": true,
  "created_at": 1678372025,
  "is_sandbox": true
}

Interpreting The Response

Once you’ve sent the request, the API will respond with a result. The response will tell you if the OTP was sent successfully or failed, along with other important information.

The API will return a JSON response with the verification results. Key fields include:

• id: Unique identifier of the Aadhaar verification request in the Zwitch database.
• type: The type of verification you want to perform.
• object: API object that is returned.
• aadhaar_number: Aadhaar number that is being verified.
• name: In the Send OTP API, this is the customer’s name that should be verified against the name linked to the Aadhaar number.
• message: The result of the API call.
• status: Status of the Send OTP request success or failed
• remark: Any remarks that may be required.
• merchant_reference_id: Unique identifier entered when creating the verification request.
• consent: Consent of the individual to get their details from the Aadhaar database.
• created_at: Unix timestamp when Zwitch received the request.
• is_sandbox: The mode in which the API was triggered.

Step 4: Download Aadhaar Details

After receiving the OTP, validate it using another POST request to the Aadhaar OTP verification endpoint. Make sure to use the id in the above response in the endpoint:

<https://api.zwitch.io/v1/kycs/aadhaar/**{aadhaar_verification_id}**/verify>

Required Parameters

• otp: The OTP received on the registered mobile number.

Example request:

{
  "otp": "000000"
}

This above is the data you’ll send to the API for verification. This triggers a request to verify the OTP and gives a response.

Success Response Example:

In case of a successful verification, the status field will say “success,” and the message field will describe “Aadhaar verified successfully”.

{
  "id": "adh_51dBvuiuTJXtkx7rmj8iUbf3p",
  "object": "aadhaar_verification",
  "message": "Aadhaar verified successfully",
  "status": "success",
  "name": "John Doe",
  "aadhaar_number": "XXXXXXXX0872",
  "date_of_birth": "2001-01-01",
  "gender": "Male",
  "father_name": null,
  "address": "John Doe, 211B Baker Street, Bangalore - 560005",
  "postal_code": "560035",
  "state": "Karnataka",
  "state_code": "KA",
  "city": "bangalore urban",
  "remark": null,
  "merchant_reference_id": "1004370",
  "consent": true,
  "is_sandbox": true
}

Failed Response Example:

In case of failure, the status field will say “failed,” and the message field will describe why it failed. (e.g., “Invalid OTP”)

{
  "id": "adh_51dBvuiuTJXtkx7rmj8iUbf3p",
  "object": "aadhaar_verification",
  "message": "Invalid OTP",
  "status": "failed",
  "aadhaar_number": "XXXXXXXX0000",
  "father_name": null,
  "remark": null,
  "merchant_reference_id": "1000794",
  "consent": true,
  "is_sandbox": true
}

Error Handling

If there’s an issue with your request, you’ll receive an error message to identify the problem.

401 Unauthorized

This means there’s an issue with your API key or token. Make sure you’ve included the correct Bearer Token.

{
  "error": {
    "type": "authentication_error",
    "message": "Invalid secret key."
  }
}

422 Unprocessable Entity

This indicates that one or more parameters in your request are incorrect or not formatted properly.

{
  "error": {
    "type": "invalid_request_error",
    "code": "resource_missing",
    "message": "no such id : adh_51dBvuiuTJXtkx7rmj8iUbf3p",
    "param": "id"
  }
}

Conclusion

Integrating Aadhaar verification through Zwitch’s API ensures regulatory compliance, enhances security, and improves operational efficiency. By following this guide, you can seamlessly integrate Aadhaar verification into your system and streamline your onboarding processes.

For more information, refer to the Zwitch Aadhaar Verification API Documentation.

FAQs

How does the Aadhaar Verification API benefit businesses?

It ensures compliance with KYC norms, prevents fraud, and streamlines onboarding processes through automation.

What information is needed for Aadhaar verification?

The Aadhaar number, an OTP sent to the registered mobile number, and a merchant reference ID.

Does Zwitch provide a testing environment?

Yes, you can use Zwitch’s sandbox environment to test API integrations before deploying live.

How secure is the Aadhaar verification process?

The process is highly secure, adhering to authentication protocols and privacy regulations.

Can Aadhaar Verification API handle large-scale verifications?

Yes, the API is scalable and can manage high-volume verifications efficiently.