---
title: "Preview a license request"
method: POST
path: "/requests/preview"
tags: ["License Portal"]
---

# Preview a license request

`POST /requests/preview`

## Request body

- PreviewLicenseRequestArgs
  - `requestId` string, required

## Response `200`

License preview.

- LicensePreviewResult
  - `request` LicenseIssueRequest, required
    - `requestId` string, required
    - `customerPartyId` string, required
    - `softwarePartyId` string, required
    - `installationId` string, required
    - `templateId` string
    - `profileId` string
    - `product` string, required
    - `edition` string, required
    - `features` string[], required
    - `quotas` LongMap, required
    - `gatePolicy` LicenseGatePolicy
      - `productFeatures` LicenseGateRules
        - `enabled` string[]
        - `disabled` string[]
      - `commands` LicenseGateRules
        - `enabled` string[]
        - `disabled` string[]
    - `validFrom` string, required
    - `expiresAt` string, required
    - `installationBaseDomain` string — Optional deployment base domain for direct issuer-created setup bundles. Omit to issue a domain-agnostic license.
    - `platformDomainRoots` string[] — Optional allowed platform domain roots for direct issuer-created setup bundles. Empty means any base domain.
    - `notes` string
    - `technicalContact` LicenseRequestContact
      - `email` string, email, required
      - `displayName` string, required
      - `role` string, required
    - `administratorContact` LicenseRequestContact
      - `email` string, email, required
      - `displayName` string, required
      - `role` string, required
    - `contactIds` StringMap, required
    - `importedRequestArtifact` ImportedPlatformLicenseRequestArtifact
      - `requestJson` string, required — Signed license request JSON generated by the target platform.
      - `signature` ImportedPlatformLicenseRequestSignature
        - `algorithm` string
        - `keyId` string
        - `signatureBase64` string
      - `certificateSigningRequest` ImportedPlatformLicenseRequestCertificateSigningRequest
        - `pem` string
        - `derBase64` string
        - `fingerprint` string
      - `artifactDigest` string
      - `schemaVersion` string
      - `requestSigningKeyId` string
      - `requestSigningPublicKeyThumbprint` string
      - `installationBaseDomain` string
      - `platformIssuer` string
      - `platformDomainRoots` string[]
      - `validationStatus` 'unvalidated' | 'valid' | 'invalid'
      - `validationMessages` string[]
    - `status` string, required
    - `createdAt` string, required
    - `tenantId` string
  - `claims` LicenseIssuanceRequest, required
    - `schema` string, required
    - `licenseId` string, required
    - `product` string, required
    - `edition` string, required
    - `customerPartyId` string, required
    - `customerName` string, required
    - `softwarePartyId` string, required
    - `installationId` string, required
    - `installationName` string, required
    - `features` string[], required
    - `quotas` LongMap, required
    - `gatePolicy` LicenseGatePolicy
      - `productFeatures` LicenseGateRules
        - `enabled` string[]
        - `disabled` string[]
      - `commands` LicenseGateRules
        - `enabled` string[]
        - `disabled` string[]
    - `validFrom` string, required
    - `expiresAt` string, required
    - `issuedAt` string, required
    - `issuer` string, required
    - `keyId` string, required
    - `profileId` string
    - `recipientKeyId` string
    - `recipientPublicKeyFingerprint` string
    - `licenseRequestId` string
    - `requestArtifactDigest` string
    - `recipientKeyThumbprint` string
    - `installationBaseDomain` string
    - `platformDomainRoots` string[]
    - `statusList` LicenseStatusListReference
      - `uri` string, required
      - `index` integer, required
      - `purpose` string, required
      - `tokenFormat` string, required
      - `listId` string
    - `checkInterval` string
    - `checkGrace` string
    - `stapledStatusListToken` string
    - `metadata` StringMap, required
  - `valid` boolean, required
  - `warnings` string[], required
  - `errors` string[], required

---

[API](https://skmtc.net/sphereon-opensource/apis/license-portal-api.md) · [All operations](https://skmtc.net/sphereon-opensource/apis/license-portal-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/sphereon-opensource/license-portal-api/versions/f45b2d91505a/schema)