Disabling MFA and regenerating recovery codes
Multi-factor authenticationTwo security-sensitive self-service operations that follow once MFA is on. Both need a STRONG step-up token (§153 X-13): the password alone is never enough — prove a factor (a code to a verified channel, a TOTP, or a recovery code). Mint a separate token for each action: a token is bound to ONE action.
- GET /v1/me/mfa/methods → check which factors are enrolled first
- POST /v1/me/step-up { action: mfa_disable | mfa_recovery_codes, currentPassword } → a password-assurance token and the factors on offer (passwordOnlyAllowed: false)
- POST /v1/me/step-up/{challengeId}/code → only for a code factor (email_code / phone_code); skip it for a TOTP or a recovery code
- POST /v1/me/step-up/{challengeId}/verify → a STRONG token for the same action
- DELETE /v1/me/mfa { stepUpToken } → every method off; hasMfaEnabled → false
- POST /v1/me/mfa/recovery-codes { stepUpToken } → all old codes invalid; 8 new ones, shown ONCE (needs its own mfa_recovery_codes token)
/v1/me/mfa/methodsauthList enrolled MFA methodsShows the enabled methods (phone_otp / totp) and whether MFA is on — review before disabling. The confirmed methods are also what the step-up below can offer as factors (totp, and a code to the phone behind phone_otp).
Field guide — what each value means & where it comes fromno inputs
Bodyless GET — no input fields. Requires a valid bearer access token (the gateway injects x-gateway-context from it); a missing/invalid context yields 403 forbidden.
GET https://api.kerja.team/v1/me/mfa/methodsResponse guide — what comes back & what each value means4 fields
200 OK, JSON { data } envelope (not raw). No notable headers (no no-store on this read endpoint).
data.hasMfaEnabledbooleanalwaystrue— Caller has >=1 confirmed MFA method; show MFA-enabled state and offer disable/add-method actions.false— No confirmed MFA method; prompt the user to enrol a second factor.
data.methodsarray<object>alwaysdata.methods[].methodstringalwaysphone_otp— SMS one-time-passcode method is enrolled; offer phone-OTP disable/manage.totp— Authenticator-app TOTP method is enrolled; offer TOTP disable/manage.
data.methods[].confirmedAtstring (ISO 8601 date-time)always/v1/me/step-upauthStart a step-up for mfa_disableProves the CURRENT password and answers { challengeId, stepUpToken, assurance: password, expiresIn, passwordOnlyAllowed, options[], loginChannel? } — both ids are captured and filled into the cards below. The token is single-use and bound to this user, this SESSION, this action and the assurance it reached (STEP_UP_TOKEN_TTL_SECONDS, default 300); spending it on another action, from another session, or twice is 401 step_up_required. passwordOnlyAllowed says whether this password token already suffices; when false, prove one of options[] (a code to a verified, non-young CURRENT value — never a pending one — a TOTP, or a recovery code) for a strong token. Errors: wrong password 401 step_up_failed (counted per user AND per session — 5 in 15 min → 429, and a second throttle trip within 24 h revokes the session); 403 without an acting session (operator / act-as contexts have none); 409 no_password (GET /v1/me → hasPassword: false — set one through the reset flow, scenario 34); 409 change_in_progress when a live change blocks this action (details[0].blocking). Change action to mfa_recovery_codes (and press Send again) before regenerating codes — the token that comes back is bound to ONE action, and spending an mfa_disable token on recovery codes is 401 step_up_required. For both actions passwordOnlyAllowed is false: prove a factor below.
Field guide — what each value means & where it comes from2 fields
Starts a step-up (E-1) for ONE named profile action: proves the CURRENT password and answers 200 { challengeId, stepUpToken, assurance: password, expiresIn, passwordOnlyAllowed, options[], loginChannel? }. Every profile mutation — display name, login mode, email / phone / password change, phone removal, MFA disable, recovery-code regeneration — spends one of these tokens; a live session alone is never enough. Auth + throttled + no-store; the body is .strict(). THE TESTER AUTO-CAPTURES BOTH IDS: challengeId is filled into the …/code and …/verify cards on this page, and stepUpToken into the card that spends it. The token is single-use and bound to this user, this SESSION, this action and the assurance it reached (STEP_UP_TOKEN_TTL_SECONDS, default 300); spending it on another action, from another session, or twice → 401 step_up_required. passwordOnlyAllowed says whether this password token already suffices for the action; when false, continue with …/code (for a code factor) and …/verify for a strong token. options[] are the factors …/verify will accept: a code factor always names the CURRENT value on the account — never a pending one — and only when it is verified and not young (applied with password assurance inside CHANNEL_TRUST_AGE_SECONDS, default 30 days); totp appears when a confirmed authenticator exists, recovery_code while unused codes remain. The challenge lives STEP_UP_CHALLENGE_TTL_SECONDS (default 600) and takes STEP_UP_MAX_ATTEMPTS (default 5) wrong codes. Errors: 401 step_up_failed (wrong password — counted per user AND per session, 5 in 15 min → 429, a second throttle trip within 24 h revokes the session) · 403 without an acting session (operator / act-as contexts have none) · 409 no_password (GET /v1/me → hasPassword: false; set one through the reset flow, scenario 34) · 409 change_in_progress when a live change blocks the action (details[0].blocking lists { kind, status }) · 409 login_channel_unavailable (password_change with no verified loginMode channel). Audited step_up_succeeded / step_up_failed.
actionbodyenumrequiredyou choosedisplay_name— For PUT /v1/me/display-name (scenario 28). passwordOnlyAllowed: true — the password token is enough. Never blocked by a live change.email_change— For POST /v1/me/email-change (scenario 30). passwordOnlyAllowed: true on an account WITHOUT confirmed TOTP; false with one, and for a second contact change beside a strong one. A PASSWORD-assurance change is HELD 3 days after its code and sends notices with a cancel link; a STRONG one applies at once. Blocked (409 change_in_progress) by a live email or password change, and beside a live phone change unless both are strong.phone_change— For POST /v1/me/phone-change (scenario 31, and the link-mode add of scenario 4). Same rules as email_change: password enough without confirmed TOTP; held vs applied by assurance; one live phone change at a time, never beside a password change, beside an email change only when both are strong.password_change— For POST /v1/me/password-change (scenario 35). passwordOnlyAllowed: true. The answer carries loginChannel — the CURRENT loginMode channel the confirmation code will go to, which must be verified (else 409 login_channel_unavailable). Blocked by, and blocks, any live contact change.login_mode— For PUT /v1/me/login-mode (scenario 33). passwordOnlyAllowed: false — needs a STRONG token. Blocked while ANY credential change is live.phone_remove— For DELETE /v1/me/phone (no §2 scenario walks this any more — the doc dropped “Removing a phone credential” at its 2026-09-27 revision, while §3.31 and this action stay live). passwordOnlyAllowed: false — needs a STRONG token. Blocked while ANY credential change is live.mfa_disable— For DELETE /v1/me/mfa (scenario 27). passwordOnlyAllowed: false — needs a STRONG token. Never blocked by a live change.mfa_recovery_codes— For POST /v1/me/mfa/recovery-codes (scenario 27). passwordOnlyAllowed: false — needs a STRONG token. Never blocked by a live change.
currentPasswordbodystringrequiredyou choosePOST https://api.kerja.team/v1/me/step-upResponse guide — what comes back & what each value means12 fields
200 OK, { data } envelope, Cache-Control: no-store. The current password was proven for ONE named action, and this is the PASSWORD-assurance step-up token plus the factors that can raise it to strong. Every profile mutation (display name, email / phone / password change, login mode, phone removal, MFA disable, recovery codes) spends one of these tokens — a live session alone is never enough. The tester captures data.challengeId and data.stepUpToken and fills them into the next cards. 401 step_up_failed = wrong password (5 in 15 min → 429; a second throttle trip in 24 h revokes the session); 409 no_password / change_in_progress / login_channel_unavailable refuse BEFORE a token is minted.
data.challengeIdUUIDalwaysdata.stepUpTokenstring (43-char opaque)alwaysdata.assuranceenumalwayspassword— Always this value here — only the current password has been proven. A strong token comes only from POST /v1/me/step-up/{challengeId}/verify.
data.expiresInnumberalwaysdata.passwordOnlyAllowedbooleanalwaystrue— Spend stepUpToken now: display_name and password_change always; a contact change on an account without confirmed TOTP (that change is then HELD after its code). Raising to strong is still possible and makes a contact change apply at once.false— Password is not enough: login_mode, phone_remove, mfa_disable, mfa_recovery_codes, and a second contact change beside a strong one. Continue with /code (for a code factor) and /verify to get a strong token.
data.optionsarrayalwaysdata.options[].factorenumalwaysemail_code— A code to the verified current email: send it with /code, then /verify.phone_code— A WhatsApp/SMS code to the verified current phone: send it with /code, then /verify.totp— Offered when a confirmed authenticator exists. Nothing to send — go straight to /verify with the app's code.recovery_code— Offered while unused recovery codes remain. Nothing to send — /verify with one; it is consumed.
data.options[].roleenumconditionalcurrent_value— The channel whose value this very action changes (e.g. the current email in an email change) — proving it confirms the owner of the old value.other_channel— The account's OTHER verified channel — proving it shows control of a second, independent credential.channel— The role used for the actions that change no channel value of their own — login_mode, phone_remove and the two MFA actions: every eligible channel is simply offered as a channel. (For phone_remove the phone is still offered as current_value, because that IS the value being removed.)
data.options[].maskedstringconditionaldata.loginChannelobjectconditionaldata.loginChannel.channelenumconditionalemail— The password-change code will be emailed.phone— The password-change code will go to the phone by WhatsApp/SMS.
data.loginChannel.maskedstringconditional/v1/me/step-up/{challengeId}/codeauthSend a step-up code to one of the offered channelsOnly for a CODE factor: factor is email_code or phone_code and must be one of the challenge's options[] (else 422 factor_not_eligible). 202 { status, masked, ttlSeconds }. The code is BOUND to this challenge, and a second send retires the first. Skip this card for a TOTP or a recovery code — they go straight to verify. 404 for an unknown or expired challenge (STEP_UP_CHALLENGE_TTL_SECONDS, default 600); 429 on the per-user, per-channel send throttle.
Field guide — what each value means & where it comes from2 fields
Sends a step-up code (E-2) to ONE of the challenge's channel options — the step_up.<action> message, in the caller's locale. 202 { status: accepted, masked, ttlSeconds }. The code is bound to THIS challenge, and a second send retires the first. Each code sent takes STEP_UP_MAX_ATTEMPTS (default 5) wrong guesses — email and phone alike — after which that CODE is burnt and a resend is needed; the challenge itself is separately capped at 5 failed proofs of any factor code. Auth + throttled (per user, per channel → 429) + no-store; the body is .strict(). Only needed for a code factor — a totp or recovery_code factor goes straight to …/verify. 404 when there is no such (live) challenge for the caller; 422 factor_not_eligible when the factor is not among the challenge's options.
challengeIdpathUUIDrequiredauto-capturedfactorbodyenumrequiredfrom a responseemail_code— Emails a code to the account's current verified address (~15 min). Retrieve it with the “Get a step-up code” helper (by challengeId).phone_code— Sends a WhatsApp/SMS code to the account's current verified number (~5 min). Retrieve it with the “Get a step-up code” helper (by challengeId).
POST https://api.kerja.team/v1/me/step-up/{challengeId}/codeResponse guide — what comes back & what each value means3 fields
202 Accepted, { data } envelope, Cache-Control: no-store. A step-up code (the step_up.<action> message, in the caller's locale) went to the chosen channel option. The code is bound to THIS challenge; a second send retires the first code. 404 = no such challenge for this caller (or it expired); 422 factor_not_eligible = the factor is not among the challenge's options; 429 = per-user, per-channel throttle.
data.statusenumalwaysaccepted— The only value: the code is on its way. Collect it (dev: the step-up OOB helper) and call /verify with the same factor.
data.maskedstringalwaysdata.ttlSecondsnumberalways/v1/me/step-up/{challengeId}/verifyauthProve the factor → a STRONG tokenfactor is email_code · phone_code · totp · recovery_code (one of the challenge's options), code is the value that proves it. 200 { stepUpToken, assurance: strong, expiresIn } — captured, and it REPLACES the password token in the card that spends it. The password token stays valid alongside it. A used recovery code is consumed. Wrong, expired or exhausted code → 401 step_up_failed; the challenge takes STEP_UP_MAX_ATTEMPTS (default 5) wrong codes and closes once it succeeds or is exhausted.
Field guide — what each value means & where it comes from3 fields
Proves a factor (E-3) — the code from …/code, a TOTP, or a recovery code — and answers 200 { stepUpToken, assurance: strong, expiresIn } for the SAME action. THE TESTER CAPTURES IT and it REPLACES the password token in the card that spends it; the password token from the start stays valid alongside it. The challenge closes once it succeeds or its attempts are exhausted (STEP_UP_MAX_ATTEMPTS, default 5). Auth + no-store; .strict(). Errors: 401 step_up_failed (wrong, expired or exhausted code; a TOTP or recovery code that did not verify; and the CHALLENGE as a whole takes STEP_UP_MAX_ATTEMPTS (default 5) failed proofs of ANY factor, after which it is DELETED and every later call answers 404) · 404 no such challenge · 422 factor_not_eligible. A used recovery code is consumed. Audited step_up_succeeded with stepUpMethod = the factor.
challengeIdpathUUIDrequiredauto-capturedfactorbodyenumrequiredfrom a responseemail_code— code is the email code sent by …/code with factor email_code. Send …/code first — the “Get a step-up code” helper REPLACES the hash of the code row that send created, so there is nothing to fetch before it.phone_code— code is the WhatsApp/SMS code sent by …/code with factor phone_code. Same helper, same order: send, then “Get a step-up code”.totp— code is the current 6-digit TOTP from the enrolled authenticator — use the “Get current TOTP code” helper. Offered only when a CONFIRMED authenticator exists. No …/code send.recovery_code— code is one of your unused MFA recovery codes (from enrolment or the last regeneration). Offered only while unused codes remain; CONSUMED on success. No …/code send.
codebodystringrequiredout-of-bandPOST https://api.kerja.team/v1/me/step-up/{challengeId}/verifyResponse guide — what comes back & what each value means3 fields
200 OK, { data } envelope, Cache-Control: no-store. A second factor was proven (the /code code, a TOTP, or a recovery code — the latter consumed) and this is a STRONG step-up token for the same action. The challenge is closed once it succeeds or its attempts run out. The tester captures data.stepUpToken, which replaces the password-assurance token in the next cards (that earlier token stays valid alongside it). 401 step_up_failed = wrong / expired / exhausted code. Audits step_up_succeeded with stepUpMethod = the factor.
data.stepUpTokenstring (43-char opaque)alwaysdata.assuranceenumalwaysstrong— Always this value here: password plus a second factor. Satisfies every step-up-gated action it was minted for.
data.expiresInnumberalways/v1/me/mfaauthDisable MFA (strong mfa_disable token)The body is { stepUpToken } only (.strict()); it must be a STRONG token minted for mfa_disable — no, spent, foreign, wrong-action or password-assurance → 401 step_up_required. 200 {}. Turns off ALL methods. Does NOT revoke existing sessions and does NOT untrust devices: sessions created with amr [pwd, mfa] keep running, only future logins skip the MFA hop. TENANT ENFORCEMENT REFUSES THE CALL OUTRIGHT: if ANY tenant you hold an active membership in requires MFA, this answers 403 mfa_enrollment_required and nothing is disabled — enforcement is at the point of REMOVAL, not only at session issue and switch-tenant. Letting the disable succeed and rejecting you at the next login would make the policy unenforceable in the one direction that matters, and the person who paid for it would be you, locked out by an action the API had just called fine. Any one confirmed method satisfies enforcement, so a member holding two may still remove one. An account without a password cannot start the step-up at all (409 no_password).
Field guide — what each value means & where it comes from1 field
Disables MFA — every enrolled method — on a STRONG step-up token minted for mfa_disable (§153 X-13). Auth (the tester sends the bearer; the gateway injects x-gateway-context). The body is .strict() and carries ONLY the token: the current password and the old otpCode factor are gone from this body, and a live session plus the password alone is no longer enough — the caller proves a SECOND factor at POST /v1/me/step-up/{challengeId}/verify (a code to a verified channel, a TOTP, or a recovery code). 200 { data: {} }. Tenant enforcement still applies after the token: if any tenant you hold an ACTIVE membership in requires MFA, the call is refused 403 mfa_enrollment_required and nothing is disabled — a member cannot opt out of a policy their admin set (scenario 55). Existing sessions are NOT revoked. Audited mfa_disabled. Walk-through: scenario 27.
stepUpTokenbodystringrequiredauto-capturedDELETE https://api.kerja.team/v1/me/mfaResponse guide — what comes back & what each value means1 field
200 OK, { data } envelope with Cache-Control: no-store; data is an empty object. Reached only with a STRONG step-up token minted for mfa_disable (scenario 27) — the password alone is not enough: a second factor (a code to a verified channel, a TOTP, or a recovery code) was proven at POST /v1/me/step-up/{challengeId}/verify. The token is spent. All MFA methods are cleared and hasMfaEnabled becomes false; existing sessions are NOT revoked. Audits mfa_disabled. A 401 step_up_required means the token was missing, spent, foreign, minted for another action or only password-assurance; 403 mfa_enrollment_required means a tenant you belong to enforces MFA.
dataobject (empty)always/v1/me/mfa/recovery-codesauthRegenerate recovery codes (strong mfa_recovery_codes token)A STRONG token minted for mfa_recovery_codes — re-run the step-up above with that action first. Invalidates all existing codes and returns 8 new ones, shown ONCE — save them immediately, they are not retrievable after the response. MFA must already be enabled → 409 conflict otherwise, and that precondition is checked BEFORE the token is spent, so a doomed request costs nothing.
Field guide — what each value means & where it comes from1 field
Regenerates MFA recovery codes (invalidate-and-reissue) on a STRONG step-up token minted for mfa_recovery_codes (§153 X-13). Auth (bearer + gateway context, handled). The body is .strict() and carries ONLY the token — the old currentPassword / otpCode factors are gone. MFA must already be enabled: that precondition is checked BEFORE the token is spent, so a doomed request (409 conflict, nothing to regenerate) costs nothing. 200 { recoveryCodes: [8 codes] } — the previous codes are dead and the new ones are shown ONCE. Audited recovery_codes_regenerated. Walk-through: scenario 27.
stepUpTokenbodystringrequiredauto-capturedPOST https://api.kerja.team/v1/me/mfa/recovery-codesResponse guide — what comes back & what each value means1 field
200 OK with a { data } envelope and Cache-Control: no-store. Reached only with a STRONG step-up token minted for mfa_recovery_codes (scenario 27); MFA must already be enabled, checked BEFORE the token is spent (409 conflict otherwise, token intact). Previous recovery codes are immediately invalidated and 8 fresh codes are returned exactly once. Audits recovery_codes_regenerated.
data.recoveryCodesstring[]always