Authentication

Secure your OmniAPI requests with an API key. Include the X-API-Key header with every request.

API key

Every request must include your API key in the X-API-Key header:

curl -H "X-API-Key: omni_live_abc123..." \
  "https://api.omnizoek.nl/v1/finance/iban-to-bic?iban=NL99INGB0001234567"

Key format

PrefixEnvironmentBilled?
omni_live_ProductionYes — Stripe metered billing
omni_test_SandboxNever

Test keys return real responses but are never metered.

Getting a key

During beta, email us and we'll generate your key within a few hours. Automated sign-up via Stripe is coming soon.

Local development

Start the API with auth disabled so you don't need a key on your machine:

cd omni-api
make run
# sets OMNI_API_KEY_DISABLED=true automatically

The playground at http://localhost:3000/playground also works without a key when the API is running in dev mode — just leave the API key field empty.

Rate limits

  • 120 requests per minute per IP (sliding window)
  • Exceeding this returns 429 Too Many Requests with a Retry-After header

On this page