For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
Log inSign up
Support
  • Core
    • Overview
    • Authorization
    • Base URL
    • Data formats
    • Paging
    • Error codes
    • Permissions
  • Calling
  • Datasphere
  • Logs
  • Messaging
  • Phone Number Management
  • Platform
      • POSTRequest MFA token via call
      • POSTRequest MFA token via SMS
      • POSTVerify MFA token
  • Resource Management
LogoLogoSignalWire Docs
Log inSign up
Support
PlatformMulti Factor Authentication

Verify MFA token

|View as Markdown|Open in Claude|
POST
https://{your_space_name}.signalwire.com/api/relay/rest/mfa/:mfa_request_id/verify
POST
/api/relay/rest/mfa/:mfa_request_id/verify
$curl -X POST https://{your_space_name}.signalwire.com/api/relay/rest/mfa/mfa_request_id/verify \
>     -H "Content-Type: application/json" \
>     -u "<project_id>:<api_token>" \
>     -d '{
>  "token": "123456"
>}'
1{
2  "success": true
3}

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.

Was this page helpful?
Previous

Create API token

Next
Built with

Authentication

AuthorizationBasic

SignalWire Basic Authentication using Project ID and API Token.

The client sends HTTP requests with the Authorization header containing the word Basic followed by a space and a base64-encoded string of project_id:token. The project ID will be used as the username and the API token as the password.

Example:

Authorization: Basic base64(project_id:token)

Path parameters

mfa_request_idstringRequiredformat: "uuid"
The MFA request ID.

Request

This endpoint expects an object.
tokenstringRequired
The token to verify.

Response

The request has succeeded.
successboolean

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.

Errors

401
Unauthorized Error
422
Unprocessable Entity Error
500
Internal Server Error