data retrieval
Health Information Request Status
Polls the current status of a previously made health information request, by transaction id. An alternative to waiting for the on-request and data flow notify callbacks: useful if a callback was missed, or if the integration prefers to poll rather than depend on inbound delivery.
Authorizations
Authorizationbearer tokenRequiredBearer token obtained from POST /hiecm/gateway/v3/sessions
Path parameters
transaction-idstringRequiredThe health information request transaction id, from the original request.
Headers
REQUEST-IDstringRequiredA 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.
TIMESTAMPstringRequiredThe 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-IDstringRequiredWhich consent manager you are talking to. sbx on the sandbox and abdm in production.
Responses
200Current status of the health information request.