ENTITY developer reference
Relationship
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.
relationship_id
Listed in this schema’s required array.
- Declared type
"string"- Declared format
"uuid"
Reading definition for relationship_id
{
"type": "string",
"format": "uuid",
"x-profile-maxLength": "string_characters_max"
}revision
Listed in this schema’s required array.
- Declared type
"string"
Reading definition for revision
{
"type": "string",
"x-profile-maxLength": "string_characters_max"
}type
Listed in this schema’s required array.
Type defined by the selected released profile; accounting parent is distinct from ownership/control.
- Declared type
"string"
Reading definition for type
{
"type": "string",
"description": "Type defined by the selected released profile; accounting parent is distinct from ownership/control.",
"x-profile-maxLength": "string_characters_max"
}from
Listed in this schema’s required array.
- Declared type
- Not declared directly; consult the complete field definition.
Reading definition for from
{
"$ref": "#/components/schemas/SubjectRef"
}to
Listed in this schema’s required array.
- Declared type
- Not declared directly; consult the complete field definition.
Reading definition for to
{
"$ref": "#/components/schemas/SubjectRef"
}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"
}quantity
Listed in this schema’s required array.
- Declared type
- Not declared directly; consult the complete field definition.
Reading definition for quantity
{
"anyOf": [
{
"type": "object",
"properties": {
"kind": {
"type": "string",
"enum": [
"exact",
"range"
],
"x-profile-maxLength": "string_characters_max"
},
"lower": {
"type": "string",
"pattern": "^[0-9]+(\\.[0-9]+)?$",
"x-profile-maxLength": "string_characters_max"
},
"upper": {
"type": "string",
"pattern": "^[0-9]+(\\.[0-9]+)?$",
"x-profile-maxLength": "string_characters_max"
},
"unit": {
"const": "percent"
},
"basis": {
"type": "string",
"enum": [
"voting",
"economic",
"other"
],
"x-profile-maxLength": "string_characters_max"
}
},
"required": [
"kind",
"lower",
"upper",
"unit",
"basis"
],
"additionalProperties": false
},
{
"type": "null"
}
]
}evidence
Listed in this schema’s required array.
- Declared type
- Not declared directly; consult the complete field definition.
Reading definition for evidence
{
"$ref": "#/components/schemas/EvidenceSummary"
}claim_ids
Listed in this schema’s required array.
- Declared type
"array"
Reading definition for claim_ids
{
"type": "array",
"items": {
"type": "string",
"format": "uuid",
"x-profile-maxLength": "string_characters_max"
},
"x-profile-maxItems": "collection_items_max"
}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"
}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": {
"relationship_id": {
"type": "string",
"format": "uuid",
"x-profile-maxLength": "string_characters_max"
},
"revision": {
"type": "string",
"x-profile-maxLength": "string_characters_max"
},
"type": {
"type": "string",
"description": "Type defined by the selected released profile; accounting parent is distinct from ownership/control.",
"x-profile-maxLength": "string_characters_max"
},
"from": {
"$ref": "#/components/schemas/SubjectRef"
},
"to": {
"$ref": "#/components/schemas/SubjectRef"
},
"clocks": {
"$ref": "#/components/schemas/Clocks"
},
"quantity": {
"anyOf": [
{
"type": "object",
"properties": {
"kind": {
"type": "string",
"enum": [
"exact",
"range"
],
"x-profile-maxLength": "string_characters_max"
},
"lower": {
"type": "string",
"pattern": "^[0-9]+(\\.[0-9]+)?$",
"x-profile-maxLength": "string_characters_max"
},
"upper": {
"type": "string",
"pattern": "^[0-9]+(\\.[0-9]+)?$",
"x-profile-maxLength": "string_characters_max"
},
"unit": {
"const": "percent"
},
"basis": {
"type": "string",
"enum": [
"voting",
"economic",
"other"
],
"x-profile-maxLength": "string_characters_max"
}
},
"required": [
"kind",
"lower",
"upper",
"unit",
"basis"
],
"additionalProperties": false
},
{
"type": "null"
}
]
},
"evidence": {
"$ref": "#/components/schemas/EvidenceSummary"
},
"claim_ids": {
"type": "array",
"items": {
"type": "string",
"format": "uuid",
"x-profile-maxLength": "string_characters_max"
},
"x-profile-maxItems": "collection_items_max"
},
"limitations": {
"type": "array",
"items": {
"type": "string",
"x-profile-maxLength": "explanation_characters_max"
},
"x-profile-maxItems": "limitations_max"
}
},
"required": [
"relationship_id",
"revision",
"type",
"from",
"to",
"clocks",
"quantity",
"evidence",
"claim_ids",
"limitations"
],
"additionalProperties": false
}