Developer API

Aadhaar API

The Aadhaar API exposes the multi-step flow already represented by the active API reference: 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.

Choose a plan API dashboard API documentation External docs

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; choose the approach that fits your application and subscription plan.

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

Use the published routes and methods below when integrating this API.

MethodRoutePurpose

ANY/aadhaarIndex

ANY/aadhaar/captchaCaptcha

ANY/aadhaar/otpOtp

ANY/aadhaar/startStart

Integration reference

Authentication, request shape and response handling

Use these examples as a quick integration reference and check the current API documentation before production use.

Authentication & access

Send the API key as Authorization: Bearer YOUR_API_KEY or X-API-Key: YOUR_API_KEY. The key must be active, assigned to the Aadhaar API product, backed by an active subscription and allowed by your whitelist settings.

Example request

curl -X POST "https://api.sinhcoms.com/aadhaar/start" 
  -H "Authorization: Bearer YOUR_API_KEY" 
  -H "Content-Type: application/x-www-form-urlencoded" 
  --data-urlencode "aadhaar=YOUR_AADHAAR_VALUE"

# Continue the same session
curl -X POST "https://api.sinhcoms.com/aadhaar/captcha" 
  -H "Authorization: Bearer YOUR_API_KEY" 
  --data-urlencode "sessionId=SESSION_ID" 
  --data-urlencode "captcha=CAPTCHA_CODE"

curl -X POST "https://api.sinhcoms.com/aadhaar/otp" 
  -H "Authorization: Bearer YOUR_API_KEY" 
  --data-urlencode "sessionId=SESSION_ID" 
  --data-urlencode "otp=OTP_VALUE"

Example response

{
  "status": "captcha",
  "message": "Enter captcha code",
  "sessionId": "SESSION_ID",
  "captcha_base64": "..."
}

# After captcha
{
  "status": "otp",
  "message": "Captcha accepted. Submit OTP.",
  "sessionId": "SESSION_ID"
}

Error handling

Documented error states

400Aadhaar, sessionId, captcha or OTP input is missing

401API key authentication or product authorization failed

429Daily request limit exceeded

504Upstream WebSocket timed out

Integration flow

From subscription to first request

Use the customer dashboard as the control point for keys, whitelist rules and plan limits.

Choose an active subscription tier

Generate or assign an API key from API Access

Configure whitelist restrictions where required

Integrate the published /aadhaar routes in sequence

Track request usage and errors from the API dashboard

Plans

Choose the request capacity you need

Pricing and limits below are read from the active subscription tiers in the API system.

Star

INR 999.00/month

4,000 requests/day
120,000 requests/month

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.

Customer workspace

Already a customer? Continue from your dashboard.

Contact Information

India

Talk to us+91 9123288803 support@vismrit.tech