Guide
Tenants
How your customers map to Aiviue tenants and the X-Tenant-ID header.
A tenant is one of your customers — the employer you are hiring for. Each tenant has its own jobs, candidates and usage inside Aiviue, and one partner account can manage several tenants.
The X-Tenant-ID header
Send the tenant on every resource request:
X-Tenant-ID: <tenant id>
The value is the Aiviue tenant ID we give you when a tenant is set up — not an ID from your own system. Store the mapping between your customer and its Aiviue tenant ID on your side.
Requests that don't need a tenant:
POST /v1/auth/token,POST /v1/auth/token/revoke,GET /v1/auth/.well-known/jwks.jsonGET /v1/integration/healthandGET /v1/integration/health/detailed
Errors
| Situation | Status | error.code |
|---|---|---|
| Header missing | 400 | VALIDATION_ERROR (with field: "X-Tenant-ID") |
| Tenant ID not found | 404 | NOT_FOUND |
| Tenant belongs to a different partner | 403 | FORBIDDEN |
Your own IDs
Your IDs live in the request bodies, not in headers. For example external_job_id on a job is your stable job
ID, and external_client_id can carry your own customer reference.