Skip to main content
The MfaVoiceEnrollment screen class provides methods associated with the mfa-voice-enrollment screen. This screen is displayed for a user needs to enter a phone number to receive a voice call with a code to continue enrollment.
MfaVoiceEnrollment

​
Constructors

Create an instance of MfaVoiceEnrollment screen
Example
import MfaVoiceEnrollment from '@auth0/auth0-acul-js/mfa-voice-enrollment';
const mfaVoiceEnrollmentManager = new MfaVoiceEnrollment();
const handleContinueEnrollment = async () => {
 try {
   await mfaVoiceEnrollmentManager.continue({
     phone: '+1234567890',
     // Add any optional CustomOptions here if needed 
   });
   console.log('Voice enrollment continued successfully.');
 } catch (error) {
   console.error('Error continuing voice enrollment:', error);
 }
};

​
Properties

​
branding
BrandingMembers
Provides branding-related configurations, such as branding theme and settings.
​
client
ClientMembers
Provides client-related configurations, such as id, name, and logoUrl.
​
organization
OrganizationMembers
Provides information about the user’s organization, such as organization id and name.
​
prompt
PromptMembers
Contains data about the current prompt in the authentication flow.
​
screen
ScreenMembers
Contains details specific to the screen, including its configuration and context.
​
tenant
TenantMembers
Contains data related to the tenant, such as id and associated metadata.
​
transaction
TransactionMembers
Provides transaction-specific data, such as active identifiers and flow states.
​
untrustedData
UntrustedDataMembers
Handles untrusted data passed to the SDK, such as user input during login.
​
user
UserMembers
Details of the active user, including username, email, and roles.

​
Methods

​
continue
(options ?)
This method continues with the default action.
Example
import MfaVoiceEnrollment from '@auth0/auth0-acul-js/mfa-voice-enrollment';
const mfaVoiceEnrollmentManager = new MfaVoiceEnrollment();
const handleContinueEnrollment = async () => {
 try {
   await mfaVoiceEnrollmentManager.continue({
     phone: '+1234567890',
     // Add any optional CustomOptions here if needed 
   });
   console.log('Voice enrollment continued successfully.');
 } catch (error) {
   console.error('Error continuing voice enrollment:', error);
 }
};
​
options
OPTIONAL
Optional payload.
​
getErrors
Error[]
This method retrieves the array of transaction errors from the context, or an empty array if none exist.
​
selectPhoneCountryCode
(options ?)
This method allows picking a country code for the phone number.
Example
import MfaVoiceEnrollment from '@auth0/auth0-acul-js/mfa-voice-enrollment';
const mfaVoiceEnrollment = new MfaVoiceEnrollment();
const handlePickCountryCode = async () => {
 await mfaVoiceEnrollment.selectPhoneCountryCode();
};
​
options
OPTIONAL
Optional payload.
​
tryAnotherMethod
(options ?)
This method allows the user to try another MFA method.
Example
import MfaVoiceEnrollment from '@auth0/auth0-acul-js/mfa-voice-enrollment';
const mfaVoiceEnrollment = new MfaVoiceEnrollment();
const handleTryAnotherMethod = async () => {
 await mfaVoiceEnrollment.tryAnotherMethod();
};
​
options
OPTIONAL
Optional payload.