Skip to main content

Reference

API Key Management

Create, list, revoke, and inspect usage of API keys programmatically.

Most developers manage keys through the dashboard at app.finorabusiness.com/settings/api-integrations. These endpoints are for the small number of callers who need programmatic key management — for example, issuing a short-lived key per customer in a multi-tenant SaaS.

List your keys

GET/v1/api-keys

Returns metadata for every active key on your account.

Response — 200

{
  "success": true,
  "data": {
    "keys": [
      {
        "keyId": "key_abc",
        "keyPrefix": "live_sk_629c",
        "keyLastFour": "ef36",
        "name": "WooCommerce Production",
        "environment": "live",
        "isActive": true,
        "createdAt": "2026-03-20T09:15:00.000Z",
        "lastUsedAt": "2026-04-17T10:29:00.000Z",
        "totalCalls": 1842,
        "expiresAt": "2026-06-18T09:15:00.000Z"
      }
    ]
  }
}

Raw key strings are never returned — only prefix, last four characters, and metadata. If you lost the plaintext, revoke and create a new one from the dashboard.

Revoke a key

DELETE/v1/api-keys/{keyId}

Instantly disables a key. Future requests with it return 401 INVALID_API_KEY.

Example

curl -X DELETE "https://api.finorabusiness.com/v1/api-keys/key_abc" \
  -H "Authorization: Bearer $FINORA_API_KEY"

Revocation is permanent — revoked keys cannot be reactivated.

Usage stats

GET/v1/usage

Returns total calls, trial status, and current credit balance.

Response — 200

{
  "success": true,
  "data": {
    "mode": "credits",
    "trialCallsUsed": 100,
    "trialCallsRemaining": 0,
    "creditsBalanceKobo": 450000,
    "creditsBalance": 4500,
    "totalCallsThisMonth": 1230,
    "totalCallsAllTime": 8415,
    "lastCallAt": "2026-04-17T10:29:12.483Z"
  }
}

When mode === 'trial', trialCallsRemaining tells you how many free calls are left. When mode === 'credits', watch creditsBalanceKoboINSUFFICIENT_CREDITS kicks in at zero.

Rotating keys before the 90-day expiry

Dashboard-generated keys expire 90 days after creation. To rotate:

  1. Create the new key in the dashboard.
  2. Deploy the new key to your integration.
  3. Verify traffic is using the new key (check this module's usage endpoint).
  4. DELETE the old key here — clean cut-over with zero downtime.

Related endpoints

Reference index

Back to all modules