Skip to main content

consent

Acknowledge a consent notification, as the HIU

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

MandatoryAny one of them is mandatory

Certification cases HIU_FLOW_101, HIU_FLOW_102, HIU_FLOW_103, HIU_FLOW_104, HIU_FLOW_105, HIU_FLOW_106, HIU_FLOW_107, HIU_FLOW_108, HIU_FLOW_109, HIU_FLOW_110, HIU_FLOW_111, HIU_FLOW_112, HIU_FLOW_113

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

The Gateway sends this notification when: - Patient grants the consent - Patient denies the consent - A previously granted consent is revoked

Authorizations

Authorizationbearer tokenRequired

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

Headers

REQUEST-IDstringRequired

A fresh UUID that you generate for this request. The callback that answers it carries the same value. In M3 a single consent can produce several callbacks, so keep the mapping from request id to consent request id rather than relying on ordering.

TIMESTAMPstringRequired

The current time in ISO 8601 UTC, with milliseconds and the Z suffix. The gateway rejects a request whose timestamp has drifted too far from its own clock, so take this from a synchronised clock rather than from a local one.

X-CM-IDstringRequired

Which consent manager you are talking to. sbx on the sandbox and abdm in production.

Body

acknowledgementobject[]Required
acknowledgement.statusstringRequired

One of OKERROR

acknowledgement.consentIdstringRequired
responseobjectRequired

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

response.requestIdstringRequired

requestId received in the original Gateway notification to HIU bridge

Responses

202

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

Callbacks​

  • You make this call in reply to A consent notification to an HIU bridge, which ABDM posts to /v0.5/consents/hiu/notify. Open the callback.
  • You make this call in reply to The patient's decision, sent to the requester, which ABDM posts to /api/v3/hiu/consent/request/notify. Open the callback.
Last updated on