Interface MfaVoiceChallengeMembers

screen

untrustedData

continue

• continue(payload: Screens.MfaVoiceChallengeContinueOptions): Promise<void>

  Submits the voice verification code to validate the MFA challenge.

  Parameters

  • payload: Screens.MfaVoiceChallengeContinueOptions

    Object containing the verification code and optional parameters

  Returns Promise<void>

  Promise that resolves when the code is successfully validated

  Example

  const mfaVoiceChallenge = new MfaVoiceChallenge();
  mfaVoiceChallenge.continue({
    code: '123456',
    rememberDevice: true
  });
  Copy

pickPhone

• pickPhone(payload?: Screens.CustomOptions): Promise<void>

  Navigates to the screen for selecting a different phone number.

  Parameters

  • Optionalpayload: Screens.CustomOptions

    Optional custom parameters

  Returns Promise<void>

  Promise that resolves when navigation is complete

  Example

  const mfaVoiceChallenge = new MfaVoiceChallenge();
  mfaVoiceChallenge.pickPhone();
  Copy

resendCode

• resendCode(payload?: Screens.CustomOptions): Promise<void>

  Requests a new voice call with a verification code.

  Parameters

  • Optionalpayload: Screens.CustomOptions

    Optional custom parameters to send with the request.

  Returns Promise<void>

  A promise that resolves once the form is submitted, before the page reloads. It doesn't confirm that a new code was sent.

  Remarks

  Submits a form POST with action: "resend-code". Auth0 responds by rendering this screen again, so the browser reloads the page and the current JavaScript context, including component state and timers, is lost.

  Code after await resendCode() may still run, but anything it sets up, such as a "code sent" message or a countdown, is gone after the reload. Server-side errors, such as rate limits, appear in transaction.errors (or useErrors() in React) on the reloaded page. They don't reject the returned promise.

  To add a cooldown between resends, use resendManager() (or useResend() in React). It stores its countdown in localStorage, so the countdown survives the reload.

resendManager

• resendManager(options?: Screens.StartResendOptions): Screens.ResendControl

  Gets resend functionality with timeout management for this screen

  Parameters

  • Optionaloptions: Screens.StartResendOptions

    Configuration options for resend functionality

  Returns Screens.ResendControl

switchToSms

• switchToSms(payload?: Screens.CustomOptions): Promise<void>

  Switches to SMS verification method instead of voice call.

  Parameters

  • Optionalpayload: Screens.CustomOptions

    Optional custom parameters

  Returns Promise<void>

  Promise that resolves when switching is complete

  Example

  const mfaVoiceChallenge = new MfaVoiceChallenge();
  mfaVoiceChallenge.switchToSms();
  Copy

tryAnotherMethod

• tryAnotherMethod(payload?: Screens.CustomOptions): Promise<void>

  Navigates to the screen for selecting an alternative MFA method.

  Parameters

  • Optionalpayload: Screens.CustomOptions

    Optional custom parameters

  Returns Promise<void>

  Promise that resolves when navigation is complete

  Example

  const mfaVoiceChallenge = new MfaVoiceChallenge();
  mfaVoiceChallenge.tryAnotherMethod();
  Copy