Sustema

ENTITY developer reference

Candidate

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.

subject

Listed in this schema’s required array.

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

display_name

Listed in this schema’s required array.

Declared type
"string"
Reading definition for display_name
{
  "type": "string",
  "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"
    }
  ]
}

identifiers

Listed in this schema’s required array.

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

hints

Listed in this schema’s required array.

Declared type
"array"
Reading definition for hints
{
  "type": "array",
  "items": {
    "type": "string",
    "x-profile-maxLength": "explanation_characters_max"
  },
  "x-profile-maxItems": "candidate_hints_max"
}

contradictions

Listed in this schema’s required array.

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

evidence_ceiling

Listed in this schema’s required array.

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

is_resolution

Listed in this schema’s required array.

Declared type
Not declared directly; consult the complete field definition.
Reading definition for is_resolution
{
  "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": {
    "subject": {
      "$ref": "#/components/schemas/SubjectRef"
    },
    "display_name": {
      "type": "string",
      "x-profile-maxLength": "string_characters_max"
    },
    "jurisdiction": {
      "anyOf": [
        {
          "type": "string",
          "x-profile-maxLength": "string_characters_max"
        },
        {
          "type": "null"
        }
      ]
    },
    "identifiers": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/Identifier"
      },
      "x-profile-maxItems": "collection_items_max"
    },
    "hints": {
      "type": "array",
      "items": {
        "type": "string",
        "x-profile-maxLength": "explanation_characters_max"
      },
      "x-profile-maxItems": "candidate_hints_max"
    },
    "contradictions": {
      "type": "array",
      "items": {
        "type": "string",
        "x-profile-maxLength": "string_characters_max"
      },
      "x-profile-maxItems": "collection_items_max"
    },
    "evidence_ceiling": {
      "$ref": "#/components/schemas/EvidenceLevel"
    },
    "is_resolution": {
      "const": false
    }
  },
  "required": [
    "subject",
    "display_name",
    "jurisdiction",
    "identifiers",
    "hints",
    "contradictions",
    "evidence_ceiling",
    "is_resolution"
  ],
  "additionalProperties": false
}

Related schemas

All API operations