Skip to navigation
PlatformMulti Factor Authentication

Request MFA token via SMS

View as MarkdownOpen in Claude

Creates a multi-factor authentication request and sends its code to the destination by SMS. Use it when an application must verify possession of a text-capable phone number; save the returned request ID and submit the code to Verify MFA token. Use the voice-call operation when the recipient cannot receive SMS.

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)

Request

This endpoint expects an object.
tostringRequired
The E164 number to use as the destination.
fromstringOptional
The E164 number from your account to use as the origin of the message. SignalWire will use a special verified number if not specified.
messagestringOptionalDefaults to Your Personal Authorization Code is:

Specify a custom message to send before the token. The message must fit within one segment; either 160 characters or 70 characters when using non-GSM symbols.

token_lengthintegerOptionalDefaults to 6
The number of characters in the token, from 4 to 20. Defaults to 6.
valid_forintegerOptionalDefaults to 3600
The number of seconds the token is considered valid for. Defaults to 3600, with a maximum of 604800.
max_attemptsintegerOptionalDefaults to 3
The number of allowed verification attempts, including the first one, from 1 to 20. Defaults to 3.
allow_alphasbooleanOptionalDefaults to false

Set to true or false, whether to include letters or just numbers in the token. Defaults to false (numbers only).

Response

The request has succeeded.
idstringformat: "uuid"
The MFA request ID. Save this for verification.
successboolean
Whether the request was successfully queued.
tostring
The destination of the MFA request.
channelstring
Can be sms for a text message or call for a phone call.

Errors

401
Unauthorized Error
422
Unprocessable Entity Error
500
Internal Server Error