Skip to main content

Overview

The Risk Cloud API uses OAuth 2.0 for authentication with bearer tokens in the Authorization HTTP header. Tokens expire after one year and must be regenerated. You can create multiple named Access Keys for different use cases instead of sharing a single token — see Service Accounts for why that matters at scale.

Retrieving your Access Key

Access keys are managed from your Profile page: Person icon → Profile → Access Key tab (requires API privileges). The Client ID is shown directly; the Secret is never shown again but can be reset.

Creating multiple Access Keys

Named Access Keys can be created directly in Risk Cloud:
  1. Enter a name identifying the use case (up to 100 characters).
  2. Click Create Access Key.
  3. Copy the access key and refresh token immediately — they’re shown only once.
  4. Store the credentials in your secrets manager.
Each key can be independently revoked without affecting others. There’s no fixed limit on the number of Access Keys.

Creating an Access Key from Client ID and Secret

  1. Get your Client ID from the Access Key tab.
  2. Reset your Secret Key to generate credentials.
  3. Base64-encode {CLIENT}:{SECRET}:
  1. POST /api/v1/account/token with Authorization: Basic {ENCODED_BASE64_STRING}:
Use the returned access_token as your bearer token.

Managing Access Keys via API

Creating an Access Key requires a JSON body with a name field; the response returns metadata with tokens displayed once.

Token lifecycle

To manually revoke your default token: DELETE /api/v1/account/token.

Best practices

  • Give each use case its own Access Key. A compromised key can be revoked independently.
  • Cache tokens for the full year. Store generated tokens in a secrets manager and reuse them — don’t call the token endpoint on every request.
  • Handle 401 with one retry. Refresh the token and replay the request once; persistent failures usually mean another service regenerated the credentials.
  • Rotate the Client Secret on a schedule. Quarterly, or immediately on suspected exposure — update your secrets manager first, then regenerate.
  • Never commit credentials to source control or container images.

Next steps

With a valid bearer token, continue to the API Reference or the Postman guide.