Skip to content

Send verification SMS

Request

Sends a one-time passcode (OTP) by SMS to the specified phone number for a selected user.

Required permissions: apps:execute, [appId]:execute, auth:execute.

Security
ClientAccessToken
Path
user_idstringrequired

ID of the user

Bodyapplication/jsonrequired
custom_messagestring

Message to send, must contain {otp} and {app} placeholders to be replaced with one time password and application name. Limited to 140 characters

sender_idstring

The sender name that appears as the message sender on recipients devices. Limited to 11 characters. Limited support see https://docs.aws.amazon.com/sns/latest/dg/sns-supported-regions-countries.html

phone_numberstringrequired

Phone number to send the OTP to

curl -i -X POST \
  'https://api.sbx.transmitsecurity.io/cis/v1/users/{user_id}/phone/verification/send' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "custom_message": "string",
    "sender_id": "string",
    "phone_number": "string"
  }'

Responses

Bodyapplication/json
messagestringread-onlyrequired
Example:"SMS sent"
Response
{ "message": "SMS sent" }