Verify Brand SMS OTP

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

Verification Flow:

User receives OTP via SMS after triggering
User submits the OTP pin through this endpoint
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

JavaScript

import Telnyx from 'telnyx';

const client = new Telnyx({
  apiKey: process.env['TELNYX_API_KEY'], // This is the default and can be omitted
});

await client.messaging10dlc.brand.verifySMSOtp('4b20019b-043a-78f8-0657-b3be3f4b4002', {
  otpPin: '123456',
});

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>"
    }
  ]
}

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

brandId

string

required

The Brand ID for which to verify the OTP

Example:

"4b20019b-043a-78f8-0657-b3be3f4b4002"

Body

application/json

Request body for verifying a Brand SMS OTP

otpPin

string

required

The OTP PIN received via SMS

Required string length: 4 - 10

Example:

"123456"

Response

OTP verified successfully - No content returned

Get Brand SMS OTP Status by Brand ID

Trigger Brand SMS OTP

⌘I

JavaScript

import Telnyx from 'telnyx';

const client = new Telnyx({
  apiKey: process.env['TELNYX_API_KEY'], // This is the default and can be omitted
});

await client.messaging10dlc.brand.verifySMSOtp('4b20019b-043a-78f8-0657-b3be3f4b4002', {
  otpPin: '123456',
});

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>"
    }
  ]
}