sendEmailVerification

AppDelegate.reachfive().sendEmailVerification(authToken, redirectUrl) (1)
1 redirectUrl is optional.

Description

Initiates the email verification process by sending a verification email to the user’s registered email address. The email contains a unique verification code required to confirm the email address.

This method requires the user to be authenticated and is typically used after signup or an email update.

  • You should configure and enable the Verify email template in the account’s settings.

Examples

import Reach5

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

AppDelegate
  .reachfive()
  .sendEmailVerification(
      authToken: profileAuthToken,
      redirectUrl: "https://example-email-verification.com" // optional
  )
  .onSuccess { emailVerificationResponse in
    switch emailVerificationResponse {
      case .Success:
        // Email verification process completed successfully
      case .VerificationNeeded(let continueEmailVerification):
        // Verification email sent, use continueEmailVerification.verify(code: String, email: String, freshAuthToken: AuthToken? = nil) or AppDelegate.reachfive().verifyEmail to complete the flow
    }
  }
  .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.

redirectUrl string

optional The URL to which the user will be redirected after clicking the verification link in the email.

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

Response

Type: Future<EmailVerificationResponse, ReachFiveError>

The response is an EmailVerificationResponse enum with two cases:

  • .Success: Indicates the email verification process completed without requiring further action.

  • .VerificationNeeded(ContinueEmailVerification): Indicates a verification email was sent, and further action (e.g., entering a verification code) is required to complete the process.

The promise is rejected and returns a ReachFiveError if:

  • The parameters are invalid.

  • The email template is incomplete.

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.

Completing the flow

Use continueEmailVerification.verify(code: String, email: String, freshAuthToken: AuthToken? = nil) or verifyEmail to complete the verification.