National Health AuthorityNHA Docs

Command Palette

Search for a command to run...

Milestone 1 — ABHA

Implement ABHA creation, login, profile access, and government benefit APIs for ABDM v3.

Milestone 1 proves that your system can create and verify an ABHA. It also proves that your system can read the ABHA profile. Government integrators can also use benefit program APIs.

Source priority

The narrative gives the flow and the rule tables. The Postman files give the exact paths, headers, and payload fields. Treat OCR curl blocks in the narrative as hints only.

Scope

AreaPrivate integratorsGovernment integrators
ABHA creation by Aadhaar OTPMandatoryMandatory
Face, fingerprint, IRIS, demographic authOptionalOptional
ABHA login by mobile numberMandatoryMandatory
ABHA login by Aadhaar numberMandatoryMandatory
ABHA login by ABHA numberMandatoryMandatory
ABHA login by ABHA addressMandatoryMandatory
Profile, ABHA card, and QR codeMandatoryMandatory
Mobile update and Re-KYCOptionalOptional
Benefit program search, link, and delinkNot applicableGovernment only

Prerequisites

Get a session token

Call the ABDM session API first. Send the access token in the Authorization header. See Authentication.

Encrypt sensitive fields

Encrypt Aadhaar, OTP, mobile, email, ABHA number, and ABHA address fields when Postman marks them as encrypted. Use the ABHA public key. See Data Encryption.

Generate request headers

Generate a new REQUEST-ID for each call. Send a current UTC TIMESTAMP for each call. Use X-token only after an ABHA login returns a user token.

Keep transaction IDs

Store each txnId from OTP and auth calls. Use the latest txnId in the next step of the same flow.

Base URLs

EnvironmentBase URL
Sandboxhttps://abhasbx.abdm.gov.in/abha/api/v3/
Productionhttps://abha.abdm.gov.in/api/abha/v3/
Sandbox v3.1 login APIshttps://abhasbx.abdm.gov.in/abha/api/v3.1/

Mixed variables in Postman

The Postman files use aws-sbx, ABHA_SBX, sbx, and BaseURL variables. This guide normalizes those variables to the sandbox base URL above.

Read the M1 pages

Certification scenarios

Prepare these scenarios for Milestone 1 certification.

  • Create ABHA by Aadhaar OTP.
  • Update the mobile number after enrolment.
  • Set or link an ABHA address.
  • Log in by mobile number, Aadhaar number, ABHA number, and ABHA address.
  • Find an ABHA with the search flow.
  • Fetch the user profile and ABHA card.
  • Handle wrong OTP, expired txnId, and duplicate benefit links.
  • For government programs, link and delink a benefit record.

Sources

  • ABDM Proposed Simplified Milestone 1 (DOCX→MD, 2026-08)
  • M1 ABHA Postman collection