signupWithPasskey

client.signupWithPasskey(
    profile,
    friendlyName,
    scope,
    origin,
    success,
    failure,
    activity,
)

About this command

The user requests to sign up with a passkey for the first time.

The WebAuthn feature must be enabled on your ReachFive account.

Examples

client.signupWithPasskey(
    ProfileWebAuthnSignupRequest(
        givenName = "John",
        familyName = "Doe",
        email = "john.doe@gmail.com"
    ),
    friendlyName = "Google Password Manager",
    origin = "passkey signup from Android app",
    success = { authToken -> ... }, // Get the profile's authentication token
    failure = { error -> ... }, // Handle a ReachFive error
    activity = activity,
)

Parameters

activity Activity

The Android activity.

failure function

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

friendlyName string

The name associated to the passkey in ReachFive.

Default to the name of the Android product.

origin string

Free text parameter describing the source of the login (only for reporting purposes).

profile ProfileWebAuthnSignupRequest

The profile data.

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.

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 pages (usually a social provider’s page).

picture string

The URL of one of the user’s profile pictures. 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.

Currently allowed values are female, male and other.

company string

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

consents Map<string, Consent>

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

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 request has succeeded.

Takes authToken as a parameter.

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

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