> ## Documentation Index > Fetch the complete documentation index at: https://developers.telnyx.com/llms.txt > Use this file to discover all available pages before exploring further. # 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. ## OpenAPI ````yaml https://telnyx-openapi-ng.s3.us-east-1.amazonaws.com/messaging-10dlc/brands.yml get /10dlc/brand/{brandId}/smsOtp openapi: 3.1.0 info: title: Telnyx 10DLC Brands API version: 2.0.0 description: API for 10DLC brand management. contact: email: support@telnyx.com servers: - url: https://api.telnyx.com/v2 security: - bearerAuth: [] paths: /10dlc/brand/{brandId}/smsOtp: get: tags: - Brands summary: Get Brand SMS OTP Status by Brand ID description: >- 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. operationId: GetBrandSmsOtpStatusByBrandId parameters: - required: true schema: title: Brandid type: string example: 4b20019b-043a-78f8-0657-b3be3f4b4002 name: brandId in: path description: The Brand ID for which to query OTP status responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/BrandSmsOtpStatus' '404': description: OTP status not found for this brand content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' 4XX: $ref: '#/components/responses/10dlc_GenericErrorResponse' x-codeSamples: - lang: JavaScript source: >- 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); - lang: Python source: |- import os from telnyx import Telnyx client = Telnyx( api_key=os.environ.get("TELNYX_API_KEY"), # This is the default and can be omitted ) response = client.messaging_10dlc.brand.retrieve_sms_otp_status( "4b20019b-043a-78f8-0657-b3be3f4b4002", ) print(response.brand_id) - lang: Go source: "package main\n\nimport (\n\t\"context\"\n\t\"fmt\"\n\n\t\"github.com/team-telnyx/telnyx-go\"\n\t\"github.com/team-telnyx/telnyx-go/option\"\n)\n\nfunc main() {\n\tclient := telnyx.NewClient(\n\t\toption.WithAPIKey(\"My API Key\"),\n\t)\n\tresponse, err := client.Messaging10dlc.Brand.GetSMSOtpStatus(context.TODO(), \"4b20019b-043a-78f8-0657-b3be3f4b4002\")\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf(\"%+v\\n\", response.BrandID)\n}\n" - lang: Java source: >- package com.telnyx.sdk.example; import com.telnyx.sdk.client.TelnyxClient; import com.telnyx.sdk.client.okhttp.TelnyxOkHttpClient; import com.telnyx.sdk.models.messaging10dlc.brand.BrandRetrieveSmsOtpStatusParams; import com.telnyx.sdk.models.messaging10dlc.brand.BrandRetrieveSmsOtpStatusResponse; public final class Main { private Main() {} public static void main(String[] args) { TelnyxClient client = TelnyxOkHttpClient.fromEnv(); BrandRetrieveSmsOtpStatusResponse response = client.messaging10dlc().brand().retrieveSmsOtpStatus("4b20019b-043a-78f8-0657-b3be3f4b4002"); } } - lang: Ruby source: >- require "telnyx" telnyx = Telnyx::Client.new(api_key: "My API Key") response = telnyx.messaging_10dlc.brand.retrieve_sms_otp_status("4b20019b-043a-78f8-0657-b3be3f4b4002") puts(response) - lang: CLI source: |- telnyx messaging-10dlc:brand retrieve-sms-otp-status \ --api-key 'My API Key' \ --brand-id 4b20019b-043a-78f8-0657-b3be3f4b4002 components: schemas: BrandSmsOtpStatus: title: BrandSmsOtpStatus required: - brandId - referenceId - mobilePhone - requestDate - deliveryStatus type: object properties: brandId: title: Brandid type: string description: The Brand ID associated with this OTP request example: B123ABC referenceId: title: Referenceid type: string description: The reference ID for this OTP request, used for status queries example: OTP4B2001 mobilePhone: title: Mobilephone type: string description: The mobile phone number where the OTP was sent, in E.164 format example: '+11234567890' requestDate: title: Requestdate type: string format: date-time description: The timestamp when the OTP request was initiated example: '2024-12-03T17:12:33.560000+00:00' verifyDate: title: Verifydate type: string format: date-time description: The timestamp when the OTP was successfully verified (if applicable) example: '2024-12-03T17:12:33.560000+00:00' deliveryStatus: title: Deliverystatus type: string description: >- The current delivery status of the OTP SMS message. Common values include: `DELIVERED_HANDSET`, `PENDING`, `FAILED`, `EXPIRED` example: DELIVERED_HANDSET deliveryStatusDate: title: Deliverystatusdate type: string format: date-time description: The timestamp when the delivery status was last updated example: '2024-12-03T17:12:33.560000+00:00' deliveryStatusDetails: title: Deliverystatusdetails type: string description: Additional details about the delivery status example: Delivered to handset description: >- Status information for an SMS OTP sent during Sole Proprietor brand verification HTTPValidationError: title: HTTPValidationError type: object properties: detail: title: Detail type: array items: $ref: '#/components/schemas/ValidationError' ValidationError: title: ValidationError required: - loc - msg - type type: object properties: loc: title: Location type: array items: anyOf: - type: string - type: integer msg: title: Message type: string type: title: Error Type type: string 10dlc_Errors: properties: errors: type: array items: $ref: '#/components/schemas/10dlc_Error' type: object 10dlc_Error: required: - code - title type: object properties: code: type: string title: type: string detail: type: string source: type: object properties: pointer: description: JSON pointer (RFC6901) to the offending entity. type: string parameter: description: Indicates which query parameter caused the error. type: string responses: 10dlc_GenericErrorResponse: description: Generic response error content: application/json: schema: $ref: '#/components/schemas/10dlc_Errors' securitySchemes: bearerAuth: scheme: bearer type: http ````