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 brand in organization

POST/organizations/{organizationId}/tcr-brands

Authorization

useraccessKey

Path parameters

organizationId*string

Body

application/json

entityType*BrandEntityType (enum)

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

PRIVATE_PROFITPUBLIC_PROFITNON_PROFITGOVERNMENT

firstNamestring

First or given name. Applicable to entity type.

lastNamestring

Last or Surname. Applicable to 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.

stockSymbolstring

Stock symbol. Required for entityType PUBLIC.

stockExchangeBrandStockExchange (enum)

Stock exchange. Required for entityType PUBLIC.

NONENASDAQNYSEAMEXAMXASXB3BMEBSEFRAICEXJPXJSEKRXLONNSEOMXSEHKSGXSSESTOSWXSZSETSXTWSEVSEOTHER

website*string

Brand website URL.

verticalstring

Vertical or industry segment of the brand.

altBusinessIdstring

Alternate business identifier.

altBusinessIdTypeBrandAltBusinessIdType (enum)

Alternate business identifier type. Required if altBusinessId is provided.

NONEDUNSGIINLEI

workspaceIds*array of string (uuid)

Response

201422

Brand successfully created

Body

application/json

idstring (uuid)

The ID of the number.

organizationIdstring (uuid)

createdAtstring (date-time)

Timestamp (UTC) when the brand was created.

updatedAtnullable string (date-time)

Timestamp (UTC) when the brand was last updated.

statusBrandStatus (enum)

Brand status

FAILEDPENDINGREJECTEDAPPROVEDDELETED

entityType*BrandEntityType (enum)

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

PRIVATE_PROFITPUBLIC_PROFITNON_PROFITGOVERNMENT

firstNamestring

First or given name. Applicable to entity type.

lastNamestring

Last or Surname. Applicable to 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.

stockSymbolstring

Stock symbol.

stockExchangeBrandStockExchange (enum)

Stock exchange. Required for entityType PUBLIC.

NONENASDAQNYSEAMEXAMXASXB3BMEBSEFRAICEXJPXJSEKRXLONNSEOMXSEHKSGXSSESTOSWXSZSETSXTWSEVSEOTHER

website*string

Brand website URL.

verticalstring

Vertical or industry segment of the brand.

altBusinessIdstring

Alternate business identifier.

altBusinessIdTypeBrandAltBusinessIdType (enum)

Alternate business identifier type. Required if altBusinessId is provided.

NONEDUNSGIINLEI

workspaceIdsnullable array of string (uuid)

Workspace IDs with access to the brand.

rejectionobject

Rejection details

workspaceIds*array of string (uuid)

Request

JavaScriptCurl

const response = await fetch('/organizations/{organizationId}/tcr-brands', {
    method: 'POST',
    headers: {
      "Authorization": "Bearer jwt",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "country": "US",
      "displayName": "ABC Mobile",
      "email": "[e-mail]",
      "entityType": "PRIVATE_PROFIT",
      "phone": "[phone]",
      "street": "123 6th Ave",
      "city": "New York",
      "state": "NY",
      "postalCode": "10001",
      "companyName": "ABC Inc.",
      "ein": "111111111",
      "einIssuingCountry": "US",
      "website": "https://example.com",
      "workspaceIds": [
        "123e4567-e89b-12d3-a456-426614174000"
      ]
    }),
});
const data = await response.json();

Response

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "organizationId": "123e4567-e89b-12d3-a456-426614174000",
  "createdAt": "2024-04-29T10:20:20.499Z",
  "updatedAt": "2024-04-29T10:20:20.499Z",
  "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",
  "workspaceIds": [
    "123e4567-e89b-12d3-a456-426614174000"
  ],
  "rejection": {
    "description": "text",
    "code": "text"
  }
}

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
workspaceIds	array<UUID>	An array of valid workspace IDs associated with organisation. Brand will be shared with workspace Ids listed	Required

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
workspaceIds	array<UUID>	An array of valid workspace IDs associated with organisation. Brand will be shared with workspace Ids listed