JustSwitch
API Access
Identity & KYC

DigiLocker Initialize API

POST /api/v1/aadhaar-identity-kyc/digilocker-initialize

DigiLocker OAuth start — response: client_id, login URL, expiry_seconds.

DigiLocker OAuth start — response: client_id, login URL, expiry_seconds.

  • Real-time integrate for aadhaar identity kyc data with sub-300ms median latency
  • Production-grade REST JSON with sandbox & webhook support
  • UIDAI / NPCI / MCA aligned partner routing where applicable
  • Audit logs, idempotency keys & enterprise SLA on JustSwitch
Get API keys Developer docs
Latency
< 300 ms
Uptime SLA
99.9%
Format
REST / JSON
Sandbox
Included

What is DigiLocker Initialize?

DigiLocker OAuth start — response: client_id, login URL, expiry_seconds.

Every request is authenticated with API keys, logged for audit, and routed through regulated partner rails where required. Responses follow a consistent `{ ok, data, message }` envelope so you can ship once and reuse the same error-handling patterns across all JustSwitch endpoints.

Whether you run a lending app, payment aggregator, or enterprise ERP, DigiLocker Initialize scales horizontally with rate limits tuned for burst traffic during campaigns. Aadhaar APIs must be used only through UIDAI rules and authorised AUA/KUA/Offline-KYC ecosystem partners. e-KYC uses OTP or biometric authentication; paperless offline e-KYC is consent-based.

Developers choose JustSwitch for DigiLocker Initialize because we aggregate multiple upstream providers behind one contract, one wallet settlement, and one support desk — so you launch faster while your compliance team retains full audit visibility through dashboard logs and exportable reports.

NBFCs Digital lending Neobanks Insurance Marketplaces

Technical specification

Endpoint details for DigiLocker Initialize integration on JustSwitch.

POST /api/v1/aadhaar-identity-kyc/digilocker-initialize
Protocol HTTPS REST / JSON
Authentication Bearer API Key + IP allow-list
Sandbox Available — no live debits
Median latency < 300 ms
Rate limits Burst-friendly — contact for enterprise tiers
Webhooks Optional async notify
Idempotency reference_id recommended
API slug digilocker-initialize

Request parameters

reference_id string required

Your unique transaction or session reference for reconciliation

consent boolean required

User consent flag — required for regulated KYC / verification flows

input string required

Primary identifier for aadhaar identity kyc data

Response fields

status string

success | pending | failed

reference_id string

Echo of your request reference

verified_at datetime

ISO-8601 timestamp of completion

message string

Human-readable result or error detail

Key features

REST + JSON

HTTPS POST/GET with UTF-8 JSON bodies and predictable status codes.

Sandbox mode

Test end-to-end without debiting wallet or hitting live rails.

Webhooks

Async callbacks for pending states — payments, recharge, KYC, payouts.

Dashboard logs

Searchable request history with filters for support & audits.

Low latency

Median sub-300 ms for verification-class endpoints in production.

Enterprise SLA

99.9% uptime target with redundant routing and monitoring.

Who uses DigiLocker Initialize?

Di

Digital lending

Pre-fill KYC, cut fraud, and shorten TAT for personal & MSME loans.

Ne

Neobanks

Onboard savings accounts with verified identity before card issuance.

Ma

Marketplaces

Seller KYC before enabling payouts or high-value listings.

In

Insurance

Validate policyholder identity at proposal & claim stages.

How it works

  1. 01

    Obtain sandbox keys from the JustSwitch developer console.

  2. 02

    POST input identifiers; handle validation errors in-line.

  3. 03

    Map response fields into your workflow & go live with production keys.

API reference

Request & response specification

Integrate DigiLocker Initialize through the JustSwitch REST API — parameters and sample JSON responses below.

Step 1 — Initialize

Endpoint

POST https://console.justswitch.in/api/v1/aadhaar-identity-kyc/digilocker-initialize

Content-Type

application/json

Developer console

Get API keys on console.justswitch.in →

Request headers

Header Type Description
Authorization required string Bearer token from your JustSwitch console API credentials
Content-Type required string application/json

Request body (JSON)

name string

User display name

email string

User email

mobile_no string

User mobile

redirect_url string

OAuth return URL

logo__u_r_l string

Brand logo URL

Response examples

Sample JSON from the JustSwitch API for this service.

Success HTTP 200 
{
    "ok": true,
    "message": "done",
    "data": {
        "client_id": "digilocker_xxx",
        "url": "https://digilocker-sdk…/token=…",
        "expiry_seconds": "600.00"
    }
}

Sample integration

Illustrative JSON for DigiLocker Initialize — see developer docs for live schemas.

POST Request
{
    "input": "XXXXXXXX",
    "reference_id": "REQ-2026-001",
    "consent": true
}
200 Response
{
    "ok": true,
    "message": "Success",
    "data": {
        "status": "success",
        "reference_id": "JS-EBURVIIE",
        "verified_at": "2026-06-26T10:34:11+00:00"
    }
}

Business benefits

  • Reduce manual ops cost by up to 70% on verification-heavy journeys
  • Improve conversion with inline validation instead of offline turnaround
  • Single contract & settlement across 200+ Indian fintech APIs
  • Audit-ready logs exported from the admin console
  • Dedicated solutions engineering for enterprise rollouts

Regulatory & compliance

Aadhaar APIs must be used only through UIDAI rules and authorised AUA/KUA/Offline-KYC ecosystem partners. e-KYC uses OTP or biometric authentication; paperless offline e-KYC is consent-based.

Frequently asked questions

What is DigiLocker Initialize used for?

It automates Aadhaar / KYC workflows so your application can verify or transact in real time without building direct integrations with multiple upstream providers.

How do I integrate DigiLocker Initialize in my app?

Sign up on JustSwitch, obtain sandbox API keys, call the REST endpoint with JSON body, handle the unified response envelope, then switch to production keys after UAT sign-off.

How do I authenticate requests?

Use Bearer API keys from the JustSwitch dashboard. Sandbox and production keys are separated; rotate keys anytime without downtime.

Is there a sandbox for testing?

Yes — every API supports sandbox mode with simulated responses so engineering, QA, and compliance can sign off before go-live.

What about webhooks and async status?

Long-running operations (payments, recharge, some KYC steps) emit webhooks to your HTTPS endpoint with signed payloads for replay protection.

Is DigiLocker Initialize compliant for regulated use in India?

JustSwitch routes requests through authorised AUA/KUA, NPCI, MCA and partner networks. Your legal team should map consent, data retention and licence obligations to your use case.

Related Aadhaar / KYC APIs

Explore more endpoints in the same verification category.

Aadhaar Masking

The Aadhaar Masking from JustSwitch lets product teams integrate Aadhaar identity records in real time through a single REST integration. De...

View API details →

Aadhaar OCR

The Aadhaar OCR from JustSwitch lets product teams ocr Aadhaar identity records in real time through a single REST integration. Designed for...

View API details →

Aadhaar PAN Link Check

The Aadhaar PAN Link Check from JustSwitch lets product teams integrate Aadhaar identity records in real time through a single REST integrat...

View API details →

Aadhaar Send OTP

The Aadhaar Send OTP from JustSwitch lets product teams otp Aadhaar identity records in real time through a single REST integration. Designe...

View API details →

Aadhaar Verify OTP

The Aadhaar Verify OTP from JustSwitch lets product teams otp Aadhaar identity records in real time through a single REST integration. Desig...

View API details →

Aadhaar to PAN Find

The Aadhaar to PAN Find from JustSwitch lets product teams integrate Aadhaar identity records in real time through a single REST integration...

View API details →

Start building with DigiLocker Initialize

Sandbox keys in minutes. Production access with compliance review for regulated endpoints.

Create free account Browse Aadhaar / KYC