{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://artifacts.apis.io/rms/json-schema/rms-address-schema.json",
  "title": "Address",
  "x-generated": "2026-11-09",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/rms-openapi.yml#/components/schemas/Address",
  "type": "object",
  "properties": {
    "addressId": {
      "description": "ID for address.",
      "type": "integer",
      "format": "int32"
    },
    "area": {
      "$ref": "#/$defs/ExposureValue"
    },
    "buildingId": {
      "description": "ID for building.",
      "type": "string"
    },
    "buildingName": {
      "description": "Name of building.",
      "type": "string"
    },
    "addressType": {
      "$ref": "#/$defs/ExposureValue"
    },
    "country": {
      "$ref": "#/$defs/ExposureValue"
    },
    "countryScheme": {
      "description": "Standard for user-supplied country code, e.g. `ISO2A`",
      "type": "string"
    },
    "countryGeoId": {
      "type": "integer",
      "format": "int32"
    },
    "countryRmsCode": {
      "description": "Internal RMS code for country.",
      "type": "string"
    },
    "latitude": {
      "description": "Latitude coordinates.",
      "type": "number",
      "format": "double"
    },
    "longitude": {
      "description": "Longitude coordinates.",
      "type": "number",
      "format": "double"
    },
    "addressText": {
      "description": "Supplemental text captured for address.",
      "type": "string"
    },
    "streetAddress": {
      "description": "Address containing number, street name, street type, etc.",
      "type": "string"
    },
    "cityCode": {
      "description": "Code for city/town.",
      "type": "string"
    },
    "cityName": {
      "description": "Name of city/town.",
      "type": "string"
    },
    "cityGeoId": {
      "description": "Globally unique ID of city/town.",
      "type": "integer",
      "format": "int64"
    },
    "postalCode": {
      "description": "Postal code.",
      "type": "string"
    },
    "postalGeoId": {
      "description": "Globally unique ID for postal code.",
      "type": "integer",
      "format": "int64"
    },
    "block": {
      "description": "ID of block.",
      "type": "string"
    },
    "blockGroup": {
      "description": "ID of block group.",
      "type": "string"
    },
    "locationCode": {
      "description": "Census track number / Sonpro / Sector / Short post code.",
      "type": "string"
    },
    "locationCodeGeoId": {
      "type": "integer",
      "format": "int64"
    },
    "parcelNumber": {
      "description": "ID of parcel.",
      "type": "string"
    },
    "subLocality": {
      "description": "Name of sub-locality (neighborhood).",
      "type": "string"
    },
    "geoResolutionConfidence": {
      "description": "Geocode confidence percentage.",
      "type": "number",
      "format": "double"
    },
    "geoAccuracyBuffer": {
      "description": "Geocode accuracy buffer.",
      "type": "number",
      "format": "double"
    },
    "geoProductVersion": {
      "type": "string"
    },
    "geoLocationCode": {
      "description": "Accuracy of assigned geocode for US high resolution geocoding.",
      "type": "string"
    },
    "geoMatchCode": {
      "description": "Code for portions of the input address that matched, did not match, or were modified during the geocoding process.\n",
      "type": "string"
    },
    "geoDataSourceId": {
      "description": "Geocode data source ID.",
      "type": "integer",
      "format": "int32"
    },
    "geoResolutionCode": {
      "$ref": "#/$defs/ExposureValue"
    },
    "geoDataSourceVersionId": {
      "type": "integer",
      "format": "int32"
    },
    "geoDateTime": {
      "type": "string"
    },
    "createDateTime": {
      "description": "Date and time address record was created.",
      "type": "string"
    },
    "updateDateTime": {
      "description": "Date and time address record was updated.",
      "type": "string"
    },
    "admin1Code": {
      "description": "Code for administrative level 1. Admin1 represents large geographic divisions, such as states or provinces.\n",
      "type": "string"
    },
    "admin1GeoId": {
      "description": "Globally unique RMS ID for administrative level 1.\n",
      "type": "integer",
      "format": "int64"
    },
    "admin1Name": {
      "description": "Name of administrative level 1.\n",
      "type": "string"
    },
    "admin2Code": {
      "description": "Code for administrative level 2. Admin2 represents smaller geographic divisions, such as counties.\n",
      "type": "string"
    },
    "admin2GeoId": {
      "description": "Globally unique RMS ID for administrative level 2.\n",
      "type": "integer",
      "format": "int64"
    },
    "admin2Name": {
      "description": "Name of administrative level 2.\n",
      "type": "string"
    },
    "admin3Code": {
      "description": "Code for administrative level 3. Admin3 represents smaller geographic divisions, such as districts.\n",
      "type": "string"
    },
    "admin3GeoId": {
      "description": "Globally unique RMS ID for administrative level 3.\n",
      "type": "integer",
      "format": "int64"
    },
    "admin3Name": {
      "description": "Name of administrative level 3.\n",
      "type": "string"
    },
    "admin4Code": {
      "description": "Code for administrative level 4.\n",
      "type": "string"
    },
    "admin4GeoId": {
      "description": "Globally unique RMS ID for administrative level 4.\n",
      "type": "integer",
      "format": "int64"
    },
    "admin4Name": {
      "type": "string",
      "description": "Name of administrative level 4.\n"
    },
    "admin5Code": {
      "description": "Code for administrative level 5.\n",
      "type": "string"
    },
    "admin5GeoId": {
      "description": "Globally unique RMS ID for administrative level 5.\n",
      "type": "integer",
      "format": "int64"
    },
    "admin5Name": {
      "description": "Name of administrative level 5.",
      "type": "string"
    },
    "zone1GeoId": {
      "description": "Zone level 1 GeoID.",
      "type": "integer",
      "format": "int64"
    },
    "zone2GeoId": {
      "description": "Zone level 2 GeoID.",
      "type": "integer",
      "format": "int64"
    },
    "zone3GeoId": {
      "description": "Zone level 3 GeoID.",
      "type": "integer",
      "format": "int64"
    },
    "zone4GeoId": {
      "description": "Zone level 4 GeoID.",
      "type": "integer",
      "format": "int64"
    },
    "zone5GeoId": {
      "description": "Zone level 5 GeoID.",
      "type": "integer",
      "format": "int64"
    },
    "zone1": {
      "description": "CRESTA zone ID\n",
      "type": "string"
    },
    "zone2": {
      "description": "For finer zone definitions.\n",
      "type": "string"
    },
    "zone3": {
      "description": "For further finer zone definitions.\n",
      "type": "string"
    },
    "zone3Name": {
      "type": "string"
    },
    "zone4Name": {
      "type": "string"
    },
    "zone5Name": {
      "type": "string"
    },
    "zone3Code": {
      "type": "string"
    },
    "zone4Code": {
      "type": "string"
    },
    "zone5Code": {
      "type": "string"
    },
    "ugid": {
      "description": "Unique global identifier.",
      "type": "string"
    }
  },
  "$defs": {
    "ExposureValue": {
      "type": "object",
      "properties": {
        "id": {
          "type": "integer",
          "format": "int32"
        },
        "code": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      }
    }
  }
}