Skip to main content
Docs

The Backend EmailAddress object

The Backend EmailAddress object is a model around an email address. Email addresses are one of the identifiers used to provide identification for users.

Email addresses must be verified to ensure that they are assigned to their rightful owners. The EmailAddress object holds all necessary state around the verification process.

For implementation examples for adding and verifying email addresses, see the email link custom flow and email code custom flow guides.

Properties

  • Name
    emailAddress
    Type
    string
    Description

    The value of the email address.

  • Name
    id
    Type
    string
    Description

    The unique identifier for the email address.

  • Name
    linkedTo
    Type
    []
    Description

    An array of objects containing information about any identifications that might be linked to the email address.

  • Name
    verification
    Type
    null |
    Description

    An object holding information on the verification of the email address.

Feedback

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

Last updated on