Sign in

v47

latestOpenAPI 3.1.0raw.githubusercontent.com2026-06-181,0851,7264.5 MB
Brands

Get Brand

Retrieve a brand by brandId.

get/10dlc/brand/{brandId}

Path parameters

brandIdstring required

Unique identifier of the brand.

Response

Successful Response

entityType'PRIVATE_PROFIT' | 'PUBLIC_PROFIT' | 'NON_PROFIT' | 'GOVERNMENT' | 'SOLE_PROPRIETOR' required

Entity type behind the brand. This is the form of business establishment.

cspIdstring

Unique identifier assigned to the csp by the registry.

brandIdstring

Unique identifier assigned to the brand.

tcrBrandIdstring

Unique identifier assigned to the brand by the registry.

displayNamestring required

Display or marketing name of the brand.

companyNamestring

(Required for Non-profit/private/public) Legal company name.

firstNamestring

First name of business contact.

lastNamestring

Last name of business contact.

einstring

(Required for Non-profit) Government assigned corporate tax ID. EIN is 9-digits in U.S.

phonestring

Valid phone number in e.164 international format.

streetstring

Street number and name.

citystring

City name

statestring

State. Must be 2 letters code for United States.

postalCodestring

Postal codes. Use 5 digit zipcode for United States

countrystring required

ISO2 2 characters country code. Example: US - United States

emailstring required

Valid email address of brand support contact.

stockSymbolstring

(Required for public company) stock symbol.

stockExchange'NONE' | 'NASDAQ' | 'NYSE' | 'AMEX' | 'AMX' | 'ASX' | 'B3' | 'BME' | 'BSE' | 'FRA' | 'ICEX' | 'JPX' | 'JSE' | 'KRX' | 'LON' | 'NSE' | 'OMX' | 'SEHK' | 'SSE' | 'STO' | 'SWX' | 'SZSE' | 'TSX' | 'TWSE' | 'VSE'

(Required for public company) stock exchange.

ipAddressstring

IP address of the browser requesting to create brand identity.

websitestring

Brand website URL.

brandRelationship'BASIC_ACCOUNT' | 'SMALL_ACCOUNT' | 'MEDIUM_ACCOUNT' | 'LARGE_ACCOUNT' | 'KEY_ACCOUNT' required

Brand relationship to the CSP.

verticalstring required

Vertical or industry segment of the brand.

altBusinessIdstring

Alternate business identifier such as DUNS, LEI, or GIIN

altBusinessIdType'NONE' | 'DUNS' | 'GIIN' | 'LEI'

An enumeration.

universalEinstring

Universal EIN of Brand, Read Only.

referenceIdstring

Unique identifier Telnyx assigned to the brand - the brandId

identityStatus'VERIFIED' | 'UNVERIFIED' | 'SELF_DECLARED' | 'VETTED_VERIFIED'

The verification status of an active brand

mockboolean

Mock brand for testing purposes

mobilePhonestring

Valid mobile phone number in e.164 international format.

isResellerboolean

Indicates whether this brand is known to be a reseller

webhookURLstring

Webhook to which brand status updates are sent.

businessContactEmailstring

Business contact email.

Required if entityType is PUBLIC_PROFIT.

webhookFailoverURLstring

Failover webhook to which brand status updates are sent.

createdAtstring

Date and time that the brand was created at.

updatedAtstring

Date and time that the brand was last updated at.

status'OK' | 'REGISTRATION_PENDING' | 'REGISTRATION_FAILED'

Status of the brand

failureReasonsstring

Failure reasons for brand

assignedCampaignsCountnumber

Number of campaigns associated with the brand

Example response

{
  "entityType": "PRIVATE_PROFIT",
  "brandId": "4b20017f-8da9-a992-a6c0-683072fb7729",
  "tcrBrandId": "BBRAND1",
  "displayName": "ABC Mobile",
  "companyName": "ABC Inc.",
  "firstName": "John",
  "lastName": "Smith",
  "ein": "111111111",
  "phone": "+12024567890",
  "street": "123",
  "city": "New York",
  "state": "NY",
  "postalCode": "10001",
  "country": "US",
  "stockSymbol": "ABC",
  "stockExchange": "NASDAQ",
  "website": "http://www.abcmobile.com",
  "mobilePhone": "+12024567890",
  "webhookURL": "https://webhook.com/67ea78a8-9f32-4d04-b62d-f9502e8e5f93",
  "businessContactEmail": "name@example.com",
  "createdAt": "2021-03-08T17:57:48.801186",
  "updatedAt": "2021-03-08T17:57:48.801186",
  "assignedCampaignsCount": 3
}