Brands

Brand operations

Create Brand

This endpoint is used to create a new brand. A brand is an entity created by The Campaign Registry (TCR) that represents an organization or a company. It is this entity that TCR created campaigns will be associated with. Each brand creation will entail an upfront, non-refundable $4 expense.

SecuritybearerAuth
Request
Request Body schema: application/json
required
entityType
required
any (EntityType)

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

Enum: "PRIVATE_PROFIT" "PUBLIC_PROFIT" "NON_PROFIT" "SOLE_PROPRIETOR" "GOVERNMENT"
cspId
string (Cspid)

Unique identifier assigned to the csp by the registry.

brandId
string (Brandid)

Unique identifier assigned to the brand.

displayName
required
string (Displayname) <= 100 characters

Display or marketing name of the brand.

companyName
string (Companyname) <= 100 characters

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

ein
string (Ein) <= 20 characters

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

phone
string (Phone) <= 20 characters

Valid phone number in e.164 international format.

street
string (Street) <= 100 characters

Street number and name.

city
string (City) <= 100 characters

City name

state
string (State) <= 20 characters

State. Must be 2 letters code for United States.

postalCode
string (Postalcode) <= 10 characters

Postal codes. Use 5 digit zipcode for United States

country
required
string (Country) <= 2 characters

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

email
required
string (Email) <= 100 characters

Valid email address of brand support contact.

stockSymbol
string (Stocksymbol) <= 10 characters

(Required for public company) stock symbol.

stockExchange
any (StockExchange)

(Required for public company) stock exchange.

Enum: "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"
ipAddress
string (Ipaddress) <= 50 characters

IP address of the browser requesting to create brand identity.

website
string (Website) <= 100 characters

Brand website URL.

vertical
required
any (Vertical)

Vertical or industry segment of the brand or campaign.

Enum: "REAL_ESTATE" "HEALTHCARE" "ENERGY" "ENTERTAINMENT" "RETAIL" "AGRICULTURE" "INSURANCE" "EDUCATION" "HOSPITALITY" "FINANCIAL" "GAMBLING" "CONSTRUCTION" "NGO" "MANUFACTURING" "GOVERNMENT" "TECHNOLOGY" "COMMUNICATION"
altBusinessId
string (Altbusinessid) <= 50 characters

Alternate business identifier such as DUNS, LEI, or GIIN

altBusinessIdType
any (AltBusinessIdType)

An enumeration.

Enum: "NONE" "DUNS" "GIIN" "LEI"
universalEin
string (Universalein)

Universal EIN of Brand, Read Only.

Responses
200

Successful Response

Response Schema: application/json
entityType
required
any (EntityType)

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

Enum: "PRIVATE_PROFIT" "PUBLIC_PROFIT" "NON_PROFIT" "SOLE_PROPRIETOR" "GOVERNMENT"
cspId
string (Cspid)

Unique identifier assigned to the csp by the registry.

brandId
string (Brandid)

Unique identifier assigned to the brand.

displayName
required
string (Displayname) <= 100 characters

Display or marketing name of the brand.

companyName
string (Companyname) <= 100 characters

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

ein
string (Ein) <= 20 characters

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

phone
string (Phone) <= 20 characters

Valid phone number in e.164 international format.

street
string (Street) <= 100 characters

Street number and name.

city
string (City) <= 100 characters

City name

state
string (State) <= 20 characters

State. Must be 2 letters code for United States.

postalCode
string (Postalcode) <= 10 characters

Postal codes. Use 5 digit zipcode for United States

country
required
string (Country) <= 2 characters

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

email
required
string (Email) <= 100 characters

Valid email address of brand support contact.

stockSymbol
string (Stocksymbol) <= 10 characters

(Required for public company) stock symbol.

stockExchange
any (StockExchange)

(Required for public company) stock exchange.

Enum: "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"
ipAddress
string (Ipaddress) <= 50 characters

IP address of the browser requesting to create brand identity.

website
string (Website) <= 100 characters

Brand website URL.

brandRelationship
any (BrandRelationship)

Brand relationship to the CSP.

Enum: "BASIC_ACCOUNT" "SMALL_ACCOUNT" "MEDIUM_ACCOUNT" "LARGE_ACCOUNT" "KEY_ACCOUNT"
vertical
required
any (Vertical)

Vertical or industry segment of the brand or campaign.

Enum: "REAL_ESTATE" "HEALTHCARE" "ENERGY" "ENTERTAINMENT" "RETAIL" "AGRICULTURE" "INSURANCE" "EDUCATION" "HOSPITALITY" "FINANCIAL" "GAMBLING" "CONSTRUCTION" "NGO" "MANUFACTURING" "GOVERNMENT" "TECHNOLOGY" "COMMUNICATION"
altBusinessId
string (Altbusinessid) <= 50 characters

Alternate business identifier such as DUNS, LEI, or GIIN

altBusinessIdType
any (AltBusinessIdType)

An enumeration.

Enum: "NONE" "DUNS" "GIIN" "LEI"
universalEin
string (Universalein)

Universal EIN of Brand, Read Only.

identityStatus
string (identityStatus)

TCR assessment of the brand identification status.

post/brand
Request samples
application/json
{
  • "entityType": "PRIVATE_PROFIT",
  • "cspId": "string",
  • "brandId": "4b206179-f731-8ab7-f19c-34e19d22ide9",
  • "displayName": "Example Company",
  • "companyName": "Example Company Inc.",
  • "ein": "142536893",
  • "phone": "+13259390512",
  • "street": "123 Example St.",
  • "city": "Chicago",
  • "state": "IL",
  • "postalCode": "60654",
  • "country": "US",
  • "email": "[email protected]",
  • "stockSymbol": "ABC",
  • "stockExchange": "NASDAQ",
  • "ipAddress": "string",
  • "website": "www.examplecompany.com",
  • "vertical": "TECHNOLOGY",
  • "altBusinessId": "string",
  • "altBusinessIdType": "NONE",
  • "universalEin": "string"
}
Response samples
application/json
{
  • "entityType": "PRIVATE_PROFIT",
  • "cspId": "string",
  • "brandId": "4b206179-f731-8ab7-f19c-34e19d22ide9",
  • "displayName": "Example Company",
  • "companyName": "Example Company Inc.",
  • "ein": "142536893",
  • "phone": "+13259390512",
  • "street": "123 Example St.",
  • "city": "Chicago",
  • "state": "IL",
  • "postalCode": "60654",
  • "country": "US",
  • "email": "[email protected]",
  • "stockSymbol": "ABC",
  • "stockExchange": "NASDAQ",
  • "ipAddress": "string",
  • "website": "www.examplecompany.com",
  • "brandRelationship": "BASIC_ACCOUNT",
  • "vertical": "TECHNOLOGY",
  • "altBusinessId": "string",
  • "altBusinessIdType": "NONE",
  • "universalEin": "string",
  • "identityStatus": "VERIFIED"
}

List Brands

This endpoint is used to list all brands associated with your organization.

SecuritybearerAuth
Request
query Parameters
displayName
string (Displayname)
entityType
string (Entitytype)
state
string (State)
country
string (Country)
page
integer (Page)
Default: 1
recordsPerPage
integer (Recordsperpage)
Default: 10
Responses
200

Successful Response

Response Schema: application/json
Array of objects (Records)
page
integer (Page)
totalRecords
integer (Totalrecords)
get/brand
Request samples 
# install http://docs.python-requests.org/en/master/
import requests

url = 'https://api.telnyx.com/10dlc/brand'
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json', 
  'Authorization': 'Bearer API_TOKEN'
}
response = requests.request('get', url, headers=headers)
print(response.text)
Response samples
application/json
{
  • "records": [
    • {
      • "brandId": "4b206179-f731-8ab7-f19c-34e19d22ide9",
      • "entityType": "PRIVATE_PROFIT",
      • "companyName": "Example Company Inc.",
      • "displayName": "Example Company",
      • "email": "[email protected]",
      • "website": "www.examplecompany.com",
      • "createAt": "2021-03-08T17:57:48.801186",
      • "updatedAt": "2021-03-08T17:57:48.801186"
      }
    ],
  • "page": 1,
  • "totalRecords": 1
}

Get Brand

Retrieve a brand by brandId.

SecuritybearerAuth
Request
path Parameters
brandId
required
string (Brand Id)
Responses
200

Successful Response

Response Schema: application/json
entityType
required
any (EntityType)

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

Enum: "PRIVATE_PROFIT" "PUBLIC_PROFIT" "NON_PROFIT" "SOLE_PROPRIETOR" "GOVERNMENT"
cspId
string (Cspid)

Unique identifier assigned to the csp by the registry.

brandId
string (Brandid)

Unique identifier assigned to the brand.

displayName
required
string (Displayname) <= 100 characters

Display or marketing name of the brand.

companyName
string (Companyname) <= 100 characters

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

ein
string (Ein) <= 20 characters

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

phone
string (Phone) <= 20 characters

Valid phone number in e.164 international format.

street
string (Street) <= 100 characters

Street number and name.

city
string (City) <= 100 characters

City name

state
string (State) <= 20 characters

State. Must be 2 letters code for United States.

postalCode
string (Postalcode) <= 10 characters

Postal codes. Use 5 digit zipcode for United States

country
required
string (Country) <= 2 characters

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

email
required
string (Email) <= 100 characters

Valid email address of brand support contact.

stockSymbol
string (Stocksymbol) <= 10 characters

(Required for public company) stock symbol.

stockExchange
any (StockExchange)

(Required for public company) stock exchange.

Enum: "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"
ipAddress
string (Ipaddress) <= 50 characters

IP address of the browser requesting to create brand identity.

website
string (Website) <= 100 characters

Brand website URL.

brandRelationship
any (BrandRelationship)

Brand relationship to the CSP.

Enum: "BASIC_ACCOUNT" "SMALL_ACCOUNT" "MEDIUM_ACCOUNT" "LARGE_ACCOUNT" "KEY_ACCOUNT"
vertical
required
any (Vertical)

Vertical or industry segment of the brand or campaign.

Enum: "REAL_ESTATE" "HEALTHCARE" "ENERGY" "ENTERTAINMENT" "RETAIL" "AGRICULTURE" "INSURANCE" "EDUCATION" "HOSPITALITY" "FINANCIAL" "GAMBLING" "CONSTRUCTION" "NGO" "MANUFACTURING" "GOVERNMENT" "TECHNOLOGY" "COMMUNICATION"
altBusinessId
string (Altbusinessid) <= 50 characters

Alternate business identifier such as DUNS, LEI, or GIIN

altBusinessIdType
any (AltBusinessIdType)

An enumeration.

Enum: "NONE" "DUNS" "GIIN" "LEI"
universalEin
string (Universalein)

Universal EIN of Brand, Read Only.

identityStatus
string (identityStatus)

TCR assessment of the brand identification status.

get/brand/{brandId}
Request samples 
# install http://docs.python-requests.org/en/master/
import requests

url = 'https://api.telnyx.com/10dlc/brand/{brandId}'
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json', 
  'Authorization': 'Bearer API_TOKEN'
}
response = requests.request('get', url, headers=headers)
print(response.text)
Response samples
application/json
{
  • "entityType": "PRIVATE_PROFIT",
  • "cspId": "string",
  • "brandId": "4b206179-f731-8ab7-f19c-34e19d22ide9",
  • "displayName": "Example Company",
  • "companyName": "Example Company Inc.",
  • "ein": "142536893",
  • "phone": "+13259390512",
  • "street": "123 Example St.",
  • "city": "Chicago",
  • "state": "IL",
  • "postalCode": "60654",
  • "country": "US",
  • "email": "[email protected]",
  • "stockSymbol": "ABC",
  • "stockExchange": "NASDAQ",
  • "ipAddress": "string",
  • "website": "www.examplecompany.com",
  • "brandRelationship": "BASIC_ACCOUNT",
  • "vertical": "TECHNOLOGY",
  • "altBusinessId": "string",
  • "altBusinessIdType": "NONE",
  • "universalEin": "string",
  • "identityStatus": "VERIFIED"
}

Update Brand

Update a brand's attributes by brandId.

SecuritybearerAuth
Request
path Parameters
brandId
required
string (Brand Id)
Request Body schema: application/json
required
entityType
required
any (EntityType)

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

Enum: "PRIVATE_PROFIT" "PUBLIC_PROFIT" "NON_PROFIT" "SOLE_PROPRIETOR" "GOVERNMENT"
displayName
required
string (Displayname) <= 100 characters

Display or marketing name of the brand.

companyName
string (Companyname) <= 100 characters

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

ein
string (Ein) <= 20 characters

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

phone
string (Phone) <= 20 characters

Valid phone number in e.164 international format.

street
string (Street) <= 100 characters

Street number and name.

city
string (City) <= 100 characters

City name

state
string (State) <= 20 characters

State. Must be 2 letters code for United States.

postalCode
string (Postalcode) <= 10 characters

Postal codes. Use 5 digit zipcode for United States

country
required
string (Country) <= 2 characters

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

email
required
string (Email) <= 100 characters

Valid email address of brand support contact.

stockSymbol
string (Stocksymbol) <= 10 characters

(Required for public company) stock symbol.

stockExchange
any (StockExchange)

(Required for public company) stock exchange.

Enum: "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"
ipAddress
string (Ipaddress) <= 50 characters

IP address of the browser requesting to create brand identity.

website
string (Website) <= 100 characters

Brand website URL.

vertical
required
any (Vertical)

Vertical or industry segment of the brand or campaign.

Enum: "REAL_ESTATE" "HEALTHCARE" "ENERGY" "ENTERTAINMENT" "RETAIL" "AGRICULTURE" "INSURANCE" "EDUCATION" "HOSPITALITY" "FINANCIAL" "GAMBLING" "CONSTRUCTION" "NGO" "MANUFACTURING" "GOVERNMENT" "TECHNOLOGY" "COMMUNICATION"
altBusinessId
string (Altbusinessid) <= 50 characters

Alternate business identifier such as DUNS, LEI, or GIIN

altBusinessIdType
any (AltBusinessIdType)

An enumeration.

Enum: "NONE" "DUNS" "GIIN" "LEI"
Responses
200

Successful Response

Response Schema: application/json
entityType
required
any (EntityType)

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

Enum: "PRIVATE_PROFIT" "PUBLIC_PROFIT" "NON_PROFIT" "SOLE_PROPRIETOR" "GOVERNMENT"
displayName
required
string (Displayname) <= 100 characters

Display or marketing name of the brand.

companyName
string (Companyname) <= 100 characters

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

ein
string (Ein) <= 20 characters

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

phone
string (Phone) <= 20 characters

Valid phone number in e.164 international format.

street
string (Street) <= 100 characters

Street number and name.

city
string (City) <= 100 characters

City name

state
string (State) <= 20 characters

State. Must be 2 letters code for United States.

postalCode
string (Postalcode) <= 10 characters

Postal codes. Use 5 digit zipcode for United States

country
required
string (Country) <= 2 characters

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

email
required
string (Email) <= 100 characters

Valid email address of brand support contact.

stockSymbol
string (Stocksymbol) <= 10 characters

(Required for public company) stock symbol.

stockExchange
any (StockExchange)

(Required for public company) stock exchange.

Enum: "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"
ipAddress
string (Ipaddress) <= 50 characters

IP address of the browser requesting to create brand identity.

website
string (Website) <= 100 characters

Brand website URL.

brandRelationship
required
any (BrandRelationship)

Brand relationship to the CSP.

Enum: "BASIC_ACCOUNT" "SMALL_ACCOUNT" "MEDIUM_ACCOUNT" "LARGE_ACCOUNT" "KEY_ACCOUNT"
vertical
required
any (Vertical)

Vertical or industry segment of the brand or campaign.

Enum: "REAL_ESTATE" "HEALTHCARE" "ENERGY" "ENTERTAINMENT" "RETAIL" "AGRICULTURE" "INSURANCE" "EDUCATION" "HOSPITALITY" "FINANCIAL" "GAMBLING" "CONSTRUCTION" "NGO" "MANUFACTURING" "GOVERNMENT" "TECHNOLOGY" "COMMUNICATION"
altBusinessId
string (Altbusinessid) <= 50 characters

Alternate business identifier such as DUNS, LEI, or GIIN

altBusinessIdType
any (AltBusinessIdType)

An enumeration.

Enum: "NONE" "DUNS" "GIIN" "LEI"
identityStatus
string (identityStatus)

TCR assessment of the brand identification status.

put/brand/{brandId}
Request samples
application/json
{
  • "entityType": "PRIVATE_PROFIT",
  • "displayName": "Example Company Updated",
  • "companyName": "Example Company Inc.",
  • "ein": "142536893",
  • "phone": "+13259390512",
  • "street": "123 Example St.",
  • "city": "San Francisco",
  • "state": "CA",
  • "postalCode": "94016",
  • "country": "US",
  • "email": "[email protected]",
  • "stockSymbol": "EXCOUP",
  • "stockExchange": "NASDAQ",
  • "ipAddress": "string",
  • "website": "www.examplecompanyupdated.com",
  • "vertical": "TECHNOLOGY",
  • "altBusinessId": "string",
  • "altBusinessIdType": "NONE"
}
Response samples
application/json
{
  • "entityType": "PRIVATE_PROFIT",
  • "displayName": "Example Company Updated",
  • "companyName": "Example Company Inc.",
  • "ein": "142536893",
  • "phone": "+13259390512",
  • "street": "123 Example St.",
  • "city": "San Francisco",
  • "state": "CA",
  • "postalCode": "94016",
  • "country": "US",
  • "email": "[email protected]",
  • "stockSymbol": "EXCOUP",
  • "stockExchange": "NASDAQ",
  • "ipAddress": "string",
  • "website": "www.examplecompanyupdated.com",
  • "brandRelationship": "BASIC_ACCOUNT",
  • "vertical": "TECHNOLOGY",
  • "altBusinessId": "string",
  • "altBusinessIdType": "NONE",
  • "identityStatus": "VERIFIED"
}

Delete Brand

This endpoint is used to delete a brand.

SecuritybearerAuth
Request
path Parameters
brandId
required
string (Brandid)
Responses
200

Successful Response

Response Schema: application/json
any
422

Validation Error

Response Schema: application/json
Array of objects (Detail)
Array
required
Array of strings or integers (Location)
msg
required
string (Message)
type
required
string (Error Type)
delete/brand/{brandId}
Request samples 
Response samples 
application/json
null
Revet the brand
This operation allows you to revet the brand. However, revetting is allowed once after the successful brand registration and thereafter limited to once every 3 months.


SecuritybearerAuth 
Request 
path Parameters
brandId
required
string
Brand alphanumeric identifier (prefixed with letter 'B')


 
Responses 
200
Successful.


Response Schema: application/json
entityType
required
any (EntityType) 
Entity type behind the brand. This is the form of business establishment.


 Enum: "PRIVATE_PROFIT" "PUBLIC_PROFIT" "NON_PROFIT" "SOLE_PROPRIETOR" "GOVERNMENT"  
cspId
string (Cspid) 
Unique identifier assigned to the csp by the registry.


 
brandId
string (Brandid) 
Unique identifier assigned to the brand.


 
displayName
required
string (Displayname)   <= 100 characters 
Display or marketing name of the brand.


 
companyName
string (Companyname)   <= 100 characters 
(Required for Non-profit/private/public) Legal company name.


 
ein
string (Ein)   <= 20 characters 
(Required for Non-profit/private/public) Government assigned corporate tax ID. EIN is 9-digits in U.S.


 
phone
string (Phone)   <= 20 characters 
Valid phone number in e.164 international format.


 
street
string (Street)   <= 100 characters 
Street number and name.


 
city
string (City)   <= 100 characters 
City name


 
state
string (State)   <= 20 characters 
State. Must be 2 letters code for United States.


 
postalCode
string (Postalcode)   <= 10 characters 
Postal codes. Use 5 digit zipcode for United States


 
country
required
string (Country)   <= 2 characters 
ISO2 2 characters country code. Example: US - United States


 
email
required
string (Email)   <= 100 characters 
Valid email address of brand support contact.


 
stockSymbol
string (Stocksymbol)   <= 10 characters 
(Required for public company) stock symbol.


 
stockExchange
any (StockExchange) 
(Required for public company) stock exchange.


 Enum: "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"  
ipAddress
string (Ipaddress)   <= 50 characters 
IP address of the browser requesting to create brand identity.


 
website
string (Website)   <= 100 characters 
Brand website URL.


 
brandRelationship
any (BrandRelationship) 
Brand relationship to the CSP.


 Enum: "BASIC_ACCOUNT" "SMALL_ACCOUNT" "MEDIUM_ACCOUNT" "LARGE_ACCOUNT" "KEY_ACCOUNT"  
vertical
required
any (Vertical) 
Vertical or industry segment of the brand or campaign.


 Enum: "REAL_ESTATE" "HEALTHCARE" "ENERGY" "ENTERTAINMENT" "RETAIL" "AGRICULTURE" "INSURANCE" "EDUCATION" "HOSPITALITY" "FINANCIAL" "GAMBLING" "CONSTRUCTION" "NGO" "MANUFACTURING" "GOVERNMENT" "TECHNOLOGY" "COMMUNICATION"  
altBusinessId
string (Altbusinessid)   <= 50 characters 
Alternate business identifier such as DUNS, LEI, or GIIN


 
altBusinessIdType
any (AltBusinessIdType) 
An enumeration.


 Enum: "NONE" "DUNS" "GIIN" "LEI"  
universalEin
string (Universalein) 
Universal EIN of Brand, Read Only.


 
identityStatus
string (identityStatus) 
TCR assessment of the brand identification status.


 
400
Request Failed.


put/brand/{brandId}/revet
Request samples 
# install http://docs.python-requests.org/en/master/
import requests

url = 'https://api.telnyx.com/10dlc/brand/{brandId}/revet'
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json', 
  'Authorization': 'Bearer API_TOKEN'
}
response = requests.request('put', url, headers=headers)
print(response.text)
Response samples 
application/json
{
  • "entityType": "PRIVATE_PROFIT",
  • "cspId": "string",
  • "brandId": "4b206179-f731-8ab7-f19c-34e19d22ide9",
  • "displayName": "Example Company",
  • "companyName": "Example Company Inc.",
  • "ein": "142536893",
  • "phone": "+13259390512",
  • "street": "123 Example St.",
  • "city": "Chicago",
  • "state": "IL",
  • "postalCode": "60654",
  • "country": "US",
  • "email": "[email protected]",
  • "stockSymbol": "ABC",
  • "stockExchange": "NASDAQ",
  • "ipAddress": "string",
  • "website": "www.examplecompany.com",
  • "brandRelationship": "BASIC_ACCOUNT",
  • "vertical": "TECHNOLOGY",
  • "altBusinessId": "string",
  • "altBusinessIdType": "NONE",
  • "universalEin": "string",
  • "identityStatus": "VERIFIED"
}
List External Vettings
Retrieve a list of valid external vetting records for a supplied brand.


SecuritybearerAuth 
Request 
path Parameters
brandId
required
string (Brand Id) 
 
Responses 
200
Successful Response


Response Schema: application/json
 Array 
evpId
string (Evpid)   <= 10 characters 
External vetting provider ID for the brand.


 
vettingId
string (vettingId) 
Unique ID that identifies a vetting transaction performed by a vetting provider. This ID is provided by the vetting provider at time of vetting.


 
vettingToken
string (vettingToken) 
Required by some providers for vetting record confirmation.


 
vettingScore
integer (vettingScore) 
Vetting score ranging from 0-100.


 
vettingClass
string (Vettingclass) 
Identifies the vetting classification.


 
vettedDate
string (vettedDate) 
Vetting effective date. This is the date when vetting was completed, or the starting effective date in ISO 8601 format. If this date is missing, then the vetting was not complete or not valid.


 
createDate
string (createDate) 
Vetting submission date. This is the date when the vetting request is generated in ISO 8601 format.


 
get/brand/{brandId}/externalVetting
Request samples 
# install http://docs.python-requests.org/en/master/
import requests

url = 'https://api.telnyx.com/10dlc/brand/{brandId}/externalVetting'
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json', 
  'Authorization': 'Bearer API_TOKEN'
}
response = requests.request('get', url, headers=headers)
print(response.text)
Response samples 
application/json
[
  • {
    • "evpId": "string",
    • "vettingId": "string",
    • "vettingToken": "string",
    • "vettingScore": 0,
    • "vettingClass": "string",
    • "vettedDate": "string",
    • "createDate": "string"
    }
]
Order Brand External Vetting
This endpoint allows you to order external vetting for a brand. Brand vetting is optional, but it is highly recommended. In essence, brand vetting is a way of letting The Campaign Registry (TCR) know that a given brand is legitimate. Carrier rate limits and daily message limits are determined by a "brand score", which is a score that TCR assigns to given brand in an attempt to measure brand credibility. Brand vetting will entail an upfront, non-refundable $40 expense.


SecuritybearerAuth 
Request 
path Parameters
brandId
required
string (Brand Id) 
 
Request Body schema: application/json
required
evpId
required
string (Evpid)   <= 10 characters 
External vetting provider ID for the brand.


 
vettingClass
required
string (Vettingclass) 
Identifies the vetting classification.


 
Responses 
200
Successful Response


Response Schema: application/json
evpId
string (Evpid)   <= 10 characters 
External vetting provider ID for the brand.


 
vettingId
string (vettingId) 
Unique ID that identifies a vetting transaction performed by a vetting provider. This ID is provided by the vetting provider at time of vetting.


 
vettingToken
string (vettingToken) 
Required by some providers for vetting record confirmation.


 
vettingScore
integer (vettingScore) 
Vetting score ranging from 0-100.


 
vettingClass
string (Vettingclass) 
Identifies the vetting classification.


 
vettedDate
string (vettedDate) 
Vetting effective date. This is the date when vetting was completed, or the starting effective date in ISO 8601 format. If this date is missing, then the vetting was not complete or not valid.


 
createDate
string (createDate) 
Vetting submission date. This is the date when the vetting request is generated in ISO 8601 format.


 
post/brand/{brandId}/externalVetting
Request samples 
application/json
{
  • "evpId": "string",
  • "vettingClass": "string"
}
Response samples 
application/json
{
  • "evpId": "string",
  • "vettingId": "string",
  • "vettingToken": "string",
  • "vettingScore": 0,
  • "vettingClass": "string",
  • "vettedDate": "string",
  • "createDate": "string"
}
Get Brand Feedback By Id
Get feedback about a brand by ID. This endpoint can be used after creating or revetting
a brand.


Possible values for .category[].id:


    

  • TAX_ID - Data mismatch related to tax id and its associated properties.
    • 

  • STOCK_SYMBOL - Non public entity registered as a public for profit entity or
the stock information mismatch.
    • 

  • GOVERNMENT_ENTITY - Non government entity registered as a government entity.
Must be a U.S. government entity.
    • 

  • NONPROFIT - Not a recognized non-profit entity. No IRS tax-exempt status
found.
    • 

  • OTHERS - Details of the data misrepresentation if any.
    • 



SecuritybearerAuth 
Request 
path Parameters
brandId
required
string (Brandid) 
 
Responses 
200
Successful Response


Response Schema: application/json
brandId
required
string (Brandid) 
ID of the brand being queried about


 
required
Array of objects (Category) 
A list of reasons why brand creation/revetting didn't go as planned


 
get/brand/feedback/{brandId}
Request samples 
Response samples 
application/json
{
  • "brandId": "d88dd2aa-1bb9-4ef0-9ec8-1752b80316a5",
  • "category": [
    • {
      • "id": "TAX_ID",
      • "displayName": "Tax Id",
      • "description": "Tax Id does not match with the company name or business type.",
      • "fields": [
        • "ein",
        • "companyName",
        • "entityType"
        ]
      }
    ]
}