Skip to main content
Most tenant-scoped requests include X-Tenant-Id to identify which of your customers the request is for: 
X-Tenant-Id: <tenantExternalId>
Tenants are created automatically on first request. No pre-registration needed. Billing happens at the integrator level (your organization), not per-tenant.

​
What tenants provide

  • Data isolation: Scores, criteria, and question sets scoped per tenant
  • Per-customer metrics: Usage, success rates, and costs broken down by customer
  • Queryability: Filter API responses and reports by tenant

​
Choosing a tenant ID

Use a stable, unique identifier that won’t change: your internal customer/account ID, a UUID, or their unique slug. Avoid: customer names, email addresses, or sequential integers.

​
Requests without a tenant header

Some endpoints are scoped by your API key and environment instead of X-Tenant-Id:
  • DELETE /v1/tenants/{tenantExternalId} uses the tenant external ID in the path.
  • GET /v1/deletion-requests/{deletionRequestId} uses the deletion request ID.
  • GET /v1/rate-limit-status returns partner-level rate-limit state.
  • Analytics endpoints return partner-level analytics with tenant breakdowns where available.
Sandbox and production have separate tenant namespaces. The same tenant ID in sandbox vs production points to different isolated data stores.