> ## Documentation Index
> Fetch the complete documentation index at: https://docs.topograph.co/llms.txt
> Use this file to discover all available pages before exploring further.

# Hawaii

> Country-specific identifiers, data sources, and integration details

## Start here

This guide contains public integration notes for Hawaii. Use it for identifier formats, search behavior, and country-specific caveats. The live source of truth for coverage, pricing, data sources, documents, legal forms, roles, and status values is the pricing page.

<Card title="Hawaii coverage, pricing, and sources" icon="arrow-up-right-from-square" href="https://topograph.co/pricing/us-hi">
  Open the current catalog for supported datapoints, documents, sources, identifiers, and availability.
</Card>

<Warning>
  This jurisdiction may be in preview or limited availability. Check the live pricing page or contact support before relying on it in production.
</Warning>

<Note>
  Country details below are preserved as integration notes. If a table or example conflicts with the live pricing page, use the pricing page as the source of truth and contact support.
</Note>

## Table of Contents

* [Data Sources](#data-sources)
* [Company Identifiers](#company-identifiers)
* [Search Capabilities](#search-capabilities)
* [Quirks & Gotchas](#quirks--gotchas)
* [Mappings](#mappings)
  * [Legal Forms](#legal-forms)
  * [Officer Roles](#officer-roles)
  * [Entity Statuses](#entity-statuses)
* [Data Availability](#data-availability)

<Warning>
  **API access:** `US-HI` is not yet part of the public `countryCode` enum. Contact us to enable it on your workspace. Requests sent with `countryCode: "US-HI"` will otherwise return `400` until the enum is expanded.
</Warning>

## Data Sources

Hawaii uses a single integration against the **Hawaii Department of Commerce and Consumer Affairs, Business Registration Division (DCCA / BREG)**, surfaced through the **Hawaii Business Express (HBE)** portal.

The register covers every entity type filed under the Hawaii Revised Statutes: domestic and foreign profit corporations, nonprofit corporations, professional corporations, limited liability companies, general partnerships, limited partnerships, limited liability partnerships, professional limited liability partnerships, agricultural and fish cooperatives, and the special Corporation Sole form.

* **DCCA / BREG detail page** (live, authoritative). Every profile (legal name, file number, business type, status, registration date, principal and mailing addresses, term, registered agent, and the officer / director / manager / general partner roster) is read directly from the register at request time. Officers are on the public record per DCCA policy and appear without any paid order.

<Note>
  There is no open-data bulk feed for Hawaii. The Hawaii Open Data Portal entry for "Business Name Search" links back to the live HBE web search; no downloadable dataset exists. All data is fetched live from the register.
</Note>

## Company Identifiers

### Query Identifiers

| Identifier Type             | Format                                                                 | Example     | Notes                                                                                                      |
| --------------------------- | ---------------------------------------------------------------------- | ----------- | ---------------------------------------------------------------------------------------------------------- |
| **Hawaii BREG File Number** | 1–7 digits followed by a two-character suffix (one letter + one digit) | `100001 D1` | Assigned by DCCA / BREG. The suffix encodes the entity type and domestic/foreign status (see table below). |

<Tip>
  The portal accepts both the display form with a space between the digits and the suffix (`100001 D1`) and the URL form without the space (`100001D1`). Both are valid when querying the Topograph API.
</Tip>

#### File Number Suffix Codes

The two-character suffix encodes both entity type and domestic vs. foreign status:

| Suffix | Entity Type                                         |
| ------ | --------------------------------------------------- |
| `D1`   | Domestic Profit Corporation                         |
| `D2`   | Domestic Nonprofit Corporation                      |
| `D9`   | Corporation Sole                                    |
| `P1`   | Domestic Professional Corporation                   |
| `F1`   | Foreign Profit Corporation                          |
| `F2`   | Foreign Nonprofit Corporation                       |
| `C5`   | Domestic Limited Liability Company                  |
| `C6`   | Foreign Limited Liability Company                   |
| `G5`   | Domestic General Partnership                        |
| `G6`   | Foreign General Partnership                         |
| `L5`   | Domestic Limited Partnership                        |
| `L6`   | Foreign Limited Partnership                         |
| `K5`   | Domestic Limited Liability Partnership              |
| `K6`   | Foreign Limited Liability Partnership               |
| `Q5`   | Domestic Professional Limited Liability Partnership |
| `Q6`   | Foreign Professional Limited Liability Partnership  |
| `A2`   | Agricultural / Fish Cooperative                     |

### Identifiers in API Response

| Identifier   | Format                                                           | Example     | Found In     |
| ------------ | ---------------------------------------------------------------- | ----------- | ------------ |
| `fileNumber` | 1–7 digits + two-character suffix (space-separated display form) | `100001 D1` | All entities |

## Search Capabilities

| Search Type    | Pattern         | Example            | Match Type                                 | Expected Results                             |
| -------------- | --------------- | ------------------ | ------------------------------------------ | -------------------------------------------- |
| By Name        | 2–100 chars     | `"Aloha Holdings"` | Begins-with or contains (case-insensitive) | Multiple results                             |
| By File Number | Digits + suffix | `100001D1`         | Exact                                      | Exact match returned first (`matchType: id`) |

<Note>
  Name search supports both begins-with and contains matching against the entity's master name. Results are capped at 50 matches per query. Using a more specific query string narrows the result set.
</Note>

## Quirks & Gotchas

| Quirk                                              | Details                                                                                                                                                                                                                                                                         |
| -------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| **File number suffix is load-bearing**             | The two-character suffix (`D1`, `C5`, etc.) is part of the identifier and encodes the legal form. Passing a bare numeric string without the suffix returns no match.                                                                                                            |
| **Space vs. no-space forms both work**             | The portal renders file numbers with a space (`100001 D1`); the URL omits it (`100001D1`). The API accepts both. The response uses the display form.                                                                                                                            |
| **Active status renders as `1` in the register**   | The BREG detail page stores the active state as the literal string `1`, not the word "Active". Topograph normalizes this to `Active` in the API response. All other statuses (Terminated, Inv. Dissolved, Withdrawn, etc.) are returned as the register's human-readable label. |
| **"Not in good standing" is separate from status** | An entity can have status `Active` and still carry a "not in good standing" flag (for example, when the most recent annual report is delinquent). The standing flag does not change the `status` field.                                                                         |
| **LLC legal-form label has a lowercase suffix**    | The BREG page renders LLC types as `Domestic Limited Liability Company (llc)`. Topograph strips the `(llc)` suffix when mapping to the standardized legal form.                                                                                                                 |
| **Officer codes are combinable**                   | BREG concatenates codes with `/` when one person holds multiple roles (`P/D` = President + Director, `MGR/MEM` = Manager + Member). Each combined record is split into separate role entries in the API response.                                                               |
| **No shareholder or UBO register**                 | Hawaii does not collect shareholder names at the state level. The detail page carries an authorised stock structure (class, shares, par value) but does not name shareholders. UBO data is federal only (FinCEN BOI).                                                           |
| **No activity codes**                              | The BREG does not collect NAICS, SIC, or any other industry classification code. The register only captures a free-text purpose field.                                                                                                                                          |
| **Annual filings are on the public record**        | Each entity shows a year-by-year filing history (Processed / Delinquent / Not Filed) on the BREG detail page. This is reflected in the API response.                                                                                                                            |
| **Certificate of Good Standing is a paid upgrade** | The free Trade Register Extract is bundled with the company profile. A paid Certificate of Good Standing is available as a separate document for entities currently in good standing (see [pricing page](https://topograph.co/pricing/us-hi)).                                  |

## Mappings

### Legal Forms

Legal form is derived from the `BUSINESS TYPE` field on the BREG detail page, which is a closed set of 17 values. The two-character file-number suffix independently encodes the same legal form.

<AccordionGroup>
  <Accordion title="All 17 Hawaii entity types">
    | BREG Entity Type                                    | Standardized            | ISO 20275 |
    | --------------------------------------------------- | ----------------------- | --------- |
    | Domestic Profit Corporation                         | Corporation             | `C3JQ`    |
    | Foreign Profit Corporation                          | Corporation             | `C3JQ`    |
    | Domestic Professional Corporation                   | Corporation             |           |
    | Domestic Nonprofit Corporation                      | NonprofitOrganization   | `4RCO`    |
    | Foreign Nonprofit Corporation                       | NonprofitOrganization   | `4RCO`    |
    | Corporation Sole                                    | Other                   |           |
    | Domestic Limited Liability Company                  | LimitedLiabilityCompany | `JY0X`    |
    | Foreign Limited Liability Company                   | LimitedLiabilityCompany | `JY0X`    |
    | Domestic General Partnership                        | Partnership             |           |
    | Foreign General Partnership                         | Partnership             |           |
    | Domestic Limited Partnership                        | Partnership             | `T91T`    |
    | Foreign Limited Partnership                         | Partnership             | `T91T`    |
    | Domestic Limited Liability Partnership              | Partnership             |           |
    | Foreign Limited Liability Partnership               | Partnership             |           |
    | Domestic Professional Limited Liability Partnership | Partnership             |           |
    | Foreign Professional Limited Liability Partnership  | Partnership             |           |
    | Agricultural / Fish Cooperative                     | Cooperative             |           |
  </Accordion>
</AccordionGroup>

The full legal form table, including provenance, is on the [pricing page](https://topograph.co/pricing/us-hi).

### Officer Roles

BREG uses a closed set of 22 base office codes, with additional ordinal variants for vice-president positions (1V–9V). Codes are concatenated with `/` when an officer holds multiple roles; the API splits compound entries into separate records.

| Office Code | Role                               | Notes                                                               |
| ----------- | ---------------------------------- | ------------------------------------------------------------------- |
| `P`         | President                          |                                                                     |
| `S`         | Secretary                          |                                                                     |
| `T`         | Treasurer                          |                                                                     |
| `D`         | Director                           |                                                                     |
| `C`         | Chairman / Chairwoman of the Board |                                                                     |
| `CEO`       | Chief Executive Officer            |                                                                     |
| `CFO`       | Chief Financial Officer            |                                                                     |
| `CO`        | Comptroller / Controller           |                                                                     |
| `AC`        | Assistant Comptroller / Controller |                                                                     |
| `AS`        | Assistant Secretary                |                                                                     |
| `AT`        | Assistant Treasurer                |                                                                     |
| `EV`        | Executive Vice President           |                                                                     |
| `SRV`       | Senior Vice President              |                                                                     |
| `V`         | Vice President                     |                                                                     |
| `1V`–`9V`   | 1st–9th Vice President             |                                                                     |
| `VC`        | Vice Chairman                      |                                                                     |
| `G`         | General Partner                    |                                                                     |
| `L`         | Limited Partner                    |                                                                     |
| `MGR`       | Manager                            |                                                                     |
| `MEM`       | Member                             | LLC-only; not in the BREG code legend but appears in compound codes |
| `R`         | Trustee                            |                                                                     |

<Note>
  Managers (`MGR`), Members (`MEM`), and General Partners (`G`) are classified as Legal Representatives. The registered agent is returned separately as an other key person and holds no statutory authority to bind the entity.
</Note>

### Entity Statuses

| BREG Status       | Notes                                                                                     |
| ----------------- | ----------------------------------------------------------------------------------------- |
| `Active`          | Entity is currently in good standing or active (normalized from BREG's internal `1` code) |
| `Inactive`        |                                                                                           |
| `Dissolved`       | Voluntarily dissolved                                                                     |
| `Inv. Dissolved`  | Involuntarily dissolved                                                                   |
| `Adm. Terminated` | Administratively terminated                                                               |
| `Terminated`      |                                                                                           |
| `Withdrawn`       | Foreign entity withdrawn from Hawaii                                                      |
| `Merged`          |                                                                                           |
| `Converted`       | Converted to a different entity type                                                      |
| `Reinstated`      | Previously dissolved / terminated, then reinstated                                        |

The full status table with provenance is on the [pricing page](https://topograph.co/pricing/us-hi).

## Data Availability

| Data Point                   | Available  | Notes                                                                                                                                                |
| ---------------------------- | ---------- | ---------------------------------------------------------------------------------------------------------------------------------------------------- |
| Company name                 | Yes        | Current legal name (master name on the BREG record)                                                                                                  |
| Company status               | Yes        | Normalized from the BREG STATUS field                                                                                                                |
| Registration date            | Yes        | Initial filing date with DCCA / BREG                                                                                                                 |
| Legal address                | Yes        | Principal address (street, city, state, ZIP)                                                                                                         |
| Mailing address              | Yes        | Separate mailing address when declared                                                                                                               |
| Legal form                   | Yes        | Closed 17-value BREG taxonomy with ISO 20275 mapping where available                                                                                 |
| Legal representatives        | Yes        | Officers, directors, managers, general partners, and members filed with the entity                                                                   |
| Registered agent             | Yes        | Returned as an other key person (name, type, and address)                                                                                            |
| Trade Register Extract       | Yes        | Free, register-issued PDF of the BREG detail page, bundled with the company profile at no extra charge                                               |
| Certificate of Good Standing | Yes (paid) | Issued by DCCA / BREG for entities currently in good standing; available as a paid document (see [pricing page](https://topograph.co/pricing/us-hi)) |
| Annual filing history        | Yes        | Year-by-year filing status (Processed / Delinquent / Not Filed) back to formation                                                                    |
| Activity codes               | No         | Not collected by the BREG                                                                                                                            |
| Shareholders                 | No         | Not published by the state register                                                                                                                  |
| UBOs                         | No         | Not published at the state level; federal FinCEN BOI records are restricted                                                                          |
| Financial data               | No         | Not collected                                                                                                                                        |

## Example API Responses

### Search by Name

```bash theme={null}
curl -X POST "https://api.topograph.co/v2/search?country=US-HI&query=Aloha+Holdings" \
  -H "x-api-key: YOUR_API_KEY"
```

```json theme={null}
[
  {
    "id": "100001 D1",
    "legalName": "ALOHA HOLDINGS, INC.",
    "countryCode": "US-HI",
    "matchReason": {
      "matchType": "default"
    },
    "address": {
      "region": "HI",
      "countryCode": "US"
    }
  }
]
```

### Search by File Number

```bash theme={null}
curl -X POST "https://api.topograph.co/v2/search?country=US-HI&query=100001D1" \
  -H "x-api-key: YOUR_API_KEY"
```

```json theme={null}
[
  {
    "id": "100001 D1",
    "legalName": "ALOHA HOLDINGS, INC.",
    "countryCode": "US-HI",
    "matchReason": {
      "matchType": "id"
    }
  }
]
```

### Company Profile

```bash theme={null}
curl -X POST "https://api.topograph.co/v2/company" \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"countryCode": "US-HI", "id": "100001 D1", "dataPoints": ["company", "legalRepresentatives"]}'
```

```json theme={null}
{
  "company": {
    "id": "100001 D1",
    "countryCode": "US-HI",
    "identifiers": { "fileNumber": "100001 D1" },
    "legalName": "ALOHA HOLDINGS, INC.",
    "status": "Active",
    "registrationDate": "2005-06-01",
    "legalForm": {
      "localName": "Domestic Profit Corporation",
      "standardized": "Corporation"
    },
    "legalAddress": {
      "street": "1 Example Street",
      "city": "Honolulu",
      "region": "HI",
      "postalCode": "96813",
      "countryCode": "US"
    }
  },
  "legalRepresentatives": [
    {
      "name": "Jane K. Sample",
      "roles": [
        { "localName": "President", "standardized": "President" },
        { "localName": "Director", "standardized": "Director" }
      ]
    }
  ]
}
```
