startMfaPhoneNumberRegistration
client.startMfaPhoneNumberRegistration({
accessToken: string,
phoneNumber: string, (1)
trustDevice: boolean, (2)
action: string
})
| 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. |
| 2 | If the phone number is already verified and you set trust_device to true, the __Host-trusted-device-id cookie is deposited in the response header and you do not need to pass trust_device in the verifyMfaPhoneNumberRegistration step. |
| 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',
action: 'stepup'
})Parameters
The authorization credential JSON Web Token (JWT) used to access the ReachFive API, less than five minutes old. |
|
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. |
|
Boolean indicating if the device should be trusted or not. Defaults to |
|
A string describing the action for the MFA flow. You can value this with whatever you like. It should match the value you describe in your MFA templates. We recommend using meaningful values like |