Sustema

ENTITY developer reference

FactConfidence

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.

SEI 0.1: semantic checks enforce exact calculation, same-basis selection, delivered<=conditional/link, unknown propagation, caps, context and disclosure.

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.

assessment_id

Listed in this schema’s required array.

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

method_revision

Listed in this schema’s required array.

Declared type
Not declared directly; consult the complete field definition.
Reading definition for method_revision
{
  "const": "sei-0.1"
}

predicate_policy_revision

Listed in this schema’s required array.

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

evaluated_at

Listed in this schema’s required array.

Declared type
"string"
Declared format
"date-time"
Reading definition for evaluated_at
{
  "type": "string",
  "format": "date-time",
  "x-profile-maxLength": "string_characters_max"
}

as_of

Listed in this schema’s required array.

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

source_linkage

Listed in this schema’s required array.

Declared type
Not declared directly; consult the complete field definition.
Reading definition for source_linkage
{
  "allOf": [
    {
      "$ref": "#/components/schemas/PercentageScore"
    },
    {
      "properties": {
        "method_revision": {
          "const": "sli-0.1"
        }
      }
    }
  ]
}

attribute_support

Listed in this schema’s required array.

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

delivered_support

Listed in this schema’s required array.

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

conflict

Listed in this schema’s required array.

Declared type
"string"
Reading definition for conflict
{
  "type": "string",
  "enum": [
    "none_found_in_assessed_scope",
    "resolved",
    "credible_weaker_unresolved",
    "material_unresolved",
    "not_assessed"
  ],
  "x-profile-maxLength": "string_characters_max"
}

explanation

Listed in this schema’s required array.

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

calibration_status

Listed in this schema’s required array.

Declared type
Not declared directly; consult the complete field definition.
Reading definition for calibration_status
{
  "const": "not_calibrated"
}

disclosure

Listed in this schema’s required array.

Declared type
"string"
Reading definition for disclosure
{
  "type": "string",
  "enum": [
    "permitted_basis",
    "explanation_limited"
  ],
  "x-profile-maxLength": "string_characters_max"
}

target

Listed in this schema’s required array.

Declared type
Not declared directly; consult the complete field definition.
Reading definition for target
{
  "const": "fact_for_entity_predicate_scope_and_time"
}

calculation

Listed in this schema’s required array.

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

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": {
    "assessment_id": {
      "type": "string",
      "format": "uuid",
      "x-profile-maxLength": "string_characters_max"
    },
    "method_revision": {
      "const": "sei-0.1"
    },
    "predicate_policy_revision": {
      "type": "string",
      "minLength": 1,
      "x-profile-maxLength": "string_characters_max"
    },
    "evaluated_at": {
      "type": "string",
      "format": "date-time",
      "x-profile-maxLength": "string_characters_max"
    },
    "as_of": {
      "$ref": "#/components/schemas/KnownTime"
    },
    "source_linkage": {
      "allOf": [
        {
          "$ref": "#/components/schemas/PercentageScore"
        },
        {
          "properties": {
            "method_revision": {
              "const": "sli-0.1"
            }
          }
        }
      ]
    },
    "attribute_support": {
      "$ref": "#/components/schemas/SupportRating"
    },
    "delivered_support": {
      "$ref": "#/components/schemas/SupportRating"
    },
    "conflict": {
      "type": "string",
      "enum": [
        "none_found_in_assessed_scope",
        "resolved",
        "credible_weaker_unresolved",
        "material_unresolved",
        "not_assessed"
      ],
      "x-profile-maxLength": "string_characters_max"
    },
    "explanation": {
      "$ref": "#/components/schemas/ConfidenceExplanation"
    },
    "calibration_status": {
      "const": "not_calibrated"
    },
    "disclosure": {
      "type": "string",
      "enum": [
        "permitted_basis",
        "explanation_limited"
      ],
      "x-profile-maxLength": "string_characters_max"
    },
    "target": {
      "const": "fact_for_entity_predicate_scope_and_time"
    },
    "calculation": {
      "$ref": "#/components/schemas/ConfidenceCalculation"
    }
  },
  "required": [
    "assessment_id",
    "method_revision",
    "predicate_policy_revision",
    "evaluated_at",
    "as_of",
    "source_linkage",
    "attribute_support",
    "delivered_support",
    "conflict",
    "explanation",
    "calibration_status",
    "disclosure",
    "target",
    "calculation"
  ],
  "additionalProperties": false,
  "description": "SEI 0.1: semantic checks enforce exact calculation, same-basis selection, delivered<=conditional/link, unknown propagation, caps, context and disclosure.",
  "allOf": [
    {
      "if": {
        "properties": {
          "attribute_support": {
            "properties": {
              "state": {
                "const": "not_assessed"
              }
            },
            "required": [
              "state"
            ]
          }
        },
        "required": [
          "attribute_support"
        ]
      },
      "then": {
        "properties": {
          "delivered_support": {
            "properties": {
              "state": {
                "const": "not_assessed"
              }
            }
          }
        }
      }
    },
    {
      "if": {
        "properties": {
          "source_linkage": {
            "properties": {
              "state": {
                "const": "not_assessed"
              }
            },
            "required": [
              "state"
            ]
          }
        },
        "required": [
          "source_linkage"
        ]
      },
      "then": {
        "properties": {
          "delivered_support": {
            "properties": {
              "state": {
                "const": "not_assessed"
              }
            }
          }
        }
      }
    },
    {
      "if": {
        "properties": {
          "conflict": {
            "const": "material_unresolved"
          }
        },
        "required": [
          "conflict"
        ]
      },
      "then": {
        "properties": {
          "attribute_support": {
            "properties": {
              "score_basis_points": {
                "maximum": 5900
              }
            }
          },
          "delivered_support": {
            "properties": {
              "score_basis_points": {
                "maximum": 5900
              }
            }
          }
        }
      }
    },
    {
      "if": {
        "properties": {
          "conflict": {
            "const": "credible_weaker_unresolved"
          }
        },
        "required": [
          "conflict"
        ]
      },
      "then": {
        "properties": {
          "attribute_support": {
            "properties": {
              "score_basis_points": {
                "maximum": 8400
              }
            }
          },
          "delivered_support": {
            "properties": {
              "score_basis_points": {
                "maximum": 8400
              }
            }
          }
        }
      }
    },
    {
      "if": {
        "properties": {
          "delivered_support": {
            "properties": {
              "zone": {
                "const": "strong"
              }
            },
            "required": [
              "zone"
            ]
          }
        },
        "required": [
          "delivered_support"
        ]
      },
      "then": {
        "properties": {
          "as_of": {
            "properties": {
              "precision": {
                "enum": [
                  "instant",
                  "date"
                ]
              }
            }
          }
        }
      }
    }
  ]
}

Related schemas

All API operations