Gateway & Bridge

Update HIP/HIU Bridge Callback URL

Register the HIP/HIU callback URL with the ABDM Gateway. All gateway push notifications (e.g. patient-share) are delivered to this URL.

PATCH/api/hiecm/gateway/v3/bridge/url

Authorizations

Authorizationbearer tokenRequired

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

Headers

REQUEST-IDstringRequired

A fresh UUID that you generate for this request. It is how you and the gateway correlate a call with its callback and with a support ticket, so log it. Reusing one across requests makes both impossible.

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. Sending the wrong one against the right host is a common first-day failure and reads as an authorisation error.

Body

urlstringRequired

HTTPS callback URL for the HIP/HIU

Responses

200

Bridge URL updated successfully

Update HIP/HIU Bridge Callback URL

curl --request PATCH \
  --url https://dev.abdm.gov.in/api/hiecm/gateway/v3/bridge/url \
  --header 'Authorization: Bearer <ACCESS_TOKEN_FROM_SESSIONS_CALL>' \
  --header 'REQUEST-ID: 5f7a4a1e-59ba-4c0c-9e0c-8e6b3b6e2f11' \
  --header 'TIMESTAMP: 2026-08-25T15:51:15.339Z' \
  --header 'X-CM-ID: <X_CM_ID>' \
  --header 'Content-Type: application/json' \
  --data '{
  "url": "<URL>"
}'

{
  "message": "<MESSAGE>"
}

Generated from the schema. The values are placeholders, not a captured response.