Sustema

ENTITY developer reference

Address

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 partial-output definition: lines may be empty when a real locality, region or postal code is known. All existing keys remain required, unknown components are null. Blank strings and country-only pseudo-addresses are invalid. Missing address uses the existing unavailable claim envelope. Preserve original script and address kind; no inferred street or completeness claim. Strict generated consumers must adopt this successor before use.

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": "string_characters_max"
}

lines

Listed in this schema’s required array.

Declared type
"array"
Reading definition for lines
{
  "type": "array",
  "items": {
    "type": "string",
    "pattern": "\\S",
    "x-profile-maxLength": "string_characters_max"
  },
  "minItems": 0,
  "x-profile-maxItems": "candidate_hints_max"
}

locality

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": "string_characters_max"
    },
    {
      "type": "null"
    }
  ]
}

region

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": "string_characters_max"
    },
    {
      "type": "null"
    }
  ]
}

postal_code

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": "string_characters_max"
    },
    {
      "type": "null"
    }
  ]
}

country

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": "^[A-Z]{2}$",
      "x-profile-maxLength": "string_characters_max"
    },
    {
      "type": "null"
    }
  ]
}

language

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": "string_characters_max"
    },
    {
      "type": "null"
    }
  ]
}

script

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": "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": "string_characters_max"
    },
    "lines": {
      "type": "array",
      "items": {
        "type": "string",
        "pattern": "\\S",
        "x-profile-maxLength": "string_characters_max"
      },
      "minItems": 0,
      "x-profile-maxItems": "candidate_hints_max"
    },
    "locality": {
      "anyOf": [
        {
          "type": "string",
          "pattern": "\\S",
          "x-profile-maxLength": "string_characters_max"
        },
        {
          "type": "null"
        }
      ]
    },
    "region": {
      "anyOf": [
        {
          "type": "string",
          "pattern": "\\S",
          "x-profile-maxLength": "string_characters_max"
        },
        {
          "type": "null"
        }
      ]
    },
    "postal_code": {
      "anyOf": [
        {
          "type": "string",
          "pattern": "\\S",
          "x-profile-maxLength": "string_characters_max"
        },
        {
          "type": "null"
        }
      ]
    },
    "country": {
      "anyOf": [
        {
          "type": "string",
          "pattern": "^[A-Z]{2}$",
          "x-profile-maxLength": "string_characters_max"
        },
        {
          "type": "null"
        }
      ]
    },
    "language": {
      "anyOf": [
        {
          "type": "string",
          "pattern": "\\S",
          "x-profile-maxLength": "string_characters_max"
        },
        {
          "type": "null"
        }
      ]
    },
    "script": {
      "anyOf": [
        {
          "type": "string",
          "pattern": "\\S",
          "x-profile-maxLength": "string_characters_max"
        },
        {
          "type": "null"
        }
      ]
    }
  },
  "required": [
    "kind",
    "lines",
    "locality",
    "region",
    "postal_code",
    "country",
    "language",
    "script"
  ],
  "additionalProperties": false,
  "anyOf": [
    {
      "properties": {
        "lines": {
          "minItems": 1
        }
      }
    },
    {
      "properties": {
        "locality": {
          "type": "string",
          "pattern": "\\S",
          "x-profile-maxLength": "string_characters_max"
        }
      }
    },
    {
      "properties": {
        "region": {
          "type": "string",
          "pattern": "\\S",
          "x-profile-maxLength": "string_characters_max"
        }
      }
    },
    {
      "properties": {
        "postal_code": {
          "type": "string",
          "pattern": "\\S",
          "x-profile-maxLength": "string_characters_max"
        }
      }
    }
  ],
  "description": "Candidate partial-output definition: lines may be empty when a real locality, region or postal code is known. All existing keys remain required, unknown components are null. Blank strings and country-only pseudo-addresses are invalid. Missing address uses the existing unavailable claim envelope. Preserve original script and address kind; no inferred street or completeness claim. Strict generated consumers must adopt this successor before use."
}

All API operations