signup

client.signup(
  profile,
  redirectUrl,
  success,
  failure,
  // Optional arguments
  scope
)

About this command

Create and authenticate a new user with the specified data.

A user may identify himself with either his email address or his phone number if the SMS feature is enabled.

Breaking changes for 10.0.0, please read.

Breaking changes for Android 10.0.0

From Android SDK version 10.0.0, the signup callback now returns a SignupResponse, and the authToken is optional.

  • If the Block unverified logins at signup feature is enabled, the signup may return SignupResponse.AwaitingIdentifierVerification instead of SignupResponse.AchievedLogin. In this case, no AuthToken will be provided, and you must handle pending verification states without errors.

  • Ensure your application logic accounts for both possible outcomes of SignupResponse (AchievedLogin and AwaitingIdentifierVerification) to avoid runtime issues.

Examples

  • With an email

  • With a phone number

  • With a custom identifier

import com.reach5.identity.sdk.core.ReachFive
import com.reach5.identity.sdk.core.models.ProfileSignupRequest
import com.reach5.identity.sdk.core.models.SignupResponse

client.signup(
    profile = ProfileSignupRequest(
        givenName = "John",
        familyName = "Doe",
        gender = "male",
        email = "john.doe@gmail.com",
        customIdentifier = "coolCat55",
        password = "hjk90wxc"
    ),
    scope = listOf("openid", "profile", "email"),
    success = { response ->
        when (response) {
            is SignupResponse.AchievedLogin(authToken) -> {
                // Signup succeeded and the user is logged in
                // Handle authenticated session
            }
            is SignupResponse.AwaitingIdentifierVerification -> {
                // Signup succeeded but requires email verification before login
                // Prompt the user to verify their email
            }
        }
    },
    failure = { error ->
        // Handle a ReachFive error
    }
)
import com.reach5.identity.sdk.core.ReachFive
import com.reach5.identity.sdk.core.models.ProfileSignupRequest
import com.reach5.identity.sdk.core.models.SignupResponse

client.signup(
    profile = ProfileSignupRequest(
        givenName = "John",
        familyName = "Doe",
        gender = "male",
        phoneNumber = "+353875551234",
        customIdentifier = "coolCat55",
        password = "hjk90wxc"
    ),
    scope = listOf("openid", "profile", "phone"),
    success = { response ->
        when (response) {
            is SignupResponse.AchievedLogin -> {
                // Signup succeeded and the user is logged in
                // Handle authenticated session
            }
            is SignupResponse.AwaitingIdentifierVerification -> {
                // Signup succeeded but requires phone number verification before login
                // Prompt the user to verify their phone number
            }
        }
    },
    failure = { error ->
        // Handle a ReachFive error
    }
)
import com.reach5.identity.sdk.core.models.Profile

client.signup(
    profile = ProfileSignupRequest(
        givenName = "John",
        familyName = "Doe",
        gender = "male",
        email = "john.doe@gmail.com",
        customIdentifier = "coolCat55",
        password = "hjk90wxc"
    ),
    scope = listOf("openid", "profile", "email"),
    success = { authToken -> ... }, // Get the profile's authentication token
    failure = { error -> ... } // Handle a ReachFive error
)

Parameters

profile ProfileSignupRequest

The data of the profile.

password string

The password of the profile. Password must meet the minimum requirements defined by the zxcvbn used.

email string

The primary email address of the profile.

phoneNumber string

The primary phone number of the profile.

Both the international format and the national conventions of the account’s country are accepted if configured in account settings.

customIdentifier string

A string that allows users to authenticate with something other than an email or phone_number. It’s important to note that an email and/or phone_number is still required to create a managed profile. Each custom_identifier value must be unique. The custom_identifier must be between 4-80 characters.

givenName string

The given name of the profile.

middleName string

The middle name of the profile.

familyName string

The family name of the profile.

name string

The full name of the profile.

nickname string

The nickname of the profile.

birthdate string

The birthdate of the profile, represented as an ISO 8601 YYYY-MM-DD format.

profileURL string

The URL of one of the user’s profile page (usually a social provider’s page).

picture string

The URL of one of the profile picture. This URL refers to an image file (PNG, JPEG, or GIF image file).

username string

The username of the profile (the login’s name).

gender string

The gender of the profile.

Allowed values are female, male and other.

company string

The company’s name of the profile.

addresses ProfileAddress[]

The list of the profile’s postal addresses

locale string

The profile’s language code in lowercase and country code in uppercase, separated by a dash (eg en, fr-FR …​).

bio string

The biography of the profile.

customFields Map<string, any>

The custom fields of the profile.

Structured custom fields are only available using the full key for the field (e.g., full.custom_field.key). They are not supported as nested objects.

consents Map<string, Consent>

The consents granted to the profile. It is a map of string keys with the associated consent object.

redirectUrl string

The URL sent in the email to which the user is redirected.

This URL must be whitelisted in the Allowed Callback URLs field of your ReachFive client settings.

scope string[]

List of space-delimited, case-sensitive strings representing the requested scope.

Default scopes are the allowed scopes set up in the client’s configuration.

success function

Callback called once the signup process completes. You receive a SignupResponse as an argument, which can be one of:

  • SignupResponse.AchievedLogin(authToken): signup succeeded and the user is immediately logged in; contains an authToken.

  • SignupResponse.AwaitingIdentifierVerification: signup is pending verification (e.g., email or phone number).

failure function

Callback called once the request has failed. You’ll get a ReachFiveError as an argument.

Response

Depending on the feature configuration and the user’s verification status, the response can contain an authentication token or indicate that verification is required before login.

AchievedLogin

Returns the authentication token.

idToken

The ID token JSON Web Token (JWT) that contains the profile’s information. Only available when the openid scope is requested.

accessToken

The authorization credential JSON Web Token (JWT) used to access the ReachFive API.

refreshToken

The refresh token JSON Web Token (JWT) used to obtain new access tokens once they expire. Only available when the offline_access scope is requested.

tokenType

The type of token. Always equal to Bearer.

expiresIn

The lifetime in seconds of the access token.

If expiresIn is less than or equal to 0, the AuthToken is expired.

user OpenIDUser

The user’s information contained in the ID token.

id string

The identifier of the user.

name string

The full name of the user in displayable form including all name parts, possibly including titles and suffixes, ordered according to the user’s locale and preferences.

preferredUsername string

The shorthand name by which the user wishes to be referred to.

givenName string

The given name or first name of the user.

familyName string

The surname or last name of the user.

middleName string

The middle name of the user.

nickname string

The casual name of the user that may or may not be the same as the givenName.

picture string

The URL of the user’s profile picture.

website string

The URL of the user’s web page or blog.

email string

The user’s preferred e-mail address.

emailVerified boolean

True if the user’s e-mail address has been verified; otherwise false.

gender string

The user’s gender.

zoneinfo string

The string from the zoneinfo time zone database representing the user’s time zone.

locale string

The user’s language code in lowercase and country code in uppercase, separated by a dash.

phoneNumber string

The user’s preferred telephone number.

phoneNumberVerified boolean

True if the user’s phone number has been verified; otherwise false.

address string

The user’s preferred postal address.

AwaitingIdentifierVerification

Returned when a signup completes but the user must verify their identifier (email or phone) before logging in.

  • No AuthToken is returned.

  • You should prompt the user to check their email or SMS for verification instructions.

  • After verification, the user can log in normally to receive an AuthToken.

ReachFiveError

message string

The message of the error.

getErrorCode() ErrorCode

The error code’s enumeration value.

code string

The HTTP status code or SDK error code.

See Android SDK errors for more details.

exception string

The stack trace of the error.

data ReachFiveApiError

Additional data about the error.

error string

The main error message.

errorId string

The identifier of the error.

errorUserMsg string

The user-friendly error message.

This property is translated according to the user’s browser settings. Currently supported languages:
Currently supported languages

  • ar - العربية Arabic

  • de - Deutsch German

  • en - English

  • es - Español Spanish

  • fr - Français French

  • hu - Magyar Hungarian

  • it - Italiano Italian

  • jp - 日本 Japanese

  • ko - 한국인 Korean

  • nl - Nederlands Dutch

  • pt - Portuguese

  • ru - Ру́сский Russian

  • sk - Slovenský Slovak

  • zh-CN - People’s Republic of China Simplified Chinese

  • zh-Hans - Simplified Chinese

  • zh-Hant - Traditional Chinese

  • zh-HK - Hong Kong Traditional Chinese

  • zh-MO - Macao Traditional Chinese

  • zh-SG - Singapore Simplified Chinese

  • zh-TW - Taiwan Traditional Chinese

errorMessageKey string

The technical error code.

errorDescription string

The technical error message.

errorDetails ReachFiveApiErrorDetails

  • field - The field concerned by the error.

  • message - The message error returned for the field.