Authentication

API key authentication identifies your organization using a static credential issued during provisioning. This method is commonly used for server-to-server integrations and batch enrichment pipelines.

How API Keys Work

An API key is automatically generated when your organization is created in SMARTe.
The key is scoped to your organization.
The same key applies across all SMARTe Enrich APIs.
API keys can be rotated or revoked.

Using an API Key

Include the API key in the request header:

apikey: YOUR_API_KEY

When to Use API Keys

Use API key authentication if you:

Integrate server-to-server
Run scheduled or batch enrichment jobs
Do not require token expiration or delegated access

Where to Find Your API Key

Obtain the API key required for API key–based authentication.
From your SMARTe workspace or onboarding materials
From your organization’s SMARTe administrator

API Key Security

Do not expose API keys in client-side applications
Do not commit API keys to public repositories
Rotate API keys periodically
Revoke compromised keys immediately

💡
API keys can be rotated or revoked at the organization level. If you need to rotate or regenerate an API key, contact your SMARTe administrator, or SMARTe Support.