PhoneNumber
The PhoneNumber
object describes a phone number. Phone numbers can be used as a proof of identification for users, or simply as a means of contacting users.
Phone numbers must be verified to ensure that they can be assigned to their rightful owners. The PhoneNumber
object holds all the necessary state around the verification process.
- The verification process always starts with the
prepareVerification()
method, which will send a one-time verification code via an SMS message. - The second and final step involves an attempt to complete the verification by calling the
attemptVerification()
method, passing the one-time code as a parameter.
Finally, phone numbers can be used as part of multi-factor authentication. During sign in, users can opt in to an extra verification step where they will receive an SMS message with a one-time code. This code must be entered to complete the sign in process.
Properties
- Name
id
- Type
string
- Description
A unique identifier for this phone number.
- Name
phoneNumber
- Type
string
- Description
The value of this phone number, in E.164 format.
- Name
reservedForSecondFactor
- Type
boolean
- Description
Set to
true
if this phone number is reserved for multi-factor authentication (2FA). Set tofalse
otherwise.
- Name
defaultSecondFactor
- Type
boolean
- Description
Set to
true
if this phone number is the default second factor. Set tofalse
otherwise. A user must have exactly one default second factor, if multi-factor authentication (2FA) is enabled.
- Name
verification
- Type
Verification
- Description
An object holding information on the verification of this phone number.
- Name
linkedTo
- Type
Array<{id: string, type: string}>
- Description
An object containing information about any other identification that might be linked to this phone number.
- Name
backupCodes
- Type
string[] | undefined
- Description
A list of backup codes in case of lost phone number access.
destroy()
Deletes this phone number.
toString()
Returns the phone number value in E.164 format. Can also be accessed via the PhoneNumber.phoneNumber
attribute.
prepareVerification()
Kick off the verification process for this phone number. An SMS message with a one-time code will be sent to the phone number value.
attemptVerification()
Attempts to verify this phone number, passing the one-time code that was sent as an SMS message. The code will be sent when calling the PhoneNumber.prepareVerification()
method.
- Name
code
- Type
string
- Description
The one-time code that was sent to the user's phone number when
prepareVerification
was called.
makeDefaultSecondFactor()
Marks this phone number as the default second factor for multi-factor authentication(2FA). A user can have exactly one default second factor.
setReservedForSecondFactor()
Marks this phone number as reserved for multi-factor authentication (2FA) or not.
- Name
reserved
- Type
boolean
- Description
Pass
true
to mark this phone number as reserved for 2FA, orfalse
to disable 2FA for this phone number.
Feedback
Last updated on