ENTITY developer reference
InputAddress
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.
Candidate input-address definition. Preserve supplied partial address and explicit purpose; at least one nonblank line, locality, region or postal code. Country/language/script alone are context, not an address. Completeness is not identity sufficiency or normalisation qualification. Output Address now has its separately versioned truthful partial-output definition. address_characters is also an aggregate semantic input limit: sum Unicode code points in every non-null decoded textual value of this address, including each lines entry and kind/language/script context; field names and JSON syntax are excluded. Count before normalisation. Per-field compiled bounds are necessary but do not replace this aggregate check. Refuse overflow as invalid_request/400,correct_request before admission; the core public Problem schema uses usage_state not_started, while FeedbackProblem retains its zero customer_debit_units and own reference rules; do not log or truncate the submitted values.
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.
kind
Listed in this schema’s required array.
- Declared type
"string"
Reading definition for kind
{
"type": "string",
"enum": [
"registered_office",
"headquarters",
"operating_location",
"other",
"unknown"
],
"x-profile-maxLength": "address_characters",
"x-additional-profile-maxLength": "string_characters_max"
}lines
Not listed in this schema’s required array.
- Declared type
"array"
Reading definition for lines
{
"type": "array",
"items": {
"type": "string",
"pattern": "\\S",
"x-profile-maxLength": "address_characters",
"x-additional-profile-maxLength": "string_characters_max"
},
"x-profile-maxItems": "collection_items_max"
}locality
Not listed in this schema’s required array.
- Declared type
- Not declared directly; consult the complete field definition.
Reading definition for locality
{
"anyOf": [
{
"type": "string",
"pattern": "\\S",
"x-profile-maxLength": "address_characters",
"x-additional-profile-maxLength": "string_characters_max"
},
{
"type": "null"
}
]
}region
Not listed in this schema’s required array.
- Declared type
- Not declared directly; consult the complete field definition.
Reading definition for region
{
"anyOf": [
{
"type": "string",
"pattern": "\\S",
"x-profile-maxLength": "address_characters",
"x-additional-profile-maxLength": "string_characters_max"
},
{
"type": "null"
}
]
}postal_code
Not listed in this schema’s required array.
- Declared type
- Not declared directly; consult the complete field definition.
Reading definition for postal_code
{
"anyOf": [
{
"type": "string",
"pattern": "\\S",
"x-profile-maxLength": "address_characters",
"x-additional-profile-maxLength": "string_characters_max"
},
{
"type": "null"
}
]
}country
Not listed in this schema’s required array.
- Declared type
- Not declared directly; consult the complete field definition.
Reading definition for country
{
"anyOf": [
{
"type": "string",
"pattern": "\\S",
"x-profile-maxLength": "address_characters",
"x-additional-profile-maxLength": "string_characters_max"
},
{
"type": "null"
}
]
}language
Not listed in this schema’s required array.
- Declared type
- Not declared directly; consult the complete field definition.
Reading definition for language
{
"anyOf": [
{
"type": "string",
"pattern": "\\S",
"x-profile-maxLength": "address_characters",
"x-additional-profile-maxLength": "string_characters_max"
},
{
"type": "null"
}
]
}script
Not listed in this schema’s required array.
- Declared type
- Not declared directly; consult the complete field definition.
Reading definition for script
{
"anyOf": [
{
"type": "string",
"pattern": "\\S",
"x-profile-maxLength": "address_characters",
"x-additional-profile-maxLength": "string_characters_max"
},
{
"type": "null"
}
]
}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": {
"kind": {
"type": "string",
"enum": [
"registered_office",
"headquarters",
"operating_location",
"other",
"unknown"
],
"x-profile-maxLength": "address_characters",
"x-additional-profile-maxLength": "string_characters_max"
},
"lines": {
"type": "array",
"items": {
"type": "string",
"pattern": "\\S",
"x-profile-maxLength": "address_characters",
"x-additional-profile-maxLength": "string_characters_max"
},
"x-profile-maxItems": "collection_items_max"
},
"locality": {
"anyOf": [
{
"type": "string",
"pattern": "\\S",
"x-profile-maxLength": "address_characters",
"x-additional-profile-maxLength": "string_characters_max"
},
{
"type": "null"
}
]
},
"region": {
"anyOf": [
{
"type": "string",
"pattern": "\\S",
"x-profile-maxLength": "address_characters",
"x-additional-profile-maxLength": "string_characters_max"
},
{
"type": "null"
}
]
},
"postal_code": {
"anyOf": [
{
"type": "string",
"pattern": "\\S",
"x-profile-maxLength": "address_characters",
"x-additional-profile-maxLength": "string_characters_max"
},
{
"type": "null"
}
]
},
"country": {
"anyOf": [
{
"type": "string",
"pattern": "\\S",
"x-profile-maxLength": "address_characters",
"x-additional-profile-maxLength": "string_characters_max"
},
{
"type": "null"
}
]
},
"language": {
"anyOf": [
{
"type": "string",
"pattern": "\\S",
"x-profile-maxLength": "address_characters",
"x-additional-profile-maxLength": "string_characters_max"
},
{
"type": "null"
}
]
},
"script": {
"anyOf": [
{
"type": "string",
"pattern": "\\S",
"x-profile-maxLength": "address_characters",
"x-additional-profile-maxLength": "string_characters_max"
},
{
"type": "null"
}
]
}
},
"required": [
"kind"
],
"additionalProperties": false,
"description": "Candidate input-address definition. Preserve supplied partial address and explicit purpose; at least one nonblank line, locality, region or postal code. Country/language/script alone are context, not an address. Completeness is not identity sufficiency or normalisation qualification. Output Address now has its separately versioned truthful partial-output definition. address_characters is also an aggregate semantic input limit: sum Unicode code points in every non-null decoded textual value of this address, including each lines entry and kind/language/script context; field names and JSON syntax are excluded. Count before normalisation. Per-field compiled bounds are necessary but do not replace this aggregate check. Refuse overflow as invalid_request/400,correct_request before admission; the core public Problem schema uses usage_state not_started, while FeedbackProblem retains its zero customer_debit_units and own reference rules; do not log or truncate the submitted values.",
"anyOf": [
{
"required": [
"lines"
],
"properties": {
"lines": {
"type": "array",
"minItems": 1,
"x-profile-maxItems": "collection_items_max"
}
}
},
{
"required": [
"locality"
],
"properties": {
"locality": {
"type": "string",
"pattern": "\\S",
"x-profile-maxLength": "address_characters",
"x-additional-profile-maxLength": "string_characters_max"
}
}
},
{
"required": [
"region"
],
"properties": {
"region": {
"type": "string",
"pattern": "\\S",
"x-profile-maxLength": "address_characters",
"x-additional-profile-maxLength": "string_characters_max"
}
}
},
{
"required": [
"postal_code"
],
"properties": {
"postal_code": {
"type": "string",
"pattern": "\\S",
"x-profile-maxLength": "address_characters",
"x-additional-profile-maxLength": "string_characters_max"
}
}
}
]
}