Skip to main content
POST
Onboarding abschließen

Authorizations

Authorization
string
header
required

Access-Token aus POST /auth/login (E-Mail und Passwort), gesendet als Authorization: Bearer <token>.

Das Token ist zeitlich begrenzt gültig. Mit dem refresh_token aus derselben Antwort holt POST /auth/token/refresh ein neues Token-Paar, ohne das Passwort erneut zu senden; POST /auth/token/invalidate macht den Refresh-Token beim Abmelden ungültig.

Ist für das Konto ein zweiter Faktor aktiv oder vorgeschrieben, liefert der Login statt des Token-Paars mfaRequired: true bzw. mfaEnrollmentRequired: true und ein kurzlebiges preAuthToken. Mit diesem Token (ebenfalls als Bearer) wird der zweite Faktor über POST /auth/2fa/verify bestätigt; erst danach gibt es das volle Token-Paar.

Headers

X-Customer-Id
string

Optionaler Kundenkontext. Ohne Header arbeitet die Anfrage im Standard-Kunden des angemeldeten Benutzers. Mit der ID eines anderen Kunden handelt die Anfrage in dessen Kontext: Listen, Lese- und Schreibzugriffe beziehen sich dann auf diesen Kunden.

Erlaubt sind der eigene Kunde, jeder Unterkunde im eigenen Teilbaum (Reseller handelt für seinen Endkunden) sowie Kunden, in denen der Benutzer selbst Mitglied ist. Übergeordnete oder fremde Kunden werden mit 403 Forbidden abgewiesen, eine unbekannte ID ebenfalls.

Die IDs der erreichbaren Kunden liefern GET /user/customers und GET /customers/{id}/children.

Example:

"01JD4Q8W3N6Y2K5T7R9V0B1C2D"

Body

application/json

The new User resource

The e-mail address is unique platform-wide (case-insensitive). This is enforced by a functional unique index on LOWER(email) created in migrations/Version20260706130000.php. Doctrine ORM 2.x cannot map expression indexes, so it lives as raw SQL there instead of as an #[ORM\UniqueConstraint].

type
enum<string>
default:PERS
required
Available options:
PERS,
ORG
Example:

"PERS"

firstName
string
default:""
required
Required string length: 2 - 255
Example:

"John"

lastName
string
default:""
required
Required string length: 2 - 255
Example:

"Doe"

address
string
default:""
required
Required string length: 2 - 255
Example:

"Mainstreet 1"

zipcode
string
default:""
required
Required string length: 2 - 20
Example:

"12345"

city
string
default:""
required
Required string length: 2 - 255
Example:

"Cologne"

countryCode
string
default:""
required

ISO 3166-1 alpha-2 country code

Example:

"DE"

phone1
string
default:""
required

Phone prefix, e.g. +49

Pattern: ^(\+\d{1,3})$
Example:

"+49"

phone2
string
default:""
required

Area code

Pattern: ^(\d{1,5})$
Example:

"221"

phone3
string
default:""
required

Phone number

Pattern: ^(\d{1,15})$
Example:

"1234567"

company
string | null
Required string length: 2 - 255
Example:

"Acme Inc."

vatId
string | null

VAT ID (USt-IdNr.), required for EU business customers

Required string length: 4 - 50
Example:

"DE123456789"

email
string<email> | null

Handle email (defaults to user email if empty)

Example:

"john@example.com"

Response

User resource created

The e-mail address is unique platform-wide (case-insensitive). This is enforced by a functional unique index on LOWER(email) created in migrations/Version20260706130000.php. Doctrine ORM 2.x cannot map expression indexes, so it lives as raw SQL there instead of as an #[ORM\UniqueConstraint].

user
object
account
object | null
customer
object | null
roles
(string | null)[]
Example:
platformRole
string | null

Platform staff role of the effective user (platform_admin|platform_support|null)

impersonation
object | null

Impersonation context ({ sessionId, impersonatedBy{id,email,name}, startedAt, expiresAt }) or null