Get started
API overview
The BroSettlement Integration API provides organization-scoped access to assets, ledger accounts, wallets, balances, transactions, MPC, Co-Signer transport, and audit logs.
Base URL and version
All documented REST endpoints use the /api/v1 prefix:
text
https://brosettlement-staging-api.brolabel.io/api/v1WebSocket events use:
text
wss://brosettlement-staging-api.brolabel.io/v1/wsAPI surface
| Area | Operations | Purpose |
|---|---|---|
| Assets | 1 | Discover supported chains, assets, token standards, and availability |
| Ledger accounts | 6 | Create accounts and read their wallets, balances, and transactions |
| Wallets and balances | 5 | Create or list wallets and inspect balance projections and journal entries |
| Transactions | 3 | Create withdrawals and read transaction state |
| MPC | 2 | Initialize the organization key and inspect readiness |
| MPC Co-Signer | 5 | Claim intents, exchange protocol messages, and report results |
| Audit Logs | 1 | Search an organization-scoped operational audit trail |
The current Swagger contains 19 paths and 23 REST operations.
Authentication
REST requests use an Ed25519 API key. Every operation requires:
X-Api-Key-IdX-Api-TimestampX-Api-NonceX-Api-Signature
Mutating operations that send a body also require X-Api-Body-Hash. Some operations require X-Idempotency-Key. See API authentication and API conventions.
Required scopes
| Scope | Used for |
|---|---|
wallets:read | Assets, wallets, wallet/account balances, and wallet journal entries |
wallets:create | Wallet and ledger-account creation |
accounts:read | Ledger-account listing and detail |
transactions:read | Transaction listing and detail |
withdrawals:create | Outgoing transaction creation |
mpc:initialize | MPC initialization |
mpc:read | MPC status |
mpc:raw | Co-Signer protocol operations |
audit-logs:read | Organization audit logs |
websockets:read | WebSocket events |
Use separate API keys for independent services and grant only the scopes each service requires.
Endpoint index
| Method | Path | Scope |
|---|---|---|
GET | /api/v1/assets | wallets:read |
GET, POST | /api/v1/ledger/accounts | accounts:read or wallets:create |
GET | /api/v1/ledger/accounts/{accountId} | accounts:read |
GET | /api/v1/ledger/accounts/{accountId}/wallets | wallets:read |
GET | /api/v1/ledger/accounts/{accountId}/balances | wallets:read |
GET | /api/v1/ledger/accounts/{accountId}/transactions | transactions:read |
GET, POST | /api/v1/wallets | wallets:read or wallets:create |
GET | /api/v1/wallets/{walletId} | wallets:read |
GET | /api/v1/wallets/{walletId}/balances | wallets:read |
GET | /api/v1/wallets/{walletId}/ledger-entries | wallets:read |
GET, POST | /api/v1/transactions | transactions:read or withdrawals:create |
GET | /api/v1/transactions/{id} | transactions:read |
POST | /api/v1/mpc/initialize | mpc:initialize |
GET | /api/v1/mpc/status | mpc:read |
GET, POST | /api/v1/co-signer/... | mpc:raw |
GET | /api/v1/orgs/{orgId}/audit-logs | audit-logs:read |