# /hawaii/companies/search

`POST /api/hawaii/companies/search`

Price: 1 credit

Search Hawaii businesses in the DCCA Business Registration Division registry by name. Matches entities, trade names, trademarks, service marks and publicity rights names. Returns each match with its file number, name, record type, mark type, status, and (for trade names, trademarks and service marks) certificate number and expiration date. Filter by match mode (begins with / contains), record type, entity type and entity status. Use the file_number with hawaii/companies for the full registry record.

## How to use it

Search Hawaii businesses by name and a count. Optionally set match (begins/contains), record_type (all/Entity/Trade Name/Trademark/Service Mark/Publicity Rights Name/Pending Filing), entity_type (all/Cooperative/Corporation/Limited Liability Company/Partnership/Other) and status (all or a specific entity status like 'Active (A)'). Returns a list of items, each with file_number, name, record_type, mark_type, status, certificate_number and expiration_date. Returns an empty list when nothing matches. Use the file_number with hawaii/companies for full details.

## Parameters

- `access-token` (string, required)

## Request body

- `timeout` (integer) — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
- `query` (string, required) — Business name to search for (examples: "ALOHA", "KONA COFFEE"; minLength: 1)
- `count` (integer, required) — Max number of results to return (min: 1)
- `match` (string) — Whether the name begins with or contains the query (default: "begins"; one of: "begins", "contains")
- `record_type` (string) — Type of record to search (default: "all"; one of: "all", "Entity", "Trade Name", "Trademark", "Service Mark", "Publicity Rights Name", "Pending Filing")
- `entity_type` (string) — Business entity type filter (applies to entity records) (default: "all"; one of: "all", "Cooperative", "Corporation", "Limited Liability Company", "Partnership", "Other")
- `status` (string) — Entity status filter (applies to entity records) (default: "all"; one of: "all", "Active (A)", "Adm. Terminated (V)", "Terminated (T)", "Withdrawn (W)", "Cancelled (C)", "Dissolved (D)", "Delinquent Status 1 (1)", "Delinquent Status 2 (2)", "Inv. Dissolved (7) or (I)", "Inv. Cancelled (X)", "Inv. Revoked (R)", "Converted (9)", "Merged (M)", "Expired (E)")

## Response

### 200 — Successful Response

- `@type` (string) (default: "HawaiiCompanySearchItem")
- `file_number` (string, required)
- `name` (string, nullable)
- `record_type` (string, nullable)
- `mark_type` (string, nullable)
- `status` (string, nullable)
- `certificate_number` (string, nullable)
- `expiration_date` (string, nullable)

## Errors

### 422 — Validation Error

The request body did not validate

What to do: Check the fields against this schema. A URN with the wrong prefix is the most common cause.

- `detail` (array)
  - `loc` (array, required)
  - `msg` (string, required)
  - `type` (string, required)
  - `input` (any)
  - `ctx` (object)

### 408

The request ran past its time limit

What to do: Raise `timeout` in the request body, up to the maximum this endpoint documents. Lowering `count` or turning off the `with_*` flags also helps, because less work finishes sooner.

### 412

The entity was not found, or a precondition failed

What to do: Retrying will not help: either the entity does not exist, or the input points at a different one.

### 429

Too many requests: a rate limit or a usage window is exhausted

What to do: When the response carries an X-Retry-After header, wait that many seconds and retry: the same number is in the body as `detail.retry_after`, and the limit clears once that window passes. The message in the body names the limit that was hit.

### 500

Something broke on our side

What to do: Retrying will not help. If it keeps happening, send us the X-Request-ID from the response headers.

### 529

Rate limit reached, or the endpoint is overloaded

What to do: Wait at least 30 seconds, then retry.

## Response envelope

Success: Array of objects (may be empty if no results)

Error: Error may coexist with partial results if it occurs mid-execution. Check X-Error header and status code.

Every response carries these headers:

- `X-Error` — Error message text (present only on error)
- `X-Request-ID` — Unique request identifier
- `X-Execution-Time` — Execution time in seconds
- `X-Result-Count` — How many records the body carries. 0 means an empty result, which is a normal answer and not by itself an error. A non-zero count can come back together with X-Error when the failure happened partway through — read this header and X-Error independently.
- `X-Total-Available-Results` — How many records exist for this query, when the endpoint can say. On a `dry_run` request this is the answer and the body is empty. It saturates: the endpoint's documented maximum means 'at least that many', any smaller number is exact.
- `X-Warning` — Present when the request body carried keys this endpoint does not document. They were ignored, so any filter you meant to apply through them did not apply. Check the spelling against this schema and retry.
- `X-Retry-After` — Seconds to wait before retrying. Present only on 429.