Get a brand

Get brand in a workspace

GET/workspaces/{workspaceId}/tcr-brands/{brandId}

Authorization

useraccessKey

Path parameters

workspaceId*string

brandId*string

Response

200404

Brand

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

Request

JavaScriptCurl

const response = await fetch('/workspaces/{workspaceId}/tcr-brands/{brandId}', {
    method: 'GET',
    headers: {
      "Authorization": "Bearer jwt"
    },
});
const data = await response.json();

Response

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "organizationId": "123e4567-e89b-12d3-a456-426614174000",
  "createdAt": "2024-04-29T10:12:38.350Z",
  "updatedAt": "2024-04-29T10:12:38.350Z",
  "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"
  }
}

Type	Description
BrandReponse	BrandResponse object describes a submitted brand