SMS verification

Verify users with SMS-based MFA by requesting and submitting a 6-digit code sent to their enrolled phone number.

React

Requesting an MFA challenge

To request an MFA challenge for the current user, call the init method from the useMfa hook, passing 'sms' as the MFA method parameter:

import {useMfa} from '@privy-io/react-auth';

const {init, submit} = useMfa();

// Request an SMS MFA challenge
await init('sms');

The init method will prepare an MFA challenge for the SMS method. The user will receive an SMS with their MFA code at the phone number they originally enrolled. The method returns a Promise that resolves if the challenge was successfully created, and rejects with an error if there was an issue.

Submitting the MFA verification

Once init has resolved successfully, prompt the user to get their MFA code from their SMS and enter it within your app. Then, call the submit method from useMfa. As parameters, pass the MFA method ('sms') and the MFA code that the user entered:

const mfaCode = 'insert-mfa-code-from-user';
await submit('sms', mfaCode);

When submit resolves successfully, the user has completed MFA and can proceed to use their embedded wallet.

React Native

Requesting an MFA challenge

To request an MFA challenge for the current user, call the init method from the useMfa hook with the appropriate parameters:

import {useMfa} from '@privy-io/expo';

const {init, submit} = useMfa();

// Request an SMS MFA challenge
await init({method: 'sms'});

The init method will prepare an MFA challenge for the SMS method. The user will receive an SMS with their MFA code at the phone number they originally enrolled.

Submitting the MFA verification

Once init has resolved successfully, prompt the user to get their MFA code from their SMS and enter it within your app. Then, call the submit method:

const mfaCode = 'insert-mfa-code-from-user';
await submit({method: 'sms', mfaCode});

When submit resolves successfully, the user has completed MFA and can proceed to use their embedded wallet.

Swift

Requesting an MFA challenge

To request an MFA challenge for the current user, call the sendCode method from user.mfa.sms.verify:

guard let user = await privy.getUser() else { return }

// Request an SMS MFA challenge
try await user.mfa.sms.verify.sendCode()

The sendCode method will prepare an MFA challenge for the SMS method. The user will receive an SMS with their MFA code at the phone number they originally enrolled. The method throws if there was an issue sending the code.

Submitting the MFA verification

Once sendCode has completed successfully, prompt the user to get their MFA code from their SMS and enter it within your app. Then, call the submit method:

let mfaCode = "123456" // Code entered by user

do {
    try await user.mfa.sms.verify.submit(code: mfaCode)

    // If you've set up an MFA required listener, notify Privy MFA succeeded and to continue pending actions
    await privy.mfa.resumeBlockedActions()
} catch {
    // Either prompt user to try again, or notify Privy MFA failed and pass the error to the call site
    await privy.mfa.resumeBlockedActions(throwing: error)
}

When submit completes successfully, the user has completed MFA and can proceed to use their embedded wallet.

If your app uses an MFA required listener, you must call privy.mfa.resumeBlockedActions() after successful verification to unblock any pending wallet operations.