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 PhoneNumber.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 PhoneNumber.attemptVerification()
method, passing the one-time code as a parameter.
Finally, phone numbers are used as part of multi-factor authentication. Users receive an SMS message with a one-time code that they need to provide as an extra verification step.
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.
destroy()
Deletes this phone number.
toString()
Returns the phone number value in E.164 format. Can also be accessed via the PhoneNumber.phoneNumber
attribute.
Additional methods
In addition to the methods listed above, the PhoneNumber
class also has the following methods: