<aside> 🔐

API Keys let your own systems send transactions to HOST (and read them back) through the HOST Transactions API instead of uploading files. There are two environments: Development keys for building and testing, and Production keys for live data. Production keys require a one-time data review by HOST.

</aside>

Where this lives

Sidebar → Help & Tools → API Keys — managers only; the entry is hidden from everyone else, and the page itself says "API keys can only be viewed and created by organization managers." It opens on the Development tab (/api-keys/dev); Production is /api-keys/prod. API reference: the API overview link in the page header opens the HOST Transactions API Overview, and the View Docs link on an issued key opens that environment's own endpoint reference.

Development vs Production

Aspect Development Production
Data Test data only — never touches live filings Your real transaction data
Availability Immediately After HOST approves a data review
Handling Safe to share with engineers and keep in staging configs Treat like a password; never commit to source control; rotate if exposed

The two environments are entirely separate services — a key from one is unknown to the other.

Creating a key

The Development tab: the create form (name and scopes) and the Issued Development Keys table.

The Development tab: the create form (name and scopes) and the Issued Development Keys table.

  1. Enter a Name (for example Acme Corp — Production Integration).
  2. Tick the scopes the integration needs: Write transaction (write:transaction) and/or Read transaction (read:transaction).
  3. Click Create development key / Create production key.
  4. Copy the key now. It's shown once and can't be retrieved later. The list below shows only its prefix.

Production data review

The Production tab before approval: the Data review required card replaces the create form.

The Production tab before approval: the Data review required card replaces the create form.

Before issuing production keys, HOST reviews your transaction data to confirm it's ready to file against. This happens once per organization.

  1. On the Production tab, under Data review required, choose the period we should look at (start and end dates) and add any notes about your data or systems.
  2. Click Request data review. You'll see "Data review requested. We'll email you when it's decided."
  3. The status strip shows In review, then Approved (the create form appears) or Changes requested with a reviewer note. If changes are requested, address them and request again; a short cooling-off period applies between requests.

Issued keys