Verify a token

View as Markdown

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.

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