ENTITY developer reference
InputReference
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.
name
Not listed in this schema’s required array.
- Declared type
"string"
Reading definition for name
{
"type": "string",
"minLength": 1,
"x-profile-maxLength": "name_characters",
"x-additional-profile-maxLength": "string_characters_max"
}name_kind
Not listed in this schema’s required array.
- Declared type
"string"
Reading definition for name_kind
{
"type": "string",
"enum": [
"unknown",
"legal",
"trading",
"historical",
"translated",
"transliterated"
],
"x-profile-maxLength": "string_characters_max"
}language
Not listed in this schema’s required array.
- Declared type
"string"
Reading definition for language
{
"type": "string",
"x-profile-maxLength": "string_characters_max"
}script
Not listed in this schema’s required array.
- Declared type
"string"
Reading definition for script
{
"type": "string",
"x-profile-maxLength": "string_characters_max"
}identifiers
Not listed in this schema’s required array.
- Declared type
"array"
Reading definition for identifiers
{
"type": "array",
"items": {
"$ref": "#/components/schemas/InputIdentifier"
},
"minItems": 1,
"x-profile-maxItems": "collection_items_max"
}address
Not listed in this schema’s required array.
- Declared type
- Not declared directly; consult the complete field definition.
Reading definition for address
{
"$ref": "#/components/schemas/InputAddress"
}subject_type
Listed in this schema’s required array.
- Declared type
- Not declared directly; consult the complete field definition.
Reading definition for subject_type
{
"const": "legal_entity"
}search_scope
Not listed in this schema’s required array.
- Declared type
- Not declared directly; consult the complete field definition.
Reading definition for search_scope
{
"$ref": "#/components/schemas/SearchScope"
}hints
Not listed in this schema’s required array.
- Declared type
- Not declared directly; consult the complete field definition.
Reading definition for hints
{
"$ref": "#/components/schemas/InputHints"
}country_text
Not listed in this schema’s required array.
Optional raw country context; must be reconciled with typed scope/address meaning, never silently override a conflict.
- Declared type
"string"
Reading definition for country_text
{
"type": "string",
"description": "Optional raw country context; must be reconciled with typed scope/address meaning, never silently override a conflict.",
"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": {
"name": {
"type": "string",
"minLength": 1,
"x-profile-maxLength": "name_characters",
"x-additional-profile-maxLength": "string_characters_max"
},
"name_kind": {
"type": "string",
"enum": [
"unknown",
"legal",
"trading",
"historical",
"translated",
"transliterated"
],
"x-profile-maxLength": "string_characters_max"
},
"language": {
"type": "string",
"x-profile-maxLength": "string_characters_max"
},
"script": {
"type": "string",
"x-profile-maxLength": "string_characters_max"
},
"identifiers": {
"type": "array",
"items": {
"$ref": "#/components/schemas/InputIdentifier"
},
"minItems": 1,
"x-profile-maxItems": "collection_items_max"
},
"address": {
"$ref": "#/components/schemas/InputAddress"
},
"subject_type": {
"const": "legal_entity"
},
"search_scope": {
"$ref": "#/components/schemas/SearchScope"
},
"hints": {
"$ref": "#/components/schemas/InputHints"
},
"country_text": {
"type": "string",
"description": "Optional raw country context; must be reconciled with typed scope/address meaning, never silently override a conflict.",
"x-profile-maxLength": "string_characters_max"
}
},
"required": [
"subject_type"
],
"additionalProperties": false,
"anyOf": [
{
"required": [
"name"
]
},
{
"required": [
"identifiers"
]
}
],
"allOf": [
{
"if": {
"not": {
"required": [
"identifiers"
]
}
},
"then": {
"required": [
"name",
"search_scope"
]
}
}
]
}