Skip to main content
POST
Error
Provisioning creates the account, confirmed admin, tenant API token, audit event, and optional identity-handoff secret in one transaction. Use an idempotency key because returned secrets are otherwise shown only once.
201
name and admin_email are required. Email is trimmed and lowercased. plan defaults to business; it must be both active and present in the partner’s operator-configured allowlist. The identity secret is omitted unless explicitly requested.

Errors

401
403
409
409 also covers a duplicate external_id within the same partner and uniqueness races.
422
422 also covers missing fields and reuse of an idempotency key with a different body.

Authorizations

Authorization
string
header
required

Operator-issued partner key. Accepted only under /api/partner/v1.

Headers

Idempotency-Key
string

Retained for 24 hours. Reuse only with the exact same request body.

Maximum string length: 255

Body

application/json
name
string
required
admin_email
string<email>
required
external_id
string | null
plan
string
default:business
admin_first_name
string | null
admin_last_name
string | null
locale
string
timezone
string
generate_identity_handoff_secret
boolean
default:false

Response

Tenant account provisioned

account
object
required
admin
object
required
api_token
string
required

Tenant API token returned only once and on exact idempotent replay.

identity_handoff_secret
string

Present only when requested; returned once and on exact idempotent replay.