API Keys

API keys are unique data strings used to authenticate a user and enable access to privileged operations on Circle APIs. All Circle APIs use API keys as the mechanism to authenticate client requests. Your API key should be kept confidential and secure at all times.

• Authentication is required for all API requests; without it, the requests will fail.
• All API requests must be made over HTTPS.

Use the Developer Dashboard to access and manage the API keys for your entity. Go to the Circle Mint developer dashboard and click on the API Keys tab to create, view, edit, and revoke API keys. You must be logged into the production or sandbox Developer Dashboard and be an Administrator to access the API keys page:

• Production: https://app.circle.com/developer
• Sandbox: https://app-sandbox.circle.com/developer

Note: By default, Circle disables all product APIs in Production. Please see Circle APIs: Sandbox to Production Transition Guide for more instructions on how to enable access to product APIs.

Circle API supports two types of API keys:

• Standard keys provide the permissions to use any of Circle APIs for which your entity has subscribed service.
• Restricted keys limit access to the product role you select during key generation.

Log into Circle Mint → Developers → API keys, then:

1. Select "create an API key"
2. Enter Name
3. Provide IP addresses for IP allowlist [OPTIONAL]
4. Select "create API key"
5. Copy API key
6. Close the dialog

Log into Circle Mint → Developers → API keys, then:

1. Select the ellipses on the API key you want to view
2. Select view details

Log into Circle Mint → Developers → API keys, then:

1. Select the ellipsis on the API key
2. Select edit
3. Change name
4. Change IP Allowlist IPs
5. Select save

Log into Circle Mint → Developers → API keys, then:

1. Select the ellipsis on the API key
2. Select delete
3. Type in DELETE
4. Select delete button

WHAT'S NEXT

• Authentication
• Sandbox & Production Environments