Sample: JSON
POST JSON Request
{
"keys": [{
"objectId":"1",
"value": "P00003PZZOIE",
"country": "usa"
},
{
"objectId":"2",
"value": "P0000KPVF7RO",
"country": "usa"
}
],
"type": "PB_KEY",
"preferences": {
"returnAllCandidateInfo": true,
"maxReturnedCandidates": "10"
}
}POST JSON Response
{
"responses": [
{
"objectId": "1",
"totalPossibleCandidates": 2,
"totalMatches": 2,
"candidates": [
{
"precisionLevel": 16,
"formattedStreetAddress": "4750 WALNUT ST",
"formattedLocationAddress": "BOULDER, CO 80301-2532",
"identifier": "947855759",
"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": [
-105.240967,
40.018297
],
"crs": {
"type": "name",
"properties": {
"name": "epsg:4326"
}
}
},
"address": {
"mainAddressLine": "4750 WALNUT ST",
"addressLastLine": "BOULDER, CO 80301-2532",
"areaName1": "CO",
"areaName2": "BOULDER COUNTY",
"areaName3": "BOULDER",
"postCode1": "80301",
"postCode2": "2532",
"country": "USA",
"addressNumber": "4750",
"streetName": "WALNUT",
"customFields": {
"ZIP": "80301",
"CSA_NUMBER": "216",
"TYPE_SHORT": "ST",
"THOROUGHFARE_TYPE": "ST",
"ROAD_CLASS": "01",
"MATCH_CODE": "V001",
"DFLT": "Y",
"COUNTY": "08013",
"LANGUAGE": "en",
"PB_KEY": "P00003PZZOIE",
"POINT_ID": "102452694",
"LAST_LINE": "BOULDER, CO 80301-2532",
"CHECK_DIGIT": "8",
"MM_RESULT_CODE": "S8H--A",
"METRO_FLAG": "Y",
"BLOCK": "080130122032110",
"QCITY": "080034000",
"ZIP_FACILITY": "P",
"LON": "-105.240967",
"LOT_CODE": "A",
"LOT_NUM": "0053",
"CTYST_KEY": "Z11102",
"ZIP_CARRTSORT": "B",
"LORANGE": "4750",
"STREET_SIDE": "L",
"DATATYPE": "12",
"SEG_LORANGE": "4750",
"LOC_CODE": "AP05",
"CART": "C033",
"BLOCK_LEFT": "080130122032110",
"HOUSE_NUMBER": "4750",
"NAME_CITY": "BOULDER",
"SEG_HIRANGE": "4750",
"COUNTY_NAME": "BOULDER COUNTY",
"HIRANGE": "4750",
"STATE": "CO",
"HI_RISE_DFLT": "Y",
"REC_TYPE": "H",
"RESOLVED_LINE": "0",
"PREF_CITY": "BOULDER",
"CBSA_NUMBER": "14500",
"ALT_FLAG": "B",
"SEGMENT_DIRECTION": "F",
"ADDRLINE_SHORT": "4750 WALNUT ST",
"HIZIP4": "2532",
"DATATYPE_NAME": "MASTER LOCATION",
"ADDRLINE": "4750 WALNUT ST",
"SEGMENT_ID": "947855759",
"SEGMENT_PARITY": "R",
"LOZIP4": "2532",
"CSA_NAME": "DENVER-AURORA, CO COMBINED STATISTICAL AREA",
"LASTLINE_SHORT": "BOULDER, CO 80301-2532",
"DPBC": "99",
"MAIN_ADDRESS": "WALNUT",
"NAME_SHORT": "WALNUT",
"CITY_SHORT": "BOULDER",
"ZIP9": "803012532",
"CITY": "BOULDER",
"IS_ALIAS": "N01",
"ZIP10": "80301-2532",
"ZIP4": "2532",
"CBSA_NAME": "BOULDER, CO METROPOLITAN STATISTICAL AREA",
"MATCHED_DB": "2",
"RANGE_PARITY": "E",
"LAT": "40.018297"
}
},
"ranges": [
{
"lowHouse": "4750",
"highHouse": "4750",
"side": "LEFT",
"oddEvenIndicator": "EVEN",
"units": [
{}
]
}
]
},
{
"precisionLevel": 16,
"formattedStreetAddress": "4750 WALNUT ST",
"formattedLocationAddress": "BOULDER, CO 80301-2538",
"identifier": "947855759",
"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": [
-105.240967,
40.018297
],
"crs": {
"type": "name",
"properties": {
"name": "epsg:4326"
}
}
},
"address": {
"mainAddressLine": "4750 WALNUT ST",
"addressLastLine": "BOULDER, CO 80301-2538",
"areaName1": "CO",
"areaName2": "BOULDER COUNTY",
"areaName3": "BOULDER",
"postCode1": "80301",
"postCode2": "2538",
"country": "USA",
"addressNumber": "4750",
"streetName": "WALNUT",
"customFields": {
"ZIP": "80301",
"CSA_NUMBER": "216",
"THOROUGHFARE_TYPE": "ST",
"ROAD_CLASS": "01",
"MATCH_CODE": "V000",
"COUNTY": "08013",
"LANGUAGE": "en",
"PB_KEY": "P00003PZZOIE",
"POINT_ID": "102452694",
"LAST_LINE": "BOULDER, CO 80301-2538",
"MM_RESULT_CODE": "S8H--A",
"METRO_FLAG": "Y",
"BLOCK": "080130122032110",
"QCITY": "080034000",
"ZIP_FACILITY": "P",
"LON": "-105.240967",
"CTYST_KEY": "Z11102",
"ZIP_CARRTSORT": "B",
"LORANGE": "4750",
"STREET_SIDE": "L",
"DATATYPE": "12",
"SEG_LORANGE": "4750",
"LOC_CODE": "AP05",
"CART": "C033",
"BLOCK_LEFT": "080130122032110",
"HOUSE_NUMBER": "4750",
"NAME_CITY": "BOULDER",
"SEG_HIRANGE": "4750",
"COUNTY_NAME": "BOULDER COUNTY",
"HIRANGE": "4750",
"STATE": "CO",
"REC_TYPE": "S",
"PREF_CITY": "BOULDER",
"CBSA_NUMBER": "14500",
"ALT_FLAG": "B",
"SEGMENT_DIRECTION": "F",
"HIZIP4": "2538",
"DATATYPE_NAME": "MASTER LOCATION",
"ADDRLINE": "4750 WALNUT ST",
"SEGMENT_ID": "947855759",
"SEGMENT_PARITY": "R",
"LOZIP4": "2538",
"CSA_NAME": "DENVER-AURORA, CO COMBINED STATISTICAL AREA",
"MAIN_ADDRESS": "WALNUT",
"CITY_SHORT": "BOULDER",
"ZIP9": "803012538",
"CITY": "BOULDER",
"IS_ALIAS": "N01",
"ZIP10": "80301-2538",
"ZIP4": "2538",
"CBSA_NAME": "BOULDER, CO METROPOLITAN STATISTICAL AREA",
"MATCHED_DB": "2",
"RANGE_PARITY": "E",
"LAT": "40.018297"
}
},
"ranges": [
{
"lowHouse": "4750",
"highHouse": "4750",
"side": "LEFT",
"oddEvenIndicator": "EVEN",
"units": [
{}
]
}
]
}
]
},
{
"objectId": "2",
"totalPossibleCandidates": 1,
"totalMatches": 1,
"candidates": [
{
"precisionLevel": 16,
"formattedStreetAddress": "143 TABERNACLE RD",
"formattedLocationAddress": "EUTAWVILLE, SC 29048-8723",
"identifier": "102306625",
"precisionCode": "S8H--A",
"sourceDictionary": "1",
"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": [
-80.323861,
33.403913
],
"crs": {
"type": "name",
"properties": {
"name": "epsg:4326"
}
}
},
"address": {
"mainAddressLine": "143 TABERNACLE RD",
"addressLastLine": "EUTAWVILLE, SC 29048-8723",
"areaName1": "SC",
"areaName2": "ORANGEBURG COUNTY",
"areaName3": "EUTAWVILLE",
"postCode1": "29048",
"postCode2": "8723",
"country": "USA",
"addressNumber": "143",
"streetName": "TABERNACLE",
"customFields": {
"ZIP": "29048",
"CSA_NUMBER": "192",
"TYPE_SHORT": "RD",
"THOROUGHFARE_TYPE": "RD",
"ROAD_CLASS": "01",
"MATCH_CODE": "V000",
"COUNTY": "45075",
"LANGUAGE": "en",
"PB_KEY": "P0000KPVF7RO",
"POINT_ID": "100079124",
"LAST_LINE": "EUTAWVILLE, SC 29048-8723",
"CHECK_DIGIT": "0",
"MM_RESULT_CODE": "S8H--A",
"METRO_FLAG": "N",
"BLOCK": "450750101003026",
"QCITY": "450096000",
"ZIP_FACILITY": "P",
"LON": "-80.323861",
"LOT_CODE": "D",
"LOT_NUM": "0489",
"CTYST_KEY": "X23858",
"ZIP_CARRTSORT": "D",
"LORANGE": "143",
"STREET_SIDE": "L",
"DATATYPE": "12",
"SEG_LORANGE": "143",
"LOC_CODE": "AP02",
"CART": "R083",
"BLOCK_LEFT": "450750101003026",
"HOUSE_NUMBER": "143",
"NAME_CITY": "EUTAWVILLE",
"SEG_HIRANGE": "143",
"COUNTY_NAME": "ORANGEBURG COUNTY",
"HIRANGE": "143",
"STATE": "SC",
"REC_TYPE": "S",
"RESOLVED_LINE": "0",
"PREF_CITY": "EUTAWVILLE",
"CBSA_NUMBER": "36700",
"ALT_FLAG": "B",
"SEGMENT_DIRECTION": "F",
"ADDRLINE_SHORT": "143 TABERNACLE RD",
"HIZIP4": "8723",
"DATATYPE_NAME": "MASTER LOCATION",
"ADDRLINE": "143 TABERNACLE RD",
"SEGMENT_ID": "102306625",
"SEGMENT_PARITY": "L",
"LOZIP4": "8723",
"CSA_NAME": "COLUMBIA-ORANGEBURG-NEWBERRY, SC COMBINED STATISTICAL AREA",
"LASTLINE_SHORT": "EUTAWVILLE, SC 29048-8723",
"DPBC": "43",
"MAIN_ADDRESS": "TABERNACLE",
"NAME_SHORT": "TABERNACLE",
"CITY_SHORT": "EUTAWVILLE",
"ZIP9": "290488723",
"CITY": "EUTAWVILLE",
"IS_ALIAS": "N01",
"ZIP10": "29048-8723",
"ZIP4": "8723",
"CBSA_NAME": "ORANGEBURG, SC MICROPOLITAN STATISTICAL AREA",
"MATCHED_DB": "1",
"RANGE_PARITY": "O",
"LAT": "33.403913"
}
},
"ranges": [
{
"lowHouse": "143",
"highHouse": "143",
"side": "LEFT",
"oddEvenIndicator": "ODD",
"units": [
{}
]
}
]
}
]
}
]
}