Brands

Verify Brand SMS OTP

Changed on

Verify the SMS OTP (One-Time Password) for Sole Proprietor brand verification.

Verification Flow:

  1. User receives OTP via SMS after triggering
  2. User submits the OTP pin through this endpoint
  3. Upon successful verification:
    • A BRAND_OTP_VERIFIED webhook event is sent to the CSP
    • The brand's identityStatus changes to VERIFIED
    • Campaigns can now be created for this brand

Error Handling:

Provides proper error responses for:

  • Invalid OTP pins
  • Expired OTPs
  • OTP verification failures
put/10dlc/brand/{brandId}/smsOtp

Request

  • Base URL: https://api.telnyx.com/v2
  • URL: https://api.telnyx.com/v2/10dlc/brand/{brandId}/smsOtp
  • Auth: HTTP bearer

Path parameters

brandIdstring required
Example:4b20019b-043a-78f8-0657-b3be3f4b4002

The Brand ID for which to verify the OTP

Request body

otpPinstring required

The OTP PIN received via SMS

Example request

{
  "otpPin": "123456"
}

Response

OTP verified successfully - No content returned

Changes

  • 19db5ee4ec59Revision changes
    • breaking

      the // response's property type changed from integer to string, and format from int32 to no format for status

    • info

      added the optional property // to the response with the status

  • a6a61a29ecddRevision changes
    • breaking

      the // response's property type changed from string to integer, and format from no format to int32 for status

    • info

      added the optional property // to the response with the status