Skip to main content

Get ABHA profile

Endpoint: GET /abha/api/v3/profile/account

GET/abha/api/v3/profile/account

Flow: ABHA Card & Profile - independent API; call the one that fits your identifier / modality.

---

This API endpoint is used to manage ABHA (Ayushman Bharat Health Account) profiles. It allows users to fetch the user profile, ensuring that their details are accurate and up-to-date. This is essential for maintaining the integrity and security of the user’s health records.

Authorizations

Authorizationbearer tokenRequired

The access token from POST /api/hiecm/gateway/v3/sessions, sent with a Bearer prefix.

Headers

X-tokenstringRequired

User token (Bearer <token>) received after ABHA creation / login.

REQUEST-IDstringRequired

Unique UUID for every request.

TIMESTAMPstringRequired

Current UTC timestamp in ISO-8601 format.

Responses

200

The account information was successfully retrieved or updated.

ABHANumberstring
preferredAbhaAddressstring
mobilestring
firstNamestring
middleNamestring
lastNamestring
namestring
yearOfBirthstring
dayOfBirthstring
monthOfBirthstring
genderstring
profilePhotostring
statusstring
stateCodestring
districtCodestring
pincodestring
addressstring
kycPhotostring
stateNamestring
districtNamestring
subdistrictNamestring
authMethodsstring[]
tagsobject
kycVerifiedboolean
verificationStatusstring
verificationTypestring
localizedDetailsobject
localizedDetails.namestring
localizedDetails.stateNamestring
localizedDetails.districtNamestring
localizedDetails.villageNamestring
localizedDetails.townNamestring
localizedDetails.genderstring
localizedDetails.localizedLabelsobject
localizedDetails.localizedLabels.namestring
localizedDetails.localizedLabels.abhaNumberstring
localizedDetails.localizedLabels.abhaAddressstring
localizedDetails.localizedLabels.genderstring
localizedDetails.localizedLabels.dobstring
localizedDetails.localizedLabels.mobilestring
createdDatestring
400

Indicates various errors encountered during the account management process, such as invalid identifiers or missing parameters.

Error codes for this module

messagestring
timestampstring
401

The request was unauthorized. This can occur due to invalid credentials or token.

Everything returns 401

codestring
messagestring
descriptionstring
404

Not Found

Error codes for this module

errorobject
error.codestring
error.messagestring
500

Internal Server Error

Error codes for this module