Brands

Get Brand SMS OTP Status by Brand ID

Changed on

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

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

Response

Successful Response

brandIdstring required

The Brand ID associated with this OTP request

referenceIdstring required

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

mobilePhonestring required

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

requestDatestring date-time required

The timestamp when the OTP request was initiated

verifyDatestring date-time

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

deliveryStatusstring required

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

deliveryStatusDatestring date-time

The timestamp when the delivery status was last updated

deliveryStatusDetailsstring

Additional details about the delivery status

Example response

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

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