verifyPhoneNumber

AppDelegate.reachfive().verifyPhoneNumber(
    authToken,
    phoneNumber,
    verificationCode
)

Description

Verify the profile’s phone number with the verification code sent by SMS after signup.

The profile must have been granted the full_write scope at the last authentication.

Examples

import Reach5

let profileAuthToken: AuthToken = // Here paste the authorization token of the profile retrieved after login

AppDelegate
  .reachfive()
  .verifyPhoneNumber(
      authToken: profileAuthToken,
      phoneNumber: "+33750253354",
      verificationCode: "501028"
  )
  .onSuccess { _ in
      // Do something
  }
  .onFailure { error in
      // Return a ReachFive error
  }

Parameters

Parameter Description

authToken AuthToken

Authorization token of the profile retrieved from login.

idToken string

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

accessToken string

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

refreshToken string

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

tokenType string

The type of token. Always equal to Bearer.

expiresIn number

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.

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.

verificationCode string

The verification code sent by email or SMS.

Response

Type: Future<(), ReachFiveError>

If the full_write scope is missing or if the verification code is incorrect, the promise will be rejected and will return a ReachFiveError.

ReachFiveError

Based on the problem, the ReachFiveError will be:

AuthCanceled: The user cancelled the request or no credential was available in the keychain.
RequestError(apiError: ApiError) for a Bad Request (status 400) error.
AuthFailure(reason: String, apiError: ApiError?) mainly for Unauthorized (status 401) error.
TechnicalError(reason: String, apiError: ApiError?) if it’s an Internal Server Error (status 500) or other internal errors.

ApiError

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 OS and app 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 error message key.

errorDescription string

The technical error message.

errorDetails FieldError[]

field string

The field concerned by the error.

message string

The message error returned for the field.

code string

The code error returned for the field.