Create a brand
Last updated
Last updated
Field | Type | Description | Mandatory |
---|---|---|---|
Field | Type | Description |
---|---|---|
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
string
Valid email address of brand support contact
Required
stockSymbol
Stock symbol
Required for entityType PUBLIC
stockExchange
Stock exchange
Required for entityType PUBLIC
website
string
Brand website URL
Required
vertical
Vertical or industry segment of the brand
Required
altBusinessId
string
Alternate business identifer
Optional
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
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
string
Valid email address of brand support contact
stockSymbol
Stock symbol
stockExchange
Stock exchange
website
string
Brand website URL
vertical
Vertical or industry segment of the brand
altBusinessId
string
Alternate business identifier
altBusinessIdType
Alternate business identifier type
brandId
string
UUID of a brand
status
Brand status
workspaceIds
array<UUID>
An array of valid workspace IDs associated with organisation. Brand will be shared with workspace Ids listed
Create a brand at organization-level. This means it will be available for all workspaces under this organization. A brand registration is mandatory due to compliance requirements.
The ID for the organization.
"d0b85ccc-b63a-4e81-b698-c359d77d250e"
Legal entity type. It can't be updated when the brand is approved.
"PRIVATE_PROFIT"
First or given name. Applicable to entity type.
"John"
Last or Surname. Applicable to entity type.
"Doe"
Display or marketing name your brand.
"ABC Mobile"
Legal company name. This should match the legal company name used to register your EIN/Tax ID.
"ABC Inc."
Government assigned corporate tax ID. EIN is 9-digits in the U.S.
"111111111"
The 2 letter ISO country of registration submitted with your EIN / Tax ID registration.
"US"
Valid phone number in e.164 international format.
"+12024567890"
Street number and name.
"123 6th Ave"
City name
"New York"
State. Must be a 2 letter state code for US states.
"NY"
Postal code. Must be a 5 digit zip code for the United States.
"10001"
ISO 2 character country code.
"US"
Valid email address of brand support contact.
"johndoe@abc.com"
Stock symbol. Required for entityType PUBLIC.
"ABC"
Stock exchange. Required for entityType PUBLIC.
"NASDAQ"
Brand website URL.
"https://example.com"
Vertical or industry segment of the brand.
"RETAIL"
Alternate business identifier.
Alternate business identifier type. Required if altBusinessId is provided.
Business contact email.
Brand successfully created
The ID of the number.
Timestamp (UTC) when the brand was created.
Timestamp (UTC) when the brand was last updated.
Brand status
"PENDING"
Legal entity type. It can't be updated when the brand is approved.
"PRIVATE_PROFIT"
First or given name. Applicable to entity type.
"John"
Last or Surname. Applicable to entity type.
"Doe"
Display or marketing name your brand.
"ABC Mobile"
Legal company name. This should match the legal company name used to register your EIN/Tax ID.
"ABC Inc."
Government assigned corporate tax ID. EIN is 9-digits in the U.S.
"111111111"
The 2 letter ISO country of registration submitted with your EIN / Tax ID registration.
"US"
Valid phone number in e.164 international format.
"+12024567890"
Street number and name.
"123 6th Ave"
City name
"New York"
State. Must be a 2 letter state code for US states.
"NY"
Postal code. Must be a 5 digit zip code for the United States.
"10001"
ISO 2 character country code.
"US"
Valid email address of brand support contact.
"johndoe@abc.com"
Stock symbol.
"ABC"
Stock exchange. Required for entityType PUBLIC.
"NASDAQ"
Brand website URL.
"https://example.com"
Vertical or industry segment of the brand.
"RETAIL"
Alternate business identifier.
Alternate business identifier type. Required if altBusinessId is provided.
Business contact email.
Timestamp (UTC) when the brand businessContactEmail was verified.
Workspace IDs with access to the brand.
Rejection details