Create a brand

A successful request to this endpoint will mean you are charged a brand registration fee. If you later need to update or resubmit your brand there may be additional fees.

Create a brand at workspace level

Create a brand at workspace level. This means it will be available only for this workspace. A brand registration is mandatory due to compliance requirements.

post

/workspaces/{workspaceId}/tcr-brands

Authorizations

useraccessKey

Path parameters

workspaceIdstring · uuidrequired

The ID for the workspace.

Example: d386a801-ee8d-4aba-a7e4-78671bd3b11e

Body

entityTypestring · enumrequired

Legal entity type. It can't be updated when the brand is approved.

Example: PRIVATE_PROFIT

Options: PRIVATE_PROFIT, PUBLIC_PROFIT, NON_PROFIT, GOVERNMENT,

firstNamestring · max: 100

First or given name. Applicable to entity type.

Example: John

lastNamestring · max: 100

Last or Surname. Applicable to entity type.

Example: Doe

displayNamestring · min: 1 · max: 255required

Display or marketing name your brand.

Example: ABC Mobile

companyNamestring · min: 1 · max: 255required

Legal company name. This should match the legal company name used to register your EIN/Tax ID.

Example: ABC Inc.

einstring · min: 1 · max: 21required

Government assigned corporate tax ID. EIN is 9-digits in the U.S.

Example: 111111111

einIssuingCountrystring · min: 1 · max: 2required

The 2 letter ISO country of registration submitted with your EIN / Tax ID registration.

Example: US

phonestring · min: 1 · max: 20required

Valid phone number in e.164 international format.

Example: [phone]

streetstring · min: 1 · max: 100required

Street number and name.

Example: 123 6th Ave

citystring · min: 1 · max: 100required

City name

Example: New York

statestring · min: 1 · max: 20required

State. Must be a 2 letter state code for US states.

Example: NY

postalCodestring · min: 1 · max: 10required

Postal code. Must be a 5 digit zip code for the United States.

Example: 10001

countrystring · min: 1 · max: 2required

ISO 2 character country code.

Example: US

emailstring · min: 1 · max: 100required

Valid email address of brand support contact.

Example: [e-mail]

stockSymbolstring · max: 10

Stock symbol. Required for entityType PUBLIC.

Example: ABC

stockExchangestring · enum

Stock exchange. Required for entityType PUBLIC.

Example: NASDAQ

Options: NONE, 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, OTHER,

websitestring · min: 1 · max: 100required

Brand website URL.

Example: https://example.com

verticalstring · max: 50

Vertical or industry segment of the brand.

Example: RETAIL

altBusinessIdstring · max: 50

Alternate business identifier.

altBusinessIdTypestring · enum

Alternate business identifier type. Required if altBusinessId is provided.

Options: NONE, DUNS, GIIN, LEI,

businessContactEmailone of

Business contact email.

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '/workspaces/{workspaceId}/tcr-brands' \
  --header 'Authorization: Bearer jwt' \
  --header 'Content-Type: application/json' \
  --data '{"entityType":"PRIVATE_PROFIT","firstName":"John","lastName":"Doe","displayName":"ABC Mobile","companyName":"ABC Inc.","ein":"111111111","einIssuingCountry":"US","phone":"[phone]","street":"123 6th Ave","city":"New York","state":"NY","postalCode":"10001","country":"US","email":"[e-mail]","stockSymbol":"ABC","stockExchange":"NASDAQ","website":"https://example.com","vertical":"RETAIL","altBusinessIdType":"NONE"}'

201

422

201

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "organizationId": "123e4567-e89b-12d3-a456-426614174000",
  "createdAt": "2025-02-21T18:01:53.397Z",
  "updatedAt": "2025-02-21T18:01:53.397Z",
  "status": "PENDING",
  "entityType": "PRIVATE_PROFIT",
  "firstName": "John",
  "lastName": "Doe",
  "displayName": "ABC Mobile",
  "companyName": "ABC Inc.",
  "ein": "111111111",
  "einIssuingCountry": "US",
  "phone": "[phone]",
  "street": "123 6th Ave",
  "city": "New York",
  "state": "NY",
  "postalCode": "10001",
  "country": "US",
  "email": "[e-mail]",
  "stockSymbol": "ABC",
  "stockExchange": "NASDAQ",
  "website": "https://example.com",
  "vertical": "RETAIL",
  "altBusinessId": "text",
  "altBusinessIdType": "NONE",
  "businessContactEmailVerifiedDate": "2025-02-21T18:01:53.397Z",
  "workspaceIds": [
    "123e4567-e89b-12d3-a456-426614174000"
  ],
  "businessContactEmail": "[e-mail]",
  "rejection": {
    "description": "text",
    "code": "text"
  }
}

Brand successfully created

BrandRequest Object

Field	Type	Description	Mandatory
entityType	entityType	Legal entity type	Required
displayName	string	Display or marketing name your brand	Required for entityType PRIVATE/PUBLIC
companyName	string	Legal company name. This should match the legal company name used to register your EIN/Tax ID	Required
ein	string	Government assigned corporate tax ID. EIN is 9-digits in the U.S.	Required
einIssuingCountry	string	The 2 letter ISO country of registration submitted with your EIN / Tax ID registration	Required
phone	string	Valid phone number in e.164 international format.	Required
street	string	Street number and name	Required
city	string	City name	Required
state	string	State. Must be a 2 letter state code for US states	Required
postalCode	string	Postal code. Must be a 5 digit zip code for the United States	Required
country	string	ISO 2 character country code	Required
email	string	Valid email address of brand support contact	Required
stockSymbol	stockSymbol	Stock symbol	Required for entityType PUBLIC
stockExchange	stockExchange	Stock exchange	Required for entityType PUBLIC
website	string	Brand website URL	Required
vertical	vertical	Vertical or industry segment of the brand	Required
altBusinessId	string	Alternate business identifer	Optional
altBusinessIdType	altBusinessIdType	Alternate business identifier type	Required if altBusinessId is provided

BrandResponse Object

Field	Type	Description
entityType	entityType	Legal entity type
displayName	string	Display or marketing name your brand
companyName	string	Legal company name. This should match the legal company name used to register your EIN/Tax ID
ein	string	Government assigned corporate tax ID. EIN is 9-digits in the U.S.
einIssuingCountry	string	The 2 letter ISO country of registration submitted with your EIN / Tax ID registration
phone	string	Valid phone number in e.164 international format.
street	string	Street number and name
city	string	City name
state	string	State. Must be a 2 letter state code for US states
postalCode	string	Postal code. Must be a 5 digit zip code for the United States
country	string	ISO 2 character country code
email	string	Valid email address of brand support contact
stockSymbol	stockSymbol	Stock symbol
stockExchange	stockExchange	Stock exchange
website	string	Brand website URL
vertical	vertical	Vertical or industry segment of the brand
altBusinessId	string	Alternate business identifier
altBusinessIdType	altBusinessIdType	Alternate business identifier type
brandId	string	UUID of a brand
status	status	Brand status