v77

latestOpenAPI 3.1.0MITraw.githubusercontent.com2026-08-012528701.8 MB

Multi-Factor Authentication

Verify MFA token

Verifies a multi-factor authentication code.

Permissions

The API token used to authenticate must have the following scope(s) enabled to make a successful request: Management.

Learn more about API scopes.

post/api/relay/rest/mfa/{mfa_request_id}/verify

Path parameters

mfa_request_idstring uuid required

Universal Unique Identifier.

The MFA request ID.

Request body

tokenstring required

The token to verify.

Example request

{
  "token": "123456"
}

Response

The request has succeeded.

successboolean required

Whether the token was successfully verified by the API. When max_attempts are reached or the request is no longer valid, the endpoint will return a 404 Not Found.

Example response

{
  "success": true
}