Sign in
Multi-Factor Authentication

Request MFA token via SMS

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.

post/api/relay/rest/mfa/sms

Request body

tostring required

The E164 number to use as the destination.

fromstring

The E164 number from your account to use as the origin of the message. SignalWire will use a special verified number if not specified.

messagestring

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_lengthinteger

The number of characters in the token, from 4 to 20. Defaults to 6.

valid_forinteger

The number of seconds the token is considered valid for. Defaults to 3600, with a maximum of 604800.

max_attemptsinteger

The number of allowed verification attempts, including the first one, from 1 to 20. Defaults to 3.

allow_alphasboolean

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

Example request

{
  "to": "+14043287382",
  "from": "+12029167968",
  "message": "Here is your code",
  "token_length": 6,
  "valid_for": 3600,
  "max_attempts": 3
}

Response

The request has succeeded.

idstring uuid required

Universal Unique Identifier.

successboolean required

Whether the request was successfully queued.

tostring required

The destination of the MFA request.

channelstring required

Can be sms for a text message or call for a phone call.

Example response

{
  "success": true,
  "to": "+15554422333",
  "channel": "call"
}

Changes

No changes found, but 3 of the 137 revisions have a changelog that could not be searched — this endpoint may have changed in one of them.