Sustema

ENTITY developer reference

Retrieve industry classification

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.

getClassifications: the 409 response prose mentions operation_in_progress and the 503 prose mentions completion_uncertain, but the corresponding operation-specific error enums do not include those codes. The explicit response enums and x-error-codes govern; those prose mentions do not add allowed responses.

GET /v1/entities/{entity_id}/classifications

Operation identifier: getClassifications

Read an already acquired classification under its current permitted rights. No new classification deduction or research. Match acquisition subject, edition and manifest; mismatch/hidden reference fails safely. An absent or other-workspace acquisition is indistinguishable resource_not_found/404. A currently readable owned record may project withdrawn/restricted/temporarily_unavailable with no code values or hidden counts. Identity correction is assessed before revealing any successor; ownership alone never confers successor rights. 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.

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."
}

Idempotency-Key

header · Required

Random UUID for one logical operation, including billed GETs. Same request/key/time replays without a second charge; ENTITY application semantics.

Reading definition for Idempotency-Key
{
  "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."
}

Entity-Operation-Created-At

header · Required

Original creation instant, unchanged on retry. New keys outside the profile admission/skew window are refused even after tombstone expiry.

Reading definition for Entity-Operation-Created-At
{
  "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."
}

Entity-Max-Units

header · Optional

Caller ceiling in the accepted offer atomic unit; cannot increase organisation authority.

Schema: Units

Reading definition for Entity-Max-Units
{
  "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."
}

entity_id

path · Required

Reading definition for entity_id
{
  "name": "entity_id",
  "in": "path",
  "required": true,
  "schema": {
    "type": "string",
    "format": "uuid",
    "maxLength": 36
  }
}

manifest_id

query · Required

Manifest returned by identity/search. A compatibility-bound follow-on read, not unrestricted historical query. Current rights and retention apply.

Reading definition for manifest_id
{
  "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."
}

Entity-Receipt-Context

header · Required

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.

Reading definition for Entity-Receipt-Context
{
  "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."
}

page_size

query · Optional

Default and maximum from the active profile.

Reading definition for page_size
{
  "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."
}

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."
}

taxonomy

query · Required

Requested acquired scheme: NACE or NAICS, with pinned edition/variant in acquisition.

Reading definition for taxonomy
{
  "name": "taxonomy",
  "in": "query",
  "schema": {
    "type": "string",
    "maxLength": 4096,
    "x-profile-maxLength": "string_characters_max"
  },
  "required": true,
  "description": "Requested acquired scheme: NACE or NAICS, with pinned edition/variant in acquisition."
}

taxonomy_version

query · Required

Exact edition from acquisition; no on-read crosswalk or refresh.

Reading definition for taxonomy_version
{
  "name": "taxonomy_version",
  "in": "query",
  "schema": {
    "type": "string",
    "maxLength": 4096,
    "x-profile-maxLength": "string_characters_max"
  },
  "required": true,
  "description": "Exact edition from acquisition; no on-read crosswalk or refresh."
}

acquisition_id

query · Required

Owned acquisition for this entity/manifest and requested taxonomy edition. No new order or research on a read.

Reading definition for acquisition_id
{
  "name": "acquisition_id",
  "in": "query",
  "required": true,
  "schema": {
    "type": "string",
    "format": "uuid",
    "maxLength": 36
  },
  "description": "Owned acquisition for this entity/manifest and requested taxonomy edition. No new order or research on a read."
}

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": "getClassifications",
  "summary": "Retrieve industry classification",
  "parameters": [
    {
      "$ref": "#/components/parameters/ServiceProfile"
    },
    {
      "$ref": "#/components/parameters/IdempotencyKey"
    },
    {
      "$ref": "#/components/parameters/OperationCreated"
    },
    {
      "$ref": "#/components/parameters/MaxUnits"
    },
    {
      "name": "entity_id",
      "in": "path",
      "required": true,
      "schema": {
        "type": "string",
        "format": "uuid",
        "maxLength": 36
      }
    },
    {
      "$ref": "#/components/parameters/Manifest"
    },
    {
      "$ref": "#/components/parameters/ReceiptContext"
    },
    {
      "$ref": "#/components/parameters/PageSize"
    },
    {
      "$ref": "#/components/parameters/Cursor"
    },
    {
      "name": "taxonomy",
      "in": "query",
      "schema": {
        "type": "string",
        "maxLength": 4096,
        "x-profile-maxLength": "string_characters_max"
      },
      "required": true,
      "description": "Requested acquired scheme: NACE or NAICS, with pinned edition/variant in acquisition."
    },
    {
      "name": "taxonomy_version",
      "in": "query",
      "schema": {
        "type": "string",
        "maxLength": 4096,
        "x-profile-maxLength": "string_characters_max"
      },
      "required": true,
      "description": "Exact edition from acquisition; no on-read crosswalk or refresh."
    },
    {
      "name": "acquisition_id",
      "in": "query",
      "required": true,
      "schema": {
        "type": "string",
        "format": "uuid",
        "maxLength": 36
      },
      "description": "Owned acquisition for this entity/manifest and requested taxonomy edition. No new order or research on a read."
    }
  ],
  "responses": {
    "200": {
      "description": "Successful governed response; examples are synthetic and no endpoint is deployed by this specification.",
      "headers": {
        "Cache-Control": {
          "schema": {
            "const": "private, no-store"
          }
        },
        "Entity-Request-Id": {
          "schema": {
            "type": "string",
            "format": "uuid"
          }
        }
      },
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/ClassificationsResponse"
          },
          "example": {
            "data": {
              "subject": {
                "entity_id": "00000001-1111-4111-8111-000000000001",
                "environment": "synthetic-review",
                "manifest_id": "00000002-1111-4111-8111-000000000002",
                "subject_type": "legal_entity"
              },
              "assignments": [],
              "page": {
                "next_cursor": null,
                "returned": 0,
                "generation": "synthetic-generation-1",
                "expires_at": null,
                "completeness": {
                  "state": "unknown",
                  "scope": "Currently permitted projection of the owned acquisition",
                  "reasons": [
                    "Acquired values are withdrawn; no hidden value or count is disclosed."
                  ]
                }
              },
              "data_state": "withdrawn",
              "absence_evidence": null,
              "confidence_summary": {
                "state": "unavailable",
                "method_revision": "sei-0.1",
                "rating": {
                  "state": "not_assessed",
                  "score_basis_points": null,
                  "display_percent": null,
                  "zone": null,
                  "zone_label": "Not assessed",
                  "interpretation": "We do not have a usable basis to assess this information.",
                  "explanation": "No qualified SEI aggregate profile supplied.",
                  "meaning": "evidence_index_not_probability",
                  "method_revision": "sei-0.1",
                  "zone_policy_revision": "sez-0.1"
                },
                "reason": "assessment_unavailable",
                "explanation": "This older synthetic result has no SEI aggregate basis; no percentage is inferred."
              }
            },
            "receipt": {
              "receipt_id": "00000005-1111-4111-8111-000000000005",
              "operation_id": "00000006-1111-4111-8111-000000000006",
              "environment": "synthetic-review",
              "committed_at": "2026-09-07T10:00:00Z",
              "accepted_offer_id": "11111111-1111-4111-8111-111111111111",
              "original_period_id": "00000008-1111-4111-8111-000000000008",
              "subject_versions": [
                {
                  "entity_id": "00000001-1111-4111-8111-000000000001",
                  "environment": "synthetic-review",
                  "manifest_id": "00000002-1111-4111-8111-000000000002",
                  "subject_type": "legal_entity"
                }
              ],
              "profile_revision": "synthetic-review-1",
              "policy_revision": "synthetic-policy-1",
              "charged_units": "0",
              "unit": "synthetic_operation_unit",
              "unit_scale": 1,
              "settlement": "settled",
              "result_available_until": "2026-09-08T10:00:00Z",
              "receipt_available_until": "2026-09-14T10:00:00Z",
              "delivery_meaning": "authorised_delivery_commit_not_client_receipt",
              "projection": "full_permitted",
              "offer_binding": {
                "offer_id": "11111111-1111-4111-8111-111111111111",
                "offer_version": 1,
                "offer_sha256": "bbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb",
                "policy_pins": {
                  "tariff": {
                    "id": "synthetic-policy",
                    "version": "1",
                    "sha256": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"
                  },
                  "terms": {
                    "id": "synthetic-policy",
                    "version": "1",
                    "sha256": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"
                  },
                  "credit": {
                    "id": "synthetic-policy",
                    "version": "1",
                    "sha256": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"
                  },
                  "refresh": {
                    "id": "synthetic-policy",
                    "version": "1",
                    "sha256": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"
                  },
                  "retrieval": {
                    "id": "synthetic-policy",
                    "version": "1",
                    "sha256": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"
                  },
                  "eligibility": {
                    "id": "synthetic-policy",
                    "version": "1",
                    "sha256": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"
                  },
                  "protection": {
                    "id": "synthetic-policy",
                    "version": "1",
                    "sha256": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"
                  },
                  "rights": {
                    "id": "synthetic-policy",
                    "version": "1",
                    "sha256": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"
                  },
                  "success": {
                    "id": "synthetic-policy",
                    "version": "1",
                    "sha256": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"
                  }
                },
                "agreement_id": "22222222-2222-4222-8222-222222222222",
                "agreement_revision": 1,
                "funded_period_id": "00000008-1111-4111-8111-000000000008",
                "selection_evidence_id": "22222222-2222-4222-8222-222222222222"
              },
              "classification_order_id": null,
              "classification_item_ids": []
            },
            "meta": {
              "request_id": "00000007-1111-4111-8111-000000000007",
              "served_at": "2026-09-07T10:00:00Z",
              "profile_revision": "synthetic-review-1",
              "synthetic": true,
              "replayed": false,
              "warnings": [
                "Illustration only; limits, retention and units are not approved production terms.",
                "Owned acquisition after withdrawal; this zero-unit read grants no new rights or refresh."
              ]
            }
          }
        }
      }
    },
    "400": {
      "description": "invalid_request",
      "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."
        },
        "WWW-Authenticate": {
          "schema": {
            "type": "string"
          },
          "description": "Bearer challenge for 401 responses."
        }
      },
      "content": {
        "application/problem+json": {
          "schema": {
            "allOf": [
              {
                "allOf": [
                  {
                    "$ref": "#/components/schemas/Problem"
                  },
                  {
                    "properties": {
                      "code": {
                        "enum": [
                          "invalid_request"
                        ]
                      },
                      "status": {
                        "const": 400
                      }
                    }
                  }
                ]
              },
              {
                "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"
                      ]
                    }
                  }
                }
              }
            ]
          },
          "example": {
            "type": "urn:sustema:entity:problem:invalid_request",
            "title": "Malformed JSON, duplicate keys, timestamp, header or structural input.",
            "status": 400,
            "code": "invalid_request",
            "request_id": "00000007-1111-4111-8111-000000000007",
            "operation_id": null,
            "retry_action": "do_not_retry",
            "usage_state": "not_started"
          }
        }
      },
      "x-error-codes": [
        "invalid_request"
      ]
    },
    "401": {
      "description": "unauthenticated",
      "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."
        },
        "WWW-Authenticate": {
          "schema": {
            "type": "string"
          },
          "description": "Bearer challenge for 401 responses."
        }
      },
      "content": {
        "application/problem+json": {
          "schema": {
            "allOf": [
              {
                "allOf": [
                  {
                    "$ref": "#/components/schemas/Problem"
                  },
                  {
                    "properties": {
                      "code": {
                        "enum": [
                          "unauthenticated"
                        ]
                      },
                      "status": {
                        "const": 401
                      }
                    }
                  }
                ]
              },
              {
                "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"
                      ]
                    }
                  }
                }
              }
            ]
          },
          "example": {
            "type": "urn:sustema:entity:problem:unauthenticated",
            "title": "Missing/invalid access token; no protected resource details.",
            "status": 401,
            "code": "unauthenticated",
            "request_id": "00000007-1111-4111-8111-000000000007",
            "operation_id": null,
            "retry_action": "reauthenticate",
            "usage_state": "not_started"
          }
        }
      },
      "x-error-codes": [
        "unauthenticated"
      ]
    },
    "403": {
      "description": "permission_denied; entitlement_denied; authority_revoked",
      "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."
        },
        "WWW-Authenticate": {
          "schema": {
            "type": "string"
          },
          "description": "Bearer challenge for 401 responses."
        }
      },
      "content": {
        "application/problem+json": {
          "schema": {
            "allOf": [
              {
                "allOf": [
                  {
                    "$ref": "#/components/schemas/Problem"
                  },
                  {
                    "properties": {
                      "code": {
                        "enum": [
                          "permission_denied",
                          "entitlement_denied",
                          "authority_revoked"
                        ]
                      },
                      "status": {
                        "const": 403
                      }
                    }
                  }
                ]
              },
              {
                "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"
                      ]
                    }
                  }
                }
              }
            ]
          },
          "example": {
            "type": "urn:sustema:entity:problem:permission_denied",
            "title": "Authenticated principal lacks the action/resource grant.",
            "status": 403,
            "code": "permission_denied",
            "request_id": "00000007-1111-4111-8111-000000000007",
            "operation_id": null,
            "retry_action": "do_not_retry",
            "usage_state": "not_started"
          }
        }
      },
      "x-error-codes": [
        "permission_denied",
        "entitlement_denied",
        "authority_revoked"
      ]
    },
    "404": {
      "description": "resource_not_found",
      "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."
        },
        "WWW-Authenticate": {
          "schema": {
            "type": "string"
          },
          "description": "Bearer challenge for 401 responses."
        }
      },
      "content": {
        "application/problem+json": {
          "schema": {
            "allOf": [
              {
                "allOf": [
                  {
                    "$ref": "#/components/schemas/Problem"
                  },
                  {
                    "properties": {
                      "code": {
                        "enum": [
                          "resource_not_found"
                        ]
                      },
                      "status": {
                        "const": 404
                      }
                    }
                  }
                ]
              },
              {
                "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"
                      ]
                    }
                  }
                }
              }
            ]
          },
          "example": {
            "type": "urn:sustema:entity:problem:resource_not_found",
            "title": "Unknown resource, or tenant-private reference intentionally concealed.",
            "status": 404,
            "code": "resource_not_found",
            "request_id": "00000007-1111-4111-8111-000000000007",
            "operation_id": null,
            "retry_action": "do_not_retry",
            "usage_state": "not_started"
          }
        }
      },
      "x-error-codes": [
        "resource_not_found"
      ]
    },
    "409": {
      "description": "idempotency_conflict; operation_in_progress; result_invalidated",
      "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."
        },
        "WWW-Authenticate": {
          "schema": {
            "type": "string"
          },
          "description": "Bearer challenge for 401 responses."
        }
      },
      "content": {
        "application/problem+json": {
          "schema": {
            "allOf": [
              {
                "allOf": [
                  {
                    "$ref": "#/components/schemas/Problem"
                  },
                  {
                    "properties": {
                      "code": {
                        "enum": [
                          "idempotency_conflict",
                          "result_invalidated"
                        ]
                      },
                      "status": {
                        "const": 409
                      }
                    }
                  }
                ]
              },
              {
                "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"
                      ]
                    }
                  }
                }
              }
            ]
          },
          "example": {
            "type": "urn:sustema:entity:problem:idempotency_conflict",
            "title": "Same key with different canonical request or creation time.",
            "status": 409,
            "code": "idempotency_conflict",
            "request_id": "00000007-1111-4111-8111-000000000007",
            "operation_id": null,
            "retry_action": "do_not_retry",
            "usage_state": "unchanged",
            "status_path": null
          }
        }
      },
      "x-error-codes": [
        "idempotency_conflict",
        "result_invalidated"
      ]
    },
    "410": {
      "description": "operation_expired; result_expired; cursor_expired",
      "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."
        },
        "WWW-Authenticate": {
          "schema": {
            "type": "string"
          },
          "description": "Bearer challenge for 401 responses."
        }
      },
      "content": {
        "application/problem+json": {
          "schema": {
            "allOf": [
              {
                "allOf": [
                  {
                    "$ref": "#/components/schemas/Problem"
                  },
                  {
                    "properties": {
                      "code": {
                        "enum": [
                          "operation_expired",
                          "result_expired",
                          "cursor_expired"
                        ]
                      },
                      "status": {
                        "const": 410
                      }
                    }
                  }
                ]
              },
              {
                "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"
                      ]
                    }
                  }
                }
              }
            ]
          },
          "example": {
            "type": "urn:sustema:entity:problem:operation_expired",
            "title": "Old logical request outside retained/admission window; not newly charged.",
            "status": 410,
            "code": "operation_expired",
            "request_id": "00000007-1111-4111-8111-000000000007",
            "operation_id": null,
            "retry_action": "do_not_retry",
            "usage_state": "unchanged",
            "status_path": null
          }
        }
      },
      "x-error-codes": [
        "operation_expired",
        "result_expired",
        "cursor_expired"
      ]
    },
    "413": {
      "description": "payload_too_large",
      "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."
        },
        "WWW-Authenticate": {
          "schema": {
            "type": "string"
          },
          "description": "Bearer challenge for 401 responses."
        }
      },
      "content": {
        "application/problem+json": {
          "schema": {
            "allOf": [
              {
                "allOf": [
                  {
                    "$ref": "#/components/schemas/Problem"
                  },
                  {
                    "properties": {
                      "code": {
                        "enum": [
                          "payload_too_large"
                        ]
                      },
                      "status": {
                        "const": 413
                      }
                    }
                  }
                ]
              },
              {
                "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"
                      ]
                    }
                  }
                }
              }
            ]
          },
          "example": {
            "type": "urn:sustema:entity:problem:payload_too_large",
            "title": "Body exceeds profile admission limit.",
            "status": 413,
            "code": "payload_too_large",
            "request_id": "00000007-1111-4111-8111-000000000007",
            "operation_id": null,
            "retry_action": "do_not_retry",
            "usage_state": "not_started"
          }
        }
      },
      "x-error-codes": [
        "payload_too_large"
      ]
    },
    "422": {
      "description": "Bounded zero-unit refusal: input-phase not_started; delivery-phase unchanged; no financial effect or reverse operation reference.",
      "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."
        },
        "WWW-Authenticate": {
          "schema": {
            "type": "string"
          },
          "description": "Bearer challenge for 401 responses."
        }
      },
      "content": {
        "application/problem+json": {
          "schema": {
            "allOf": [
              {
                "allOf": [
                  {
                    "allOf": [
                      {
                        "$ref": "#/components/schemas/Problem"
                      },
                      {
                        "properties": {
                          "code": {
                            "enum": [
                              "unsupported_scope",
                              "limit_out_of_range"
                            ]
                          },
                          "status": {
                            "const": 422
                          }
                        }
                      },
                      {
                        "if": {
                          "properties": {
                            "code": {
                              "const": "limit_out_of_range"
                            }
                          },
                          "required": [
                            "code"
                          ]
                        },
                        "then": {
                          "properties": {
                            "usage_state": {
                              "enum": [
                                "not_started",
                                "unchanged"
                              ]
                            },
                            "retry_action": {
                              "const": "do_not_retry"
                            },
                            "operation_id": {
                              "type": "null"
                            },
                            "status_path": {
                              "type": "null"
                            }
                          }
                        }
                      }
                    ]
                  },
                  {
                    "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"
                          ]
                        }
                      }
                    }
                  }
                ]
              },
              {
                "if": {
                  "properties": {
                    "code": {
                      "const": "limit_out_of_range"
                    },
                    "delivery_limit": {
                      "properties": {
                        "phase": {
                          "const": "delivery"
                        }
                      },
                      "required": [
                        "phase"
                      ]
                    }
                  },
                  "required": [
                    "code",
                    "delivery_limit"
                  ]
                },
                "then": {
                  "properties": {
                    "usage_state": {
                      "const": "unchanged"
                    }
                  }
                }
              }
            ]
          },
          "example": {
            "type": "urn:sustema:entity:problem:unsupported_scope",
            "title": "Well-formed territory/identifier/module/projection is not released in profile.",
            "status": 422,
            "code": "unsupported_scope",
            "request_id": "00000007-1111-4111-8111-000000000007",
            "operation_id": null,
            "retry_action": "do_not_retry",
            "usage_state": "not_started"
          }
        }
      },
      "x-error-codes": [
        "unsupported_scope",
        "limit_out_of_range"
      ]
    },
    "429": {
      "description": "rate_limited; concurrency_limited",
      "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."
        },
        "WWW-Authenticate": {
          "schema": {
            "type": "string"
          },
          "description": "Bearer challenge for 401 responses."
        }
      },
      "content": {
        "application/problem+json": {
          "schema": {
            "allOf": [
              {
                "allOf": [
                  {
                    "$ref": "#/components/schemas/Problem"
                  },
                  {
                    "properties": {
                      "code": {
                        "enum": [
                          "rate_limited",
                          "concurrency_limited"
                        ]
                      },
                      "status": {
                        "const": 429
                      }
                    }
                  }
                ]
              },
              {
                "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"
                      ]
                    }
                  }
                }
              }
            ]
          },
          "example": {
            "type": "urn:sustema:entity:problem:rate_limited",
            "title": "Throughput admission refused.",
            "status": 429,
            "code": "rate_limited",
            "request_id": "00000007-1111-4111-8111-000000000007",
            "operation_id": null,
            "retry_action": "wait_then_retry_same_operation",
            "usage_state": "not_started"
          }
        }
      },
      "x-error-codes": [
        "rate_limited",
        "concurrency_limited"
      ]
    },
    "500": {
      "description": "internal_error",
      "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."
        },
        "WWW-Authenticate": {
          "schema": {
            "type": "string"
          },
          "description": "Bearer challenge for 401 responses."
        }
      },
      "content": {
        "application/problem+json": {
          "schema": {
            "allOf": [
              {
                "allOf": [
                  {
                    "$ref": "#/components/schemas/Problem"
                  },
                  {
                    "properties": {
                      "code": {
                        "enum": [
                          "internal_error"
                        ]
                      },
                      "status": {
                        "const": 500
                      }
                    }
                  }
                ]
              },
              {
                "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"
                      ]
                    }
                  }
                }
              }
            ]
          },
          "example": {
            "type": "urn:sustema:entity:problem:internal_error",
            "title": "Safe internal failure; no stack or protected payload.",
            "status": 500,
            "code": "internal_error",
            "request_id": "00000007-1111-4111-8111-000000000007",
            "operation_id": null,
            "retry_action": "wait_then_retry_same_operation",
            "usage_state": "not_started"
          }
        }
      },
      "x-error-codes": [
        "internal_error"
      ]
    },
    "503": {
      "description": "dependency_unavailable; correction_pending; completion_uncertain",
      "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."
        },
        "WWW-Authenticate": {
          "schema": {
            "type": "string"
          },
          "description": "Bearer challenge for 401 responses."
        }
      },
      "content": {
        "application/problem+json": {
          "schema": {
            "allOf": [
              {
                "allOf": [
                  {
                    "$ref": "#/components/schemas/Problem"
                  },
                  {
                    "properties": {
                      "code": {
                        "enum": [
                          "dependency_unavailable",
                          "correction_pending"
                        ]
                      },
                      "status": {
                        "const": 503
                      }
                    }
                  }
                ]
              },
              {
                "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"
                      ]
                    }
                  }
                }
              }
            ]
          },
          "example": {
            "type": "urn:sustema:entity:problem:dependency_unavailable",
            "title": "Required policy, publication, ledger or search dependency unavailable.",
            "status": 503,
            "code": "dependency_unavailable",
            "request_id": "00000007-1111-4111-8111-000000000007",
            "operation_id": null,
            "retry_action": "wait_then_retry_same_operation",
            "usage_state": "not_started"
          }
        }
      },
      "x-error-codes": [
        "dependency_unavailable",
        "correction_pending"
      ]
    },
    "504": {
      "description": "operation_timeout",
      "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."
        },
        "WWW-Authenticate": {
          "schema": {
            "type": "string"
          },
          "description": "Bearer challenge for 401 responses."
        }
      },
      "content": {
        "application/problem+json": {
          "schema": {
            "allOf": [
              {
                "allOf": [
                  {
                    "$ref": "#/components/schemas/Problem"
                  },
                  {
                    "properties": {
                      "code": {
                        "enum": [
                          "operation_timeout"
                        ]
                      },
                      "status": {
                        "const": 504
                      }
                    }
                  }
                ]
              },
              {
                "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"
                      ]
                    }
                  }
                }
              }
            ]
          },
          "example": {
            "type": "urn:sustema:entity:problem:operation_timeout",
            "title": "Read deadline exceeded; no fresh business effect or debit.",
            "status": 504,
            "code": "operation_timeout",
            "request_id": "00000007-1111-4111-8111-000000000007",
            "operation_id": null,
            "retry_action": "wait_then_retry_same_operation",
            "usage_state": "unchanged",
            "status_path": null
          }
        }
      },
      "x-error-codes": [
        "operation_timeout"
      ]
    },
    "default": {
      "description": "RFC 9457 problem; exact code/status/usage rules in errors.json. Current authority applies to all errors and replay.",
      "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."
        },
        "WWW-Authenticate": {
          "schema": {
            "type": "string"
          },
          "description": "Bearer challenge for 401 responses."
        }
      },
      "content": {
        "application/problem+json": {
          "schema": {
            "allOf": [
              {
                "allOf": [
                  {
                    "$ref": "#/components/schemas/Problem"
                  },
                  {
                    "properties": {
                      "code": {
                        "enum": [
                          "invalid_request",
                          "unauthenticated",
                          "permission_denied",
                          "entitlement_denied",
                          "authority_revoked",
                          "resource_not_found",
                          "idempotency_conflict",
                          "result_invalidated",
                          "operation_expired",
                          "result_expired",
                          "cursor_expired",
                          "payload_too_large",
                          "unsupported_scope",
                          "limit_out_of_range",
                          "rate_limited",
                          "concurrency_limited",
                          "dependency_unavailable",
                          "correction_pending",
                          "operation_timeout",
                          "internal_error"
                        ]
                      }
                    }
                  }
                ]
              },
              {
                "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.read",
  "x-billable": false,
  "description": "Read an already acquired classification under its current permitted rights. No new classification deduction or research. Match acquisition subject, edition and manifest; mismatch/hidden reference fails safely. An absent or other-workspace acquisition is indistinguishable resource_not_found/404. A currently readable owned record may project withdrawn/restricted/temporarily_unavailable with no code values or hidden counts. Identity correction is assessed before revealing any successor; ownership alone never confers successor rights. 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.",
  "x-cross-adapter-bound": {
    "operation": "getClassifications",
    "rule": "#/x-delivery-bound-contract",
    "before_settlement": true
  }
}

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