For AI agents: a documentation index is available at https://docs.coverbase.com/llms.txt. This page is also available in markdown by appending .md to the URL.
Your Coverbase representative turns on the third-party lifecycle features, including OAuth clients, for your organization.
ak_* key can use the OAuth 2.0 client credentials grant instead. An admin creates an OAuth client: a public client_id and a client_secret shown once. The integration trades them for a bearer token that lasts at most an hour, and sends that token wherever an ak_* key goes.
A token acts exactly like an ak_* key: it authenticates as your organization’s API service account, every public route and the IP allowlist apply unchanged, and its calls are recorded in the public API audit log. It carries the elevated scopes the client was granted, or fewer if the token request narrows them.
For a walkthrough, see OAuth 2.0 client credentials.
Get a token
Follows RFC 6749 section 4.4. The body is form-encoded (application/x-www-form-urlencoded), not JSON. Send the client ID and secret as HTTP Basic credentials (preferred), or as client_id and client_secret form fields, but not both.
Request body
Space-separated scopes to request. Optional. It can only narrow what the client was granted: asking for a scope the client does not hold fails with
invalid_scope. Omit it to get every scope the client holds.Example request
cURL
Example response
Cache-Control: no-store. Send the token as Authorization: Bearer cbat_... until expires_in seconds pass, then request a new one. A client holds at most 50 live tokens. Requesting a 51st revokes its oldest, so an integration should reuse a token until it expires rather than request one per call.
Errors
Errors follow RFC 6749 section 5.2, not the coded envelope:List clients
Returns{ "clients": [ ... ] }, one client object per client, revoked ones included. Secrets are never returned.
Create a client
Returns201 Created with the client object plus client_secret. This is the only time the secret is returned. Coverbase stores only its SHA-256 digest and last four characters.
Elevated scopes to grant:
keys:manage, audit:read, banking:read, review:sensitive_changes. Granting any needs an admin dashboard JWT; any other caller gets 403 scope_grant_forbidden. Omit for a client with standard access.cURL
Revoke a client
Revokes the client and deletes every token it issued. Returns the client object withrevoked_at set. A server that already cached a token can keep accepting it for a few seconds. Creating and revoking clients are recorded in the activity log.