Example: JSON POST Request & Response

Key Lookup Request

{
  "keys": [
    {
      "value": "P0000GL638OL",
      "country": "USA"
    }
  ],
  "type": "PB_KEY",
  "preferences": {
    "returnAllCandidateInfo": true
  }
}

Key Lookup Response

{
  "responses": [
    {
      "totalPossibleCandidates": 1,
      "totalMatches": 1,
      "candidates": [
        {
          "precisionLevel": 16,
          "formattedStreetAddress": "350 JORDAN RD",
          "formattedLocationAddress": "TROY, NY  12180-8352",
          "identifier": "869200424",
          "precisionCode": "S8H--A",
          "sourceDictionary": "2",
          "matching": {
            "matchOnAddressNumber": false,
            "matchOnPostCode1": true,
            "matchOnPostCode2": true,
            "matchOnAreaName1": true,
            "matchOnAreaName2": false,
            "matchOnAreaName3": true,
            "matchOnAreaName4": false,
            "matchOnAllStreetFields": false,
            "matchOnStreetName": true,
            "matchOnStreetType": true,
            "matchOnStreetDirectional": true,
            "matchOnPlaceName": false,
            "matchOnInputFields": false
          },
          "geometry": {
            "type": "Point",
            "coordinates": [
              -73.700257,
              42.678161
            ],
            "crs": {
              "type": "name",
              "properties": {
                "name": "epsg:4326"
              }
            }
          },
          "address": {
            "mainAddressLine": "350 JORDAN RD",
            "addressLastLine": "TROY, NY  12180-8352",
            "placeName": "",
            "areaName1": "NY",
            "areaName2": "RENSSELAER COUNTY",
            "areaName3": "TROY",
            "areaName4": "",
            "postCode1": "12180",
            "postCode2": "8352",
            "country": "USA",
            "addressNumber": "350",
            "streetName": "JORDAN",
            "unitType": "",
            "unitValue": "",
            "customFields": {
              "ZIP": "12180",
              "CSA_NUMBER": "104",
              "TYPE_SHORT": "RD",
              "THOROUGHFARE_TYPE": "RD",
              "ROAD_CLASS": "01",
              "MATCH_CODE": "V001",
              "DFLT": "Y",
              "COUNTY": "36083",
              "LANGUAGE": "en",
              "PB_KEY": "P0000GL638OL",
              "POINT_ID": "108535989",
              "LAST_LINE": "TROY, NY  12180-8352",
              "CHECK_DIGIT": "2",
              "MM_RESULT_CODE": "S8H--A",
              "METRO_FLAG": "Y",
              "BLOCK": "360830523011022",
              "QCITY": "361305000",
              "ZIP_FACILITY": "P",
              "LON": "-73.700257",
              "LOT_CODE": "A",
              "LOT_NUM": "0063",
              "CTYST_KEY": "V16572",
              "ZIP_CARRTSORT": "D",
              "LORANGE": "350",
              "STREET_SIDE": "L",
              "DATATYPE": "12",
              "SEG_LORANGE": "350",
              ...
 
              "LASTLINE_SHORT": "TROY, NY  12180-8352",
              "DPBC": "99",
              "MAIN_ADDRESS": "JORDAN",
              "NAME_SHORT": "JORDAN",
              "CITY_SHORT": "TROY",
              "ZIP9": "121808352",
              "CITY": "TROY",
              "IS_ALIAS": "N01",
              "ZIP10": "12180-8352",
              "ZIP4": "8352",
              "CBSA_NAME": "ALBANY-SCHENECTADY-TROY, NY METROPOLITAN STATISTICAL AREA",
              "MATCHED_DB": "2",
              "RANGE_PARITY": "E",
              "LAT": "42.678161"
            }
          },
          "ranges": [
            {
              "placeName": "",
              "lowHouse": "350",
              "highHouse": "350",
              "side": "LEFT",
              "oddEvenIndicator": "EVEN",
              "units": [
                {
                  "placeName": "",
                  "unitType": "",
                  "highUnitValue": "",
                  "lowUnitValue": "",
                  "customValues": {}
                }
              ],
              "customValues": {}
            }
          ]
        }
      ],
      "customValues": {}
    }
  ]
}