ENTITY developer reference
InputHints
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.
Separately qualified hints only; no URL fetch or identity equality. Unreleased hints are rejected before work.
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.
website
Not listed in this schema’s required array.
- Declared type
"string"
Reading definition for website
{
"type": "string",
"minLength": 1,
"x-profile-maxLength": "string_characters_max"
}phone
Not listed in this schema’s required array.
- Declared type
"string"
Reading definition for phone
{
"type": "string",
"minLength": 1,
"x-profile-maxLength": "string_characters_max"
}phone_country
Not listed in this schema’s required array.
- Declared type
"string"
Reading definition for phone_country
{
"type": "string",
"pattern": "^[A-Z]{2}$",
"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": {
"website": {
"type": "string",
"minLength": 1,
"x-profile-maxLength": "string_characters_max"
},
"phone": {
"type": "string",
"minLength": 1,
"x-profile-maxLength": "string_characters_max"
},
"phone_country": {
"type": "string",
"pattern": "^[A-Z]{2}$",
"x-profile-maxLength": "string_characters_max"
}
},
"required": [],
"additionalProperties": false,
"anyOf": [
{
"required": [
"website"
]
},
{
"required": [
"phone"
]
}
],
"allOf": [
{
"if": {
"properties": {
"phone_country": {
"type": "string",
"x-profile-maxLength": "string_characters_max"
}
},
"required": [
"phone_country"
]
},
"then": {
"required": [
"phone"
]
}
}
],
"description": "Separately qualified hints only; no URL fetch or identity equality. Unreleased hints are rejected before work."
}