scan_and_share

AS - Record On Share

Callback the gateway sends with the outcome of a record share request.

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

Authorizations

Authorizationbearer tokenRequired

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

Body

hiRequestobjectRequired

hiRequest.transactionIdstringRequired

hiRequest.dataPushUrlstringRequired

hiRequest.keyMaterialobjectRequired

hiRequest.keyMaterial.cryptoAlgstringRequired

hiRequest.keyMaterial.curvestringRequired

hiRequest.keyMaterial.dhPublicKeyobjectRequired

hiRequest.keyMaterial.dhPublicKey.expirystringRequired

hiRequest.keyMaterial.dhPublicKey.parametersstringRequired

hiRequest.keyMaterial.dhPublicKey.keyValuestringRequired

hiRequest.keyMaterial.noncestringRequired

responseobjectRequired

response.requestIdstringRequired

Responses

200

No response body is documented for this request.

AS - Record On Share

curl --request POST \
  --url https://phrsbx.abdm.gov.in/scan-share/record-share/on-share \
  --header 'Authorization: Bearer <ACCESS_TOKEN_FROM_SESSIONS_CALL>' \
  --header 'Content-Type: application/json' \
  --data '{
  "hiRequest": {
    "transactionId": "<TXN_ID>",
    "dataPushUrl": "https://webhook.site/<TXN_ID>/health-information/transfer",
    "keyMaterial": {
      "cryptoAlg": "ECDH.",
      "curve": "curve25519",
      "dhPublicKey": {
        "expiry": "2026-12-28T13:18:20.742Z",
        "parameters": "Ephemeral public key.",
        "keyValue": "<KEYVALUE>"
      },
      "nonce": "H5EG5X61tTJ2ctjs3ByenbMvUezrf1VCRHZukspooaY="
    }
  },
  "response": {
    "requestId": "<TXN_ID>"
  }
}'

No response body is documented for this request.