Skip to main content

Get Brand

GET 
/brand/:brandId

Retrieve a brand by brandId.

Request​

Path Parameters

    brandId Brandidrequired

Responses​

200: Successful Response

Schema

    entityType EntityTyperequired

    Possible values: [PRIVATE_PROFIT, PUBLIC_PROFIT, NON_PROFIT, SOLE_PROPRIETOR, GOVERNMENT]

    Entity type behind the brand. This is the form of business establishment.

    cspId Cspid (string)

    Unique identifier assigned to the csp by the registry.

    brandId Brandid (string)

    Unique identifier assigned to the brand.

    tcrBrandId TcrBrandid (string)

    Unique identifier assigned to the brand by the registry.

    displayName Displayname (string)required

    Possible values: <= 100 characters

    Display or marketing name of the brand.

    companyName Companyname (string)

    Possible values: <= 100 characters

    (Required for Non-profit/private/public) Legal company name.

    firstName Firstname (string)

    Possible values: <= 100 characters

    First name of business contact.

    lastName Lastname (string)

    Possible values: <= 100 characters

    Last name of business contact.

    ein Ein (string)

    Possible values: <= 20 characters

    (Required for Non-profit) Government assigned corporate tax ID. EIN is 9-digits in U.S.

    phone Phone (string)

    Possible values: <= 20 characters

    Valid phone number in e.164 international format.

    street Street (string)

    Possible values: <= 100 characters

    Street number and name.

    city City (string)

    Possible values: <= 100 characters

    City name

    state State (string)

    Possible values: <= 20 characters

    State. Must be 2 letters code for United States.

    postalCode Postalcode (string)

    Possible values: <= 10 characters

    Postal codes. Use 5 digit zipcode for United States

    country Country (string)required

    Possible values: <= 2 characters

    ISO2 2 characters country code. Example: US - United States

    email Email (string)required

    Possible values: <= 100 characters

    Valid email address of brand support contact.

    stockSymbol Stocksymbol (string)

    Possible values: <= 10 characters

    (Required for public company) stock symbol.

    stockExchange StockExchange

    Possible values: [NONE, NASDAQ, NYSE, AMEX, AMX, ASX, B3, BME, BSE, FRA, ICEX, JPX, JSE, KRX, LON, NSE, OMX, SEHK, SSE, STO, SWX, SZSE, TSX, TWSE, VSE]

    (Required for public company) stock exchange.

    ipAddress Ipaddress (string)

    Possible values: <= 50 characters

    IP address of the browser requesting to create brand identity.

    website Website (string)

    Possible values: <= 100 characters

    Brand website URL.

    brandRelationship BrandRelationshiprequired

    Possible values: [BASIC_ACCOUNT, SMALL_ACCOUNT, MEDIUM_ACCOUNT, LARGE_ACCOUNT, KEY_ACCOUNT]

    Brand relationship to the CSP.

    vertical Vertical (string)required

    Possible values: <= 50 characters

    Vertical or industry segment of the brand.

    altBusinessId Altbusinessid (string)

    Possible values: <= 50 characters

    Alternate business identifier such as DUNS, LEI, or GIIN

    altBusinessIdType AltBusinessIdType

    Possible values: [NONE, DUNS, GIIN, LEI]

    An enumeration.

    universalEin Universalein (string)

    Universal EIN of Brand, Read Only.

    referenceId Referenceid (string)

    Unique identifier Telnyx assigned to the brand - the brandId

    identityStatus BrandIdentityStatus

    Possible values: [VERIFIED, UNVERIFIED, SELF_DECLARED, VETTED_VERIFIED]

    The verification status of an active brand

    optionalAttributes

    object

    taxExemptStatus Taxexemptstatus (string)

    The tax exempt status of the brand

    mock Mock (boolean)

    Mock brand for testing purposes

    mobilePhone Mobilephone (string)

    Possible values: <= 20 characters

    Valid mobile phone number in e.164 international format.

    isReseller Isreseller (boolean)

    Indicates whether this brand is known to be a reseller

422: Validation Error

Schema

    detail

    object[]

  • Array [

    • loc

    object[]

    required

  • Array [

    • anyOf

    string

  • ]

    • msg Message (string)required
    type Error Type (string)required

  • ]

Loading...