Validate Brand Information API Reference

Serverhttps://api.pinnacle.sh/

Validate your brand information for compliance and correctness before submission or storage.

Authorization

Pinnacle API key

PINNACLE-API-KEY<token>

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

addressstringOptional

Primary brand address where this brand is located.

Example

"123 Market Street"

objectOptional

Contact information for the primary brand representative.

dbastringOptional

"Doing Business As" name - the public name this brand operates under.

Example

"Acme Health"

descriptionstringOptional

Brief description of what this brand does.

Example

"Primary messaging workflow"

einstringOptional

Employer Identification Number (EIN) assigned by the IRS.

Example

"123456789"

emailstringOptional

Main contact email address for this brand.

Example

"avery@example.com"

namestringOptional

Legal name of the brand as registered.

Example

"Acme Support"

sectorunknownOptional

Industry the Brand operates in.

Allowed values

"AGRICULTURE""COMMUNICATION""CONSTRUCTION""EDUCATION""ENERGY""ENTERTAINMENT""FINANCIAL""GAMBLING""GOVERNMENT""HEALTHCARE""HOSPITALITY""INSURANCE""MANUFACTURING""NGO""REAL_ESTATE""RETAIL""TECHNOLOGY"

typeunknownOptional

Legal structure of the brand.

Allowed values

"GOVERNMENT""NON_PROFIT""PRIVATE_PROFIT""PUBLIC_PROFIT""SOLE_PROPRIETOR"

entityTypeunknownOptional

Legal entity type of the brand.

Allowed values

"LLC""SOLE_PROPRIETORSHIP""PARTNERSHIP""CORP""S_CORP"

websitestringOptional

Brand website URL.

Example

"https://pinnacle.sh"

Response Body

`application/json`

Pinnacle client libraries

import { PinnacleClient } from "rcs-js";

const client = new PinnacleClient({
  apiKey: process.env.PINNACLE_API_KEY!,
});

await client.brands.validate({});

Responses

{  "isValid": true,  "errors": []}

Validate Brand Information

Request body

Authorization

Request Body

Response Body

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

Try asking

Validate Brand Information

AuthorizationCopy Anchor Link

Request BodyCopy Anchor Link

Response BodyCopy Anchor Link

200application/json

400application/json

401application/json

403application/json

500application/json

Authorization

Request Body

Response Body

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`