A newer version of this documentation is available.

View Latest


  // Optional arguments

About this command

Authenticate the user with the specified identifier (email or phone number) and password.

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


  • With an email

  • With a phone number

  username = "john.doe@gmail.com",
  password = "UCrcF4RH",
  scope = listOf("openid", "profile", "email"),
  success = { authToken -> ... }, // Get the profile's authentication token
  failure = { error -> ... } // Return a ReachFive error
  username = "+33682234940",
  password = "UCrcF4RH",
  scope = listOf("openid", "profile", "phone"),
  success = { authToken -> ... }, // Get the profile's authentication token
  failure = { error -> ... } // Return a ReachFive error


username string

Username of the profile: email address or phone number.

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

password string

The password of the profile

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 login has succeeded. You’ll get an AuthToken as an argument.

failure function

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


Type: Unit


The authentication token.


The ID token JSON Web Token (JWT) that contains the profile’s information.


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


The refresh token JSON Web Token (JWT) used to obtain new access tokens once they expire.


The type of token. Always equal to Bearer.


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


message string

The message of the error.

code string

The HTTP status code.

Redirection errors

The errors listed here are specific to redirection activity for the ReachFive Android SDK.

  • 0 = Success!

  • -1 = Unexpected result. Contact support.

  • 1 = Request aborted.

  • 2 = Unauthorized request.

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-HK - 廣東話 Hong Kong 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.