Sustema

ENTITY developer reference

ICSuccessRule

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.

No hard-coded production threshold. Every required check plus minimum delivered score must pass; no overall-score substitution or tariff-dependent score. Qualification must set an accepted value.

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.

policy

Listed in this schema’s required array.

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

minimum_confidence_basis_points

Listed in this schema’s required array.

Declared type
"integer"
Reading definition for minimum_confidence_basis_points
{
  "type": "integer",
  "minimum": 0,
  "maximum": 10000
}

comparison

Listed in this schema’s required array.

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

assessment_method

Listed in this schema’s required array.

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

score_scope

Listed in this schema’s required array.

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

required_checks

Listed in this schema’s required array.

Declared type
"array"
Reading definition for required_checks
{
  "type": "array",
  "items": {
    "type": "string",
    "enum": [
      "resolved_subject",
      "requested_edition",
      "requested_depth",
      "activity_role",
      "current_evidence",
      "permitted_rights",
      "no_material_conflict"
    ],
    "x-profile-maxLength": "string_characters_max"
  },
  "minItems": 7,
  "maxItems": 7,
  "uniqueItems": true,
  "x-profile-maxItems": "collection_items_max"
}

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": {
    "policy": {
      "$ref": "#/components/schemas/ICVersionRef"
    },
    "minimum_confidence_basis_points": {
      "type": "integer",
      "minimum": 0,
      "maximum": 10000
    },
    "comparison": {
      "const": "greater_than_or_equal_to"
    },
    "assessment_method": {
      "const": "sei-0.1"
    },
    "score_scope": {
      "const": "each_delivered_classification"
    },
    "required_checks": {
      "type": "array",
      "items": {
        "type": "string",
        "enum": [
          "resolved_subject",
          "requested_edition",
          "requested_depth",
          "activity_role",
          "current_evidence",
          "permitted_rights",
          "no_material_conflict"
        ],
        "x-profile-maxLength": "string_characters_max"
      },
      "minItems": 7,
      "maxItems": 7,
      "uniqueItems": true,
      "x-profile-maxItems": "collection_items_max"
    }
  },
  "required": [
    "policy",
    "minimum_confidence_basis_points",
    "comparison",
    "assessment_method",
    "score_scope",
    "required_checks"
  ],
  "additionalProperties": false,
  "description": "No hard-coded production threshold. Every required check plus minimum delivered score must pass; no overall-score substitution or tariff-dependent score. Qualification must set an accepted value."
}

Related schemas

All API operations