Skip to main content

Test mode (this site)

Everything documented here - examples, the playground, your test API key - targets the test-mode environment:
  • Synthetic data only. Test journeys are flagged end-to-end and structurally excluded from settlement, reporting, and clinician-facing queues.
  • No live rails. Payment legs run in test mode only; a test journey can never charge a real card or ship a real order.
  • Test records are marked. Test-mode records are marked where they surface — a patient’s order view carries a Test order badge, and operator views mark test-mode records (with a banner on the onboarding view). The marking rides the individual record; there is no blanket watermark across every screen.
The test-environment base URL ($BASE_URL in the examples) is issued together with your test API key.

Production

Production access is not available through this site. Production credentials, the production base URL, and any production playground exposure are a later, separately-gated step in your onboarding - your onboarding contact owns that hand-off.

Versioning

The API is versioned under the /v1 path prefix. This reference is generated from the same contract artifacts the platform itself builds against, on every change - it cannot drift from the deployed API.