Brand

Get Org Brand

get/api/v1/compliance/brand

Request

  • Base URL
    https://api.inkbox.ai (the document declares no server; this is the origin it was published from)
  • URL
    https://api.inkbox.ai/api/v1/compliance/brand
  • Auth
    • API key in header X-API-Key
    • or HTTP bearer

Response

Successful Response

brandRelationship'BASIC_ACCOUNT' | 'SMALL_ACCOUNT' | 'MEDIUM_ACCOUNT' | 'LARGE_ACCOUNT' | 'KEY_ACCOUNT' required
countrystring required
displayNamestring required
emailstring required
entityType'PRIVATE_PROFIT' | 'PUBLIC_PROFIT' | 'NON_PROFIT' | 'GOVERNMENT' | 'SOLE_PROPRIETOR' required
verticalstring required
altBusinessIdstring nullable
altBusinessIdType'NONE' | 'DUNS' | 'GIIN' | 'LEI' nullable
brandIdstring nullable
businessContactEmailstring nullable
citystring nullable
companyNamestring nullable
createdAtstring nullable
cspIdstring nullable
einstring nullable
firstNamestring nullable
identityStatus'VERIFIED' | 'UNVERIFIED' | 'SELF_DECLARED' | 'VETTED_VERIFIED' nullable
ipAddressstring nullable
isResellerboolean nullable
lastNamestring nullable
mobilePhonestring nullable
mockboolean nullable
phonestring nullable
postalCodestring nullable
referenceIdstring nullable
statestring nullable
status'OK' | 'REGISTRATION_PENDING' | 'REGISTRATION_FAILED' nullable
stockExchange'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' nullable
stockSymbolstring nullable
streetstring nullable
tcrBrandIdstring nullable
universalEinstring nullable
updatedAtstring nullable
webhookFailoverURLstring nullable
webhookURLstring nullable
websitestring nullable

Changes

No recorded changes to this operation across all 38 revisions of this API.