handleRemoveUserPhoneNumber()

Package: react-wallet-kit

Defined in: react-wallet-kit/src/providers/client/Types.tsx:720

Overview

Handles the removal of a user’s phone number from their Turnkey account.

• Opens a modal with the RemovePhoneNumber component, allowing the user to confirm and remove their phone number.
• Supports optional overrides for userId, organizationId, and stamper type.
• Returns the user ID associated with the removed phone number.

Parameters

params · HandleRemoveUserPhoneNumberParams

Show params details

params.organizationId

string

organization ID to target (defaults to the session’s organization ID or the parent organization ID).

params.stampWith

StamperType

stamper type to use for the removal (StamperType.Passkey, StamperType.ApiKey, or StamperType.Wallet).

params.successPageDuration

number

duration in milliseconds to display the success page after removal (default: 0, no success page).

params.userId

string

user ID to remove the phone number for (defaults to the current session’s userId).

Response

A successful response returns the following fields:

returns · string · required

A promise that resolves to the user ID associated with the removed phone number.