---
title: "callback API by HIU/HIPs as acknowledgement of auth notification"
method: POST
path: "/v0.5/users/auth/on-notify"
tags: ["user auth", "hip facing", "hiu facing"]
---

# callback API by HIU/HIPs as acknowledgement of auth notification

`POST /v0.5/users/auth/on-notify`

This API is called by HIU/HIPs to confirm acknowledgement for receipt of auth notification is case of DIRECT authentication.

## Headers

- `Authorization` string, required
- `X-CM-ID` string, required

## Request body

- PatientAuthNotificationAcknowledgement
  - `acknowledgement` object
    - `status` 'OK', required
  - `error` Error
    - `code` 1000 | 10001
    - `message` string
  - `requestId` string, uuid, required — a nonce, unique for each HTTP request
  - `resp` RequestReference, required
    - `requestId` string, uuid, required — the requestId that was passed
  - `timestamp` string, date-time, required — Date time format in UTC, includes miliseconds YYYY-MM-DDThh:mm:ss.vZ

## Response `202`

Request accepted

## Other responses

- `400` — **Causes:** * required details not provided * neither auth nor error specified
- `401` — **Causes:** * Unauthorized request
- `500` — **Causes:** * Downstream system(s) is down. * Unhandled exceptions.

---

[API](https://skmtc.net/ndhm/apis/ndhm-gateway.md) · [All operations](https://skmtc.net/ndhm/apis/ndhm-gateway/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/ndhm/ndhm-gateway/versions/a440e2981b29/schema)