Sustema

ENTITY developer reference

Inspect permitted classification prices, success rules and supported targets

Candidate documentation for reading and synthetic examples. Account creation, live API access, SDKs, collections and MCP are not available here. A released service profile and matching integration instructions are required before use.

This is a documentation reading view of an unreleased candidate, not a downloadable replacement schema. Public wire names, types and constraints are retained except for the explicitly marked private-only subsets and route patterns. Private governance references are explained in public language. Use only a separately released, verified generation for clients. Read the explicit exclusions.

GET /v1/classification-offers

Operation identifier: listClassificationOffers

Inspect permitted classification prices, success rules and supported targets. All effects obey the classification acquisition, accounting, cancellation, correction and retention rules on this page and in the shared contract rules; current authority and rights are rechecked. This pure owned read creates no new business effect or debit. Its failure reports only not_started/unchanged with null operation/status references. Existing underlying financial uncertainty is shown in the successful owned status envelope; unavailable read dependencies use the existing dependency_unavailable retry path. Never report a new reservation/settlement or invent a polling operation for this read. Original-resource disclosure: No original-object relation; current explicit integration grant plus exact offer eligibility, with no customer sibling state. API integration never borrows a human or another integration relation. Every current credential/action/profile/source/retention guard still applies.

Entity-Service-Profile carries the accepted profile_id; the endpoint pins its separate immutable revision. The retained template parameter description says “revision”; follow this current interpretation when reading that historical wording. No reserved example URL in the definitions is a live service destination.

Authentication

Apply the operation’s security requirement when present, otherwise the contract default below. These definitions do not provision access or qualify an authentication flow.

[
  {
    "bearerAuth": []
  }
]
Security scheme definitions
{
  "bearerAuth": {
    "type": "http",
    "scheme": "bearer",
    "description": "Validated OAuth access token, never an ID token. Issuer/audience/token endpoint and scope mapping are deployment-profile values. ENTITY current role, data and budget policy additionally applies."
  }
}

Request parameters

Headers, path and query parameters from the candidate contract. Operation-specific definitions take precedence over inherited definitions with the same name and location. Request body fields appear in the reading view below.

Entity-Service-Profile

header · Required

Accepted immutable service-profile revision; missing/unknown profiles cannot activate an operation.

Reading definition for Entity-Service-Profile
{
  "name": "Entity-Service-Profile",
  "in": "header",
  "required": true,
  "schema": {
    "type": "string",
    "maxLength": 4096,
    "x-profile-maxLength": "string_characters_max"
  },
  "description": "Accepted immutable service-profile revision; missing/unknown profiles cannot activate an operation."
}

page_size

query · Optional

Default and maximum from the active profile. Effective maximum is the smaller of this response ceiling and the selected profile page-size limit.

Reading definition for page_size
{
  "name": "page_size",
  "in": "query",
  "required": false,
  "schema": {
    "type": "integer",
    "minimum": 1,
    "x-profile-maximum": "page_size_max",
    "maximum": 50,
    "x-additional-profile-maximum": "collection_items_max"
  },
  "description": "Default and maximum from the active profile. Effective maximum is the smaller of this response ceiling and the selected profile page-size limit."
}

cursor

query · Optional

Opaque signed cursor bound to query, organisation, environment, profile, rights and index/publication generation.

Reading definition for cursor
{
  "name": "cursor",
  "in": "query",
  "required": false,
  "schema": {
    "type": "string",
    "maxLength": 4096,
    "x-profile-maxLength": "string_characters_max"
  },
  "description": "Opaque signed cursor bound to query, organisation, environment, profile, rights and index/publication generation."
}

Request and response contract

The candidate operation is shown below with the declared documentation-only public-meaning projection. References open the corresponding public schema. No server URL or credential is supplied by this page.

{
  "operationId": "listClassificationOffers",
  "summary": "Inspect permitted classification prices, success rules and supported targets",
  "description": "Inspect permitted classification prices, success rules and supported targets. All effects obey the classification acquisition, accounting, cancellation, correction and retention rules on this page and in the shared contract rules; current authority and rights are rechecked. This pure owned read creates no new business effect or debit. Its failure reports only not_started/unchanged with null operation/status references. Existing underlying financial uncertainty is shown in the successful owned status envelope; unavailable read dependencies use the existing dependency_unavailable retry path. Never report a new reservation/settlement or invent a polling operation for this read. Original-resource disclosure: No original-object relation; current explicit integration grant plus exact offer eligibility, with no customer sibling state. API integration never borrows a human or another integration relation. Every current credential/action/profile/source/retention guard still applies.",
  "tags": [
    "Industry Classification Intelligence"
  ],
  "parameters": [
    {
      "$ref": "#/components/parameters/ServiceProfile"
    },
    {
      "name": "page_size",
      "in": "query",
      "required": false,
      "schema": {
        "type": "integer",
        "minimum": 1,
        "x-profile-maximum": "page_size_max",
        "maximum": 50,
        "x-additional-profile-maximum": "collection_items_max"
      },
      "description": "Default and maximum from the active profile. Effective maximum is the smaller of this response ceiling and the selected profile page-size limit."
    },
    {
      "$ref": "#/components/parameters/Cursor"
    }
  ],
  "responses": {
    "200": {
      "description": "Proposed governed response; no deployed endpoint.",
      "headers": {
        "Cache-Control": {
          "schema": {
            "const": "private, no-store"
          }
        },
        "Entity-Request-Id": {
          "schema": {
            "type": "string",
            "format": "uuid"
          }
        }
      },
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/ICOffersPageResponse"
          }
        }
      }
    },
    "422": {
      "description": "Bounded zero-unit refusal: input-phase is not_started; delivery-phase is unchanged. Stop the unchanged request; no fresh financial effect or reverse operation reference.",
      "x-error-codes": [
        "limit_out_of_range"
      ],
      "content": {
        "application/problem+json": {
          "schema": {
            "allOf": [
              {
                "$ref": "#/components/schemas/ICProblem"
              },
              {
                "properties": {
                  "code": {
                    "const": "limit_out_of_range"
                  },
                  "status": {
                    "const": 422
                  },
                  "usage_state": {
                    "enum": [
                      "not_started",
                      "unchanged"
                    ]
                  },
                  "retry_action": {
                    "const": "do_not_retry"
                  },
                  "operation_id": {
                    "type": "null"
                  },
                  "status_path": {
                    "type": "null"
                  }
                }
              },
              {
                "if": {
                  "properties": {
                    "delivery_limit": {
                      "properties": {
                        "phase": {
                          "const": "delivery"
                        }
                      },
                      "required": [
                        "phase"
                      ]
                    }
                  },
                  "required": [
                    "delivery_limit"
                  ]
                },
                "then": {
                  "properties": {
                    "usage_state": {
                      "const": "unchanged"
                    }
                  }
                }
              }
            ]
          }
        }
      },
      "headers": {
        "Cache-Control": {
          "schema": {
            "const": "private, no-store"
          }
        },
        "Entity-Request-Id": {
          "schema": {
            "type": "string",
            "format": "uuid"
          }
        },
        "Retry-After": {
          "schema": {
            "type": "string",
            "minLength": 1,
            "maxLength": 128
          },
          "description": "Provided only when a specific retry delay is known; never implies extra spending authority. Only valid delay-seconds or HTTP-date, no CR/LF; same128-character MCP bound. Unknown timing is omitted, not truncated."
        }
      }
    },
    "default": {
      "description": "Typed safe error; inspect original operation after uncertain acceptance.",
      "headers": {
        "Cache-Control": {
          "schema": {
            "const": "private, no-store"
          }
        },
        "Entity-Request-Id": {
          "schema": {
            "type": "string",
            "format": "uuid"
          }
        },
        "Retry-After": {
          "schema": {
            "type": "string",
            "minLength": 1,
            "maxLength": 128
          },
          "description": "Provided only when a specific retry delay is known; never implies extra spending authority. Only valid delay-seconds or HTTP-date, no CR/LF; same128-character MCP bound. Unknown timing is omitted, not truncated."
        }
      },
      "content": {
        "application/problem+json": {
          "schema": {
            "allOf": [
              {
                "$ref": "#/components/schemas/ICProblem"
              },
              {
                "properties": {
                  "usage_state": {
                    "enum": [
                      "not_started",
                      "unchanged"
                    ]
                  },
                  "operation_id": {
                    "type": "null"
                  },
                  "status_path": {
                    "type": "null"
                  },
                  "code": {
                    "not": {
                      "enum": [
                        "operation_in_progress",
                        "operation_reconciling",
                        "completion_uncertain",
                        "budget_exhausted",
                        "funding_window_too_short"
                      ]
                    }
                  }
                }
              }
            ]
          }
        }
      }
    }
  },
  "x-permission": "classification.offers.read",
  "x-billable": false,
  "x-commercial-effect": "zero_new_classification_units",
  "x-cross-adapter-bound": {
    "operation": "listClassificationOffers",
    "rule": "#/x-delivery-bound-contract",
    "before_settlement": true
  },
  "x-original-resource-relation": "No original-object relation; current explicit integration grant plus exact offer eligibility, with no customer sibling state. API integration never borrows a human or another integration relation. Every current credential/action/profile/source/retention guard still applies."
}

Referenced schemas

Includes schemas used by this operation and its shared or inherited parameters. Open a schema to follow its related definitions.

Shared parameter definitions
{
  "Cursor": {
    "name": "cursor",
    "in": "query",
    "required": false,
    "schema": {
      "type": "string",
      "maxLength": 4096,
      "x-profile-maxLength": "string_characters_max"
    },
    "description": "Opaque signed cursor bound to query, organisation, environment, profile, rights and index/publication generation."
  },
  "IdempotencyKey": {
    "name": "Idempotency-Key",
    "in": "header",
    "required": true,
    "schema": {
      "type": "string",
      "format": "uuid",
      "maxLength": 36
    },
    "description": "Random UUID for one logical operation, including billed GETs. Same request/key/time replays without a second charge; ENTITY application semantics."
  },
  "Manifest": {
    "name": "manifest_id",
    "in": "query",
    "required": true,
    "schema": {
      "type": "string",
      "format": "uuid",
      "maxLength": 36
    },
    "description": "Manifest returned by identity/search. A compatibility-bound follow-on read, not unrestricted historical query. Current rights and retention apply."
  },
  "MaxUnits": {
    "name": "Entity-Max-Units",
    "in": "header",
    "required": false,
    "schema": {
      "$ref": "#/components/schemas/Units"
    },
    "description": "Caller ceiling in the accepted offer atomic unit; cannot increase organisation authority."
  },
  "OperationCreated": {
    "name": "Entity-Operation-Created-At",
    "in": "header",
    "required": true,
    "schema": {
      "type": "string",
      "format": "date-time",
      "maxLength": 35
    },
    "description": "Original creation instant, unchanged on retry. New keys outside the profile admission/skew window are refused even after tombstone expiry."
  },
  "PageSize": {
    "name": "page_size",
    "in": "query",
    "required": false,
    "schema": {
      "type": "integer",
      "minimum": 1,
      "x-profile-maximum": "page_size_max"
    },
    "description": "Default and maximum from the active profile."
  },
  "ReceiptContext": {
    "name": "Entity-Receipt-Context",
    "in": "header",
    "required": true,
    "schema": {
      "type": "string",
      "format": "uuid",
      "maxLength": 36
    },
    "description": "Readable own-organisation receipt containing the requested entity/manifest. Binds follow-on evidence/module reads to a known permitted result within its retention window; this is not unrestricted historical access."
  },
  "ServiceProfile": {
    "name": "Entity-Service-Profile",
    "in": "header",
    "required": true,
    "schema": {
      "type": "string",
      "maxLength": 4096,
      "x-profile-maxLength": "string_characters_max"
    },
    "description": "Accepted immutable service-profile revision; missing/unknown profiles cannot activate an operation."
  }
}
Inherited path parameters
[]

All API operations