webhooks

The consent manager reports the state of a consent request you asked about.

POST/api/v3/hiu/consent/request/on-status

GRANTED is absent from status's enum here on purpose: a grant is communicated through the notify callback with consentArtefacts, not through this status callback.

Authorizations

Authorizationbearer tokenRequired

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

Body

consentRequestobjectRequired

consentRequest.idstringRequired

consentRequest.statusstringRequired

GRANTED is not one of these values; see the operation description for why.

One of REQUESTEDDENIEDEXPIREDREVOKED

errornullRequired

responseobjectRequired

response.requestIdstringRequired

respnullRequired

Responses

200

OK. Acknowledge quickly, then process asynchronously.

The consent manager reports the state of a consent request you asked about.

curl --request POST \
  --url https://dev.abdm.gov.in/api/api/v3/hiu/consent/request/on-status \
  --header 'Authorization: Bearer <ACCESS_TOKEN_FROM_SESSIONS_CALL>' \
  --header 'Content-Type: application/json' \
  --data '{
  "consentRequest": {
    "id": "77969467-5a92-44bb-9d6c-4caf24907ea5",
    "status": "REQUESTED"
  },
  "error": null,
  "response": {
    "requestId": "68b099de-f7ba-4a92-9bd5-97de2e397f31"
  },
  "resp": null
}'

OK. Acknowledge quickly, then process asynchronously.

Where this fits

You produce this callback by calling Check the status of a consent request.

The consent manager reports the state of a consent request you asked about.

Authorizations

Body

Responses

Where this fits​

Where this fits