startMfaEmailRegistration
client.startMfaEmailRegistration({ accessToken: string, // Optional arguments trustDevice: boolean, (1) redirectUrl: string })
1 | If the email 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 verifyMfaEmailRegistration step. |
About this command
Starts the MFA email registration flow. When started, an email is sent to the user for verification.
If the user already has a verified email as an identifier in their account, no additional verification code is sent. If an existing email exists but is unverified, it becomes automatically verified with verifyMfaEmailRegistration. |
Examples
client.startMfaEmailRegistration({
accessToken: 'eyJ0eXAiOiJKV1QiL...',
redirectUrl: 'https://example.com/redirect'
})
Parameters
The authorization credential JSON Web Token (JWT) used to access the ReachFive API, less than five minutes old. |
|
Boolean indicating if the device should be trusted or not. Defaults to |
|
The URL sent in the email to which the user is redirected. This URL must be whitelisted in the |