ENTITY developer reference
Lifecycle
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.
state
Listed in this schema’s required array.
- Declared type
"string"
Reading definition for state
{
"type": "string",
"enum": [
"active",
"retired_after_correction",
"split_requires_review"
],
"x-profile-maxLength": "string_characters_max"
}successors
Listed in this schema’s required array.
- Declared type
"array"
Reading definition for successors
{
"type": "array",
"items": {
"$ref": "#/components/schemas/SubjectRef"
},
"x-profile-maxItems": "collection_items_max"
}reason
Listed in this schema’s required array.
- Declared type
- Not declared directly; consult the complete field definition.
Reading definition for reason
{
"anyOf": [
{
"type": "string",
"x-profile-maxLength": "string_characters_max"
},
{
"type": "null"
}
]
}recorded_at
Listed in this schema’s required array.
- Declared type
"string"- Declared format
"date-time"
Reading definition for recorded_at
{
"type": "string",
"format": "date-time",
"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": {
"state": {
"type": "string",
"enum": [
"active",
"retired_after_correction",
"split_requires_review"
],
"x-profile-maxLength": "string_characters_max"
},
"successors": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SubjectRef"
},
"x-profile-maxItems": "collection_items_max"
},
"reason": {
"anyOf": [
{
"type": "string",
"x-profile-maxLength": "string_characters_max"
},
{
"type": "null"
}
]
},
"recorded_at": {
"type": "string",
"format": "date-time",
"x-profile-maxLength": "string_characters_max"
}
},
"required": [
"state",
"successors",
"reason",
"recorded_at"
],
"additionalProperties": false,
"allOf": [
{
"if": {
"properties": {
"state": {
"const": "active"
}
},
"required": [
"state"
]
},
"then": {
"properties": {
"successors": {
"maxItems": 0
}
}
}
},
{
"if": {
"properties": {
"state": {
"const": "retired_after_correction"
}
},
"required": [
"state"
]
},
"then": {
"properties": {
"successors": {
"minItems": 1,
"maxItems": 1
}
}
}
},
{
"if": {
"properties": {
"state": {
"const": "split_requires_review"
}
},
"required": [
"state"
]
},
"then": {
"properties": {
"successors": {
"minItems": 2
}
}
}
}
]
}