---
title: "Autofill Brand Information"
method: POST
path: "/brands/autofill"
tags: ["Brands"]
---

# Autofill Brand Information

`POST /brands/autofill`

## Request

- Base URL: `https://api.pinnacle.sh`
- URL: `https://api.pinnacle.sh/brands/autofill`
- Auth: API key in header `PINNACLE-API-KEY`

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

## Request body

- AutofillBrandSchema
  - `additional_info` string: Any extra details about the brand to help improve data accuracy.
  - `name` string: Name of the brand.
  - `options` AutofillBrandOptions
    - `forceReload` boolean: Set to true to bypass cached data and fetch fresh information.
  - `website` string, url: Brand's website URL.

## Response `200`

Returns enriched brand information retrieved from the autofill service.

- OptionalBrandSchema
  - `address` string: Primary brand address where this brand is located.
  - `contact` OptionalContactSchema: Contact information for the primary brand representative.
    - `email` string: Email address of the contact person.
    - `name` string: Full name of the contact person.
    - `phone` string: Phone number of the contact person in E.164 format.
    - `title` string: Job title or position oft he contact person.
  - `dba` string, nullable: "Doing Business As" name - the public name this brand operates under.
  - `description` string: Brief description of what this brand does.
  - `ein` string: Employer Identification Number (EIN) assigned by the IRS.
  - `email` string: Main contact email address for this brand.
  - `name` string: Legal name of the brand as registered.
  - `sector` 'AGRICULTURE' | 'COMMUNICATION' | 'CONSTRUCTION' | 'EDUCATION' | 'ENERGY' | 'ENTERTAINMENT' | 'FINANCIAL' | 'GAMBLING' | 'GOVERNMENT' | 'HEALTHCARE' | 'HOSPITALITY' | 'INSURANCE' | 'MANUFACTURING' | 'NGO' | 'REAL_ESTATE' | 'RETAIL' | 'TECHNOLOGY': Industry the Brand operates in.
  - `type` 'GOVERNMENT' | 'NON_PROFIT' | 'PRIVATE_PROFIT' | 'PUBLIC_PROFIT' | 'SOLE_PROPRIETOR': Legal structure of the brand.
  - `entityType` 'LLC' | 'SOLE_PROPRIETORSHIP' | 'PARTNERSHIP' | 'CORP' | 'S_CORP': Legal entity type of the brand.
  - `website` string: Brand website URL.

## Other responses

- `400`: Validation failed. The payload has missing required fields and/or invalid types. <br> See https://zod.dev/error-formatting for more information.
- `401`: The request lacks valid authentication credentials or the provided credentials are invalid. <br> Ensure you're including a valid API key in the request headers and that your account has the necessary permissions to access this endpoint.
- `403`: Your subscription does not include access to this feature. <br> This occurs when attempting to use functionality that requires a higher subscription tier. Please upgrade your subscription to access this feature.
- `500`: An unexpected error occurred on Pinnacle's servers while processing your request. <br> If this error persists, please contact support with the request details.

---

[API](https://skmtc.dev/pinnacle/apis/pinnacle-2.md) - [All operations](https://skmtc.dev/pinnacle/apis/pinnacle-2/llms.txt) - [OpenAPI document](https://skmtc.dev/pinnacle/apis/pinnacle-2/revisions/45416dadab79?raw)