Authentication

All API requests require authentication via a partner API key, provided during onboarding by your Lumen contact.

Include the key in every request as a header:

X-Partner-Api-Key: YOUR_API_KEY

All traffic must be over TLS 1.2 or higher.

Environments

You will receive two API keys during onboarding, along with their respective base URLs:

• Sandbox, for integration testing. Data submitted here is non-production and may be reset periodically.
• Production, for live data. Use only after your sandbox integration is verified.

The two keys are independent. Sandbox keys do not work against production, and vice versa.

Key handling

• Treat the API key as a secret. Do not commit it to source control or expose it in client-side code.
• If you suspect a key has been compromised, contact your Lumen integration manager to rotate it.