startMfaPhoneNumberRegistration

client.startMfaPhoneNumberRegistration({
  accessToken: string,
  phoneNumber: string (1)
})
1 If the user already has a verified phone number as an identifier in their account, there’s no need to pass the phoneNumber parameter.
If an existing phone number is unverified, it becomes automatically verified with the verifyMfaPhoneNumberRegistration step.

About this command

Starts the MFA phone number registration flow. When started, an SMS is sent to the user for verification.

Examples

client.startMfaPhoneNumberRegistration({
    accessToken: 'eyJ0eXAiOiJKV1QiL...',
    phoneNumber: '+33606060606'
  })

Parameters

accessToken string

The authorization credential JSON Web Token (JWT) used to access the ReachFive API, less than five minutes old.

phoneNumber string

The user’s phone number.

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

Response

Type: Promise<void>