POST /v1/check-email-with-onboard

POST /v1/check-email-with-onboard — Self-service signup + email verification in one call. No authentication required. Creates a tenant, generates an API key, verifies the email, and returns all three.

Family: Onboarding · Operation ID: v1_check_email_with_onboard

Access

Backend-only onboarding entry point. The shared app host returns 403; use the app sign-up flow.

Open setup and status journey

Request body · application/json

{
  "$ref": "#/components/schemas/OnboardRequest",
  "definition": {
    "properties": {
      "contact_email": {
        "description": "Contact email for the tenant account (billing, alerts).",
        "type": "string"
      },
      "email_to_verify": {
        "description": "Email address to verify.",
        "type": "string"
      },
      "plan_tier": {
        "description": "Optional plan tier (defaults to \"free\").",
        "nullable": true,
        "type": "string"
      },
      "slug": {
        "description": "URL-safe slug (auto-generated from tenant_name if omitted).",
        "nullable": true,
        "type": "string"
      },
      "tenant_name": {
        "description": "Display name for the new tenant.",
        "type": "string"
      }
    },
    "required": [
      "email_to_verify",
      "tenant_name",
      "contact_email"
    ],
    "type": "object"
  }
}

Responses

201

{
  "description": "Tenant onboarded and email verified"
}

default

{
  "content": {
    "application/json": {
      "schema": {
        "$ref": "#/components/schemas/ErrorEnvelope"
      }
    }
  },
  "description": "Request error"
}

Download the full OpenAPI contract