Scan & Share

Send Share Acknowledgement (HIP → Gateway)

HIP sends an acknowledgement back to the ABDM Gateway after receiving and processing the patient's shared profile. Typically includes a token/queue number assigned to the patient. Server: https://dev.abdm.gov.in/api/hiecm

Mandatory

Certification case SHARE_PATIENT_PROFILE_701

POST/patient-share/v3/on-share

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.

Body

acknowledgementobjectRequired

acknowledgement.statusstringRequired

Processing result

One of SUCCESSFAILURE

acknowledgement.abhaAddressstringRequired

ABHA Address of the patient who shared their profile

acknowledgement.profileobject

Present on SUCCESS, echoes context and provides assigned token

acknowledgement.profile.contextstring

Context value from the original share request

acknowledgement.profile.tokenNumberstring

Queue/token number assigned to the patient by the HIP

acknowledgement.errorobject

Present on FAILURE

acknowledgement.error.codestring

acknowledgement.error.messagestring

Responses

200

Acknowledgement accepted by Gateway

Send Share Acknowledgement (HIP → Gateway)

curl --request POST \
  --url https://abhasbx.abdm.gov.in/abha/api/patient-share/v3/on-share \
  --header 'Authorization: Bearer <ACCESS_TOKEN_FROM_SESSIONS_CALL>' \
  --header 'REQUEST-ID: <REQUEST_ID>' \
  --header 'TIMESTAMP: <TIMESTAMP>' \
  --header 'Content-Type: application/json' \
  --data '{
  "acknowledgement": {
    "status": "SUCCESS",
    "abhaAddress": "johnkumar@sbx",
    "profile": {
      "context": "123",
      "tokenNumber": "TKN-0042"
    }
  }
}'

Acknowledgement accepted by Gateway