Multi-Factor Authentication

Verify MFA token

Checks a submitted code against the multi-factor authentication request identified in the path. Use it after requesting delivery by SMS or voice call and before granting the user access. The request's configured lifetime and attempt limit determine whether further verification is allowed.

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

Request

  • Base URL
    https://{Your_Space_Name}.signalwire.com
  • URL
    https://{Your_Space_Name}.signalwire.com/api/relay/rest/mfa/{mfa_request_id}/verify
  • Auth
    HTTP basic

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
}

Changes

No operation changes found yet. Some revisions have not been checked.