Verify Service Response - geo_addressing_sdk - 5.0

Geo Addressing SDK Developer Guide

Product type
Software
Portfolio
Locate
Product family
Geo Addressing
Product
Geo Addressing SDK
Version
5.0
Language
English
Product name
Geo Addressing SDK
Title
Geo Addressing SDK Developer Guide
Copyright
2023
First publish date
2007
ft:lastEdition
2024-07-12
ft:lastPublication
2024-07-12T13:44:57.839102

Within the Addressing REST API, a request to the Verify Service returns a list of results. Not every field will be returned with a result; see Addressing API Objects: Result for more detail.

Note: If you need to return Location information in the response, use the Geocode Service.

Within the Addressing REST API, a request to the Address Verify Service returns a list of results. Not every field will be returned with a result.

Below are the Response fields returned:
Table 1.
Field Type Description
errorMessage String Exception message. The error message returned from the service with an error code
status Status Status of the response.
results <Result array List of results based on the specified criteria.

Addressing: Verify Example

In the Sample application, do the following:

  1. Navigate to Addressing v1 > Verify.
  2. Enter the Address "10 downing street london SW1A 2AA" and "GBR" as the Country.
  3. Click Submit and review the Response.
    {
      "responses": [
        {
          "status": "OK",
          "results": [
            {
              "score": 97,
              "address": {
                "formattedAddress": "1700 DISTRICT AVE STE 300, BURLINGTON MA 01803-5231, United States",
                "formattedStreetAddress": "1700 DISTRICT AVE STE 300",
                "formattedLocationAddress": "BURLINGTON, MA  01803-5231",
                "addressNumber": "1700",
                "country": {
                  "name": "United States",
                  "isoAlpha2Code": "US",
                  "isoAlpha3Code": "USA",
                  "isoNumericCode": "840"
                },
                "admin1": {
                  "longName": "Massachusetts",
                  "shortName": "MA"
                },
                "admin2": {
                  "longName": "MIDDLESEX COUNTY",
                  "shortName": "MIDDLESEX COUNTY"
                },
                "city": {
                  "longName": "BURLINGTON",
                  "shortName": "BURLINGTON"
                },
                "postalCode": "01803",
                "postalCodeExt": "5231",
                "unit": "300",
                "unitType": "STE",
                "street": "DISTRICT"
              },
              "addressLines": [
                "1700 DISTRICT AVE STE 300",
                "BURLINGTON MA 01803-5231",
                "United States"
              ],
              "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": "NONE"
                    },
                    {
                      "label": "streetType",
                      "matchType": "EXACT"
                    },
                    {
                      "label": "postalCodeExt",
                      "matchType": "NONE"
                    },
                    {
                      "label": "streetDirectional",
                      "matchType": "EXACT"
                    }
                  ]
                },
                "source": {
                  "label": "ggs"
                }
              },
              "customFields": {
                "RESBUS": "B",
                "LOTSIZE_METERS": "14677",
                "CSA_NUMBER": "148",
                "TYPE_SHORT": "AVE",
                "THOROUGHFARE_TYPE": "AVE",
                "HIUNIT": "300",
                "PARCEN_ELEVATION_METERS": "44.2",
                "ROAD_CLASS": "01",
                "MATCH_CODE": "S902",
                "RDI_RETCODE": "N",
                "COUNTY": "25017",
                "PB_KEY": "P0000BJ4F90Q",
                "LANGUAGE": "en",
                "UNIT_TYPE": "STE",
                "ADDRTYPE": "M",
                "INC_IND": "N",
                "BLOCK_2010": "250173324002012",
                "POINT_ID": "100893034",
                "CHECK_DIGIT": "5",
                "METRO_FLAG": "Y",
                "BLOCK": "250173324011003",
                "POST_THOROUGHFARE_TYPE": "AVE",
                "QCITY": "250065000",
                "ZIP_FACILITY": "P",
                "TFID": "258319428",
                "UNIT_RANGE_PARITY": "E",
                "APN_ID": "048 46-51-0",
                "LOT_CODE": "A",
                "LOT_NUM": "0212",
                "CTYST_KEY": "V21569",
                "UACEPOP": "4181019",
                "NAME": "DISTRICT",
                "ZIP_CARRTSORT": "B",
                "PARENT_ID": "P0000BJ68DL3",
                "LORANGE": "1700",
                "CLOSE_MATCH": "T",
                "STREET_SIDE": "L",
                "DATATYPE": "12",
                "INTERSECTION": "F",
                "ZIP_CITY_DELV": "Y",
                "LOUNIT": "300",
                "LOC_CODE": "AP05",
                "CART": "C023",
                "NAME_CITY": "BURLINGTON",
                "BLOCK_LEFT": "250173324011003",
                "COUNTY_FIPS": "25017",
                "HIRANGE": "1700",
                "UACE": "09271",
                "REC_TYPE": "H",
                "HI_RISE_DFLT": "N",
                "URBANICITY": "L",
                "RESOLVED_LINE": "0",
                "MATCH_TYPE": "ADDRESS",
                "PARCEN_ELEVATION": "145",
                "PREF_CITY": "BURLINGTON",
                "CBSA_NUMBER": "14460",
                "ALT_FLAG": "B",
                "SEGMENT_DIRECTION": "F",
                "ADDRLINE_SHORT": "1700 DISTRICT AVE STE 300",
                "LOTSIZE": "157983",
                "CONFIDENCE": "89",
                "HIZIP4": "5231",
                "DATATYPE_NAME": "MASTER LOCATION",
                "SEGMENT_PARITY": "R",
                "CBSA_DIVISION_NAME": "CAMBRIDGE-NEWTON-FRAMINGHAM, MA METROPOLITAN DIVISION",
                "LOZIP4": "5231",
                "CSA_NAME": "BOSTON-WORCESTER-PROVIDENCE, MA-RI-NH-CT COMBINED STATISTICAL AREA",
                "DPBC": "75",
                "LASTLINE_SHORT": "BURLINGTON, MA  01803-5231",
                "PLACE": "2509875",
                "CITY_SHORT": "BURLINGTON",
                "NAME_SHORT": "DISTRICT",
                "ZIP9": "018035231",
                "IS_ALIAS": "N01",
                "PRECISION_CODE": "S8HPNTSC-A",
                "ZIP10": "01803-5231",
                "CBSA_NAME": "BOSTON-CAMBRIDGE-NEWTON, MA-NH METROPOLITAN STATISTICAL AREA",
                "RANGE_PARITY": "E",
                "CBSA_DIVISION_NUMBER": "15764"
              }
            }
          ]
        }
      ]
    }