Aadhaar eKYC API Integration Guide: OKYC vs Offline KYC Methods

Aadhaar eKYC (Electronic Know Your Customer) allows businesses to verify customer identity instantly using their Aadhaar number. This guide covers all Aadhaar verification methods and how to integrate them into your application.

Types of Aadhaar Verification

There are three main methods to verify Aadhaar:

OTP

Aadhaar eKYC (OTP)

Real-time verification using OTP sent to Aadhaar-linked mobile number.

  • Requires customer OTP
  • Returns full KYC data
  • Photo, address, DOB
  • UIDAI authentication
XML

Offline KYC (XML)

Customer downloads XML from UIDAI and shares with you.

  • No OTP needed
  • Customer-initiated
  • Masked Aadhaar (last 4 digits)
  • Valid for 3 days
QR

OKYC (QR Based)

Scan QR code from physical Aadhaar card or downloaded PDF.

  • No OTP needed
  • Instant verification
  • Limited data (no photo)
  • Signed by UIDAI

Aadhaar eKYC API Flow

Here is the step-by-step flow for OTP-based Aadhaar eKYC:

1
Send OTP Request - Submit Aadhaar number to generate OTP
2
Customer Receives OTP - 6-digit OTP sent to Aadhaar-linked mobile
3
Submit OTP - Verify OTP with transaction ID
4
Receive KYC Data - Get verified name, address, DOB, photo

API Integration Code Examples

Step 1: Generate OTP

POST /api/v1/aadhaar/generate-otp
Content-Type: application/json

{
  "aadhaar_number": "XXXX XXXX 1234",
  "consent": true,
  "reason": "KYC verification for loan application"
}

Response:
{
  "success": true,
  "transaction_id": "TXN-ABC123456",
  "message": "OTP sent to registered mobile"
}

Step 2: Verify OTP and Get KYC

POST /api/v1/aadhaar/verify-otp
Content-Type: application/json

{
  "transaction_id": "TXN-ABC123456",
  "otp": "123456"
}

Response:
{
  "success": true,
  "data": {
    "name": "Rajesh Kumar",
    "dob": "1990-05-15",
    "gender": "M",
    "address": {
      "house": "123",
      "street": "MG Road",
      "locality": "Koramangala",
      "city": "Bangalore",
      "state": "Karnataka",
      "pincode": "560034"
    },
    "photo": "base64_encoded_image",
    "masked_aadhaar": "XXXX XXXX 1234"
  }
}

Offline Aadhaar XML Verification

For cases where OTP is not feasible, use Offline KYC:

  1. Customer downloads XML from resident.uidai.gov.in
  2. Customer sets a share code (4-digit PIN)
  3. Customer shares XML file and share code with you
  4. Your system decrypts and verifies the XML
POST /api/v1/aadhaar/verify-xml
Content-Type: multipart/form-data

{
  "xml_file": [uploaded_xml],
  "share_code": "1234"
}

Response:
{
  "success": true,
  "data": {
    "name": "Rajesh Kumar",
    "dob": "1990-05-15",
    "gender": "M",
    "address": "123, MG Road, Koramangala, Bangalore - 560034",
    "masked_aadhaar": "XXXX XXXX 1234",
    "xml_generated_on": "2024-01-15",
    "signature_valid": true
  }
}

OKYC - QR Code Verification

The QR code on Aadhaar card contains digitally signed data:

POST /api/v1/aadhaar/verify-qr
Content-Type: application/json

{
  "qr_data": "scanned_qr_code_string"
}

Response:
{
  "success": true,
  "data": {
    "name": "Rajesh Kumar",
    "dob": "1990-05-15",
    "gender": "M",
    "masked_aadhaar": "XXXX XXXX 1234",
    "signature_valid": true
  }
}

Comparison of Methods

Feature eKYC (OTP) Offline XML OKYC (QR)
OTP Required Yes No No
Photo Available Yes Yes No
Full Address Yes Yes Limited
Real-time Yes No Yes
Best For Online KYC Offline/Rural Quick verify

Compliance Requirements

When using Aadhaar for KYC, ensure compliance with:

  • Explicit Consent: Obtain clear consent before collecting Aadhaar
  • Purpose Limitation: Use Aadhaar data only for stated purpose
  • Data Security: Encrypt and securely store Aadhaar data
  • Audit Trail: Maintain logs of all Aadhaar verifications
  • UIDAI Guidelines: Follow latest UIDAI circulars and guidelines

Integrate Aadhaar Verification Today

Get API access for eKYC, Offline XML, and QR verification

Get API Access


Originally published at: Aadhaar eKYC API Integration Guide: OKYC vs Offline KYC Methods

Comments

Post a Comment

Popular posts from this blog

Credit Bureau API Integration: Access CIBIL, Experian, CRIF & Equifax Reports Without OTP

If you are a DSA agent, NBFC, or fintech company looking to automate credit assessment, integrating a Credit Bureau API is the most efficient solution. This guide covers everything you need to know about fetching credit reports from all four RBI-registered bureaus through a single API integration. Table of Contents What is Credit Bureau API Four Credit Bureaus in India No-OTP vs OTP-Based Credit Checks API Integration Guide Understanding Credit Score Ranges Industry Use Cases Compliance Requirements Getting Started What is Credit Bureau API? A Credit Bureau API is a programmatic interface that enables businesses to fetch credit reports and credit scores directly from RBI-registered Credit Information Companies (CICs). Instead of logging into multiple bureau portals and manually checking each report, you can retrieve comprehensive credit data with a single API call. The API returns structured data including credit score, payment history, active loans, credit utilizatio...
Read more

Personal Finance Guide for Indians: Budgeting, Saving & Investment Tips 2026

Managing personal finances effectively is the foundation of financial freedom. Whether you are a salaried employee, business owner, or freelancer, understanding how to budget, save, and invest your money can transform your financial future. This comprehensive guide covers everything you need to know about personal finance in India. Why Personal Finance Matters Personal finance is not just about saving money - it is about making your money work for you. Here is why it matters: 72% Indians live paycheck to paycheck 23% Have emergency fund for 3+ months 15% Invest in stock market 40% Have no retirement planning The 50/30/20 Budgeting Rule The simplest and most effective budgeting method for beginners is the 50/30/20 rule : 50% Needs Rent, food, utilities, EMIs, insurance, transport 30% Wants Entertainment, dining out, shopping, hobbies 20% Savings Emergency fund, investments, retirement Example: Monthly Budget for Rs 50,000 Salary Cate...
Read more

White Label Digital Office for DSA and Financial Services

In today competitive financial services market, having your own branded digital platform is no longer optional - it is essential. A White Label Digital Office allows you to launch a fully functional fintech platform under your own brand without building technology from scratch. Table of Contents What is White Label Digital Office? Benefits for Your Business Key Features Who Needs This? How It Works Pricing Models Getting Started What is White Label Digital Office? A White Label Digital Office is a ready-made software platform that you can rebrand and offer to your clients as your own product. Instead of spending months building technology, you get a complete solution with your logo, colors, and domain. Think of it like this: You get the engine, chassis, and all components ready - you just add your brand paint and start driving. Benefits for Your Business Launch in Days Go live in 3-7 days instead of 6-12 months of development. Save 90% Costs No development t...
Read more