Domains / Customer Management/ API Endpoint

Onboarding API

REST API for managing tenant onboarding workflows, checkpoints, and progress tracking.

API Endpoint Application active

Onboarding API provides endpoints for initiating, tracking, and completing tenant onboarding flows. Each onboarding journey consists of configurable steps with checkpoint tracking.

Endpoints

  • POST /api/v1/onboarding/start — Initiate onboarding for a new tenant
  • GET /api/v1/onboarding/{tenant-id}/status — Get onboarding progress
  • POST /api/v1/onboarding/{tenant-id}/checkpoint — Mark a step complete
  • POST /api/v1/onboarding/{tenant-id}/skip — Skip optional step
  • GET /api/v1/onboarding/templates — List available onboarding templates

Relationships

◇ Composes outgoing 1
Target Element Element Type
Onboarding Orchestrator Software Subsystem
◇ Part of incoming 1
Source Element Element Type
Onboarding Orchestrator Software Subsystem
→ Served by incoming 4
Source Element Element Type
Onboarding Completed Domain Event
Onboarding Started Domain Event
Tenant Created Domain Event
Tenant Reactivated Domain Event

Architecture Context

Diagrams

Properties

Type API Endpoint
Layer Application
Domain Customer Management
Status active
Owner Platform Team

Additional Metadata

Protocol REST/JSON
Archimate Type application-interface

Meta Model

Business
Organization
Application current
Technology

Actions