Get Brand

GET /brand/:brandId

Retrieve a brand by brandId.

Responses

200: Successful Response

application/json

Schema

entityType EntityTyperequired

Possible values: [PRIVATE_PROFIT, PUBLIC_PROFIT, NON_PROFIT, SOLE_PROPRIETOR, GOVERNMENT]

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

cspId Cspid (string)

Unique identifier assigned to the csp by the registry.

brandId Brandid (string)

Unique identifier assigned to the brand.

tcrBrandId TcrBrandid (string)

Unique identifier assigned to the brand by the registry.

displayName Displayname (string)required

Possible values: <= 100 characters

Display or marketing name of the brand.

companyName Companyname (string)

Possible values: <= 100 characters

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

firstName Firstname (string)

Possible values: <= 100 characters

First name of business contact.

lastName Lastname (string)

Possible values: <= 100 characters

Last name of business contact.

ein Ein (string)

Possible values: <= 20 characters

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

phone Phone (string)

Possible values: <= 20 characters

Valid phone number in e.164 international format.

street Street (string)

Possible values: <= 100 characters

Street number and name.

city City (string)

Possible values: <= 100 characters

City name

state State (string)

Possible values: <= 20 characters

State. Must be 2 letters code for United States.

postalCode Postalcode (string)

Possible values: <= 10 characters

Postal codes. Use 5 digit zipcode for United States

country Country (string)required

Possible values: <= 2 characters

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

email Email (string)required

Possible values: <= 100 characters

Valid email address of brand support contact.

stockSymbol Stocksymbol (string)

Possible values: <= 10 characters

(Required for public company) stock symbol.

stockExchange StockExchange

Possible values: [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.

ipAddress Ipaddress (string)

Possible values: <= 50 characters

IP address of the browser requesting to create brand identity.

website Website (string)

Possible values: <= 100 characters

Brand website URL.

brandRelationship BrandRelationshiprequired

Possible values: [BASIC_ACCOUNT, SMALL_ACCOUNT, MEDIUM_ACCOUNT, LARGE_ACCOUNT, KEY_ACCOUNT]

Brand relationship to the CSP

vertical Vertical (string)required

Possible values: <= 50 characters

Vertical or industry segment of the brand.

altBusinessId Altbusinessid (string)

Possible values: <= 50 characters

Alternate business identifier such as DUNS, LEI, or GIIN

altBusinessIdType AltBusinessIdType

Possible values: [NONE, DUNS, GIIN, LEI]

An enumeration.

universalEin Universalein (string)

Universal EIN of Brand, Read Only.

referenceId Referenceid (string)

Unique identifier Telnyx assigned to the brand - the brandId

identityStatus BrandIdentityStatus

Possible values: [VERIFIED, UNVERIFIED, SELF_DECLARED, VETTED_VERIFIED]

The verification status of an active brand

optionalAttributes

object

taxExemptStatus Taxexemptstatus (string)

The tax exempt status of the brand

mock Mock (boolean)

Mock brand for testing purposes

mobilePhone Mobilephone (string)

Possible values: <= 20 characters

Valid mobile phone number in e.164 international format.

isReseller Isreseller (boolean)

Indicates whether this brand is known to be a reseller

webhookURL WebhookURL (string)

Webhook to which brand status updates are sent.

businessContactEmail BusinessContactEmail (string)

Business contact email.

Required if entityType is PUBLIC_PROFIT.

webhookFailoverURL WebhookFailoverURL (string)

Failover webhook to which brand status updates are sent.

createdAt string

Date and time that the brand was created at.

updatedAt string

Date and time that the brand was last updated at.

status status

Possible values: [OK, REGISTRATION_PENDING, REGISTRATION_FAILED]

Status of the brand

failureReasons failureReasons

Failure reasons for brand

assignedCampaignsCount AssignedCampaignsCount (number)

Number of campaigns associated with the brand

{
  "entityType": "PRIVATE_PROFIT",
  "cspId": "string",
  "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",
  "email": "string",
  "stockSymbol": "ABC",
  "stockExchange": "NASDAQ",
  "ipAddress": "string",
  "website": "http://www.abcmobile.com",
  "vertical": "string",
  "altBusinessId": "string",
  "universalEin": "string",
  "referenceId": "string",
  "optionalAttributes": {
    "taxExemptStatus": "string"
  },
  "mock": false,
  "mobilePhone": "+12024567890",
  "isReseller": false,
  "webhookURL": "https://webhook.com/67ea78a8-9f32-4d04-b62d-f9502e8e5f93",
  "businessContactEmail": "name@example.com",
  "webhookFailoverURL": "string",
  "createdAt": "2021-03-08T17:57:48.801186",
  "updatedAt": "2021-03-08T17:57:48.801186",
  "assignedCampaignsCount": 3
}

422: Validation Error

application/json

Schema

detail

object[]

Array [

loc

object[]

required

Array [

anyOf

string

]

msg Message (string)required

type Error Type (string)required

]

{
  "detail": [
    {
      "loc": [
        "string",
        0
      ],
      "msg": "string",
      "type": "string"
    }
  ]
}

Request samples

curl -L 'https://api.telnyx.com/10dlc/brand/:brandId' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>'

Response samples

{
  "entityType": "PRIVATE_PROFIT",
  "cspId": "string",
  "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",
  "email": "string",
  "stockSymbol": "ABC",
  "stockExchange": "NASDAQ",
  "ipAddress": "string",
  "website": "http://www.abcmobile.com",
  "vertical": "string",
  "altBusinessId": "string",
  "universalEin": "string",
  "referenceId": "string",
  "optionalAttributes": {
    "taxExemptStatus": "string"
  },
  "mock": false,
  "mobilePhone": "+12024567890",
  "isReseller": false,
  "webhookURL": "https://webhook.com/67ea78a8-9f32-4d04-b62d-f9502e8e5f93",
  "businessContactEmail": "name@example.com",
  "webhookFailoverURL": "string",
  "createdAt": "2021-03-08T17:57:48.801186",
  "updatedAt": "2021-03-08T17:57:48.801186",
  "assignedCampaignsCount": 3
}

{
  "detail": [
    {
      "loc": [
        "string",
        0
      ],
      "msg": "string",
      "type": "string"
    }
  ]
}

Get Brand

Request ​

Path Parameters

Responses ​

Request

Responses