verify | SignalWire

Verify an MFA code submitted by the user.

Path parameters

mfa_request_idstringRequiredformat: "uuid"

The MFA request ID.

Request

tokenstringRequired

The token to verify.

Response

successbooleanRequired

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`.

Response Example

Response

1 {
2   "success": true
3 }

Example

1 import { RestClient } from "@signalwire/sdk";
2 
3 const client = new RestClient({
4   project: "your-project-id",
5   token: "your-api-token",
6   host: "your-space.signalwire.com"
7 });
8 
9 const result = await client.mfa.verify("your-mfa-request-id", { token: "123456" });
10 if (result.success) {
11   console.log("Verification successful");
12 } else {
13   console.log("Invalid code");
14 }