Link request

Flows:

POST/abha/api/v3/phr/app/login/profile/link

P2-Consents Management › P2 -PHR Profile › P2 - Link ABHA Number › P2 - via ABHA OTP › Link Request
P2-Consents Management › P2 -PHR Profile › P2 - Link ABHA Number › P2 - via Aadhaar OTP › Link Request

Authorizations

Authorizationbearer tokenRequired

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

Headers

X-tokenstringRequired

The user token from a login or enrolment response, sent with a Bearer prefix. It acts for that ABHA holder.

REQUEST-IDstringRequired

Unique UUID for each request.

TIMESTAMPstringRequired

Request timestamp in UTC, ISO-8601 with Z.

Body

actionstringRequired

transactionIdstringRequired

Responses

200

messagestring

authResultstring

400

Bad Request

Error codes for this module

codestring

messagestring

403

Forbidden

Error codes for this module

curl --request POST \
  --url https://abhasbx.abdm.gov.in/abha/api/v3/phr/app/login/profile/link \
  --header 'Authorization: Bearer <ACCESS_TOKEN_FROM_SESSIONS_CALL>' \
  --header 'X-token: Bearer <JWT TOKEN>' \
  --header 'REQUEST-ID: 18235d89-cb13-479d-ad71-7a57d5f669a8' \
  --header 'TIMESTAMP: 2022-10-06T15:10:00.587Z' \
  --header 'Content-Type: application/json' \
  --data '{
  "action": "LINK",
  "transactionId": "37d8d312-35a0-41e7-a6e4-1074eb18a5fa"
}'

{
  "message": "ABHA number is securely linked to ABHA address",
  "authResult": "success"
}