webhooks

The patient's decision, sent to the requester

On a grant, carries every consent artefact id created against the request, with the request id. On a denial, carries the denial, with reason set if the gateway supplied one.

POST/api/v3/hiu/consent/request/notify

Authorizations

Authorizationbearer tokenRequired

The accessToken from POST /api/hiecm/gateway/v3/sessions. Send it as Authorization: Bearer <ACCESS_TOKEN>.

Body

notificationobjectRequired

notification.consentRequestIdstringRequired

notification.statusstringRequired

notification.reasonstringnullRequired

Set when the request was denied; null otherwise.

notification.consentArtefactsobject[]Required

notification.consentArtefacts.idstringRequired

Responses

200

Your bridge acknowledged the callback with 200 OK. The gateway validates the body you send back, so a 200 carrying the wrong body is still a failure.

The patient's decision, sent to the requester

curl --request POST \
  --url https://dev.abdm.gov.in/api/api/v3/hiu/consent/request/notify \
  --header 'Authorization: Bearer <ACCESS_TOKEN_FROM_SESSIONS_CALL>' \
  --header 'Content-Type: application/json' \
  --data '{
  "notification": {
    "consentRequestId": "77969467-5a92-44bb-9d6c-4caf24907ea5",
    "status": "GRANTED",
    "reason": null,
    "consentArtefacts": [
      {
        "id": "28ef6ae8-ad03-488d-b26e-940e27154cc0"
      }
    ]
  }
}'

Your bridge acknowledged the callback with 200 OK. The gateway validates the body you send back, so a 200 carrying the wrong body is still a failure.

Where this fits

Answer this callback by calling Acknowledge a consent notification, as the HIU.

The patient's decision, sent to the requester

Authorizations

Body

Responses

Where this fits​

Where this fits