Sign in

v11

latestOpenAPI 3.0.4Apache 2.0raw.githubusercontent.com2026-07-07396689.4 KB
TenantSignup

Request tenant signup email verification

Public entry point. Starts a self-service signup and sends an email verification to the supplied address. Returns the signup request id, its expiry, whether operator approval is required, and the email delivery result.

post/tenants/signup/request

Request body

emailstring email required

Requester email address. The verification email is sent here.

slugstring required

Requested tenant slug.

parentTenantIdstring nullable

Parent tenant for a subtenant signup, or null for a root signup.

displayNamestring required

Requested tenant display name.

challengeProofstring nullable

Bot-defence challenge proof, when the deployment requires one.

Example request

{
  "email": "admin@acme.example",
  "slug": "acme",
  "parentTenantId": null,
  "displayName": "Acme Corporation"
}

Response

Signup request accepted.

signupRequestIdstring required

Identifier of the signup request.

expiresAtstring date-time required

Expiry of the signup request.

requiresApprovalboolean required

Whether operator approval is required after email verification.

Example response

{
  "signupRequestId": "signup-9f12a7c4",
  "expiresAt": "2026-06-09T09:00:00Z",
  "requiresApproval": true,
  "emailDelivery": {
    "status": "SENT",
    "deliveryId": "del-9f12a7c4",
    "providerMessageId": "msg-101"
  }
}