Sustema

ENTITY developer reference

InputNormalisation

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.

Protected same-request diagnostics, no original values, normalised company text, arbitrary source URLs or customer row IDs in logs/receipts. Reference versions may be empty only when not_assessed. No parsing probability.

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_revision

Listed in this schema’s required array.

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

status

Listed in this schema’s required array.

Declared type
"string"
Reading definition for status
{
  "type": "string",
  "enum": [
    "no_change",
    "normalised",
    "needs_review",
    "blocked",
    "not_assessed"
  ],
  "x-profile-maxLength": "string_characters_max"
}

issues

Listed in this schema’s required array.

Declared type
"array"
Reading definition for issues
{
  "type": "array",
  "items": {
    "$ref": "#/components/schemas/NormalisationIssue"
  },
  "x-profile-maxItems": "collection_items_max"
}

reference_versions

Listed in this schema’s required array.

Declared type
"array"
Reading definition for reference_versions
{
  "type": "array",
  "items": {
    "type": "string",
    "x-profile-maxLength": "string_characters_max"
  },
  "x-profile-maxItems": "collection_items_max"
}

raw_values_included

Listed in this schema’s required array.

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

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_revision": {
      "type": "string",
      "minLength": 1,
      "x-profile-maxLength": "string_characters_max"
    },
    "status": {
      "type": "string",
      "enum": [
        "no_change",
        "normalised",
        "needs_review",
        "blocked",
        "not_assessed"
      ],
      "x-profile-maxLength": "string_characters_max"
    },
    "issues": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/NormalisationIssue"
      },
      "x-profile-maxItems": "collection_items_max"
    },
    "reference_versions": {
      "type": "array",
      "items": {
        "type": "string",
        "x-profile-maxLength": "string_characters_max"
      },
      "x-profile-maxItems": "collection_items_max"
    },
    "raw_values_included": {
      "const": false
    }
  },
  "required": [
    "policy_revision",
    "status",
    "issues",
    "reference_versions",
    "raw_values_included"
  ],
  "additionalProperties": false,
  "description": "Protected same-request diagnostics, no original values, normalised company text, arbitrary source URLs or customer row IDs in logs/receipts. Reference versions may be empty only when not_assessed. No parsing probability.",
  "allOf": [
    {
      "if": {
        "properties": {
          "status": {
            "not": {
              "const": "not_assessed"
            }
          }
        },
        "required": [
          "status"
        ]
      },
      "then": {
        "properties": {
          "reference_versions": {
            "minItems": 1
          }
        }
      }
    }
  ]
}

Related schemas

All API operations