Skip to main content
POST
/
v1
/
tenants
Create Tenant
curl --request POST \
  --url https://api.example.com/v1/tenants \
  --header 'Content-Type: application/json' \
  --header 'X-Access-Key: <x-access-key>' \
  --header 'X-Signature: <x-signature>' \
  --header 'X-Timestamp: <x-timestamp>' \
  --data '
{
  "tenantName": "<string>",
  "adminEmail": "<string>",
  "plan": "<string>"
}
'
{
  "tenant": {
    "tenantId": "<string>",
    "tenantName": "<string>",
    "status": "<string>",
    "plan": "<string>",
    "createdAt": "<string>"
  }
}

Create Tenant

Create a new tenant organization on the AxonVault platform.
This endpoint is typically used during initial onboarding and requires admin privileges.

Authentication

X-Access-Key
string
required
Admin API access key
X-Signature
string
required
HMAC-SHA256 signature
X-Timestamp
string
required
ISO 8601 timestamp

Request Body

tenantName
string
required
Display name for the tenant organization
adminEmail
string
required
Email address for the tenant admin
plan
string
default:"starter"
Subscription plan (starter, growth, enterprise)

Response

tenant
object

Example

curl -X POST https://api.axonvault.io/v1/tenants \
  -H "X-Access-Key: ak_live_abc123" \
  -H "X-Signature: sha256=..." \
  -H "X-Timestamp: 2024-01-15T10:30:00Z" \
  -H "Content-Type: application/json" \
  -d '{
    "tenantName": "Acme Corp",
    "adminEmail": "[email protected]",
    "plan": "growth"
  }'
Response:
{
  "tenant": {
    "tenantId": "ten_abc123",
    "tenantName": "Acme Corp",
    "status": "active",
    "plan": "growth",
    "createdAt": "2024-01-15T10:30:00Z"
  }
}