/hawaii/companies

POST /api/hawaii/companies

Price: 5 credits

Get a Hawaii business's registry record from the DCCA Business Registration Division by its file number: exact entity name, business type, status, purpose, place and date of registration, principal and mailing addresses, any cross-reference names, term, registered agent (name and address), good-standing state, the annual filing history (year, date received, status), officers (name, office, titles, address, role), authorized stock (class, shares, paid shares, par value), registered trade names, trademarks and service marks (name, type, category, certificate number, registration and expiration dates, status), and other filings (date, description, remarks, transaction and form codes).

How to use it

Look up one Hawaii business by its DCCA file number (e.g. '100000D1', '1D2', '1000F1'; accepts a space before the suffix like '100000 D1'). Returns one item with file_number, name, legal_form, entity_type_code, status, purpose, place_of_formation, registration_date, principal_address, mailing_address, cross_reference_names, consent_name, term, agent_name, agent_address, is_commercial_registered_agent, is_in_good_standing, good_standing_message, annual_filings (filing_year, date_received, status), officers (name, office, office_titles, date, address, affiliation_type, role), stocks (date, stock_class, shares, paid_shares, par_value), trade_names (name, type, category, certificate_number, registration_date, expiration_date, status) and other_filings (date, description, remarks, transaction_code, form_code).

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• file_number string required — Hawaii DCCA business registry file number (examples: "100000D1", "1D2", "1000F1"; minLength: 1)

Response

• @type string (default: "HawaiiCompany")
• file_number string required
• name string nullable
• legal_form string nullable
• entity_type_code string nullable
• status string nullable
• purpose string nullable
• place_of_formation string nullable
• registration_date string nullable
• principal_address string nullable
• mailing_address string nullable
• cross_reference_names array (default: [])
• consent_name string nullable
• term string nullable
• agent_name string nullable
• agent_address string nullable
• is_commercial_registered_agent boolean nullable
• is_in_good_standing boolean nullable
• good_standing_message string nullable
• annual_filings array (default: [])
  • @type string (default: "HawaiiAnnualFiling")
  • filing_year integer nullable
  • date_received string nullable
  • status string nullable
• officers array (default: [])
  • @type string (default: "HawaiiOfficer")
  • name string required
  • office string nullable
  • office_titles string nullable
  • date string nullable
  • address string nullable
  • affiliation_type string nullable
  • role string nullable
• stocks array (default: [])
  • @type string (default: "HawaiiStock")
  • date string nullable
  • stock_class string nullable
  • shares string nullable
  • paid_shares string nullable
  • par_value string nullable
• trade_names array (default: [])
  • @type string (default: "HawaiiTradeName")
  • name string required
  • type string nullable
  • category string nullable
  • certificate_number string nullable
  • registration_date string nullable
  • expiration_date string nullable
  • status string nullable
• other_filings array (default: [])
  • @type string (default: "HawaiiOtherFiling")
  • date string nullable
  • description string nullable
  • remarks string nullable
  • transaction_code string nullable
  • form_code string nullable
• url string required

Errors

• 422 — The request body did not validate Check the fields against this schema. A URN with the wrong prefix is the most common cause.
• 408 — The request ran past its time limit 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 — No business found for the given file number 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 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 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 Wait at least 30 seconds, then retry.

Response 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.