scan_and_share

AS - RecordShare on-notify

Callback the gateway sends to notify the PHR that a record share has been acted on.

POST/scan-share/record-share/on-notify

Authorizations

Authorizationbearer tokenRequired

The access token from POST /api/hiecm/gateway/v3/sessions.

Body

notificationobjectRequired

notification.transactionIdstringRequired

notification.doneAtstringRequired

notification.statusNotificationobjectRequired

notification.statusNotification.sessionStatusstringRequired

notification.statusNotification.statusResponsesobject[]Required

notification.statusNotification.statusResponses.careContextReferencestringRequired

notification.statusNotification.statusResponses.hiStatusstringRequired

notification.statusNotification.statusResponses.descriptionstringRequired

Responses

404

Example values, scrubbed.

Error codes for this module

500

Example values, scrubbed.

Error codes for this module

AS - RecordShare on-notify

curl --request POST \
  --url https://phrsbx.abdm.gov.in/scan-share/record-share/on-notify \
  --header 'Authorization: Bearer <ACCESS_TOKEN_FROM_SESSIONS_CALL>' \
  --header 'Content-Type: application/json' \
  --data '{
  "notification": {
    "transactionId": "<TXN_ID>",
    "doneAt": "2026-06-24T06:35:44.167Z",
    "statusNotification": {
      "sessionStatus": "TRANSFERRED",
      "statusResponses": [
        {
          "careContextReference": "74538",
          "hiStatus": "DELIVERED",
          "description": "Data received successfully"
        }
      ]
    }
  }
}'

{
  "code": "404",
  "type": "Status report",
  "message": "Runtime Error",
  "description": "No matching resource found for given API Request"
}

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