Sustema

ENTITY developer reference

Claim

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.

Existence-withheld claims are omitted entirely, including IDs/counts/receipts. Visible restricted/withdrawn claims use a minimal non-value projection.

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.

claim_id

Listed in this schema’s required array.

Declared type
"string"
Declared format
"uuid"
Reading definition for claim_id
{
  "type": "string",
  "format": "uuid",
  "x-profile-maxLength": "string_characters_max"
}

claim_version_id

Listed in this schema’s required array.

Declared type
"string"
Declared format
"uuid"
Reading definition for claim_version_id
{
  "type": "string",
  "format": "uuid",
  "x-profile-maxLength": "string_characters_max"
}

predicate

Listed in this schema’s required array.

Declared type
"string"
Reading definition for predicate
{
  "type": "string",
  "x-profile-maxLength": "string_characters_max"
}

availability

Listed in this schema’s required array.

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

value

Not listed in this schema’s required array.

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

evidence

Not listed in this schema’s required array.

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

clocks

Listed in this schema’s required array.

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

evidence_path

Not listed in this schema’s required array.

Declared type
Not declared directly; consult the complete field definition.
Reading definition for evidence_path
{
  "anyOf": [
    {
      "type": "string",
      "description": "Relative API path; no raw source-object URL.",
      "x-profile-maxLength": "string_characters_max"
    },
    {
      "type": "null"
    }
  ]
}

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

freshness

Listed in this schema’s required array.

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

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": {
    "claim_id": {
      "type": "string",
      "format": "uuid",
      "x-profile-maxLength": "string_characters_max"
    },
    "claim_version_id": {
      "type": "string",
      "format": "uuid",
      "x-profile-maxLength": "string_characters_max"
    },
    "predicate": {
      "type": "string",
      "x-profile-maxLength": "string_characters_max"
    },
    "availability": {
      "$ref": "#/components/schemas/Availability"
    },
    "value": {
      "$ref": "#/components/schemas/TypedValue"
    },
    "evidence": {
      "$ref": "#/components/schemas/EvidenceSummary"
    },
    "clocks": {
      "$ref": "#/components/schemas/Clocks"
    },
    "evidence_path": {
      "anyOf": [
        {
          "type": "string",
          "description": "Relative API path; no raw source-object URL.",
          "x-profile-maxLength": "string_characters_max"
        },
        {
          "type": "null"
        }
      ]
    },
    "limitations": {
      "type": "array",
      "items": {
        "type": "string",
        "x-profile-maxLength": "explanation_characters_max"
      },
      "x-profile-maxItems": "limitations_max"
    },
    "freshness": {
      "$ref": "#/components/schemas/Freshness"
    }
  },
  "required": [
    "claim_id",
    "claim_version_id",
    "predicate",
    "availability",
    "clocks",
    "limitations",
    "freshness"
  ],
  "additionalProperties": false,
  "allOf": [
    {
      "if": {
        "properties": {
          "availability": {
            "const": "available"
          }
        },
        "required": [
          "availability"
        ]
      },
      "then": {
        "required": [
          "value",
          "evidence"
        ]
      },
      "else": {
        "not": {
          "required": [
            "value"
          ]
        }
      }
    },
    {
      "if": {
        "properties": {
          "availability": {
            "enum": [
              "restricted",
              "withdrawn"
            ]
          }
        },
        "required": [
          "availability"
        ]
      },
      "then": {
        "properties": {
          "clocks": {
            "const": {
              "effective_from": {
                "precision": "unknown"
              },
              "effective_until": {
                "precision": "unknown"
              },
              "source_published": {
                "precision": "unknown"
              },
              "acquired": {
                "precision": "unknown"
              },
              "processed": {
                "precision": "unknown"
              },
              "verified": {
                "precision": "unknown"
              }
            }
          }
        },
        "not": {
          "anyOf": [
            {
              "required": [
                "evidence"
              ]
            },
            {
              "required": [
                "evidence_path"
              ]
            },
            {
              "required": [
                "confidence"
              ]
            },
            {
              "required": [
                "lineage"
              ]
            }
          ]
        }
      }
    }
  ],
  "description": "Existence-withheld claims are omitted entirely, including IDs/counts/receipts. Visible restricted/withdrawn claims use a minimal non-value projection."
}

Related schemas

All API operations