Brands

Get Brand SMS OTP Status

Changed on

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

This endpoint allows you to check the delivery and verification status of an OTP sent during the Sole Proprietor brand verification process. You can query by either:

  • referenceId - The reference ID returned when the OTP was initially triggered
  • brandId - Query parameter for portal users to look up OTP status by Brand ID

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

get/10dlc/brand/smsOtp/{referenceId}

Request

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

Path parameters

referenceIdstring required
Example:OTP4B2001

The reference ID returned when the OTP was initially triggered

Query parameters

brandIdstring
Example:B123ABC

Filter by Brand ID for easier lookup in portal applications

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

  • 67df31283a8aRevision 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

  • a72569d69430Revision 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