---
title: "Get a patient's authentication modes relevant to specified purpose"
method: POST
path: "/v0.5/users/auth/fetch-modes"
tags: ["user auth", "hip facing", "hiu facing"]
---

# Get a patient's authentication modes relevant to specified purpose

`POST /v0.5/users/auth/fetch-modes`

This API is meant for identify supported authentication modes for a patient given a specific purpose

## Headers

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

## Request body

- PatientAuthModeQueryRequest
  - `query` object, required
    - `id` string, required
    - `purpose` 'LINK' | 'KYC' | 'KYC_AND_LINK', required — what is the purpose of user auth
    - `requester` object, required
      - `id` string, required
      - `type` 'HIP' | 'HIU', required
  - `requestId` string, uuid, required — a nonce, unique for each HTTP request
  - `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` — Invalid request, required attributes not provided
- `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)