Search user by HPR ID

GET/v1/search/searchByHprId/{hprId}

Authorizations

Authorizationbearer tokenRequired

M4 declares bearer authentication. The HPID calls publish POST /getManagementToken.

Path parameters

hprIdstringRequired

Responses

200

hprIdNumberstring

namestring

authMethodsstring[]

hprIdstring

categoryIdstring

subCategoryIdstring

404

Not Found

curl --request GET \
  --url https://apihspsbx.abdm.gov.in/v4/int/v1/search/searchByHprId/{hprId} \
  --header 'Authorization: Bearer <ACCESS_TOKEN_FROM_SESSIONS_CALL>'

{
  "hprIdNumber": "<HPR_ID>",
  "name": "Ayushman Bharat Mission",
  "authMethods": [
    "PASSWORD",
    "MOBILE_OTP",
    "AADHAAR_OTP"
  ],
  "hprId": "<EMAIL>",
  "categoryId": "1",
  "subCategoryId": "1"
}