TCR Enums

Brands

verticals

List of available verticals in TCR

get

A vertical refers to a specific industry, market, or niche in which a company operates or targets its products and services. This endpoint returns the available ones here at Bird.

Authorizations

accessKey

HTTPRequired

Uses the Authorization header: 'AccessKey ' followed by your access key token (e.g., 'Authorization: AccessKey AbCdEfGhIjKlMnOpQrStUvWxYzAbCdEfGhIj')

Responses

200

OK

application/json

get

/numbers-tcr/verticals

HTTPcURLJavaScriptPython

GET /numbers-tcr/verticals HTTP/1.1
Host: api.bird.com
Authorization: AccessKey YOUR_SECRET_TOKEN
Accept: */*

200

OK

{
  "results": [
    {
      "name": "text",
      "industryId": "text",
      "displayName": "text",
      "description": "text"
    }
  ]
}

entityType

Value	Description
PRIVATE_PROFIT	Public company
PUBLIC_PROFIT	Private company
NON_PROFIT	A non profit
GOVERNMENT	A government entity

altBusinessIdType

Value	Description
DUNS	Set if altBusinessId is DUNS number
LEI	Set if altBusinessId is LEI code
GIIN	Set if altBusinessId is GIIN number

stockExchange

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

stockSymbol

stockSymbol must belong to a stockExchange

brandStatus

Value	Description
FAILED	Failed to submit Brand to the campaign registry
PENDING	Brand is pending approval
REJECTED	Brand has been rejected by the campaign registry
APPROVED	Brand has been approved by the campaign registry
DELETED	Brand has been deleted

Brand Vetting

vettingClass

Value	Description
STANDARD	Standard vetting

vettingProviderId

Value	Description
AEGIS	Vetting provider AEGIS

vettingStatus

Value	Description
PENDING	The vetting request is pending
REJECTED	This vetting request has been rejected
FAILED	The vetting request has failed
APPROVED	The vetting request has been approved
EXPIRED	The vetting has expired and a new vetting must be requested

Campaigns

useCases

List of available use cases in TCR

get

Retrieve list of available use cases in TCR

Authorizations

accessKey

HTTPRequired

Uses the Authorization header: 'AccessKey ' followed by your access key token (e.g., 'Authorization: AccessKey AbCdEfGhIjKlMnOpQrStUvWxYzAbCdEfGhIj')

Responses

200

OK

application/json

get

/numbers-tcr/usecases

HTTPcURLJavaScriptPython

GET /numbers-tcr/usecases HTTP/1.1
Host: api.bird.com
Authorization: AccessKey YOUR_SECRET_TOKEN
Accept: */*

200

OK

{
  "results": [
    {
      "name": "text",
      "accountingName": "text",
      "classification": "text",
      "displayName": "text",
      "description": "text",
      "maxSubUsecases": 1,
      "minSubUsecases": 1,
      "validSubUsecase": true
    }
  ]
}

campaignStatus

Value	Description
FAILED	Campaign was submitted to MBCR but rejected by TCR
PENDING	Campaign is pending with TCR
REJECTED	Campaign is rejected by AT&T and no way to re submit
APPROVED	Campaign is approved
DECLINED	Campaign is rejected and can be edited and re submitted again.
SUSPENDED	Campaign is suspended
DELETED	Campaign has been deleted
EXPIRED	Campaign has expired