Start reset by SMS OTP

Request

Starts a password reset flow by sending an SMS OTP.

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

Security

ClientAccessToken

Bodyapplication/jsonrequired

prev_reset_tokenstring

Reset token that contains mfa_required as true. Should be passed when initiating a second factor authentication, in case MFA is required for password reset flows.

ignore_mfaboolean

Allows resetting the password without MFA in case MFA is required for password reset flows

phone_numberstringrequired

Phone number to send the SMS to, specified in E.164 format

Example:"+16175551212"

curl -i -X POST \
  https://api.sbx.transmitsecurity.io/cis/v1/auth/password/reset/sms/otp \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "prev_reset_token": "string",
    "ignore_mfa": true,
    "phone_number": "+16175551212"
  }'

Responses

Bodyapplication/json

messagestringread-onlyrequired

Example:"SMS Sent"

Response

{
  "message": "SMS Sent"
}