Share patient profile

Read the signed in person's ABHA profile

Needs the X-token from login, because it reads one person's account rather than anything about your application.

MandatoryEither of the test cases CRT_ABHA_114 or CRT_ABHA_115 is mandatory for Governement Optional for Private. Either of the test cases CRT_ABHA_209 or CRT_ABHA_210 is mandatory for Governement Optional for Private. Either of the test cases CRT_ABHA_308 or CRT_ABHA_309 is mandatory for Governement Optional for Private. Mandatory for Private. Mandatory for Private /Government (Optional for integrated program using demo auth as they have default ABHA address generated)

Certification cases CRT_ABHA_101, CRT_ABHA_102, CRT_ABHA_103, CRT_ABHA_104, CRT_ABHA_105, CRT_ABHA_106, CRT_ABHA_107, CRT_ABHA_108, CRT_ABHA_109, CRT_ABHA_112, CRT_ABHA_113, CRT_ABHA_114, CRT_ABHA_115, CRT_ABHA_201, CRT_ABHA_202, CRT_ABHA_203, CRT_ABHA_204, CRT_ABHA_205, CRT_ABHA_206, CRT_ABHA_207, CRT_ABHA_208, CRT_ABHA_209, CRT_ABHA_210, CRT_ABHA_301, CRT_ABHA_302, CRT_ABHA_303, CRT_ABHA_304, CRT_ABHA_305, CRT_ABHA_306, CRT_ABHA_307, CRT_ABHA_308, CRT_ABHA_309, PROF_ABHA_602, VRFY_ABHA_101, VRFY_ABHA_201, VRFY_ABHA_301, VRFY_ABHA_302, VRFY_ABHA_303, VRFY_ABHA_304, VRFY_ABHA_305, VRFY_ABHA_401, VRFY_ABHA_402, VRFY_ABHA_403, VRFY_ABHA_404, VRFY_ABHA_405, VRFY_ABHA_501

GET/v3/profile/account

Authorizations

Authorizationbearer tokenRequired

The accessToken from POST /api/hiecm/gateway/v3/sessions. Send it as Authorization: Bearer <ACCESS_TOKEN>.

Headers

REQUEST-IDstringRequired

Unique UUID v4 per request. Used for idempotency and distributed tracing. Generate a fresh UUID for every call.

TIMESTAMPstringRequired

ISO 8601 UTC timestamp of the request.

X-tokenstringRequired

The user scoped token returned when a person logs in or verifies an OTP. Required on this operation. See the shared XToken parameter, and note that this header takes the bare token with no prefix.

Responses

200

The response.

400

Bad Request, invalid scope, loginHint, or encrypted field

Error codes for this module

401

Unauthorized, missing, invalid, or expired Bearer token

Everything returns 401

403

Forbidden, the token is valid but not permitted for this operation

Error codes for this module

500

Server error, retry

Error codes for this module

Read the signed in person's ABHA profile

curl --request GET \
  --url https://abhasbx.abdm.gov.in/abha/api/v3/profile/account \
  --header 'Authorization: Bearer <ACCESS_TOKEN_FROM_SESSIONS_CALL>' \
  --header 'REQUEST-ID: <REQUEST_ID>' \
  --header 'TIMESTAMP: <TIMESTAMP>' \
  --header 'X-token: <X_TOKEN_FROM_LOGIN_VERIFY>'

{
  "ABHANumber": "<ABHANUMBER>",
  "preferredAbhaAddress": "<PREFERRED_ABHA_ADDRESS>",
  "mobile": "<MOBILE>",
  "firstName": "<FIRST_NAME>",
  "middleName": "<MIDDLE_NAME>",
  "lastName": "<LAST_NAME>",
  "name": "<NAME>",
  "yearOfBirth": "<YEAR_OF_BIRTH>",
  "dayOfBirth": "<DAY_OF_BIRTH>",
  "monthOfBirth": "<MONTH_OF_BIRTH>",
  "gender": "<GENDER>",
  "profilePhoto": "<PROFILE_PHOTO>",
  "status": "<STATUS>",
  "stateCode": "<STATE_CODE>",
  "districtCode": "<DISTRICT_CODE>",
  "pincode": "<PINCODE>",
  "address": "<ADDRESS>",
  "kycPhoto": "<KYC_PHOTO>",
  "stateName": "<STATE_NAME>",
  "districtName": "<DISTRICT_NAME>",
  "subdistrictName": "<SUBDISTRICT_NAME>",
  "authMethods": [
    "<AUTH_METHODS>"
  ],
  "kycVerified": false,
  "verificationStatus": "<VERIFICATION_STATUS>",
  "verificationType": "<VERIFICATION_TYPE>",
  "createdDate": "<CREATED_DATE>"
}

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