Skip to main content

Search ABHA by mobile

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

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

Flow: Find ABHA - Face - step 1 of 4

  • Previous: none (first call of this flow)
  • Next: *Find ABHA via Face - send authentication request*

---

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 mobile numbers. This is essential for verifying the user’s identity and ensuring secure access to their ABHA profile.

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

Authorizations

Authorizationbearer tokenRequired

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

Headers

REQUEST-IDstringRequired

Unique UUID for every request.

TIMESTAMPstringRequired

Current UTC timestamp in ISO-8601 format.

Body

scopestring[]Required

The scope of the request. Use search-abha.

mobilestringRequired

The mobile number, encrypted with the public key from GET /abha/api/v3/profile/public/certificate.

Responses

200

Successfully retrieved ABHA details.

400

Invalid mobile number.

Error codes for this module

mobilestring
timestampstring
401

Missing Credentials.

Everything returns 401

codestring
messagestring
descriptionstring
404

User not found.

Error codes for this module

errorobject
error.codestring
error.messagestring
500

Internal Server Error.

Error codes for this module