---
title: "Get persisted first-run onboarding state"
method: GET
path: "/onboarding/state"
tags: ["Setup"]
---

# Get persisted first-run onboarding state

`GET /onboarding/state`

Returns the persisted deployment draft and generated license request artifact, if present, so the setup UI can resume after a browser restart.

## Response `200`

Current setup onboarding state.

- OnboardingState
  - `gateOpen` boolean, required
  - `resumeStep` integer, required
  - `deployment` LicenseRequestDeployment
    - `deployment` LicenseRequestDeploymentScope, required
      - `id` string, nullable
      - `baseDomains` string[], required
    - `organizationName` string, required
    - `organizationUnit` string, nullable
    - `locality` string, nullable
    - `state` string, nullable
    - `country` string, nullable
    - `licenseDeliveryMethod` 'MANUAL'
    - `contacts` LicenseRequestContact[], required
      - `email` string, email, required
      - `givenName` string, required
      - `familyName` string, required
      - `roles` LicenseRequestContactRole[], required
      - `displayName` string, nullable
  - `generatedRequest` LicenseRequestResponse
    - `request` LicenseRequestPayload, required
      - `version` string, required
      - `requestId` string, required
      - `generatedAt` string, date-time, required
      - `deployment` LicenseRequestDeploymentScope, required
        - `id` string, nullable
        - `baseDomains` string[], required
      - `platformIssuer` string, uri, required
      - `tenant` LicenseRequestTenant, required
        - `name` string, required
        - `slug` string, required
      - `owner` LicenseRequestOwner, required
        - `email` string, email, required
        - `displayName` string, required
      - `contacts` LicenseRequestContact[], required
        - `email` string, email, required
        - `givenName` string, required
        - `familyName` string, required
        - `roles` LicenseRequestContactRole[], required
        - `displayName` string, nullable
      - `organizationName` string, nullable
      - `organizationUnit` string, nullable
      - `licenseDeliveryMethod` 'MANUAL', required
      - `localCertificate` LocalInstanceCertificate, required
        - `commonName` string, required
        - `organizationName` string, nullable
        - `organizationUnit` string, nullable
        - `locality` string, nullable
        - `state` string, nullable
        - `country` string, nullable
        - `email` string, nullable
        - `serialNumber` integer, required
      - `localPublicKey` LocalInstancePublicKey, required
        - `alias` string, required
        - `providerId` string, required
        - `kid` string, nullable
        - `publicJwk` object, required
      - `certificateSigningRequest` LicenseRequestCertificateSigningRequest, required
        - `derBase64` string, byte, required
        - `pem` string, required
        - `fingerprint` string, required
      - `licenseRecipient` LicenseRecipientPublicKey, required
        - `kid` string, required
        - `publicJwk` object, required
        - `thumbprint` string, required
        - `certificate` LicenseRecipientCertificate
          - `derBase64` string, byte, required
          - `pem` string, required
          - `chainBase64` string[], required
          - `fingerprint` string, required
    - `requestJson` string, required
    - `signature` LicenseRequestSignature, required
      - `algorithm` string, required
      - `keyId` string, nullable
      - `signatureBase64` string, byte, required
    - `artifactDigest` string, nullable

## Other responses

- `404` — Setup gate is closed.

## Changes

- **2026-06-19** `ef25767f07be` — 1 info
  - endpoint added

[Change history](https://skmtc.dev/sphereon-opensource/apis/platform-setup-api/changes/onboarding/state/get.md)

---

[API](https://skmtc.dev/sphereon-opensource/apis/platform-setup-api.md) · [All operations](https://skmtc.dev/sphereon-opensource/apis/platform-setup-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/sphereon-opensource/platform-setup-api/revisions/f6d32c93ac68/schema)