startPasswordless

client.startPasswordless(
  email,
  phoneNumber
  success,
  failure,
  activity,
  // Optional argument
  redirectUri,
)

About this command

Starts a passwordless flow by sending an email or an SMS to the profile with a single-use auth code.

Examples

  • With an email

  • With a phone number

import com.reach5.identity.sdk.core.models.Profile

client.startPasswordless(
    email = "john.doe@email.com",
    redirectUri = "reachfive-${clientId}://callback",
    success = { _ -> ... }, // Do something
    failure = { error -> ... }, // Handle a ReachFive error
    activity = activity
)
import com.reach5.identity.sdk.core.models.Profile

client.startPasswordless(
    phoneNumber = "+33612345678",
    redirectUri = "reachfive-${clientId}://callback",
    success = { _ -> ... }, // Do something
    failure = { error -> ... }, // Handle a ReachFive error
    activity = activity
)

Parameters

email string

The email address of the profile.

phoneNumber string

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

redirectUri string

The URL where the user will be redirected after the passwordless success. Default value is reachfive-${clientId}://callback.

failure function

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

success function

Callback called once the request has succeeded. No argument is expected.

activity Activity

The Android activity.

Response

Type: Unit

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.

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
  • de - Deutsch German

  • en - English

  • es - Español Spanish

  • fr - Français French

  • hu - Magyar Hungarian

  • it - Italiano Italian

  • nl - Nederlands Dutch

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

  • sk - Slovenský Slovak

  • pt - Portuguese

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.