Skip to Content

Authentication

How to send your API key with every request, and how keys are made and revoked.

Every request carries your key as a Bearer token.

Authorization: Bearer cs_live_...
  • One key, one company. A key always acts for the company it was issued to. You never send a company name or id; we take it from the key.
  • Keys look like cs_live_ followed by 43 letters, digits, _ or -. The first 12 characters (for example cs_live_Ab3d) are the key's prefix. It is safe to log, and GET /api/v1/me returns it, so you can tell keys apart without exposing them.
  • We only store a fingerprint of your key, not the key itself. If you lose it, we cannot show it again: make a new key and revoke the old one yourself.
  • Keys can be revoked at any time. A missing, revoked or expired key gets 401 unauthorized.

Making and revoking keys

Your company makes and revokes its own keys in Settings → Developer on the platform. See Create a key. If the Developer tab is not shown, the API is not switched on for your company yet. Your CharpstAR contact switches it on.

Check a key

GET/api/v1/meany valid key

The answer names your company, the key's prefix and its scopes. See Scopes for what each scope allows.

On this page