Sustema

ENTITY developer reference

LegalForm

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.

Jurisdiction-specific ISO 20275/ELF, not cross-country legal equivalence. Reserved 8888/9999 and code validity/version require semantic validation; raw label retained when unmapped.

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.

jurisdiction

Listed in this schema’s required array.

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

native_label

Listed in this schema’s required array.

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

language

Listed in this schema’s required array.

Declared type
Not declared directly; consult the complete field definition.
Reading definition for language
{
  "anyOf": [
    {
      "type": "string",
      "x-profile-maxLength": "string_characters_max"
    },
    {
      "type": "null"
    }
  ]
}

elf_code

Listed in this schema’s required array.

Declared type
Not declared directly; consult the complete field definition.
Reading definition for elf_code
{
  "anyOf": [
    {
      "type": "string",
      "pattern": "^[A-Z0-9]{4}$",
      "x-profile-maxLength": "string_characters_max"
    },
    {
      "type": "null"
    }
  ]
}

code_list_version

Listed in this schema’s required array.

Declared type
Not declared directly; consult the complete field definition.
Reading definition for code_list_version
{
  "anyOf": [
    {
      "type": "string",
      "x-profile-maxLength": "string_characters_max"
    },
    {
      "type": "null"
    }
  ]
}

mapping_status

Listed in this schema’s required array.

Declared type
"string"
Reading definition for mapping_status
{
  "type": "string",
  "enum": [
    "mapped",
    "unmapped",
    "requested_code",
    "no_separate_legal_form",
    "not_available"
  ],
  "x-profile-maxLength": "string_characters_max"
}

source_form_ref

Listed in this schema’s required array.

Declared type
Not declared directly; consult the complete field definition.
Reading definition for source_form_ref
{
  "anyOf": [
    {
      "type": "string",
      "x-profile-maxLength": "string_characters_max"
    },
    {
      "type": "null"
    }
  ]
}

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": {
    "jurisdiction": {
      "type": "string",
      "minLength": 1,
      "x-profile-maxLength": "string_characters_max"
    },
    "native_label": {
      "type": "string",
      "x-profile-maxLength": "string_characters_max"
    },
    "language": {
      "anyOf": [
        {
          "type": "string",
          "x-profile-maxLength": "string_characters_max"
        },
        {
          "type": "null"
        }
      ]
    },
    "elf_code": {
      "anyOf": [
        {
          "type": "string",
          "pattern": "^[A-Z0-9]{4}$",
          "x-profile-maxLength": "string_characters_max"
        },
        {
          "type": "null"
        }
      ]
    },
    "code_list_version": {
      "anyOf": [
        {
          "type": "string",
          "x-profile-maxLength": "string_characters_max"
        },
        {
          "type": "null"
        }
      ]
    },
    "mapping_status": {
      "type": "string",
      "enum": [
        "mapped",
        "unmapped",
        "requested_code",
        "no_separate_legal_form",
        "not_available"
      ],
      "x-profile-maxLength": "string_characters_max"
    },
    "source_form_ref": {
      "anyOf": [
        {
          "type": "string",
          "x-profile-maxLength": "string_characters_max"
        },
        {
          "type": "null"
        }
      ]
    }
  },
  "required": [
    "jurisdiction",
    "native_label",
    "language",
    "elf_code",
    "code_list_version",
    "mapping_status",
    "source_form_ref"
  ],
  "additionalProperties": false,
  "description": "Jurisdiction-specific ISO 20275/ELF, not cross-country legal equivalence. Reserved 8888/9999 and code validity/version require semantic validation; raw label retained when unmapped.",
  "allOf": [
    {
      "if": {
        "properties": {
          "elf_code": {
            "const": "8888"
          }
        },
        "required": [
          "elf_code"
        ]
      },
      "then": {
        "properties": {
          "mapping_status": {
            "const": "requested_code"
          }
        }
      }
    },
    {
      "if": {
        "properties": {
          "mapping_status": {
            "const": "requested_code"
          }
        },
        "required": [
          "mapping_status"
        ]
      },
      "then": {
        "properties": {
          "elf_code": {
            "const": "8888"
          },
          "code_list_version": {
            "type": "string",
            "minLength": 1,
            "x-profile-maxLength": "string_characters_max"
          }
        }
      }
    },
    {
      "if": {
        "properties": {
          "elf_code": {
            "const": "9999"
          }
        },
        "required": [
          "elf_code"
        ]
      },
      "then": {
        "properties": {
          "mapping_status": {
            "const": "no_separate_legal_form"
          }
        }
      }
    },
    {
      "if": {
        "properties": {
          "mapping_status": {
            "const": "no_separate_legal_form"
          }
        },
        "required": [
          "mapping_status"
        ]
      },
      "then": {
        "properties": {
          "elf_code": {
            "const": "9999"
          },
          "code_list_version": {
            "type": "string",
            "minLength": 1,
            "x-profile-maxLength": "string_characters_max"
          }
        }
      }
    },
    {
      "if": {
        "properties": {
          "mapping_status": {
            "const": "unmapped"
          }
        },
        "required": [
          "mapping_status"
        ]
      },
      "then": {
        "properties": {
          "elf_code": {
            "const": null
          }
        }
      }
    },
    {
      "if": {
        "properties": {
          "mapping_status": {
            "const": "not_available"
          }
        },
        "required": [
          "mapping_status"
        ]
      },
      "then": {
        "properties": {
          "elf_code": {
            "const": null
          }
        }
      }
    },
    {
      "if": {
        "properties": {
          "mapping_status": {
            "const": "mapped"
          }
        },
        "required": [
          "mapping_status"
        ]
      },
      "then": {
        "properties": {
          "elf_code": {
            "type": "string",
            "not": {
              "enum": [
                "8888",
                "9999"
              ]
            },
            "x-profile-maxLength": "string_characters_max"
          },
          "code_list_version": {
            "type": "string",
            "minLength": 1,
            "x-profile-maxLength": "string_characters_max"
          }
        }
      }
    }
  ]
}

All API operations