Skip to main content

Search ABHA address (auth methods)

Endpoint: POST /abha/api/v3/phr/web/login/abha/search

POST/abha/api/v3/phr/web/login/abha/search

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

  • Previous: none (first call of this flow)
  • Next: *ABHA address login via Aadhaar OTP - send OTP*

---

This API endpoint is used to search for ABHA (Ayushman Bharat Health Account) profiles. It allows users to retrieve information about their ABHA profiles using identifier ABHA address. This is essential for verifying the user’s identity and ensuring secure access to their ABHA profile

Headers

REQUEST-IDstringRequired

Unique UUID for every request.

TIMESTAMPstringRequired

Current UTC timestamp in ISO-8601 format.

Body

abhaAddressstringRequired

The ABHA address chosen for the account, without the @ suffix.

Responses

200

The 200 response code indicates a successful request. In this context, it refers to the successful retrieve of user details based on the ABHA address

healthIdNumberstring
abhaAddressstring
authMethodsstring[]
blockedAuthMethodsstring[]
statusstring
messagestring
fullNamestring
mobilestring
400

The 400 response code signifies a bad request. In this context, it means that no user was found for the provided ABHA address.

Error codes for this module

codestring
messagestring
401

A 401 Unauthorized error occurs when a server receives a request without valid authentication credentials or with incorrect credentials. This error indicates that the server cannot authenticate the user,

Everything returns 401

codestring
messagestring
descriptionstring
404

A 404 Not Found error occurs when a server cannot find the requested resource. This error indicates that the server is reachable, but the specific page or resource is not available

Error codes for this module

codestring
messagestring
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