Security & API Auth

API Authentication

Intellectua uses secure SHA-256 hashed API keys to authenticate your REST API and eFax webhook requests. You can generate and rotate keys in your clinical dashboard under Settings > API & Webhooks.

API Key Structure

We provide secret keys (intel_live_... or sk-intel_...) that must be kept confidential. These keys grant access to your organization's documents, outbound faxes, and metadata.

HIPAA Best Practices

Never share your API keys in client-side code, public repositories, or unsecured environments. Always use environment variables on your backend servers.

Using your API Key

All API requests must include your API key in the x-api-key HTTP header (or as Authorization: Bearer <key>).

cURL Example
REST API v1
curl -X GET "https://api.intellectua.ai/v1/documents" \
  -H "x-api-key: intel_live_9f8e7d6c5b4a3a2b1c..." \
  -H "Content-Type: application/json"

Authentication Error Codes

If authentication fails, the API returns a 401 Unauthorized response with a structured JSON error:

missing_api_key

No API key was supplied in the x-api-key or Authorization header.

invalid_key_format

The provided API key is malformed or has an invalid prefix.

revoked_or_invalid_key

The API key does not match any active organization key or has been revoked.

expired_key

The API key has passed its designated expiration timestamp.

Ready to secure your integration?

Generate and manage your production and sandbox API keys directly in the clinical dashboard.

Generate API Key