# Create a brand {% hint style="warning" %} A successful request to this endpoint will mean you are charged a [brand registration](https://docs.bird.com/applications/channels/channels/supported-channels/sms/concepts/united-states-sms-registration/sms-10dlc/brand-registration) fee. If you later need to update or resubmit your brand there may be additional fees. {% endhint %} ## 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.
```json {"openapi":"3.0.3","info":{"title":"Numbers","version":"v1"},"tags":[{"description":"TCR Brands","name":"number_brands"}],"servers":[{"url":"https://api.bird.com","description":"Production API"}],"security":[{"accessKey":[]}],"components":{"securitySchemes":{"accessKey":{"description":"Uses the Authorization header: 'AccessKey ' followed by your access key token","scheme":"AccessKey","type":"http"}},"schemas":{"BrandCreateWorkspace":{"type":"object","properties":{"entityType":{"$ref":"#/components/schemas/BrandEntityType"},"firstName":{"maxLength":100,"type":"string","description":"First or given name. Applicable to entity type."},"lastName":{"maxLength":100,"type":"string","description":"Last or Surname. Applicable to entity type."},"displayName":{"minLength":1,"maxLength":255,"type":"string","description":"Display or marketing name your brand."},"companyName":{"minLength":1,"maxLength":255,"type":"string","description":"Legal company name. This should match the legal company name used to register your EIN/Tax ID."},"ein":{"minLength":1,"maxLength":21,"type":"string","description":"Government assigned corporate tax ID. EIN is 9-digits in the U.S."},"einIssuingCountry":{"minLength":1,"maxLength":2,"type":"string","description":"The 2 letter ISO country of registration submitted with your EIN / Tax ID registration."},"phone":{"minLength":1,"maxLength":20,"type":"string","description":"Valid phone number in e.164 international format."},"street":{"minLength":1,"maxLength":100,"type":"string","description":"Street number and name."},"city":{"minLength":1,"maxLength":100,"type":"string","description":"City name"},"state":{"minLength":1,"maxLength":20,"type":"string","description":"State. Must be a 2 letter state code for US states."},"postalCode":{"minLength":1,"maxLength":10,"type":"string","description":"Postal code. Must be a 5 digit zip code for the United States."},"country":{"minLength":1,"maxLength":2,"type":"string","description":"ISO 2 character country code."},"email":{"minLength":1,"maxLength":100,"type":"string","description":"Valid email address of brand support contact."},"stockSymbol":{"maxLength":10,"type":"string","description":"Stock symbol. Required for entityType PUBLIC."},"stockExchange":{"$ref":"#/components/schemas/BrandStockExchange"},"website":{"minLength":1,"maxLength":255,"type":"string","description":"Brand website URL."},"vertical":{"maxLength":50,"type":"string","description":"Vertical or industry segment of the brand."},"altBusinessId":{"maxLength":50,"type":"string","description":"Alternate business identifier."},"altBusinessIdType":{"$ref":"#/components/schemas/BrandAltBusinessIdType"},"businessContactEmail":{"description":"Business contact email.","oneOf":[{"type":"string","format":"email"},{"type":"string","minLength":0,"maxLength":0}]}},"required":["country","displayName","email","entityType","phone","street","city","state","postalCode","companyName","ein","einIssuingCountry","website"]},"BrandEntityType":{"type":"string","description":"Legal entity type. It can't be updated when the brand is approved.","enum":["PRIVATE_PROFIT","PUBLIC_PROFIT","NON_PROFIT","GOVERNMENT",""]},"BrandStockExchange":{"type":"string","description":"Stock exchange. Required for entityType PUBLIC.","enum":["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",""]},"BrandAltBusinessIdType":{"type":"string","description":"Alternate business identifier type. Required if altBusinessId is provided.","enum":["NONE","DUNS","GIIN","LEI",""]},"WorkspaceTCRBrand":{"type":"object","additionalProperties":false,"required":["country","displayName","email","entityType","phone","street","city","state","postalCode","companyName","ein","einIssuingCountry","website"],"properties":{"id":{"type":"string","description":"The ID of the number.","format":"uuid"},"tcrBrandId":{"type":"string","description":"The Campaign Registry brand ID."},"organizationId":{"type":"string","format":"uuid"},"createdAt":{"type":"string","description":"Timestamp (UTC) when the brand was created.","format":"date-time"},"updatedAt":{"type":"string","description":"Timestamp (UTC) when the brand was last updated.","nullable":true,"format":"date-time"},"status":{"$ref":"#/components/schemas/BrandStatus"},"authPlusStatus":{"$ref":"#/components/schemas/BrandAuthPlusStatus"},"entityType":{"$ref":"#/components/schemas/BrandEntityType"},"firstName":{"maxLength":100,"type":"string","description":"First or given name. Applicable to entity type."},"lastName":{"maxLength":100,"type":"string","description":"Last or Surname. Applicable to entity type."},"displayName":{"maxLength":255,"type":"string","description":"Display or marketing name your brand."},"companyName":{"maxLength":255,"type":"string","description":"Legal company name. This should match the legal company name used to register your EIN/Tax ID."},"ein":{"maxLength":21,"type":"string","description":"Government assigned corporate tax ID. EIN is 9-digits in the U.S."},"einIssuingCountry":{"maxLength":2,"type":"string","description":"The 2 letter ISO country of registration submitted with your EIN / Tax ID registration."},"phone":{"maxLength":20,"type":"string","description":"Valid phone number in e.164 international format."},"street":{"maxLength":100,"type":"string","description":"Street number and name."},"city":{"maxLength":100,"type":"string","description":"City name"},"state":{"maxLength":20,"type":"string","description":"State. Must be a 2 letter state code for US states."},"postalCode":{"maxLength":10,"type":"string","description":"Postal code. Must be a 5 digit zip code for the United States."},"country":{"maxLength":2,"type":"string","description":"ISO 2 character country code."},"email":{"maxLength":100,"type":"string","description":"Valid email address of brand support contact."},"stockSymbol":{"maxLength":10,"type":"string","description":"Stock symbol."},"stockExchange":{"$ref":"#/components/schemas/BrandStockExchange"},"website":{"maxLength":255,"type":"string","description":"Brand website URL."},"vertical":{"maxLength":50,"type":"string","description":"Vertical or industry segment of the brand."},"altBusinessId":{"maxLength":50,"type":"string","description":"Alternate business identifier."},"altBusinessIdType":{"$ref":"#/components/schemas/BrandAltBusinessIdType"},"businessContactEmail":{"description":"Business contact email.","oneOf":[{"type":"string","format":"email"},{"type":"string","minLength":0,"maxLength":0}]},"businessContactEmailVerifiedDate":{"type":"string","description":"Timestamp (UTC) when the brand businessContactEmail was verified.","format":"date-time"},"rejection":{"type":"object","description":"Rejection details","required":["description"],"properties":{"description":{"type":"string","description":"Rejection description"},"code":{"type":"string","description":"Rejection code"}}}}},"BrandStatus":{"type":"string","description":"Brand status","enum":["FAILED","PENDING","REJECTED","APPROVED","DELETED","DRAFT"]},"BrandAuthPlusStatus":{"type":"string","description":"Brand Auth+ status","enum":["NOT_APPLICABLE","NEEDS_CHARGE","NEEDS_TRIGGER","DONE"]},"error.validation":{"additionalProperties":false,"description":"A validation error returned from the API. The `details` map keys are JSON paths\npointing into the request body / parameters; values are arrays of human-readable\nmessages describing each problem with that path.\n","properties":{"code":{"description":"A unique code that identifies the error. This code can be used to programmatically identify the error.","minLength":3,"type":"string"},"details":{"additionalProperties":{"items":{"type":"string"},"type":"array"},"description":"Per-field validation messages keyed by JSON path.","type":"object"},"message":{"description":"A human-readable message that describes the error.","minLength":1,"type":"string"}},"required":["code","message"],"title":"ValidationError","type":"object"}},"responses":{"error.response.invalid_request":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/error.validation"}}},"description":"The request contains invalid parameters or body fields."}}},"paths":{"/workspaces/{workspaceId}/tcr-brands":{"post":{"description":"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.\n","operationId":"createWorkspaceBrand","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BrandCreateWorkspace"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WorkspaceTCRBrand"}}},"description":"Brand successfully created"},"422":{"$ref":"#/components/responses/error.response.invalid_request"}},"summary":"Create a brand at workspace level","tags":["number_brands"]}}}} ``` ## BrandRequest Object
FieldTypeDescriptionMandatory
entityTypeentityTypeLegal entity typeRequired
displayNamestringDisplay or marketing name your brandRequired for entityType PRIVATE/PUBLIC
companyNamestringLegal company name. This should match the legal company name used to register your EIN/Tax IDRequired
einstringGovernment assigned corporate tax ID. EIN is 9-digits in the U.S.Required
einIssuingCountrystringThe 2 letter ISO country of registration submitted with your EIN / Tax ID registrationRequired
phonestringValid phone number in e.164 international format.Required
streetstringStreet number and nameRequired
citystringCity nameRequired
statestringState. Must be a 2 letter state code for US statesRequired
postalCodestringPostal code. Must be a 5 digit zip code for the United StatesRequired
countrystringISO 2 character country codeRequired
emailstringValid email address of brand support contactRequired
stockSymbolstockSymbolStock symbolRequired for entityType PUBLIC
stockExchangestockExchangeStock exchangeRequired for entityType PUBLIC
websitestringBrand website URLRequired
verticalverticalVertical or industry segment of the brandRequired
altBusinessIdstringAlternate business identiferOptional
altBusinessIdTypealtBusinessIdTypeAlternate business identifier typeRequired if altBusinessId is provided
## BrandResponse Object | Field | Type | Description | | ----------------- | --------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | | entityType | [entityType](/api/numbers-api/api-reference/10dlc-compliance/tcr-enums.md#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](/api/numbers-api/api-reference/10dlc-compliance/tcr-enums.md#stocksymbol) | Stock symbol | | stockExchange | [stockExchange](/api/numbers-api/api-reference/10dlc-compliance/tcr-enums.md#stockexchange) | Stock exchange | | website | string | Brand website URL | | vertical | [vertical](/api/numbers-api/api-reference/10dlc-compliance/tcr-enums.md#verticals) | Vertical or industry segment of the brand | | altBusinessId | string | Alternate business identifier | | altBusinessIdType | [altBusinessIdType](/api/numbers-api/api-reference/10dlc-compliance/tcr-enums.md#altbusinessidtype) | Alternate business identifier type | | brandId | string | UUID of a brand | | status | [status](/api/numbers-api/api-reference/10dlc-compliance/tcr-enums.md#brandstatus) | Brand status | --- # Agent Instructions: Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on the current page URL with the `ask` query parameter: ``` GET https://docs.bird.com/api/numbers-api/api-reference/10dlc-compliance/brands-workspace/create-a-brand.md?ask= ``` The question should be specific, self-contained, and written in natural language. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.