Skip to main content

ABHA, the patient registry

ABHA is the Ayushman Bharat Health Account, the patient half of Registries. It answers "who is this patient", and every record flow in ABDM starts from that answer.

One account, two identifiers

ABHA numberABHA address
What it looks like14 digits, hyphenated in samples as 91-XXXX-XXXX-XXXXA readable name, such as name@abdm
How it is issuedAfter an Aadhaar based KYC check passesChosen by the person, or issued as a default
What it is forThe identity anchor. One person, one numberRouting. It is the handle other systems address records to
Can exist aloneNo. It always carries a default addressYes. A person can hold an address with no number

Store both. You match a patient record against the number, and you send the address when you link a care context or ask for consent. The number is issued only after a strong KYC process completes.

The check digit

Two validation utilities exist: ABHA number validation by the Luhn algorithm, and Aadhaar number validation by the Verhoeff algorithm. Luhn derives the last digit from the ones before it, so you catch a mistyped number locally before spending a call.

How identity is verified

Verification runs against Aadhaar through the ABHA service, so your system never calls Aadhaar directly. There are four routes:

RouteHow the person proves identityPrivate integratorsGovernment integrators
Aadhaar OTPA code sent to the Aadhaar linked mobile numberMandatoryMandatory
Face authenticationA QR code scanned in the ABHA app, then face capture through the Aadhaar RD serviceOptionalOptional
BiometricsFingerprint or IRIS on a registered device, which returns a signed PID blockOptionalOptional
Demographic authenticationName, date of birth and gender matched against AadhaarNot requiredMandatory

Build Aadhaar OTP first. It is mandatory for everyone and needs no hardware.

Child ABHA

A child under six has no Aadhaar number. Child ABHA is a 14 digit identifier created with a parent or legal guardian's consent, so a health record exists from birth. It is restricted to specific government integrators approved by NHA leadership, through programmes including UWIN, RCH and POSHAN. Private integrators cannot use it.

The ABHA address

The shape is name@abdm.

  • Every number gets a default address, the number with a suffix: 14digit@sbx in sandbox, 14digit@abdm in production. The M1 Postman collection shows a preferredAbhaAddress field holding the 14 digits with the @abdm suffix and no hyphens.
  • A person can then create a memorable one. A suggestion call offers addresses, and a custom address is accepted, linked to the number.
  • An address can exist without a number. One can be created on the HIE-CM from mobile number, name, age and gender, self declared and with no KYC. Expect accounts with no number behind them.

Address policy

These rules apply:

  • Letters, numbers and a dot are allowed.
  • It cannot begin with a number.
  • It cannot begin or end with a dot.
  • An all numeric address is allowed only in the 14digit@abdm default form.
  • A 10 digit mobile number as an address is restricted and not created.

Minimum length differs by flow. Validate against the error the endpoint returns rather than assuming one rule across all of them.

What an address is allowed to be

NHA validates the address on creation, so a form that accepts what NHA refuses produces a failure the person cannot act on. Letters, digits and a single dot are allowed, and beyond that:

  • It cannot begin with a digit.
  • It cannot begin or end with a dot.
  • An all digit address is allowed for an ABHA number and nothing else, which is what makes the default 14digit@abdm legal.

Three shapes read as though they should work and do not. A ten digit mobile number as an address is restricted. An ABHA number as an address you create is not allowed, although the default one is issued automatically and signing in with it works on both web and mobile. And anything failing the rules above is refused at creation rather than at submission.

The minimum length is stated twice, differently

NHA's PHR document gives the minimum as 4 characters in its narrative and as 8 in the test case for creating an address by mobile number. Neither has been run against the sandbox from here. Build to 8, which is the stricter reading.

A password is created alongside the address: at least 8 characters, at least one uppercase letter, one lowercase letter, one digit and one symbol, no spaces, and no more than two consecutive characters or keyboard keys. NHA describes enforcing it as optional for the application, not the password itself as optional.

Offer suggestions rather than an empty box and a policy. Two calls exist for it, address suggestions and address exists, and NHA asks that suggestions be built from the person's name and the username part of their email.

What an ABHA record holds

The profile response carries:

FieldWhat it is
ABHANumberThe 14 digit number, hyphenated
preferredAbhaAddressThe address, with its suffix
mobileThe communication mobile number
firstName, middleName, lastName, nameName parts and the joined name
yearOfBirth, monthOfBirth, dayOfBirthDate of birth as three separate strings
genderA single letter
emailPresent once an email is verified, otherwise null
profilePhotoBase64 image data with no data URI prefix

The communication mobile number need not be the Aadhaar linked one. It is verified separately, by its own OTP, after enrolment. Email is optional throughout. An ABHA also carries a card, downloadable as an image, and a QR code, both M1 calls. Field level detail is on M1 APIs.

Where the calls go

Sandbox https://abhasbx.abdm.gov.in/abha/api/v3/
Production https://abha.abdm.gov.in/api/abha/v3/

One exception: login by Aadhaar number using fingerprint or IRIS uses the v3.1 base URL, https://abhasbx.abdm.gov.in/abha/api/v3.1/. No production v3.1 URL is given.

What M1 does with it

M1 is the only milestone that writes to this registry. It covers creation, login, profile management and sessions. Login by mobile number, Aadhaar number, ABHA number and ABHA address are all four mandatory for both private and government integrators.

What every other milestone assumes

No flow starts without an ABHA, so M1 comes first even when your real goal is M2 or M3.

Next