Get Health
GET /health
Authorizations
Paste your Connect API key (sk_live_… for production, sk_test_… for sandbox) without the Bearer prefix. Mint and rotate keys from the admin panel.
Response
Successful Response
Auth-check response for /connect/v1/health.
/health is the canonical "is my key valid + which env" probe.
Partners poll on app startup and on a schedule (for the
key_expires_at rotation reminder).
Always ok when this endpoint returns 200. We do NOT surface per-subsystem health here -- partners shouldn't tune retries on our DB health -- so the field is binary: either the call succeeded (200 + status='ok') or it failed (4xx/5xx envelope).
"ok"
Which environment the calling key authenticates. live for sk_live_… keys, sandbox for sk_test_…. Branch on this in mode-aware code (e.g. don't credit a real merchant balance for mode='sandbox').
"live"
UUID of the organization the key authenticates. Echo into your own logs so multi-org partners can confirm they hit the intended tenant.
"8c3f1d4a-1e22-4b6f-9a72-9d4eb6c20fce"
Connect API version. Currently always v1; bumps in coordination with breaking schema changes.
"v1"
ISO-4217 codes for the fiat currencies the org has enabled (drives which valuations show up on /balances). Defaults to ['USD'] when no per-org config exists.
ISO-8601 timestamp at which the calling key expires, or null when the key has no expiry set. Poll on a schedule (e.g. daily) to build proactive rotation tooling -- the alternative is waiting for the 401 expired_credential response when the key has already lapsed.
"2026-09-01T00:00:00Z"