Receive the HIU subscription requests on init
Hosted by the HIP/HIU, not by ABDM. ABDM calls this endpoint at the callback URL registered for your bridge, so the path below is relative to that URL.
This API endpoint serves as a callback for the /api/hiecm/subscription-requests/v3/init API. It is used to handle the response from the subscription request initiation process. By invoking this API, the Health Information User (HIU) can receive and process the outcome of the subscription request, ensuring that the system accurately reflects the status and actions taken. Unique UUID for track the end to end request transaction Actual time of the request was initiated, ISO 8601 represents date and time by starting with the year, followed by the month, the day, the hour, the minutes, seconds and milliseconds Identifier of the health information user to which the request was intended Random generated uniqueid. Allows alpha numeric character and special characters like [A-Z a-z 0-9]+[A-Z a-z 0-9 //_//-]*[A-Z a-z 0-9]$ Incase of success, error object is optional ABDM-1001 - No data found. May be returned either bare ( The appropriate error message Request id that was passed. Allows alpha numeric character and special characters like [A-Z a-z 0-9]+[A-Z a-z 0-9 //_//-]*[A-Z a-z 0-9]$ OK Internal Server Error -> It is just one example, for every api the path will be changed.Authorizations
Authorizationbearer tokenRequiredHeaders
REQUEST-IDstringRequiredTIMESTAMPstringRequiredX-HIU-IDstringRequiredBody
subscriptionRequestobjectRequiredsubscriptionRequest.idstringerrorobjecterror.codestringRequiredABDM-1001) or with a trailing ": " separator (ABDM-1001: ); match on the code itself and tolerate the separator.error.messagestringRequiredresponseobjectRequiredresponse.requestIdstringRequiredResponses
200500
Where this fits
hiecm-subscription.yaml declares this callback at module level and names no call against it. Which call produces it is not documented, so this page does not say.