updateUserPhoneNumber()

Package: react-wallet-kit

Updates the user’s phone number.

This function updates the user’s phone number and, if provided, verifies it using a verification token (from an OTP flow).
If a userId is provided, it updates the phone number for that specific user; otherwise, it uses the current session’s userId.
If a verificationToken is not provided, the phone number will be updated but will not be marked as verified.
Automatically ensures an active session exists before making the request.
Handles session management and error reporting for both update and verification flows.

params

object

required

Show params details

params.phoneNumber

string

required

new phone number to set for the user.

params.stampWith

StamperType

parameter to stamp the request with a specific stamper (StamperType.Passkey, StamperType.ApiKey, or StamperType.Wallet).

params.userId

string

user ID to update a specific user’s phone number (defaults to the current session’s userId).

params.verificationToken

string

verification token from OTP phone verification (required if verifying the phone number).

A successful response returns the following fields:

returns

string

required

A promise that resolves to the userId of the updated user.