data transfer

Acknowledge a consent notification, as the HIP

Also known as: Consent HIP On-Notify. Async Callback: After ABDM Gateway sends a consent grant notification to the HIP bridge URL ({bridgeUrl}/v0.5/consents/hip/notify), the HIP calls this Gateway endpoint to acknowledge receipt of the consent artefact.

Mandatory

Certification case HIP_INIT_SHARE_CARECONTEXT

POST/hiecm/consent/v3/request/hip/on-notify

The consent notification contains the full consent details including care contexts, HI types, date range, and digital signature for validation.

Authorizations

Authorizationbearer tokenRequired

Bearer token obtained from POST /hiecm/gateway/v3/sessions

Body

acknowledgementobjectRequired

acknowledgement.statusstringRequired

One of OKERROR

acknowledgement.consentIdstringRequired

The consent artefact ID being acknowledged

responseobjectRequired

Echo of the requestId from the original Gateway-to-HIP request

response.requestIdstringRequired

requestId received in the original Gateway request to HIP bridge

Responses

202

Consent acknowledgement accepted

The callback never arrives

400

Bad request, invalid parameters or missing fields

Error codes for this module

401

Unauthorized, missing or invalid Bearer token

Everything returns 401

Acknowledge a consent notification, as the HIP

curl --request POST \
  --url https://dev.abdm.gov.in/api/hiecm/consent/v3/request/hip/on-notify \
  --header 'Authorization: Bearer <ACCESS_TOKEN_FROM_SESSIONS_CALL>' \
  --header 'Content-Type: application/json' \
  --data '{
  "acknowledgement": {
    "status": "OK",
    "consentId": "consent-art-uuid-001"
  },
  "response": {
    "requestId": "req-uuid-from-hip-notify"
  }
}'

Consent acknowledgement accepted