Skip to content
BuildBase
HTTP API menu

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.

MethodPathWhat it does
GET/api/v1/public/mfaGet the signed-in person's two-step sign-in status
POST/api/v1/public/mfa/backup-codes/regenerateReplace the backup codes for the authenticator app
POST/api/v1/public/mfa/sms/disableTurn off text-message codes as a second step
POST/api/v1/public/mfa/sms/enrollSend the code that turns on text-message codes as a second step
POST/api/v1/public/mfa/sms/enroll/confirmConfirm text-message codes as a second step with the texted code
POST/api/v1/public/mfa/totp/confirmConfirm an authenticator app with its first code
POST/api/v1/public/mfa/totp/disableRemove the authenticator app
POST/api/v1/public/mfa/totp/enrollStart setting up an authenticator app