Sustema

ENTITY developer reference

NormalisationIssue

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.

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.

field_path

Listed in this schema’s required array.

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

code

Listed in this schema’s required array.

Declared type
"string"
Reading definition for code
{
  "type": "string",
  "enum": [
    "format_only",
    "country_alias_resolved",
    "country_ambiguous",
    "country_conflict",
    "invalid_identifier",
    "identifier_conflict",
    "language_unknown",
    "script_mixed",
    "legal_form_unmapped",
    "translation_candidate_only",
    "insufficient_context",
    "unsupported_scope"
  ],
  "x-profile-maxLength": "string_characters_max"
}

severity

Listed in this schema’s required array.

Declared type
"string"
Reading definition for severity
{
  "type": "string",
  "enum": [
    "information",
    "review",
    "blocking"
  ],
  "x-profile-maxLength": "string_characters_max"
}

next_action

Listed in this schema’s required array.

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

recovery_action

Not listed in this schema’s required array.

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

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": {
    "field_path": {
      "type": "string",
      "x-profile-maxLength": "string_characters_max"
    },
    "code": {
      "type": "string",
      "enum": [
        "format_only",
        "country_alias_resolved",
        "country_ambiguous",
        "country_conflict",
        "invalid_identifier",
        "identifier_conflict",
        "language_unknown",
        "script_mixed",
        "legal_form_unmapped",
        "translation_candidate_only",
        "insufficient_context",
        "unsupported_scope"
      ],
      "x-profile-maxLength": "string_characters_max"
    },
    "severity": {
      "type": "string",
      "enum": [
        "information",
        "review",
        "blocking"
      ],
      "x-profile-maxLength": "string_characters_max"
    },
    "next_action": {
      "type": "string",
      "x-profile-maxLength": "string_characters_max"
    },
    "recovery_action": {
      "$ref": "#/components/schemas/RecoveryAction"
    }
  },
  "required": [
    "field_path",
    "code",
    "severity",
    "next_action"
  ],
  "additionalProperties": false
}

Related schemas

All API operations