Retrieve all registered brands. Use any combination of the query parameters to filter the results (value must be an exact match). Use sortBy and sortDir to sort the results, and use page and recordsPerPage to limit the number of results returned.
GET /v1/brands
Authorization: Bearer <access_token>
or
Authorization: Basic <encodedString>
where <encodedString> is your <api-key>:<api-secret> string encoded using Base64 encoding
companyName
string, max length: 255, min length: 0
Legal name of the business. Not required if entityType is SOLE_PROPRIETOR.
displayName
string, max length: 255, min length: 0
Display or marketing name for the brand.
status
string enum, values: ACTIVE, DECLINED, DELETED, PENDING
Current status of the brand. Possible values include:
entityType
string (UUID)
Type of business for the brand. Use the List Brand Entity Types API to retrieve a list of alias values that can be used in this field.
phone
string, max length: 20, min length: 0
pattern: ^\+?[1-9]\d{1,14}$
Phone number (in E.164 format) for the brand support contact.
vertical
string
Industry segment for the brand. Not required if entityType is SOLE_PROPRIETOR. Use the List Verticals API to retrieve a list of verticalName values that can be used in this field.
dateFrom
string, format: YYYY-MM-DD
Date the brand was created in the RocketCOMS system. This filter will return brands created on or after this date. Can be used in conjunction with dateTo to specify a date range.
dateTo
string, format: YYYY-MM-DD
Date the brand was created in the RocketCOMS system. This filter will return brands created on or before this date. Can be used in conjunction with dateFrom to specify a date range.
sortBy
string
Sort the response by any field.
sortDir
string, values: desc, asc
Sort direction.
page
integer (int32), default: 0
Page number to return.
pageSize
integer (int32)
Maximum number of results to return per page.
None
Returns a paginated response with an array of Brand objects.
SAMPLE RESPONSE
{
"status": "0000",
"result": {
"content": [
{
"companyName": "ABC Inc.",
"displayName": "ABC Mobile",
"ein": "111111111",
"einIssuingCountry": "US",
"entityType": "PUBLIC_PROFIT",
"vertical": "RETAIL",
"website": "http://www.abcmobile.com",
"stockSymbol": "ABC",
"stockExchange": "NASDAQ",
"firstName": "John",
"lastName": "Doe",
"phone": "+12024567890",
"email": "johndoe@abc.com",
"street": "123 6th Ave",
"city": "New York",
"state": "NY",
"postalCode": "10001",
"country": "US",
"id": "d7b0e25f-30c9-456b-b287-6b3dcaa4b8f7",
"businessAccountId": "67b25a5e-f90a-4491-9ee4-291ff290c1fe",
"universalEin": "111111111",
"cspId": "4e0c15a5-d798-46ff-8c50-2b30bd597abf",
"countryCode": "US",
"brandRelationship": "BASIC_ACCOUNT",
"registrationScore": 0,
"createdAt": "2022-04-20T00:18:06.347Z",
"status": "ACTIVE",
"lastStatus": "633eb3bb-7e78-447b-be04-e234dadfb629",
"lastStatusAt": "2022-04-20T00:18:06.347Z",
"rejectionReason": "string"
},
{...},
{...}
],
"page": 0,
"total": 100,
"pageSize": 10
}
}
© 2023 Rocket Financial. All rights reserved. RocketFNCL, RocketKOR, RocketBNK are trade names of Rocket Financial Inc.
Services Agreement | Privacy Policy | RocketFNCL | © 2023 by Rocket Financial Inc. All rights reserved.
Services Agreement | Privacy Policy | RocketFNCL | © 2023 by Rocket Financial Inc. All rights reserved.
Services Agreement | Privacy Policy | RocketFNCL
© 2023 by Rocket Financial Inc. All rights reserved.