Skip to main content
GET /api/v1/health is the go/no-go source for partner UI state.

​
Flags

FlagMeaning
ready.displayProduct state can be displayed
ready.historyChart and history data are fresh enough
ready.activityActivity and redeem lifecycle data are fresh enough
ready.operationsKeeper-dependent operations are confirmed healthy
ready.depositsNative deposits can be shown and quoted
const canShowProduct = health.ready.display;
const canShowHistory = health.ready.history;
const canShowActivity = health.ready.activity;
const canShowDeposit = health.ready.deposits;
Withdraw UI should stay visible when live vault reads are available, but the specific instant, queued, claim, cancel, and fulfill actions must still be built through the server action endpoints because they precheck live state.

​
Reason codes

Common reason codes include:
  • KEEPER_HEARTBEAT_NOT_FRESH
  • KEEPER_HEARTBEAT_INVALID
  • KEEPER_HEARTBEAT_UNHEALTHY
  • KEEPER_ROLES_INVALID
  • DEPOSITS_PAUSED
  • INDEXER_NOT_FRESH
  • SNAPSHOT_UNAVAILABLE
  • VAULT_READ_UNAVAILABLE
  • KEEPER_WIRING_INVALID
  • CACHE_FALLBACK
Use reason codes for deterministic partner UI copy. Do not parse raw error messages.