Onboarding (admin)
The admin steps that bring a platform account online — account creation, activation, key issuance, contract, and white-labelling. Done by Swarmz through support, not host-callable.
The steps below are performed by a Swarmz superadmin through support. They are not host-callable — there is no endpoint to create or activate your own account. They are documented here so you know exactly what to request and in what order.
Account creation
Your platform account is created by a Swarmz superadmin in draft status. While draft, create and sso return 409 account_inactive — see Data model.
Activation
A card on file is the gate. Once billing is set up we flip the account to active, and the lifecycle endpoints begin to work.
API key issuance
We generate the plaintext key, store only a SHA-256 hash plus an 8-character prefix, and hand you the key once. It is never recoverable afterward. See Authentication.
Contract
The contract sets the commercial terms for your account and drives the wholesale invoice that flows through Stripe Billing Meters. Pricing is discussed during onboarding — please contact us.
White-label theme + custom domain
You provide your logo, colors, app name, and the dashboard host. The active custom domain becomes the host of the dashboard_url returned by create; without one, dashboards live at https://<your-slug>.swarmz.net.
Ongoing changes
Key rotation, theme updates, and contract changes are all handled the same way — request them through support. In particular, rotate a key by asking us to issue a new one and revoke the old; both can be active during a deploy window. See Authentication.