---
title: "Entitlement Check"
method: POST
path: "/v1/entitlement/check"
tags: ["Entitlement"]
---

# Entitlement Check

`POST /v1/entitlement/check`

Return the current entitlement check decision for SuperLink.

## Headers

- `authorization` string, nullable

## Request body

- EntitlementCheckRequest — Request schema for entitlement check.
  - `subject` EntitlementSubject, required — Schema for entitlement subject.
    - `type` 'account', required
    - `id` string, required
  - `action` 'start_run' | 'create_federation' | 'register_supernode' | 'create_invitation' | 'accept_invitation', required — Entitlement action values.
  - `context` union, required
    - StartRunContext — Schema for start run context.
      - `type` 'start_run', required
      - `federation_id` string, required
      - `runtime` 'deployment' | 'simulation', required
    - CreateFederationContext — Schema for create federation context.
      - `type` 'create_federation', required
      - `visibility` 'public' | 'private', required
      - `runtime` 'deployment' | 'simulation', required
    - RegisterSuperNodeContext — Schema for register super node context.
      - `type` 'register_supernode', required
    - CreateInvitationContext — Schema for create invitation context.
      - `type` 'create_invitation', required
      - `federation_id` string, required
      - `invitee_account_name` string, required
      - `runtime` 'deployment' | 'simulation', required
    - AcceptInvitationContext — Schema for accept invitation context.
      - `type` 'accept_invitation', required
      - `federation_id` string, required
      - `runtime` 'deployment' | 'simulation', required

## Response `200`

Successful Response

- EntitlementConsumeResponse — Response schema for entitlement consume.
  - `allowed` boolean, required
  - `reason_code` integer, required
  - `reason_message` string, required
  - `public_details` string, required

## Other responses

- `422` — Validation Error

---

[API](https://skmtc.dev/flower/apis/superlink-api.md) · [All operations](https://skmtc.dev/flower/apis/superlink-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/flower/superlink-api/revisions/adf853ac4f41/schema)