Skip to main content

Get ABHA-address profile

Endpoint: GET /abha/api/v3/phr/web/login/profile/abha-profile

GET/abha/api/v3/phr/web/login/profile/abha-profile

Flow: ABHA Address Login - Aadhaar OTP - step 4 of 6

  • Previous: *ABHA address login via Aadhaar OTP - verify*
  • Next: *Get PHR card*

---

This API endpoint retrieves the user’s ABHA (Ayushman Bharat Health Account) profile. Access to this profile is granted after the successful verification of the OTP, ensuring the user’s profile information is secure.

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 200 response code indicates a successful request. In this context, it signifies that the user was successfully verified with the OTP in the previous API call. A valid JWT token was provided, which authenticated the user and allowed access to their profile. As a result, the user profile was successfully retrieved, including all ABHA profile details.

abhaAddressstring
fullNamestring
profilePhotostring
firstNamestring
middleNamestring
lastNamestring
dayOfBirthstring
monthOfBirthstring
yearOfBirthstring
dateOfBirthstring
genderstring
emailstring
mobilestring
abhaNumberstring
addressstring
stateNamestring
pinCodestring
stateCodestring
districtCodestring
authMethodsstring[]
statusstring
subDistrictCodestring
subDistrictNamestring
emailVerifiedstring
mobileVerifiedstring
kycStatusstring
400

A Bad Request error with the description “invalid X-token” indicates that the server received a request with an invalid or missing authentication token.

Error codes for this module

401

The 401 response code indicates that the request was not authorized due to invalid credentials. Ensure that your API invocation includes the appropriate authorization header.

Everything returns 401

codestring
messagestring
descriptionstring
500

Internal Server Error

An Internal Server Error (500) indicates that the server encountered an unexpected condition that prevented it from fulfilling the request.

Error codes for this module