🔑Subscriber Credentials (AI)

Associate usage with specific API key or other credentials

Credentials contain unique identifiers used by subscribers to access services. You can choose the unique ID to be used by setting the subscriber_credential_value parameter in Revenium's middleware. In many cases it will be the email address of the subscriber, but it could also be an alias for different API keys used by internal developers or external customers. You can provide a label for the subscriber credential as well using subscriber_credential_name if you wish to store an alias for the credential.

In general, we do not recommend you send Revenium the actual API key value, but instead use a friendly name or alias for each key.

---

Example Scenarios

Internal Business Unit:

BrightHealth's clinical team uses multiple shared terminals. Each terminal is issued a unique API credential for accountability and audit logging.

• Subscriber: [email protected]

• Credential Name: "EHR Key – Nurse Station A"

• Credential Value: "pk-ehra57"

• Organization: brighthealth-clinops

Credentials allow BrightHealth to understand where and how requests originate, even when shared across multiple users or devices.

External SaaS Customer:

FinPilot customers often use multiple applications or automated systems to access the platform.

For ACME Bank:

• Subscriber: [email protected]

• Credential Name: "ACME - Portfolio Risk Tool"

• Credential Value: "pk-acme-risk01"

• Organization: acme-bank

FinPilot can segment usage based on tool or integration and tie billing to specific credentials. This also allows them to detect anomalies (e.g., surging usage tied to a single tool).