All requests to the Acclaim API require authentication using an API key. API keys are used to identify and authorize requests made by your organization. You can create and manage your API keys in the Acclaim Console under Settings → Developers → API Keys.Documentation Index
Fetch the complete documentation index at: https://docs.withacclaim.com/llms.txt
Use this file to discover all available pages before exploring further.
API Keys
Acclaim provides two types of keys:| Type | Usage | Example |
|---|---|---|
| Secret key | Used for server-side API requests. Must be kept private. | sk_live_ABC123... |
| Publishable key | Used in client-side integrations (for example, embeddable payee forms). | pk_live_DEF456... |
Authorization Header
Include your secret API key as a Bearer token in theAuthorization header when making requests:
Text
Environment
The same API endpoint is used for both sandbox and production requests:Text
sk_test_, while live keys begin with sk_live_.
Example
cURL
Best Practices
- Rotate API keys periodically.
- Limit key permissions to only what’s required.
- Revoke unused keys immediately.
- Never embed secret keys in client-side or mobile applications.