Sustema

ENTITY developer reference

Entity

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.

This is the public candidate schema reading view. Read it with the operation that uses it; a representable field does not establish enabled coverage or entitlement.

Complete means every fixed public profile slot has exactly one outcome and every permitted emitted claim is mapped; it is not a claim of complete real-world data. Missing and existence-withheld data both yield not_provided without private IDs. Unavailable optional computation yields partial_optional_modules; required identity failure is an error. No size truncation. Bind the public slot manifest and policy in projection_binding even when confidence is unavailable.

Declared type: "object"

Declared fields

This list shows only properties declared directly in this schema. Required labels refer only to this schema’s own required array. Referenced, composed and conditional rules can add constraints; a field not listed as required here is not guaranteed to be optional.

subject

Listed in this schema’s required array.

Declared type
Not declared directly; consult the complete field definition.
Reading definition for subject
{
  "$ref": "#/components/schemas/SubjectRef"
}

lifecycle

Listed in this schema’s required array.

Declared type
Not declared directly; consult the complete field definition.
Reading definition for lifecycle
{
  "$ref": "#/components/schemas/Lifecycle"
}

publication

Listed in this schema’s required array.

Declared type
Not declared directly; consult the complete field definition.
Reading definition for publication
{
  "$ref": "#/components/schemas/Publication"
}

claims

Listed in this schema’s required array.

Declared type
"array"
Reading definition for claims
{
  "type": "array",
  "items": {
    "$ref": "#/components/schemas/Claim"
  },
  "x-profile-maxItems": "entity_claims_max"
}

modules

Listed in this schema’s required array.

Declared type
"array"
Reading definition for modules
{
  "type": "array",
  "items": {
    "$ref": "#/components/schemas/ModuleState"
  },
  "x-profile-maxItems": "entity_modules_max"
}

limitations

Listed in this schema’s required array.

Declared type
"array"
Reading definition for limitations
{
  "type": "array",
  "items": {
    "type": "string",
    "x-profile-maxLength": "explanation_characters_max"
  },
  "x-profile-maxItems": "limitations_max"
}

confidence_summary

Listed in this schema’s required array.

Declared type
Not declared directly; consult the complete field definition.
Reading definition for confidence_summary
{
  "$ref": "#/components/schemas/ConfidenceSummary"
}

completeness

Listed in this schema’s required array.

Declared type
Not declared directly; consult the complete field definition.
Reading definition for completeness
{
  "$ref": "#/components/schemas/EntityCompleteness"
}

projection_binding

Listed in this schema’s required array.

Declared type
Not declared directly; consult the complete field definition.
Reading definition for projection_binding
{
  "$ref": "#/components/schemas/ProjectionBinding"
}

slot_outcomes

Listed in this schema’s required array.

Declared type
"array"
Reading definition for slot_outcomes
{
  "type": "array",
  "maxItems": 256,
  "items": {
    "type": "object",
    "additionalProperties": false,
    "properties": {
      "slot_id": {
        "type": "string",
        "minLength": 1,
        "maxLength": 120
      },
      "state": {
        "enum": [
          "provided",
          "not_provided",
          "unavailable"
        ]
      },
      "claim_ids": {
        "type": "array",
        "items": {
          "type": "string",
          "format": "uuid"
        },
        "x-profile-maxItems": "entity_claims_max"
      }
    },
    "required": [
      "slot_id",
      "state",
      "claim_ids"
    ],
    "allOf": [
      {
        "if": {
          "properties": {
            "state": {
              "enum": [
                "not_provided",
                "unavailable"
              ]
            }
          },
          "required": [
            "state"
          ]
        },
        "then": {
          "properties": {
            "claim_ids": {
              "maxItems": 0
            }
          }
        },
        "else": {
          "properties": {
            "claim_ids": {
              "minItems": 1
            }
          }
        }
      }
    ]
  }
}

Schema reading view

Read all retained constraints, including any allOf, oneOf, anyOf, conditional and additional-property constraints. The field list does not combine branches. Explicitly marked private-only omissions mean this view is not an executable substitute for the original schema or a released contract.

{
  "type": "object",
  "properties": {
    "subject": {
      "$ref": "#/components/schemas/SubjectRef"
    },
    "lifecycle": {
      "$ref": "#/components/schemas/Lifecycle"
    },
    "publication": {
      "$ref": "#/components/schemas/Publication"
    },
    "claims": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/Claim"
      },
      "x-profile-maxItems": "entity_claims_max"
    },
    "modules": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/ModuleState"
      },
      "x-profile-maxItems": "entity_modules_max"
    },
    "limitations": {
      "type": "array",
      "items": {
        "type": "string",
        "x-profile-maxLength": "explanation_characters_max"
      },
      "x-profile-maxItems": "limitations_max"
    },
    "confidence_summary": {
      "$ref": "#/components/schemas/ConfidenceSummary"
    },
    "completeness": {
      "$ref": "#/components/schemas/EntityCompleteness"
    },
    "projection_binding": {
      "$ref": "#/components/schemas/ProjectionBinding"
    },
    "slot_outcomes": {
      "type": "array",
      "maxItems": 256,
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "slot_id": {
            "type": "string",
            "minLength": 1,
            "maxLength": 120
          },
          "state": {
            "enum": [
              "provided",
              "not_provided",
              "unavailable"
            ]
          },
          "claim_ids": {
            "type": "array",
            "items": {
              "type": "string",
              "format": "uuid"
            },
            "x-profile-maxItems": "entity_claims_max"
          }
        },
        "required": [
          "slot_id",
          "state",
          "claim_ids"
        ],
        "allOf": [
          {
            "if": {
              "properties": {
                "state": {
                  "enum": [
                    "not_provided",
                    "unavailable"
                  ]
                }
              },
              "required": [
                "state"
              ]
            },
            "then": {
              "properties": {
                "claim_ids": {
                  "maxItems": 0
                }
              }
            },
            "else": {
              "properties": {
                "claim_ids": {
                  "minItems": 1
                }
              }
            }
          }
        ]
      }
    }
  },
  "required": [
    "subject",
    "lifecycle",
    "publication",
    "claims",
    "modules",
    "limitations",
    "confidence_summary",
    "completeness",
    "projection_binding",
    "slot_outcomes"
  ],
  "additionalProperties": false,
  "description": "Complete means every fixed public profile slot has exactly one outcome and every permitted emitted claim is mapped; it is not a claim of complete real-world data. Missing and existence-withheld data both yield not_provided without private IDs. Unavailable optional computation yields partial_optional_modules; required identity failure is an error. No size truncation. Bind the public slot manifest and policy in projection_binding even when confidence is unavailable.",
  "allOf": [
    {
      "if": {
        "required": [
          "completeness"
        ],
        "properties": {
          "completeness": {
            "const": "partial_optional_modules"
          }
        }
      },
      "then": {
        "properties": {
          "modules": {
            "contains": {
              "type": "object",
              "required": [
                "release",
                "entitlement",
                "operation"
              ],
              "properties": {
                "release": {
                  "const": "released"
                },
                "entitlement": {
                  "const": "permitted"
                },
                "operation": {
                  "enum": [
                    "degraded",
                    "unavailable"
                  ]
                }
              }
            }
          }
        }
      },
      "else": {
        "properties": {
          "modules": {
            "not": {
              "contains": {
                "type": "object",
                "required": [
                  "release",
                  "entitlement",
                  "operation"
                ],
                "properties": {
                  "release": {
                    "const": "released"
                  },
                  "entitlement": {
                    "const": "permitted"
                  },
                  "operation": {
                    "enum": [
                      "degraded",
                      "unavailable"
                    ]
                  }
                }
              }
            }
          }
        }
      }
    },
    {
      "if": {
        "properties": {
          "slot_outcomes": {
            "contains": {
              "properties": {
                "state": {
                  "const": "unavailable"
                }
              },
              "required": [
                "state"
              ]
            }
          }
        },
        "required": [
          "slot_outcomes"
        ]
      },
      "then": {
        "properties": {
          "completeness": {
            "const": "partial_optional_modules"
          }
        }
      }
    }
  ],
  "x-semantic-invariants": [
    "Exact profile, slot-manifest hash and confidence-policy revision match the selected capability.",
    "Exactly one outcome per public slot; no additional, missing or duplicated slots. Every visible claim maps to a compatible slot; every listed claim is present.",
    "Required identity slots are provided; unavailable permitted optional slots match degraded/unavailable ModuleState.",
    "Per-entity hidden data never changes public slot vocabulary/hash or not_provided representation."
  ]
}

Related schemas

All API operations