Skip to main content
Interface describing the members of the Mfa Voice Enrollment screen.
Example
export interface MfaVoiceEnrollmentMembers extends BaseMembers {
  client: ClientMembers;
  organization: OrganizationMembers;
  prompt: PromptMembers;
  screen: ScreenMembers;
  transaction: TransactionMembers;

  /**
   * Continues with the voice enrollment process.
   * @param payload - The phone number and optional custom options.
   * @returns Promise that resolves when enrollment continues.
   */
  continue(payload: ContinueOptions): Promise<void>;

  /**
   * Allows trying another authentication method.
   * @param payload - Optional custom options.
   * @returns Promise that resolves when the user switches method.
   */
  tryAnotherMethod(payload?: CustomOptions): Promise<void>;

  /**
   * Allows picking a country code for the phone number.
   * @param payload - Optional custom options.
   * @returns Promise that resolves when the country code is selected.
   */
  selectPhoneCountryCode(payload?: CustomOptions): Promise<void>;
}

Properties

branding
client
organization
prompt
screen
tenant
transaction
untrustedData
user

Methods

continue
Promise<void>
Continues with the voice enrollment process.Promise that resolves when enrollment continues.
selectPhoneCountryCode
Promise<void>
Allows picking a country code for the phone number.Promise that resolves when the country code is selected.
tryAnotherMethod
Promise<void>
Allows trying another authentication method.Promise that resolves when the user switches method.