Sustema

ENTITY developer reference

EvidenceContribution

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.

contribution_id

Listed in this schema’s required array.

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

claim_version_id

Listed in this schema’s required array.

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

source_ref

Listed in this schema’s required array.

Permitted source identity/reference only.

Declared type
"string"
Reading definition for source_ref
{
  "type": "string",
  "description": "Permitted source identity/reference only.",
  "x-profile-maxLength": "string_characters_max"
}

source_record_ref

Not listed in this schema’s required array.

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

source_release_ref

Not listed in this schema’s required array.

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

selection

Listed in this schema’s required array.

Declared type
"string"
Reading definition for selection
{
  "type": "string",
  "enum": [
    "selected",
    "supporting",
    "competing"
  ],
  "x-profile-maxLength": "string_characters_max"
}

authority_class

Listed in this schema’s required array.

Declared type
"string"
Reading definition for authority_class
{
  "type": "string",
  "enum": [
    "constitutive",
    "statutory",
    "governed_identifier",
    "specialist",
    "commercial",
    "discovery",
    "not_assessed"
  ],
  "x-profile-maxLength": "string_characters_max"
}

origin

Listed in this schema’s required array.

Declared type
"string"
Reading definition for origin
{
  "type": "string",
  "enum": [
    "direct",
    "copied",
    "unknown",
    "derived",
    "contributed"
  ],
  "x-profile-maxLength": "string_characters_max"
}

origin_group_ref

Not listed in this schema’s required array.

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

clocks

Listed in this schema’s required array.

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

value

Not listed in this schema’s required array.

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

permitted_reference_url

Not listed in this schema’s required array.

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

limitations

Listed in this schema’s required array.

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

lineage

Listed in this schema’s required array.

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

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": {
    "contribution_id": {
      "type": "string",
      "format": "uuid",
      "x-profile-maxLength": "string_characters_max"
    },
    "claim_version_id": {
      "type": "string",
      "format": "uuid",
      "x-profile-maxLength": "string_characters_max"
    },
    "source_ref": {
      "type": "string",
      "description": "Permitted source identity/reference only.",
      "x-profile-maxLength": "string_characters_max"
    },
    "source_record_ref": {
      "anyOf": [
        {
          "type": "string",
          "x-profile-maxLength": "string_characters_max"
        },
        {
          "type": "null"
        }
      ]
    },
    "source_release_ref": {
      "anyOf": [
        {
          "type": "string",
          "x-profile-maxLength": "string_characters_max"
        },
        {
          "type": "null"
        }
      ]
    },
    "selection": {
      "type": "string",
      "enum": [
        "selected",
        "supporting",
        "competing"
      ],
      "x-profile-maxLength": "string_characters_max"
    },
    "authority_class": {
      "type": "string",
      "enum": [
        "constitutive",
        "statutory",
        "governed_identifier",
        "specialist",
        "commercial",
        "discovery",
        "not_assessed"
      ],
      "x-profile-maxLength": "string_characters_max"
    },
    "origin": {
      "type": "string",
      "enum": [
        "direct",
        "copied",
        "unknown",
        "derived",
        "contributed"
      ],
      "x-profile-maxLength": "string_characters_max"
    },
    "origin_group_ref": {
      "anyOf": [
        {
          "type": "string",
          "x-profile-maxLength": "string_characters_max"
        },
        {
          "type": "null"
        }
      ]
    },
    "clocks": {
      "$ref": "#/components/schemas/Clocks"
    },
    "value": {
      "$ref": "#/components/schemas/TypedValue"
    },
    "permitted_reference_url": {
      "anyOf": [
        {
          "type": "string",
          "format": "uri",
          "x-profile-maxLength": "string_characters_max"
        },
        {
          "type": "null"
        }
      ]
    },
    "limitations": {
      "type": "array",
      "items": {
        "type": "string",
        "x-profile-maxLength": "explanation_characters_max"
      },
      "x-profile-maxItems": "limitations_max"
    },
    "lineage": {
      "$ref": "#/components/schemas/OriginLineage"
    }
  },
  "required": [
    "contribution_id",
    "claim_version_id",
    "source_ref",
    "selection",
    "authority_class",
    "origin",
    "clocks",
    "limitations",
    "lineage"
  ],
  "additionalProperties": false
}

Related schemas

All API operations