Authentication
Every request must carry anAuthorization: Bearer <token> header.
401 invalid_token_format.
Key format
New keys use the formatck_live_<prefix>_<secret>.
Keys issued earlier in the format
cope_sk_live_<key_id>_<secret> keep working unchanged. You do not need to replace them.
Live keys produce real side effects. Test-mode keys are reserved for a future test mode and are not accepted yet.
Getting a key
- Sign in to the COPE vendor dashboard.
- Open Settings → API Keys.
- Click Create API key, give the key a name, and copy the secret token that appears.
- The secret is shown only once — store it securely. It cannot be retrieved later.
Read-only keys
A key is created with Full access or Read only, and keeps it: to change it, create a new key. A read-only key can make every read its creator can make through the public API. Every write it sends answers403 insufficient_scope and changes nothing. Use one for reporting, exports and AI assistants. See API key integrations.
Rotation and revocation
- Issue a new integration, switch the client to the new key, then deactivate the previous one from the same dashboard view.
- Deactivated and deleted keys stop authenticating within 60 seconds.
- Keys are scoped to one business. Use separate integrations for separate businesses rather than sharing a key across them.