Other operations

Search ABHA account existence

Verify the existence of an Ayushman Bharat Health Account (ABHA) before proceeding with the OTP request for ABHA login.

POST/abha/api/v3/profile/login/search

The request body must include the abhaNumber, which the user should provide. If the specified abhaNumber exists, the response will contain the basic details of the corresponding ABHA account.

Authorizations

Authorizationbearer tokenRequired

Headers

REQUEST-IDstringRequired

TIMESTAMPstringRequired

Body

ABHANumberstringRequired

Responses

200

Successfully retrieved ABHA details.

400

Invalid ABHA number.

Error codes for this module

401

Missing Credentials.

Everything returns 401

404

User not found.

Error codes for this module

500

Internal Server Error.

Error codes for this module

Search ABHA account existence

curl --request POST \
  --url https://abhasbx.abdm.gov.in/abha/api/v3/profile/login/search \
  --header 'Authorization: Bearer <ACCESS_TOKEN_FROM_SESSIONS_CALL>' \
  --header 'REQUEST-ID: 18235d89-cb13-479d-ad71-7a57d5f669a8' \
  --header 'TIMESTAMP: 2022-10-06T15:10:00.587Z' \
  --header 'Content-Type: application/json' \
  --data '{
  "ABHANumber": "91-1760-5301-xxxx"
}'

[
  {
    "preferredAbhaAddress": "<ABHA_ADDRESS>",
    "ABHANumber": "<ABHA_NUMBER>",
    "authMethods": [
      "DEMOGRAPHICS",
      "AADHAAR_OTP",
      "MOBILE_OTP",
      "AADHAAR_BIO"
    ],
    "blockedAuthMethods": [
      "<BLOCKED_AUTH_METHODS>"
    ],
    "status": "ACTIVE",
    "verificationStatus": "VERIFIED",
    "mobile": "**********",
    "verificationType": "AADHAAR",
    "isDocumentAccount": false
  }
]

Generated from the schema. The values are placeholders, not a captured response.