Rate Limits

The screening API implements rate limiting to ensure fair usage and system stability. You can check your current rate limit status using the rate limit endpoint.

Get Rate Limit Information

curl --location 'https://api.enigma.com/evaluation/sanctions/_rate_limit' \
--header 'x-api-key: <YOUR API KEY>'

Response

{
  "billing_pricing_plan": "enterprise",
  "billing_account_id": "acct-123456",
  "organization_id": "org-789012",
  "rate_limit_info": {
    "requests_remaining": 950,
    "requests_limit": 1000,
    "window_reset_seconds": 3600
  }
}

Response Fields

Field	Description
billing_pricing_plan	Your account's pricing plan
billing_account_id	Your billing account identifier
organization_id	Your organization identifier
rate_limit_info.requests_remaining	Number of requests remaining in current window
rate_limit_info.requests_limit	Total requests allowed per window
rate_limit_info.window_reset_seconds	Seconds until the rate limit window resets

Handling Rate Limits

When rate limits are exceeded, the API returns a 429 Too Many Requests status code with a Retry-After header indicating when you can retry.

Best Practices

1. Monitor usage: Periodically check the rate limit endpoint to monitor your usage
2. Implement backoff: When receiving a 429 response, wait for the Retry-After duration before retrying
3. Batch efficiently: Use batch processing for high-volume needs instead of many individual requests
4. Cache results: Cache screening results where appropriate to reduce redundant requests

Rate Limit Headers

Rate limit information is also included in response headers:

Header	Description
X-RateLimit-Limit	Total requests allowed per window
X-RateLimit-Remaining	Requests remaining in current window
X-RateLimit-Reset	Unix timestamp when the window resets
Retry-After	Seconds to wait before retrying (only on 429 responses)