Sign in with MFA
Use Sign in with MFA to verify the user’s authenticator app code during sign-in.
This screen appears after the user submits valid sign-in credentials and the account requires MFA.
This screen includes:
| # | Element | Description |
|---|---|---|
| 1 | Verification code modal | Requests the user’s 6-digit authentication code. |
| 2 | Modal title | Displays Verification code. |
| 3 | Close action | Closes the modal. |
| 4 | Instruction text | Tells the user to check their authenticator app. |
| 5 | Code input fields | Accept the 6-digit verification code. |
| 6 | Verify action | Submits the verification code. |
| 7 | Background sign-in screen | Shows the sign-in modal behind the verification modal. |
Workflow
- Submit sign-in credentials.
- Display the MFA verification modal when MFA is enabled.
- Enter the 6-digit code from the authenticator app.
- Select Verify.
- Complete sign-in after successful verification.
- Keep the modal open when verification fails.
Validations
| Scenario | App behavior | SDK output |
|---|---|---|
| MFA required | Display verification code modal | mfa = required |
| Code missing | Disable or block verification | validation = code_required |
| Code incomplete | Keep verification blocked | validation = code_incomplete |
| Code invalid | Display validation error | error = invalid_mfa_code |
| Code expired | Display validation error | error = expired_mfa_code |
| MFA verification succeeds | Complete sign-in | state = authenticated |
| Request rejected | Display error state | status = 405 |
Actions
| Scenario | App behavior | SDK output |
|---|---|---|
| MFA screen opens | Load MFA verification screen | PUT /api/v3/sign-in/mfa |
| Code entered | Update code input state | mfa = updated |
| Verify selected | Submit MFA code | POST /api/v3/sign-in/mfa |
| Verification succeeds | Complete sign-in | state = authenticated |
| Close selected | Close MFA modal | state = dismissed |
| Request rejected | Preserve current state | state = unchanged |
Endpoint Resources
MFA
PUT
v3/sign-in/mfa
Returns the MFA verification screen for completing sign-in.
Sign In With MFA
POST
v3/sign-in/mfa
Authenticates the user with sign-in credentials and verifies the MFA one-time code.
Query Parameters
| Name | Type | Required | Description |
|---|---|---|---|
screen-mode | string | Yes | Controls which sign-in experience to render. |
email | string | Yes | Account email address. |
password | string | Yes | Account password. |
mfa | string | Yes | One-time code from the user’s authenticator app. |