Skip to main content

Authentication

Partner calls use API keys, not end-user login tokens.

Header format

Authorization: Bearer dk_live_<key_id>.<secret>

Test keys use the dk_test_ prefix instead of dk_live_.

PartMeaning
dk_live_ / dk_test_Environment prefix
key_idPublic identifier (shown in Admin → Developers)
secretPrivate secret (shown once at creation)

Managing keys

Client and case-manager organisations manage keys under Admin → Developers. Keys are scoped to that organisation. Revoking a key takes effect immediately.

Environments

Use test keys against non-production Dimmi environments. Live keys are rejected when the deployment environment does not match.

Rate limits

Each key has a per-minute rate limit (default 60). Exceeding it returns a standard error response; back off and retry.