Skip to main content
Docs

The Backend PhoneNumber object

The Backend 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.

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
    defaultSecondFactor
    Type
    boolean
    Description

    Set to true if this phone number is the default second factor. Set to false otherwise. A user must have exactly one default second factor, if multi-factor authentication (2FA) is enabled.

  • Name
    id
    Type
    string
    Description

    The unique identifier for this phone number.

  • Name
    linkedTo
    Type
    IdentificationLink[]
    Description

    An object containing information about any other identification that might be linked to 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 to false otherwise.

  • Name
    verification
    Type
    null | Verification
    Description

    An object holding information on the verification of this phone number.

Feedback

What did you think of this content?
Edit this page on GitHub

Last updated on