SignUp

The SignUp object contains the state of the current sign-up that the user has initiated.

Name

Description

status

string

The status of the current sign-up.

It can take the following values:

  • missing_requirements: There are required fields that are either missing or they are unverified.

  • complete: All the required fields have been supplied and verified, so the sign-up is complete and a new user and a session have been created.

  • abandoned: The sign-up has been inactive for a long period of time, thus it's considered as abandoned and need to start over.

requiredFields

string[]

An array of all the required fields that need to be supplied and verified in order for this sign-up to be marked as complete and converted into a user.

optionalFields

string[]

An array of all the fields that can be supplied to the sign-up, but their absence does not prevent the sign-up from being marked as complete.

missingFields

string[]

An array of all the fields whose values are not supplied yet but they are mandatory in order for a sign-up to be marked as complete.

unverifiedFields

string[]

An array of all the fields whose values have been supplied, but they need additional verification in order for them to be accepted.

Examples of such fields are emailAddress and phoneNumber.

In order to verify these fields,

supportedExternalAccounts

string[]

An array of all the external accounts that are supported in the current sign-up, e.g. oauth_google, oauth_facebook, etc.

verifications

SignUpVerificationResource[]

An object that contains information about all the verifications that are in-flight.

username

string | null

emailAddress

string | null

phoneNumber

string | null

externalAccount

passwordEnabled

boolean

firstName

string | null

lastName

string | null

createdSessionId

string | null

createdUserId

string | null