Get Brand SMS OTP Status by Brand ID

Query the status of an SMS OTP (One-Time Password) for Sole Proprietor brand verification using the Brand ID.

This endpoint allows you to check the delivery and verification status of an OTP sent during the Sole Proprietor brand verification process by looking it up with the brand ID.

The response includes delivery status, verification dates, and detailed delivery information.

Note: This is an alternative to the /10dlc/brand/smsOtp/{referenceId} endpoint when you have the Brand ID but not the reference ID.

GET /10dlc/brand/{brandId}/smsOtp

JavaScript

JavaScript

import Telnyx from 'telnyx';

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

const response = await client.messaging10dlc.brand.retrieveSMSOtpStatus(
  '4b20019b-043a-78f8-0657-b3be3f4b4002',
);

console.log(response.brandId);

200

{
  "brandId": "B123ABC",
  "referenceId": "OTP4B2001",
  "mobilePhone": "[phone]",
  "requestDate": "2024-12-03T17:12:33.560000+00:00",
  "deliveryStatus": "DELIVERED_HANDSET",
  "verifyDate": "2024-12-03T17:12:33.560000+00:00",
  "deliveryStatusDate": "2024-12-03T17:12:33.560000+00:00",
  "deliveryStatusDetails": "Delivered to handset"
}

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 query OTP status

Example:

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

Response

200

application/json

Successful Response

Status information for an SMS OTP sent during Sole Proprietor brand verification

brandId · string · required

The Brand ID associated with this OTP request

Example:

"B123ABC"

referenceId · string · required

The reference ID for this OTP request, used for status queries

Example:

"OTP4B2001"

mobilePhone · string · required

The mobile phone number where the OTP was sent, in E.164 format

Example:

"[phone]"

requestDate · string<date-time> · required

The timestamp when the OTP request was initiated

Example:

"2024-12-03T17:12:33.560000+00:00"

deliveryStatus · string · required

The current delivery status of the OTP SMS message. Common values include: DELIVERED_HANDSET, PENDING, FAILED, EXPIRED

Example:

"DELIVERED_HANDSET"

verifyDate · string<date-time>

The timestamp when the OTP was successfully verified (if applicable)

Example:

"2024-12-03T17:12:33.560000+00:00"

deliveryStatusDate · string<date-time>

The timestamp when the delivery status was last updated

Example:

"2024-12-03T17:12:33.560000+00:00"

deliveryStatusDetails · string

Additional details about the delivery status

Example:

"Delivered to handset"