Search ABHA profile

Search for ABHA (Ayushman Bharat Health Account) profiles. It allows users to retrieve information about their ABHA profiles using mobile numbers.

POST/abha/api/v3/profile/account/abha/search

This is essential for verifying the user’s identity and ensuring secure access to their ABHA profile.

<br><br> <strong>Note: </strong> You need to use the Encryption API first. Only an RSA-encrypted mobile number should be in the request body.

Authorizations

Authorizationbearer tokenRequired

Headers

REQUEST-IDstringRequired

TIMESTAMPstringRequired

Body

scopestring[]Required

mobilestringRequired

Responses

200

Successfully retrieved ABHA details.

400

Invalid mobile 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 profile

curl --request POST \
  --url https://abhasbx.abdm.gov.in/abha/api/v3/profile/account/abha/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 '{
  "scope": [
    "search-abha"
  ],
  "mobile": "{{rsaMobileEncryptionOutput}}"
}'

[
  {
    "txnId": "d5b1fb36-e0be-401d-b4cf-cc71c5aca98a",
    "ABHA": [
      {
        "index": 1,
        "ABHANumber": "xx-xxxx-xxxx-XX31",
        "name": "<NAME>",
        "gender": "F",
        "kycVerified": "true",
        "authMethods": [
          "AADHAAR_OTP",
          "MOBILE_OTP",
          "AADHAAR_BIO",
          "DEMOGRAPHICS"
        ]
      }
    ]
  }
]

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