Start TOTP enrolment
POST/v1/auth/mfa/enrol
Returns a fresh secret and an otpauth:// URI to render as a QR code. Nothing is enabled until /v1/auth/mfa/confirm proves the app has it. Two-factor authentication is **mandatory for any account that has ever spent money**: until such an account enrols, every other endpoint answers 403 mfa_required to its console sessions.
Example
curl -X POST https://api.woyra.io/v1/auth/mfa/enrol \
-H "Authorization: Bearer $WOYRA_KEY"Response
200 Enrolment material.
| Field | Type | Description |
|---|---|---|
| object | "mfa_enrolment" | |
| secret | string | Base32 |
| uri | string | otpauth URI for a QR code. |
Errors
| Status | Codes |
|---|---|
| 400 | invalid_request, unsupported_version |
Also in Console
- POST /v1/auth/signup — Create an account and sign in
- POST /v1/auth/login — Sign in with email and password
- POST /v1/auth/logout — End the session
- GET /v1/auth/config — What a sign-in page needs before anyone signs in
- GET /v1/auth/me — The signed-in user, account and MFA state
- POST /v1/auth/mfa/verify — Finish signing in with a TOTP code or a recovery code
- POST /v1/auth/passkeys/login/begin — Start signing in with a passkey
- POST /v1/auth/passkeys/login/finish — Finish signing in with a passkey
- GET /v1/auth/passkeys — The signed-in user's passkeys
- POST /v1/auth/passkeys/register/begin — Start adding a passkey
- POST /v1/auth/passkeys/register/finish — Finish adding a passkey
- DELETE /v1/auth/passkeys/{id} — Remove a passkey
- POST /v1/auth/recovery_codes — Make a fresh set of recovery codes
- POST /v1/auth/mfa/confirm — Confirm TOTP enrolment with a code
- DELETE /v1/auth/mfa — Disable TOTP
- POST /v1/auth/verify-email — Confirm an email address from its link
- POST /v1/auth/resend-verification — Send the verification email again
- POST /v1/auth/forgot-password — Request a password reset link
- POST /v1/auth/reset-password — Set a new password from a reset link
- POST /v1/auth/change-password — Change the password while signed in
- GET /v1/auth/invites/{token} — Describe an invitation before accepting it
- POST /v1/auth/invites/accept — Accept an invitation and sign in
- GET /v1/console/overview — Dashboard counts
- GET /v1/console/analytics — Daily series and the route view
- GET /v1/console/stream — Live message events
- GET /v1/audit_events — The account's audit trail