Retrieve ABHA card image

Endpoint: GET /abha/api/v3/profile/account/abha-card

GET/abha/api/v3/profile/account/abha-card

Flow: ABHA Card & Profile - independent API; call the one that fits your identifier / modality.

---

This API endpoint is used to retrieve the ABHA card image. It requires valid credentials and headers for authentication.

Authorizations

Authorizationbearer tokenRequired

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

Headers

X-tokenstringRequired

User token (Bearer <token>) received after ABHA creation / login.

REQUEST-IDstringRequired

Unique UUID for every request.

TIMESTAMPstringRequired

Current UTC timestamp in ISO-8601 format.

Responses

200

Successfully retrieved ABHA card image.

400

Invalid X-token.

Error codes for this module

messagestring

timestampstring

401

Unauthorized.

Everything returns 401

codestring

messagestring

descriptionstring

500

Internal Server Error.

Error codes for this module

curl --request GET \
  --url https://abhasbx.abdm.gov.in/abha/api/v3/profile/account/abha-card \
  --header 'Authorization: Bearer <ACCESS_TOKEN_FROM_SESSIONS_CALL>' \
  --header 'X-token: Bearer {{X-token}}' \
  --header 'REQUEST-ID: 18235d89-cb13-479d-ad71-7a57d5f669a8' \
  --header 'TIMESTAMP: 2022-10-06T15:10:00.587Z'

Successfully retrieved ABHA card image.