Skip to main content

GET /v1/auth/mfa/status

Whether the caller has TOTP MFA enabled.

::: tip Auth Required: cookie or Bearer. :::

Request

GET /v1/auth/mfa/status

HeaderRequiredNotes
Cookie: identsphere_at=... OR Authorization: Bearer ...yes

Response

200 OK

{ "enabled": true }

Error responses

StatusCodeWhen
401authentication_requiredNo valid auth credential.
404not_foundThe authenticated user no longer exists.

Example: curl

curl https://auth.example.com/v1/auth/mfa/status -b cookies.txt

Example: TypeScript (@identsphere/react)

import { useMfaStatus } from '@identsphere/react';

function MfaToggle() {
const { data } = useMfaStatus();
return <span>MFA is {data?.enabled ? 'on' : 'off'}</span>;
}

Notes

This endpoint reflects the persisted state. A user mid-enrollment (has run /setup but not yet /enable) reports enabled: false.