Geo Confidence fields

Geo confidence data output fields provide detailed information about the type of geo confidence polygon returned by the geocoding process. These fields are essential for understanding the precision and nature of the geocoded location.

Returning Geo Confidence Fields from GA-SDK

To return the new geo confidence fields from GA-SDK, follow these steps:

Add a new custom preference RETURN_GEOCONFIDENCE_FIELDS and set its value to true.

Example: "RETURN_GEOCONFIDENCE_FIELDS": "true"

Geo Confidence Data Output Fields

When the custom preference RETURN_GEOCONFIDENCE_FIELDS is set to true, the following geo confidence fields are returned under the customFields tag:

GEO_CONFIDENCE_CENTROID_LONGITUDE : The longitude of the centroid of the geo confidence polygon.
GEO_CONFIDENCE_CENTROID_LATITUDE: The latitude of the centroid of the geo confidence polygon.
STREET_SEGMENT_POINTS: An array of latitude/longitude values that represent the street segment points. This field contains values only if the GEO_CONFIDENCE_CODE field returns a value of ADDRESS, POSTAL2, or POSTAL3.
GEO_CONFIDENCE_CODE:
- INTERSECTION: A geocode point for the intersection of two streets.
- ADDRESS: An array of street segment points representing the street segment where the address is located.
- POINT: If the geocoder was able to match the address using point data, the point geometry where the address is located.
- POSTAL1: A geocode point for the ZIP centroid.
- POSTAL2: An array of points for all street segments in the ZIP + 2 in which the address is located.
- POSTAL3: An array of points for street segments in the ZIP + 4 in which the address is located.
- ERROR: An error has occurred.

Sample Request and Response

Below are sample Request and Response including the Geo Confidence fields:

Request

{
  "preferences": {
    "maxResults": 1,
    "returnAllInfo": true,
    "factoryDescription": {
      "label": "",
      "featureSpecific": {}
    },
    "clientLocale": "",
    "clientCoordSysName": "",
    "distance": {
      "value": 150,
      "distanceUnit": "METER"
    },
    "streetOffset": {
      "value": 7,
      "distanceUnit": "METER"
    },
    "cornerOffset": {
      "value": 7,
      "distanceUnit": "METER"
    },
    "customPreferences": {
    "RETURN_GEOCONFIDENCE_FIELDS": "true"
			}
  },
  "addresses": [
    {
      "addressLines": [
        "15259 Arroyo Dr, Irvine, CA 92617-5348"
      ],
      "country": "USA",
      "addressNumber": "",
      "admin1": "",
      "admin2": "",
      "city": "",
      "borough": "",
      "neighborhood": "",
      "suburb": "",
      "postalCode": "",
      "postalCodeExt": "",
      "placeName": "",
      "building": "",
      "floor": "",
      "room": "",
      "unit": "",
      "unitType": ""
    }
  ]
}

Response

a{
  "responses": [
    {
      "status": "OK",
      "results": [
        {a
          "score": 100,
          "address": {
            "formattedAddress": "15259 ARROYO DR, IRVINE CA 92617-5348, United States",
            "formattedStreetAddress": "15259 ARROYO DR",
            "formattedLocationAddress": "IRVINE, CA  92617-5348",
            "addressNumber": "15259",
            "country": {
              "name": "United States",
              "isoAlpha2Code": "US",
              "isoAlpha3Code": "USA",
              "isoNumericCode": "840"
            },
            "admin1": {
              "longName": "California",
              "shortName": "CA"
            },
            "admin2": {
              "longName": "ORANGE COUNTY",
              "shortName": "ORANGE COUNTY"
            },
            "city": {
              "longName": "IRVINE",
              "shortName": "IRVINE"
            },
            "postalCode": "92617",
            "postalCodeExt": "5348",
            "street": "ARROYO"
          },
          "addressLines": [
            "15259 ARROYO DR",
            "IRVINE CA 92617-5348",
            "United States"
          ],
          "location": {
            "explanation": {
              "type": "STREET",
              "description": "POSTAL_CODE_EXT",
              "designation": "CENTROID"
            },
            "feature": {
              "type": "Feature",
              "properties": {
                "crsName": "epsg:4326"
              },
              "geometry": {
                "type": "Point",
                "coordinates": [
                  -117.8237,
                  33.6442
                ]
              }
            }
          },
          "explanation": {
            "addressMatch": {
              "type": "ADDRESS",
              "description": [
                {
                  "label": "placeName",
                  "matchType": "NONE"
                },
                {
                  "label": "addressNumber",
                  "matchType": "EXACT"
                },
                {
                  "label": "admin1",
                  "matchType": "EXACT"
                },
                {
                  "label": "admin2",
                  "matchType": "NONE"
                },
                {
                  "label": "city",
                  "matchType": "EXACT"
                },
                {
                  "label": "neighborhood",
                  "matchType": "NONE"
                },
                {
                  "label": "suburb",
                  "matchType": "NONE"
                },
                {
                  "label": "street",
                  "matchType": "EXACT"
                },
                {
                  "label": "postalCode",
                  "matchType": "EXACT"
                },
                {
                  "label": "streetType",
                  "matchType": "EXACT"
                },
                {
                  "label": "postalCodeExt",
                  "matchType": "EXACT"
                },
                {
                  "label": "streetDirectional",
                  "matchType": "EXACT"
                },
                {
                  "label": "unitMatch",
                  "matchType": "NONE"
                }
              ]
            },
            "source": {
              "label": "ggs"
            }
          },
          "customFields": {
            "POBOX_ZONE": "N",
            "SIMPLE_MATCH_CODE": "V4-P4S4A0T4R4Z4C4-5",
            "CSA_NUMBER": "348",
            "TYPE_SHORT": "DR",
            "THOROUGHFARE_TYPE": "DR",
            "MATCH_CODE": "S000",
            "EXTENDED_MATCH_CODE": "V4-D0M0B0U0F0G0P4S4Q0X0A0T4E0R4W0Z4Y4C4-5",
            "DATABASE_VERSION": "December 2024",
            "COUNTY": "06059",
            "LANGUAGE": "en",
            "NON_DELIVERABLE": "N",
            "STREET_SEGMENT_POINTS": "[LINESTRING (-117.829426 33.647016, -117.829426 33.647016, -117.829054 33.647119, -117.828843 33.647194, -117.828803 33.647221, -117.828803 33.647221), LINESTRING (-117.828803 33.647221, -117.828402 33.647499), LINESTRING (-117.828402 33.647499, -117.828402 33.647499, -117.828072 33.647693, -117.827717 33.647844, -117.827717 33.647844), LINESTRING (-117.827717 33.647844, -117.827717 33.647844, -117.82745 33.647921, -117.827113 33.647974, -117.826969 33.647984, -117.826809 33.647981, -117.826809 33.647981), LINESTRING (-117.826809 33.647981, -117.826809 33.647981, -117.826499 33.647961, -117.826074 33.647869, -117.825935 33.647824, -117.825787 33.647761, -117.825787 33.647761), LINESTRING (-117.825787 33.647761, -117.825787 33.647761, -117.825669 33.647711, -117.825433 33.647572, -117.82517 33.647367, -117.82504 33.647229, -117.82504 33.647229), LINESTRING (-117.82504 33.647229, -117.82504 33.647229, -117.824918 33.647101, -117.82464 33.646658, -117.82464 33.646658), LINESTRING (-117.82464 33.646658, -117.82464 33.646658, -117.824405 33.646303, -117.824242 33.64602, -117.824069 33.645562, -117.824069 33.645562), LINESTRING (-117.824069 33.645562, -117.824069 33.645562, -117.823887 33.644928, -117.823853 33.644738, -117.823853 33.644738), LINESTRING (-117.823853 33.644738, -117.823853 33.644738, -117.82377 33.644225, -117.823753 33.643896, -117.823753 33.643896), LINESTRING (-117.823753 33.643896, -117.823753 33.643896, -117.823746 33.643767, -117.823755 33.64355, -117.823755 33.64355), LINESTRING (-117.823755 33.64355, -117.823755 33.64355, -117.823802 33.643198, -117.823837 33.643044, -117.823837 33.643044), LINESTRING (-117.823857 33.642964, -117.823837 33.643044), LINESTRING (-117.823976 33.642483, -117.823857 33.642964), LINESTRING (-117.824113 33.642006, -117.824113 33.642006, -117.824033 33.642254, -117.823976 33.642483, -117.823976 33.642483), LINESTRING (-117.824134 33.64194, -117.824113 33.642006), LINESTRING (-117.824718 33.640725, -117.824718 33.640725, -117.824627 33.640864, -117.824371 33.641342, -117.8242 33.641736, -117.824134 33.64194, -117.824134 33.64194), LINESTRING (-117.825865 33.639657, -117.825865 33.639657, -117.825826 33.639702, -117.825721 33.639742, -117.825582 33.639801, -117.825406 33.639902, -117.825258 33.640013, -117.825161 33.640107, -117.824932 33.6404, -117.824718 33.640725, -117.824718 33.640725), LINESTRING (-117.828402 33.647499, -117.828402 33.647499, -117.828196 33.647404, -117.828168 33.647381, -117.828124 33.647388, -117.827772 33.64754, -117.827661 33.647572, -117.827374 33.64762, -117.827307 33.647623, -117.827307 33.647623), LINESTRING (-117.827307 33.647623, -117.827307 33.647623, -117.827217 33.647626, -117.827115 33.647624, -117.827115 33.647624), LINESTRING (-117.827115 33.647624, -117.827115 33.647624, -117.826954 33.64762, -117.826775 33.6476, -117.8265 33.647523, -117.826245 33.647412, -117.826051 33.647299, -117.825953 33.647222, -117.825833 33.647118, -117.825722 33.647, -117.825722 33.647), LINESTRING (-117.825722 33.647, -117.825652 33.646887), LINESTRING (-117.825652 33.646887, -117.825652 33.646887, -117.825596 33.646895, -117.825563 33.646888, -117.82553 33.646869, -117.82553 33.646869), LINESTRING (-117.82553 33.646869, -117.825174 33.64713), LINESTRING (-117.825174 33.64713, -117.82504 33.647229), LINESTRING (-117.825652 33.646887, -117.825652 33.646887, -117.825698 33.646834, -117.825692 33.64678, -117.825668 33.646754, -117.825668 33.646754), LINESTRING (-117.825668 33.646754, -117.825668 33.646754, -117.825626 33.646733, -117.82559 33.646727, -117.825551 33.646741, -117.825518 33.64677, -117.825509 33.646819, -117.82553 33.646869, -117.82553 33.646869), LINESTRING (-117.829521 33.646997, -117.829426 33.647016), LINESTRING (-117.825004 33.637829, -117.825004 33.637829, -117.825205 33.637928, -117.825298 33.63797, -117.825365 33.638004, -117.825417 33.638036, -117.825465 33.638074, -117.825498 33.638118, -117.825523 33.638155, -117.825535 33.638182, -117.825535 33.638182), LINESTRING (-117.825004 33.637829, -117.825004 33.637829, -117.82469 33.638302, -117.824355 33.638793, -117.824049 33.639244, -117.824049 33.639244), LINESTRING (-117.824049 33.639244, -117.824049 33.639244, -117.823647 33.639838, -117.823618 33.639884, -117.823618 33.639884), LINESTRING (-117.823618 33.639884, -117.823618 33.639884, -117.823443 33.640158, -117.823382 33.640252, -117.823382 33.640252), LINESTRING (-117.823382 33.640252, -117.823382 33.640252, -117.823347 33.640307, -117.823207 33.640551, -117.823108 33.640736, -117.823052 33.640857, -117.823052 33.640857), LINESTRING (-117.823052 33.640857, -117.823052 33.640857, -117.822832 33.641342, -117.822781 33.641489, -117.822724 33.641652, -117.822724 33.641652), LINESTRING (-117.822724 33.641652, -117.822724 33.641652, -117.822671 33.641808, -117.822652 33.64185, -117.822625 33.641873, -117.822596 33.641879, -117.822566 33.641879, -117.822542 33.641875, -117.822515 33.641862, -117.822496 33.641846, -117.82248 33.641821, -117.82247 33.641792, -117.82247 33.641768, -117.82248 33.641734, -117.822555 33.641513, -117.822649 33.641279, -117.822869 33.640794, -117.822869 33.640794), LINESTRING (-117.822869 33.640794, -117.822869 33.640794, -117.82303 33.640464, -117.823172 33.640211, -117.823454 33.639771, -117.823872 33.639153, -117.823872 33.639153), LINESTRING (-117.823872 33.639153, -117.823872 33.639153, -117.82479 33.637775, -117.824806 33.637757, -117.82483 33.63775, -117.824857 33.637757, -117.825004 33.637829, -117.825004 33.637829), LINESTRING (-117.825535 33.638182, -117.825535 33.638182, -117.82555 33.638211, -117.825566 33.638246, -117.825579 33.638285, -117.825613 33.638398, -117.825857 33.639546, -117.825869 33.639611, -117.825865 33.639657, -117.825865 33.639657)]",
            "CHECK_DIGIT": "1",
            "METRO_FLAG": "Y",
            "BLOCK": "060590626144",
            "POST_THOROUGHFARE_TYPE": "DR",
            "QCITY": "060424001",
            "ZIP_FACILITY": "P",
            "LOT_CODE": "A",
            "LOT_NUM": "0019",
            "GEOHASH": "9mupquersv3w",
            "CTYST_KEY": "Z21529",
            "NAME": "ARROYO",
            "ZIP_CARRTSORT": "D",
            "LORANGE": "15201",
            "CLOSE_MATCH": "T",
            "ZIP_VALID": "Y",
            "DATATYPE": "2",
            "EXPIRATION_DATE": "04/29/2025",
            "INTERSECTION": "F",
            "ZIP_CITY_DELV": "Y",
            "LOC_CODE": "ZT9F",
            "GLOBAL_LOCATION_CODE": "436",
            "CART": "C003",
            "NAME_CITY": "IRVINE",
            "COUNTY_FIPS": "06059",
            "PRECISION_LEVEL": "5",
            "HIRANGE": "15299",
            "REC_TYPE": "S",
            "RESOLVED_LINE": "0",
            "MATCH_TYPE": "ADDRESS",
            "PREF_CITY": "IRVINE",
            "CBSA_NUMBER": "31080",
            "ALT_FLAG": "B",
            "SEGMENT_DIRECTION": "F",
            "ADDRLINE_SHORT": "15259 ARROYO DR",
            "CONFIDENCE": "50",
            "GEO_CONFIDENCE_CENTROID_LONGITUDE": "-117.8237",
            "HIZIP4": "5348",
            "DATATYPE_NAME": "TOMTOM",
            "ORIG_DPBC": "59",
            "SEGMENT_PARITY": "B",
            "CBSA_DIVISION_NAME": "ANAHEIM-SANTA ANA-IRVINE, CA METROPOLITAN DIVISION",
            "LOZIP4": "5348",
            "CSA_NAME": "LOS ANGELES-LONG BEACH, CA COMBINED STATISTICAL AREA",
            "GEO_CONFIDENCE_CENTROID_LATITUDE": "33.6442",
            "GEO_CONFIDENCE_CODE": "POSTAL3",
            "DPBC": "59",
            "LASTLINE_SHORT": "IRVINE, CA  92617-5348",
            "CITY_SHORT": "IRVINE",
            "NAME_SHORT": "ARROYO",
            "ZIP9": "926175348",
            "IS_ALIAS": "N01",
            "PRECISION_CODE": "S3HPNTSCZA",
            "ZIP10": "92617-5348",
            "CBSA_NAME": "LOS ANGELES-LONG BEACH-ANAHEIM, CA METROPOLITAN STATISTICAL AREA",
            "RANGE_PARITY": "O",
            "CBSA_DIVISION_NUMBER": "11244"
          },
          "parsed": [
            {
              "classifications": [
                {
                  "label": "street",
                  "value": "ARROYO"
                },
                {
                  "label": "admin1",
                  "value": "CA"
                },
                {
                  "label": "city",
                  "value": "IRVINE"
                },
                {
                  "label": "addressNumber",
                  "value": "15259"
                },
                {
                  "label": "postalCodeExt",
                  "value": "5348"
                },
                {
                  "label": "postalCode",
                  "value": "92617"
                },
                {
                  "label": "country",
                  "value": "USA"
                },
                {
                  "label": "streetSuffix",
                  "value": "DR"
                }
              ]
            }
          ]
        }
      ]
    }
  ]
}