Integration Flow

With ZWITCH, you can verify an individual’s Aadhaar in 2 steps.

332 — Aadhaar Verification via OTP Workflow

Follow the below steps to verify an individual’s Aadhaar.

Send OTP
Download Aadhaar Details

1. Send OTP

The Aadhaar holder's consent is required to download their details from the Aadhaar database. Consent is obtained in the form of an OTP sent to the mobile number linked to the Aadhaar number.

Use the below endpoint to send an OTP to the mobile number linked to the entered Aadhaar number.

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

Below is a sample request and sample response for the Send OTP API.

{
  "aadhaar_number": "123456787824",
  "name": "Anil Reddy",
  "merchant_reference_id": "1298867i"
}

{
  "id": "adh_frU0Ci7GLAntGqtaL1RTHyc1J",
  "object": "aadhaar_verification",
  "aadhaar_number": "XXXXXXXX6824",
  "name": "Anil Reddy",
  "message": "OTP sent to registered mobile number",
  "status": "success",
  "remark": null,
  "merchant_reference_id": "1298867i",
  "created_at": 1655209188,
  "is_sandbox": false
}

2. Download Aadhaar Details

The Aadhaar holder sends you the OTP they received. Use this OTP to download their details from the Aadhaar database.

Use the below endpoint to download Aadhaar details.

POST: https://api.zwitch.io/v1/kycs/aadhaar/{aadhaar_id}/verify

Below is a sample request and response for the Download Aadhaar Details API.

{
  "otp": "000000"
}

{
  "id": "adh_frU0Ci7GLAntGqtaL1RTHyc1J",
  "object": "aadhaar_verification",
  "message": "Aadhaar XML file downloaded successfully",
  "status": "success",
  "name": "Anil Reddy",
  "aadhaar_number": "XXXXXXXX6824",
  "date_of_birth": "1991-12-31",
  "gender": "M",
  "father_name": "Sunil Reddy",
  "address": "221B, Baker Street",
  "postal_code": "560100",
  "state": "Karnataka",
  "state_code": "KA",
  "city": "bangalore",
  "remark": null,
  "merchant_reference_id": "1298867i",
  "is_sandbox": false
}

Learn more about our Aadhaar Verification via OTP APIs.