Skip to content

Authentication Overview

Last updated: Phase 8.5

ValidonX supports two authentication methods depending on your use case:

MethodUse CaseHeaderAudience
API KeyIntegration API (license validation, activations, usage)X-API-KeyExternal applications, SDKs
Bearer TokenTenant Dashboard, Admin Dashboard, Billing PortalAuthorization: Bearer {token}Authenticated users

API Key Authentication

For server-to-server integration (license validation, activation, entitlement checks, usage reporting):

POST /api/v1/integration/licenses/{key}/validate
X-API-Key: vx_abc123def456...
Content-Type: application/json

API keys are tenant-scoped. Each key resolves to exactly one tenant. Keys are hashed with HMAC-SHA256 before storage — the raw key is shown only once at creation time.

See API Keys for details.

Bearer Token Authentication

For dashboard and portal access:

GET /api/v1/tenant/products
Authorization: Bearer 1|abc123...
X-Tenant-ID: tenant-uuid
Content-Type: application/json

Tokens are issued via POST /api/auth/login and carry ability scopes (admin or tenant).

See Token Auth for details.

Required Headers

All requests should include:

HeaderRequiredDescription
Content-TypeYesapplication/json
X-API-KeyIntegration API onlyYour API key
AuthorizationDashboard/portal onlyBearer {token}
X-Tenant-IDMulti-tenant users onlyTenant UUID (auto-selected for single-tenant users)
X-Request-IDRecommendedUUID for request tracing

Response Headers

All responses include:

HeaderDescription
X-ValidonX-API-VersionAlways 1
X-Request-IDRequest trace ID (echoed from request or generated)
X-RateLimit-LimitRate limit ceiling (integration API)
X-RateLimit-RemainingRemaining requests
X-RateLimit-ResetUnix timestamp when limit resets

Built by Veltara Works