Sign Up
Request Body
true if the End-User's e-mail address has been verified; otherwise false. If force_email_verification is enabled in your tenant's settings, it will check this value of user while performing email verification checks.
Used password hash function identifier.
Available Values: bcryptargon2
Default Value: bcrypt
Available Values: twilionetgsm3gbilisimdataportmessagebirdcustomnativeplusauthaws_sespostmarksendgridsmtpcustom-oauth2amazonappledribbbledropboxfacebookgithubgooglelinkedinmicrosoftslackspotifytwittersamle-devletldap
Default Value: twilio
Available Values: smspushwebauthnemailsocialenterprise
Default Value: sms
Failed login attempts of user. It will reset to 0 after successful login.
End-User's full name in displayable form including all name parts, possibly including titles and suffixes, ordered according to the End-User's locale and preferences.
End-User's password in plaintext. Defined password policy rules will be enforced.
End-User's preferred phone number. It will be stored in E.164 format.
true if the End-User's phone number has been verified; otherwise false. If SMS MFA is enabled this value will be used to determine whether End-User has verified it's phone or not.
Additional metadata for your End-User. It must be an object containing 10 fields at max with keys and values no more than 1024 characters. Values can be only one of the types string, number and boolean. You can also use null as value to make metadata consistent across other users.
Identifier for user address. Example: Delivery Address, Billing Address etc.
Full street address component, which MAY include house number, street name, Post Office Box, and multi-line extended street address information. This field may contain multiple lines, separated by newline characters.
Full street address component, which MAY include house number, street name, Post Office Box, and multi-line extended street address information. This field may contain multiple lines, separated by newline characters.
End-User's birthday. ISO 8601:2004 YYYY-MM-DD format. The year may be 0000, indicating that it is omitted. To represent only the year, YYYY format is preferred.
Surname(s) or last name(s) of the End-User. Note that in some cultures, people can have multiple family names or no family name; all can be present, with the names being separated by space characters.
Given name(s) or first name(s) of the End-User. Note that in some cultures, people can have multiple given names; all can be present, with the names being separated by space characters.
Middle name(s) of the End-User. Note that in some cultures, people can have multiple middle names; all can be present, with the names being separated by space characters. Also note that in some cultures, middle names are not used.
Casual name of the End-User that may or may not be the same as the given_name. For instance, a nickname value of Mike might be returned alongside a given_name value of Michael.