<aside>
🎯
When to use this — your developers will send transactions to HOST through the API instead of monthly file uploads, and need a key for testing (Development) or for live data (Production).
</aside>
Before you start
- [ ] You're a Manager of the organization (the API Keys page is managers only)
- [ ] A name for the key that says which system will use it
- [ ] Which scopes it needs: Write transaction, Read transaction, or both
- [ ] For Production: the date range of transaction data HOST should review, and a note about the systems involved
- [ ] Somewhere safe to store the key (a secrets manager, not a chat message)
Steps — development key
- Sidebar → Help & Tools → API Keys (opens on Development).
- Enter a Name, tick the scopes, click Create development key.
- Click Copy and store the key. It's shown once.
Steps — production data review
- Switch to the Production tab.
- Under Data review required, set the Start date and End date of the period to review and add any notes.
- Click Request data review. The status strip shows In review.
- Wait for HOST's email. Approved unlocks the create form; Changes requested shows a reviewer note to act on before requesting again.
Steps — production key
- On the Production tab (once approved), enter a Name, tick scopes, click Create production key.
- Copy and store the key immediately.