Autofill Brand Information

POST

https://api.pinnacle.sh/brands/autofill

POST

/brands/autofill

1 import { PinnacleClient } from "rcs-js";
2 
3 async function main() {
4     const client = new PinnacleClient({
5         apiKey: "YOUR_API_KEY_HERE",
6     });
7     await client.brands.autofill({
8         additionalInfo: "A developer-friendly, compliant API for SMS, MMS, and RCS, built to scale real conversations.",
9         name: "Pinnacle",
10         options: {
11             forceReload: true,
12         },
13         website: "https://www.pinnacle.sh",
14     });
15 }
16 main();

1 {
2   "address": "500 Folsom St, San Francisco, CA 94105",
3   "contact": {
4     "email": "michael.chen@trypinnacle.app",
5     "name": "Michael Chen",
6     "phone": "+14155551234",
7     "title": "Customer Support Representative"
8   },
9   "dba": "Pinnacle Messaging",
10   "ein": "88-1234567",
11   "email": "founders@trypinnacle.app",
12   "name": "Pinnacle",
13   "sector": "TECHNOLOGY",
14   "type": "PRIVATE_PROFIT",
15   "entityType": "LLC",
16   "website": "https://www.pinnacle.sh"
17 }

Automatically populate brand information based on partial input data you provide.

Authentication

PINNACLE-API-KEYstring

API Key authentication via header

Request

This endpoint expects an object.

Either ‘name’ or ‘website’ must be provided.

additional_infostringOptional

Any extra details about the brand to help improve data accuracy.

namestringOptional

Name of the brand.

optionsobjectOptional

websitestringOptionalformat: "url"

Brand's website URL.

Response

Returns enriched brand information retrieved from the autofill service.

addressstringOptional

Primary brand address where this brand is located.

contactobjectOptional

Contact information for the primary brand representative.

dbastring or nullOptional

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

descriptionstringOptional

Brief description of what this brand does.

einstringOptional

Employer Identification Number (EIN) assigned by the IRS.

emailstringOptional

Main contact email address for this brand.

namestringOptional

Legal name of the brand as registered.

sectorenumOptional

Industry the Brand operates in.

typeenumOptional

Legal structure of the brand.

entityTypeenumOptional

Legal entity type of the brand.

websitestringOptional

Brand website URL.

Errors

400

Bad Request Error

401

Unauthorized Error

403

Forbidden Error

500

Internal Server Error