Skip to main content
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