> ## Documentation Index
> Fetch the complete documentation index at: https://docs.netzfabrik.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Onboarding abschließen

> Legt in einem Schritt Kunde, Konto und Rechnungs-Handle für einen frisch registrierten Benutzer an.



## OpenAPI

````yaml /api-reference/openapi.json post /onboarding/complete
openapi: 3.1.0
info:
  title: NETZFABRIK API
  description: >-
    REST-API der NETZFABRIK-Plattform für Domains, DNS, Cloud-Server, Webspaces,
    E-Mail-Dienste und Konto. Authentifizierung per JWT (Authorization: Bearer)
    oder API-Token (X-API-TOKEN).
  termsOfService: https://www.netzfabrik.com/tos
  contact:
    name: NETZFABRIK GmbH
    url: https://www.netzfabrik.com
    email: info@netzfabrik.com
  license:
    name: Proprietary
    url: https://www.netzfabrik.com/license
  version: 2026-11-19-9237c1a3
servers:
  - url: https://api.netzfabrik.com
security:
  - JWT: []
  - ApiToken: []
tags:
  - name: Login
  - name: Zwei-Faktor-Authentifizierung
  - name: Passkeys
  - name: Benutzer
  - name: Konten
  - name: Kunden
  - name: Verträge
  - name: Rechnungen
  - name: Support-Tickets
  - name: Domains
  - name: Domain-Bestellungen
  - name: Premium-Domains
  - name: Inhaberwechsel
  - name: Handles (Kontakte)
  - name: Handle-Verifizierung
  - name: TLD-Daten
  - name: Domain-Preise
  - name: Preislisten-Vorlagen
  - name: Preislisten-Versionen
  - name: Preis-Überschreibungen
  - name: Preisänderungen
  - name: Domain-Aktionen
  - name: Öffentliche Preislisten
  - name: Domain-Reseller
  - name: DNS-Zonen
  - name: DNS-Records
  - name: Weiterleitungen
  - name: Cloud-Server
  - name: Cloud-Server-Vorlagen
  - name: Regionen
  - name: SSH-Keys
  - name: ISO-Images
  - name: Anwendungen
  - name: Webspaces
  - name: Webspace-Tarife
  - name: Object Storage
  - name: E-Mail-Protection
  - name: E-Mail-Security
  - name: E-Mail-Archiv
  - name: Colocation
  - name: Racks
  - name: Stromzuführungen
  - name: Interconnections
  - name: VLANs
  - name: Traffic
paths:
  /onboarding/complete:
    post:
      tags:
        - Benutzer
      summary: Onboarding abschließen
      description: >-
        Legt in einem Schritt Kunde, Konto und Rechnungs-Handle für einen frisch
        registrierten Benutzer an.
      operationId: onboardingComplete
      parameters:
        - $ref: '#/components/parameters/CustomerId'
      requestBody:
        description: The new User resource
        content:
          application/json:
            schema:
              $ref: >-
                #/components/schemas/User.OnboardingCompleteRequest-onboarding.write
        required: true
      responses:
        '201':
          description: User resource created
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/User.UserMeResponse-user.read_user_me.read_account.me_customer.me
          links: {}
        '400':
          description: Invalid input
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Error'
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
          links: {}
        '403':
          description: Forbidden
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Error'
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
          links: {}
        '422':
          description: An error occurred
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ConstraintViolation'
            application/json:
              schema:
                $ref: '#/components/schemas/ConstraintViolation'
          links: {}
components:
  parameters:
    CustomerId:
      name: X-Customer-Id
      in: header
      required: false
      description: >-
        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`.
      schema:
        type: string
        example: 01JD4Q8W3N6Y2K5T7R9V0B1C2D
  schemas:
    User.OnboardingCompleteRequest-onboarding.write:
      type: object
      description: >-
        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].
      required:
        - type
        - firstName
        - lastName
        - address
        - zipcode
        - city
        - countryCode
        - phone1
        - phone2
        - phone3
      properties:
        type:
          enum:
            - PERS
            - ORG
          default: PERS
          example: PERS
          type: string
        firstName:
          minLength: 2
          maxLength: 255
          default: ''
          example: John
          type: string
        lastName:
          minLength: 2
          maxLength: 255
          default: ''
          example: Doe
          type: string
        company:
          minLength: 2
          maxLength: 255
          example: Acme Inc.
          type:
            - string
            - 'null'
        vatId:
          minLength: 4
          maxLength: 50
          description: VAT ID (USt-IdNr.), required for EU business customers
          example: DE123456789
          type:
            - string
            - 'null'
        address:
          minLength: 2
          maxLength: 255
          default: ''
          example: Mainstreet 1
          type: string
        zipcode:
          minLength: 2
          maxLength: 20
          default: ''
          example: '12345'
          type: string
        city:
          minLength: 2
          maxLength: 255
          default: ''
          example: Cologne
          type: string
        countryCode:
          description: ISO 3166-1 alpha-2 country code
          default: ''
          example: DE
          type: string
        phone1:
          pattern: ^(\+\d{1,3})$
          description: Phone prefix, e.g. +49
          default: ''
          example: '+49'
          type: string
        phone2:
          pattern: ^(\d{1,5})$
          description: Area code
          default: ''
          example: '221'
          type: string
        phone3:
          pattern: ^(\d{1,15})$
          description: Phone number
          default: ''
          example: '1234567'
          type: string
        email:
          format: email
          description: Handle email (defaults to user email if empty)
          externalDocs:
            url: https://schema.org/email
          example: john@example.com
          type:
            - string
            - 'null'
    User.UserMeResponse-user.read_user_me.read_account.me_customer.me:
      type: object
      description: >-
        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].
      properties:
        user:
          $ref: >-
            #/components/schemas/User-user.read_user_me.read_account.me_customer.me
        account:
          anyOf:
            - $ref: >-
                #/components/schemas/Account-user.read_user_me.read_account.me_customer.me
            - type: 'null'
        customer:
          anyOf:
            - $ref: >-
                #/components/schemas/Customer-user.read_user_me.read_account.me_customer.me
            - type: 'null'
        roles:
          example:
            - ROLE_USER
          type: array
          items:
            type:
              - string
              - 'null'
        platformRole:
          description: >-
            Platform staff role of the effective user
            (platform_admin|platform_support|null)
          type:
            - string
            - 'null'
        impersonation:
          description: >-
            Impersonation context ({ sessionId, impersonatedBy{id,email,name},
            startedAt, expiresAt }) or null
          type:
            - object
            - 'null'
          additionalProperties:
            anyOf:
              - type: object
                additionalProperties:
                  type: string
              - type: string
              - type: 'null'
    Error:
      type: object
      description: A representation of common errors.
      properties:
        title:
          readOnly: true
          description: A short, human-readable summary of the problem.
          type:
            - string
            - 'null'
        detail:
          readOnly: true
          description: >-
            A human-readable explanation specific to this occurrence of the
            problem.
          type:
            - string
            - 'null'
        status:
          type:
            - integer
            - 'null'
          examples:
            - 404
          default: 400
        instance:
          readOnly: true
          description: >-
            A URI reference that identifies the specific occurrence of the
            problem. It may or may not yield further information if
            dereferenced.
          type:
            - string
            - 'null'
        type:
          readOnly: true
          description: A URI reference that identifies the problem type
          type: string
    ConstraintViolation:
      type: object
      description: Unprocessable entity
      properties:
        status:
          default: 422
          type: integer
        violations:
          type: array
          items:
            type: object
            properties:
              propertyPath:
                type: string
                description: The property path of the violation
              message:
                type: string
                description: The message associated with the violation
              code:
                type: string
                description: The code of the violation
              hint:
                type: string
                description: An extra hint to understand the violation
              payload:
                type: object
                additionalProperties: true
                description: The serialized payload of the violation
            required:
              - propertyPath
              - message
        detail:
          readOnly: true
          type: string
        type:
          readOnly: true
          type: string
        title:
          readOnly: true
          type:
            - string
            - 'null'
        instance:
          readOnly: true
          type:
            - string
            - 'null'
    User-user.read_user_me.read_account.me_customer.me:
      type: object
      properties:
        id:
          readOnly: true
          example: 01F9Z3ZJXZQZJZJZJZJZJZJZJZ
          type: string
        firstName:
          minLength: 2
          maxLength: 255
          readOnly: true
          description: The firstname of the user
          example: John
          type: string
        lastName:
          minLength: 2
          maxLength: 255
          readOnly: true
          description: The lastname of the user
          example: Doe
          type: string
        company:
          minLength: 2
          maxLength: 255
          readOnly: true
          description: The company of the user
          example: Acme Inc.
          type:
            - string
            - 'null'
        email:
          format: email
          externalDocs:
            url: https://schema.org/email
          type: string
        emailVerified:
          readOnly: true
          description: Whether the user email is verified
          default: false
          type: boolean
        phoneNumber:
          readOnly: true
          description: Phone number (E.164 format)
          type:
            - string
            - 'null'
        phoneVerified:
          readOnly: true
          description: Whether the user phone number is verified
          default: false
          type: boolean
        locale:
          description: Preferred panel language locale
          example: de
          type:
            - string
            - 'null'
        colorScheme:
          description: Preferred color scheme
          example: dark
          type:
            - string
            - 'null'
        skipAccountSelection:
          description: Skip account selection on login (auto login)
          type:
            - boolean
            - 'null'
        passwordResetRequired:
          readOnly: true
          description: Whether the user must set a new password before logging in
          default: false
          type: boolean
      required:
        - firstName
        - lastName
        - email
    Account-user.read_user_me.read_account.me_customer.me:
      type: object
      properties:
        id:
          readOnly: true
          example: 01F9Z3ZJXZQZJZJZJZJZJZJZJZ
          type: string
    Customer-user.read_user_me.read_account.me_customer.me:
      type: object
      properties:
        id:
          readOnly: true
          example: 01F9Z3ZJXZQZJZJZJZJZJZJZJZ
          type: string
        name:
          minLength: 2
          maxLength: 255
          description: The name of the customer
          example: ACME Inc.
          type: string
        customerNumber:
          readOnly: true
          type: string
        vatValidated:
          readOnly: true
          description: >-
            True once the VAT ID (vatNumber) has been positively confirmed via
            VIES

            (or the configured validation service). Only a validated EU VAT ID
            makes

            the customer eligible for reverse charge. Defaults to false — an

            unverified or unverifiable VAT ID is never treated as reverse-charge
            eligible.
          default: false
          type: boolean
        vatValidatedAt:
          readOnly: true
          description: >-
            Timestamp of the last successful VIES validation of the current VAT
            ID.
          type:
            - string
            - 'null'
          format: date-time
        billingCountryCode:
          description: ISO 3166-1 alpha-2 country code of the customer's billing address.
          type:
            - string
            - 'null'
        fynnDebtorId:
          description: >-
            Fynn-Debitor des Kunden. Nur in `/user/me` lesbar (Gruppe ME), also
            für den Kunden

            selbst: Shop und Panel geben die Kennung an die Auswertung weiter,
            damit sich

            Besuche später der Abrechnung zuordnen lassen (ARC-211). `null`,
            solange das

            Onboarding den Debitor noch nicht angelegt hat oder der Kunde über
            den Elternkunden

            abgerechnet wird.
          type:
            - string
            - 'null'
        isResellingEnabled:
          default: false
          type: boolean
        canManageBrands:
          description: 'Capability: darf eigene Brands (Auftritte) anlegen und verwalten.'
          default: false
          type: boolean
        billingMode:
          type:
            - string
            - 'null'
          enum:
            - PREPAID
            - POSTPAID
            - null
        mfaPolicy:
          description: >-
            MFA obligation for this customer and its subtree
            (OPTIONAL|REQUIRED_FOR_ADMINS|REQUIRED)
          example: REQUIRED_FOR_ADMINS
          type:
            - string
            - 'null'
          enum:
            - OPTIONAL
            - REQUIRED_FOR_ADMINS
            - REQUIRED
            - null
        mfaGraceDays:
          minimum: 0
          maximum: 365
          description: Grace period in days before the MFA obligation is enforced
          example: 14
          type:
            - integer
            - 'null'
        priceListTemplate:
          description: Zugewiesene Domain-Preislistenvorlage (für Reseller).
          type:
            - string
            - 'null'
          format: iri-reference
          example: https://example.com/
        lockedAt:
          readOnly: true
          description: 'Read-only: set when platform staff locked this customer (ISO 8601)'
          type:
            - string
            - 'null'
          format: date-time
        derivedRole:
          readOnly: true
          description: >-
            Derived role (ROOT|RESELLER|CUSTOMER), computed from hierarchy and
            capabilities
          example: RESELLER
          type: string
        warnings:
          readOnly: true
          description: >-
            Hinweise zur letzten Änderung (z. B. mfa_policy_tightened mit
            affectedUsers/notifiedUsers); nie persistiert
          type: array
          items:
            type: object
            additionalProperties:
              type:
                - string
                - 'null'
      required:
        - name
  securitySchemes:
    JWT:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: >-
        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.
    ApiToken:
      type: apiKey
      in: header
      name: X-API-TOKEN
      description: >-
        Persönlicher API-Token für Skripte, CI/CD und
        Server-zu-Server-Integrationen, gesendet im Header `X-API-TOKEN:
        <token>`.


        Tokens werden im Kundenpanel unter **Einstellungen → Sicherheit**
        angelegt oder per `POST /user/api-tokens` mit einem gültigen JWT. Der
        Klartext erscheint nur einmal in der Antwort beim Anlegen. Ein Token
        handelt mit den Rechten des Benutzers, der ihn erstellt hat, kann ein
        Ablaufdatum haben und wird mit `DELETE /user/api-tokens/{id}` sofort
        widerrufen.

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.