Sustema

ENTITY developer reference

Identifier

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.

scheme

Listed in this schema’s required array.

Registered identifier scheme; unknown/unreleased schemes are rejected.

Declared type
"string"
Reading definition for scheme
{
  "type": "string",
  "description": "Registered identifier scheme; unknown/unreleased schemes are rejected.",
  "x-profile-maxLength": "string_characters_max"
}

authority

Listed in this schema’s required array.

Issuing namespace from the service profile; mandatory even when globally governed.

Declared type
"string"
Reading definition for authority
{
  "type": "string",
  "description": "Issuing namespace from the service profile; mandatory even when globally governed.",
  "x-profile-maxLength": "string_characters_max"
}

jurisdiction

Listed in this schema’s required array.

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

value

Listed in this schema’s required array.

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

subject_type

Listed in this schema’s required array.

Declared type
"string"
Reading definition for subject_type
{
  "type": "string",
  "enum": [
    "legal_entity",
    "branch",
    "instrument",
    "other_supported"
  ],
  "x-profile-maxLength": "string_characters_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": {
    "scheme": {
      "type": "string",
      "description": "Registered identifier scheme; unknown/unreleased schemes are rejected.",
      "x-profile-maxLength": "string_characters_max"
    },
    "authority": {
      "type": "string",
      "description": "Issuing namespace from the service profile; mandatory even when globally governed.",
      "x-profile-maxLength": "string_characters_max"
    },
    "jurisdiction": {
      "anyOf": [
        {
          "type": "string",
          "x-profile-maxLength": "string_characters_max"
        },
        {
          "type": "null"
        }
      ]
    },
    "value": {
      "type": "string",
      "minLength": 1,
      "x-profile-maxLength": "string_characters_max"
    },
    "subject_type": {
      "type": "string",
      "enum": [
        "legal_entity",
        "branch",
        "instrument",
        "other_supported"
      ],
      "x-profile-maxLength": "string_characters_max"
    }
  },
  "required": [
    "scheme",
    "authority",
    "jurisdiction",
    "value",
    "subject_type"
  ],
  "additionalProperties": false
}

All API operations