Test vs live

Sandbox test keys vs live production keys for the Partner API.

Partner API keys are issued in two environments: test (sandbox) and live (production). The key prefix (clfy_test_* or clfy_live_*) determines which environment your requests run in.

Behavior matrix

Test key (clfy_test_*)Live key (clfy_live_*)
HostWorks on staging and production hostsProduction (or staging with live data)
DataDeterministic sandbox / fake payloadsReal tenant database
MutationsSimulated IDs; no real ledger or payment railsReal services; soft-delete + audit
Portal X-Client-IdOptional (fixtures)Required

When to use test

  • Exploring the API and Postman collections
  • CI smoke tests
  • UI demos without touching real borrowers

When to use live

  • Production partner integrations after UAT
  • Real disbursements and repayments
  • Webhook delivery against real events

Switching

  1. Keep separate keys for test and live. Never reuse a test secret in production code paths.
  2. Point the same base URL path at your tenant; only the key prefix changes behavior.
  3. Confirm environment via GET /ping or GET /me (data.environment).

Going live checklist

  1. Complete flows with a test key.
  2. Generate a live key with minimal scopes.
  3. Update server-side config only.
  4. Monitor rate limits and audit logs.
  5. Rotate on a schedule or after staff changes.