Skip to main content

Authentication

All SanctionsWise API requests require authentication using an API key.

Getting Your API Key​

Via AWS Marketplace​

  1. Subscribe to SanctionsWise API on AWS Marketplace
  2. Complete the registration flow
  3. Access your API keys at app.orchestraprime.ai

Direct Access​

Contact sales@orchestraprime.ai for direct API access.

Using Your API Key​

Include your API key in the x-api-key header with every request:

curl -X POST "https://api.orchestraprime.ai/sanctionswise/screen/entity" \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"name": "John Smith"}'

API Key Management​

Manage your API keys at app.orchestraprime.ai:

  • View keys - See all active API keys
  • Create keys - Generate new API keys
  • Rotate keys - Replace keys without downtime
  • Revoke keys - Immediately disable compromised keys
  • Usage stats - Monitor API call volume per key

Security Best Practices​

1. Never Hardcode API Keys​

Use environment variables or a secrets manager:

import os

API_KEY = os.environ.get("SANCTIONSWISE_API_KEY")
if not API_KEY:
    raise ValueError("SANCTIONSWISE_API_KEY environment variable not set")

2. Rotate Keys Regularly​

Rotate your API keys at least quarterly, or immediately if you suspect compromise.

3. Use Separate Keys per Environment​

Maintain separate API keys for:

  • Development
  • Staging
  • Production

4. Monitor API Key Usage​

Set up alerts for unusual patterns:

  • Unexpected spike in requests
  • Requests from new IP addresses
  • High error rates

Error Responses​

401 Unauthorized​

Missing or invalid API key:

{
  "message": "Unauthorized"
}

Solution: Verify your API key is correctly included in the x-api-key header.

403 Forbidden​

API key lacks permission or is revoked:

{
  "message": "Forbidden - Invalid API key"
}

Solution: Check your API key status at app.orchestraprime.ai.

Rate Limits by Tier​

API keys are associated with subscription tiers that determine rate limits:

TierRate LimitBurst LimitDaily Quota
Free1/sec5500
Starter5/sec205,000
Professional25/sec10025,000
Enterprise50/sec200100,000+

See Rate Limits for more details.

Support​

Having trouble with authentication? Contact support@orchestraprime.ai.