Send a Multi-Factor Code When Disabling MFA

You are disabling MFA for a user. You must provide an API key or a valid JWT for the User you are modifying. This should only be used if you want FusionAuth to send the code. Do not use this if you are using a TOTP based authentication method.

Request#

Send a Multi-Factor code to an existing User by Id

POST/api/two-factor/send

OpenAPI Spec

Request Headers#

X-FusionAuth-TenantIdStringoptional

The unique Id of the tenant used to scope this API request.

The tenant Id is not required on this request even when more than one tenant has been configured because the tenant can be identified based upon the request parameters or it is otherwise not required.

Specify a tenant Id on this request when you want to ensure the request is scoped to a specific tenant. The tenant Id may be provided through this header or by using a tenant locked API key to achieve the same result.

See Making an API request using a Tenant Id for additional information.

Request Body#

applicationIdUUIDoptionalAvailable since 1.46.0

An optional Application Id. When this value is provided, it will be used to resolve an application-specific email or message template and make application available as a template variable.

If not provided, only the tenant configuration will be used when resolving templates, and application will not be available as a template variable.

messageTypeStringoptionalDefaults to SMSAvailable since 1.65.0

The message type used when sending a code for a phone-based MFA method.

This value is only used when the method identified by methodId is an sms method.

Valid values are:

SMS
Voice

methodIdStringrequired

The Id of the MFA method which will be removed.

userIdUUIDrequired

The User Id of the User to send a Multi-Factor verification code. This User is expected to already have Multi-Factor enabled.

Example Request JSON

{
  "messageType": "Voice",
  "methodId": "RLRT",
  "userId": "c075e472-a732-47d6-865a-d385a5fcb525"
}

Send a Multi-Factor code to an authenticated User using a JWT