AABDM M1 Sandbox Console
ABDM sandbox · milestone 1

ABHA enrollment & profile APIs

A focused PHP console for testing the ABDM V3 M1 enrollment and profile journeys. Configure your sandbox variables, authenticate, then work through each API on its own page.

Sandbox only
Before you begin: add your ABDM sandbox client credentials in Settings. Test only with identities and OTPs issued for the sandbox; this console is not for production or real patient information.
Authentication

Create sandbox session

Exchange your sandbox client credentials for a short-lived access token used by the M1 APIs.

POST /gateway/v3/sessions
Enrollment

Request enrollment OTP

Start a new ABHA enrollment flow by asking ABDM to send a one-time password to the Aadhaar-linked mobile.

POST /v3/enrollment/request/otp
Enrollment

Enroll by Aadhaar

Complete ABHA number creation by verifying the OTP issued during Aadhaar enrollment.

POST /v3/enrollment/enrol/byAadhaar
Enrollment

Enroll by ABDM

Alternate ABDM enrollment operation using an OTP-authenticated transaction and enrollment consent.

POST /v3/enrollment/enrol/byAbdm
Profile

Request login OTP

Start a login flow for an existing ABHA profile and request an OTP through ABDM.

POST /v3/profile/login/request/otp
Profile

Verify login OTP

Verify the OTP for an existing ABHA account and obtain the profile token.

POST /v3/profile/login/verify
Profile

Get ABHA Card

Retrieve an authenticated ABHA card image or PDF for the logged-in profile.

POST /v3/profile/account/getAbhaCard

Suggested M1 flow

  1. Save sandbox settings and create a gateway session.
  2. For new enrollment, request an OTP, then complete either Aadhaar or ABDM enrollment.
  3. For an existing sandbox profile, request a login OTP, verify it, then get the ABHA card.