Developer API

Aadhaar API

The Aadhaar API exposes the multi-step flow already represented by the active API controller catalogue: start a workflow, work through captcha handling and continue to the OTP stage. It is intended as a developer integration building block inside an authorised application workflow rather than a standalone customer interface.

api-aadhaar
Published endpoints4
Active plans0
Base daily limit1,000
Base monthly limit30,000
Capabilities

What this API is designed to do

Multi-step Aadhaar workflow API with session, captcha and OTP stages.

Start an Aadhaar-related workflow session
Handle captcha stages exposed by the API
Continue the session into OTP processing
Use Vismrit API keys and account-level access controls around requests
Use cases

Where it can fit

These are common integration scenarios; the exact use depends on your application, data handling requirements and subscription tier.

Authorised identity-related onboarding flows
Internal workflow automation where Aadhaar interaction is legally and contractually permitted
Applications that need to orchestrate the existing multi-step Aadhaar controller flow
Endpoint catalogue

Published routes and methods

The endpoint list is read from the existing API controller catalogue. It changes automatically when the catalogue is refreshed.

MethodRoutePurpose
ANY/aadhaarIndex
ANY/aadhaar/captchaCaptcha
ANY/aadhaar/otpOtp
ANY/aadhaar/startStart
Integration flow

From subscription to first request

Keep access and usage manageable by using the customer dashboard as the control point for keys, whitelist rules and plan limits.

01

Choose an active subscription tier

02

Generate or assign an API key from API Access

03

Configure whitelist restrictions where required

04

Integrate the published /aadhaar routes in sequence

05

Track request usage and errors from the API dashboard

Integration notes

Before you go live

Aadhaar and identity data can be sensitive and regulated. Use this API only for lawful, authorised purposes and apply appropriate consent, data-minimisation, security and retention controls.