# MFA API

The MFA operations of the BuildBase HTTP API: method, path, sign-in, request fields, answers and errors for each.

8 operations, 7 fully described. For how this part of BuildBase works, start with the [guide](/authentication/overview).

| Method | Path                                                                                                       | What it does                                                     |
| ------ | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------- |
| GET    | [`/api/v1/public/mfa`](/http-api/reference/mfa/mfa-list)                                                   | Get the signed-in person's two-step sign-in status               |
| POST   | [`/api/v1/public/mfa/backup-codes/regenerate`](/http-api/reference/mfa/mfa-backup-codes-regenerate-create) | Replace the backup codes for the authenticator app               |
| POST   | [`/api/v1/public/mfa/sms/disable`](/http-api/reference/mfa/mfa-sms-disable-create)                         | Turn off text-message codes as a second step                     |
| POST   | [`/api/v1/public/mfa/sms/enroll`](/http-api/reference/mfa/mfa-sms-enroll-create)                           | Send the code that turns on text-message codes as a second step  |
| POST   | [`/api/v1/public/mfa/sms/enroll/confirm`](/http-api/reference/mfa/mfa-sms-enroll-confirm-create)           | Confirm text-message codes as a second step with the texted code |
| POST   | [`/api/v1/public/mfa/totp/confirm`](/http-api/reference/mfa/mfa-totp-confirm-create)                       | Confirm an authenticator app with its first code                 |
| POST   | [`/api/v1/public/mfa/totp/disable`](/http-api/reference/mfa/mfa-totp-disable-create)                       | Remove the authenticator app                                     |
| POST   | [`/api/v1/public/mfa/totp/enroll`](/http-api/reference/mfa/mfa-totp-enroll-create)                         | Start setting up an authenticator app                            |

## Related

- [API reference](/http-api/reference): every tag
- [MFA guide](/authentication/overview)
