API Keys
Create and manage API keys to access your Superstate data programmatically.
API keys let you read your Superstate balances and transactions programmatically.
Who can manage keys
Admin
Yes
Yes
Operator
Yes
No
Viewer
Yes
No
Create an API key
Sign in and go to Settings → Developer.
If prompted, click Verify with 2FA. Two-factor verification is required to create or revoke keys.
Click Create API key and fill in:
FieldWhat to enterName
Something memorable, e.g.
Treasury reconciliationPermission
Issuer Roles:
View Instrument: read your fund's transactions and shareholders
Manage Instrument: create shareholders and record subscriptions and redemptions
Investor Roles:
Read balances: query entity and subaccount balances Read transactions: list transactions and their status
Scope
All entities in your organization, or a single entity
Click Create API key.
Copy the API key and API secret, then click Done.
Each key has one permission. To read both balances and transactions, create two keys.
Manage your keys
The Developer tab lists every key you have access to, with its name, permission, and when it was last used. Use the search bar to find a key by name or key value, or filter the list by permission. Keys that have expired are marked Expired.
Open a key's Actions menu to:
Details: view the key's name, permission, scope, and API key, plus who created it, when, its status (Active or Expired), and when it was last used. The secret is never shown again after creation.
Duplicate key: open a new key form pre-filled with the same name (with "(copy)" added), permission, and scope. Duplicating creates a new key with a new secret; the original keeps working.
Revoke key: permanently disable the key. It stops working immediately, and this cannot be undone.
Rotating a key? Duplicate it, update your integration with the new key and secret, then revoke the old one.
Last updated