Portable Postal Address (Medium-Grained)

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/address_portable",
  "title": "Portable Postal Address (Medium-Grained)",
  "type": "object",
  "description": "The portable international postal address. Maps to [AddressValidationMetadata](https://github.com/googlei18n/libaddressinput/wiki/AddressValidationMetadata) and HTML 5.1 [Autofilling form controls: the autocomplete attribute](https://www.w3.org/TR/html51/sec-forms.html#autofilling-form-controls-the-autocomplete-attribute).",
  "properties": {
    "address_line_1": {
      "type": "string",
      "description": "The first line of the address. For example, number or street. For example, `173 Drury Lane`. Required for data entry and compliance and risk checks. Must contain the full address.",
      "maxLength": 300
    },
    "address_line_2": {
      "type": "string",
      "description": "The second line of the address. For example, suite or apartment number.",
      "maxLength": 300
    },
    "address_line_3": {
      "type": "string",
      "description": "The third line of the address, if needed. For example, a street complement for Brazil, direction text, such as `next to Walmart`, or a landmark in an Indian address.",
      "maxLength": 100
    },
    "admin_area_4": {
      "type": "string",
      "description": "The neighborhood, ward, or district. Smaller than `admin_area_level_3` or `sub_locality`. Value is:<ul><li>The postal sorting code for Guernsey and many French territories, such as French Guiana.</li><li>The fine-grained administrative levels in China.</li></ul>",
      "maxLength": 100
    },
    "admin_area_3": {
      "type": "string",
      "description": "A sub-locality, suburb, neighborhood, or district. Smaller than `admin_area_level_2`. Value is:<ul><li>Brazil. Suburb, bairro, or neighborhood.</li><li>India. Sub-locality or district. Street name information is not always available but a sub-locality or district can be a very small area.</li></ul>",
      "maxLength": 100
    },
    "admin_area_2": {
      "type": "string",
      "description": "A city, town, or village. Smaller than `admin_area_level_1`.",
      "maxLength": 120
    },
    "admin_area_1": {
      "type": "string",
      "description": "The highest level sub-division in a country, which is usually a province, state, or ISO-3166-2 subdivision. Format for postal delivery. For example, `CA` and not `California`. Value, by country, is:<ul><li>UK. A county.</li><li>US. A state.</li><li>Canada. A province.</li><li>Japan. A prefecture.</li><li>Switzerland. A kanton.</li></ul>",
      "maxLength": 300
    },
    "postal_code": {
      "type": "string",
      "description": "The postal code, which is the zip code or equivalent. Typically required for countries with a postal code or an equivalent. See [postal code](https://en.wikipedia.org/wiki/Postal_code).",
      "maxLength": 60
    },
    "country_code": {
      "$ref": "#/components/schemas/country_code"
    },
    "address_details": {
      "type": "object",
      "title": "Address Details",
      "description": "The non-portable additional address details that are sometimes needed for compliance, risk, or other scenarios where fine-grain address information might be needed. Not portable with common third party and open source. Redundant with core fields.<br/>For example, `address_portable.address_line_1` is usually a combination of `address_details.street_number`, `street_name`, and `street_type`.",
      "properties": {
        "street_number": {
          "type": "string",
          "description": "The street number.",
          "maxLength": 100
        },
        "street_name": {
          "type": "string",
          "description": "The street name. Just `Drury` in `Drury Lane`.",
          "maxLength": 100
        },
        "street_type": {
          "type": "string",
          "description": "The street type. For example, avenue, boulevard, road, or expressway.",
          "maxLength": 100
        },
        "delivery_service": {
          "type": "string",
          "description": "The delivery service. Post office box, bag number, or post office name.",
          "maxLength": 100
        },
        "building_name": {
          "type": "string",
          "description": "A named locations that represents the premise. Usually a building name or number or collection of buildings with a common name or number. For example, <code>Craven House</code>.",
          "maxLength": 100
        },
        "sub_building": {
          "type": "string",
          "description": "The first-order entity below a named building or location that represents the sub-premises. Usually a single building within a collection of buildings with a common name. Can be a flat, story, floor, room, or apartment.",
          "maxLength": 100
        }
      }
    }
  },
  "required": [
    "country_code"
  ]
}