Whole-platform ledger view — every tenant's position and health (global admin only)
One row per tenant with its user count, 30-day movement, treasury float, outstanding liabilities and whether its books net to zero, plus totals per currency.
/v1/platform/overviewOne row per tenant with its user count, 30-day movement, treasury float, outstanding liabilities and whether its books net to zero, plus totals per currency. Amounts are minor units of each tenant's own currency and are never summed across currencies.
Authorization
bearerAuth A tenant API key (sk_{env}_{id}_{secret}), a wallet user token, or an IdP access token. Which principal the credential resolves to decides the scopes it carries; see the authentication guide.
In: header
Response Body
application/json
application/problem+json
application/problem+json
application/problem+json
curl -X GET "https://example.com/v1/platform/overview"{ "tenants": [ { "tenant": { "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "name": "string", "currency": "string", "status": "string", "fees": { "payment": { "bps": 0, "flat": 0, "min_fee": 0, "max_fee": 0 }, "subscription": { "bps": 0, "flat": 0, "min_fee": 0, "max_fee": 0 }, "commission": { "bps": 0, "flat": 0, "min_fee": 0, "max_fee": 0 }, "p2p": { "bps": 0, "flat": 0, "min_fee": 0, "max_fee": 0 }, "topup": { "bps": 0, "flat": 0, "min_fee": 0, "max_fee": 0 }, "payout": { "bps": 0, "flat": 0, "min_fee": 0, "max_fee": 0 } }, "commission_mode": "deduct", "created_at": "2019-08-24T14:15:22Z" }, "users": 0, "transactions_30d": 0, "volume_30d": 0, "treasury": 0, "user_cash": 0, "merchant_settlement": 0, "subscriptions_active": 0, "balanced": true } ], "totals": [ { "currency": "string", "tenants": 0, "users": 0, "transactions_30d": 0, "volume_30d": 0, "treasury": 0, "user_cash": 0, "merchant_settlement": 0 } ], "as_of": "2019-08-24T14:15:22Z"}Per-tenant health snapshot — balances, fee plan, ledger invariants (platform staff only)
The tenant's balance rollup by owner type, purpose and commodity, plus the one invariant a caller can check without holding the books: every commodity must net to zero across the whole ledger.
Ecosystem clients across all tenants, the review queue (global admin only)
Ecosystem clients across every tenant — the moderation queue.