Skip to content

API Authentication

Last updated: March 19, 20265 min readIntermediateDeveloper

All Arqam360 API endpoints require authentication via API keys. This guide covers creating keys, setting headers, and handling rate limits.

Creating an API Key

1

Go to Settings > API Keys

Navigate to the API Keys section in your dashboard.

2

Click 'Create New Key'

Provide a name and select the key scope (read-only or full access).

3

Copy your key

Copy the key immediately — it won't be shown again.

Authentication Headers

javascript
curl -X GET https://api.arqam360.com/api/v1/consent/records \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json"

Rate Limits

  • 100 requests per minute per API key
  • 1,000 requests per hour per API key
  • Rate limit headers: X-RateLimit-Limit, X-RateLimit-Remaining, X-RateLimit-Reset

Error Responses

javascript
// 401 Unauthorized — Invalid or missing API key
// 429 Too Many Requests — Rate limit exceeded
// 403 Forbidden — Key doesn't have required scope
Never expose your API key in client-side code. Use it only in server-to-server requests.

Next Steps

Was this article helpful?