API overview

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/v1

WebSocket events use:

text
wss://brosettlement-staging-api.brolabel.io/v1/ws

API surface

AreaOperationsPurpose
Assets1Discover supported chains, assets, token standards, and availability
Ledger accounts6Create accounts and read their wallets, balances, and transactions
Wallets and balances5Create or list wallets and inspect balance projections and journal entries
Transactions3Create withdrawals and read transaction state
MPC2Initialize the organization key and inspect readiness
MPC Co-Signer5Claim intents, exchange protocol messages, and report results
Audit Logs1Search 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-Id
  • X-Api-Timestamp
  • X-Api-Nonce
  • X-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

ScopeUsed for
wallets:readAssets, wallets, wallet/account balances, and wallet journal entries
wallets:createWallet and ledger-account creation
accounts:readLedger-account listing and detail
transactions:readTransaction listing and detail
withdrawals:createOutgoing transaction creation
mpc:initializeMPC initialization
mpc:readMPC status
mpc:rawCo-Signer protocol operations
audit-logs:readOrganization audit logs
websockets:readWebSocket events

Use separate API keys for independent services and grant only the scopes each service requires.

Endpoint index

MethodPathScope
GET/api/v1/assetswallets:read
GET, POST/api/v1/ledger/accountsaccounts:read or wallets:create
GET/api/v1/ledger/accounts/{accountId}accounts:read
GET/api/v1/ledger/accounts/{accountId}/walletswallets:read
GET/api/v1/ledger/accounts/{accountId}/balanceswallets:read
GET/api/v1/ledger/accounts/{accountId}/transactionstransactions:read
GET, POST/api/v1/walletswallets:read or wallets:create
GET/api/v1/wallets/{walletId}wallets:read
GET/api/v1/wallets/{walletId}/balanceswallets:read
GET/api/v1/wallets/{walletId}/ledger-entrieswallets:read
GET, POST/api/v1/transactionstransactions:read or withdrawals:create
GET/api/v1/transactions/{id}transactions:read
POST/api/v1/mpc/initializempc:initialize
GET/api/v1/mpc/statusmpc:read
GET, POST/api/v1/co-signer/...mpc:raw
GET/api/v1/orgs/{orgId}/audit-logsaudit-logs:read