Example: JSON POST Request & Response

Interactive Request

{
  "address": {
    "mainAddressLine": "13-15 Quai André Citroën",
    "country": null
  },
  "preferences": {
    "maxReturnedCandidates": 10,
    "distanceUnits": "MILES",
    "distance": null,
    "customPreferences": {
      "COMPRESSED_AREA_RESULT": "false",
      "SEARCH_TYPE": "ADDRESS_COMPLETION"
    },
    "returnAllCandidateInfo": true,
    "originXY": []
  }
}
}

Interactive Response

{
  "totalPossibleCandidates": 1,
  "totalMatches": 1,
  "candidates": [
    {
      "precisionLevel": 0,
      "formattedStreetAddress": "13-15 Quai André Citroën",
      "formattedLocationAddress": "75015 Paris",
      "matching": {
        "matchOnAddressNumber": true,
        "matchOnPostCode1": false,
       
        ...
        
        "matchOnStreetType": false,
        "matchOnStreetDirectional": false,
        "matchOnPlaceName": false,
        "matchOnInputFields": false
      },
      "geometry": {
        "type": "Point",
        "coordinates": [
          2.275675,
48.844045
        ],
        "crs": {
          "type": "name",
          "properties": {
            "name": "epsg:4326"
          }
        }
      },
      "address": {
        "mainAddressLine": "",
        "addressLastLine": "",
        "areaName1": "Île-de-France",
        "areaName2": "Paris",
        "areaName3": "Paris",
        "areaName4": "15e Arrondissement",
        "postCode1": "75015",
        "postCode2": "",
        "country": "FRA",
        "addressNumber": "13-15",
        "streetName": "Quai André Citroën",
        "unitType": "",
        "unitValue": "",
        "customFields": {
          "FORMATTED_ADDRESS": "13-15 Quai André Citroën, 75015 Paris",
          "DISTANCE": "-0.0",
          "FEATUREID": "12500001640586",
          "FROM_CUSTOM_DATASET": "false",
          "MATCHED_FROM_ADDRESSNUMBER": "13 15",
          "MATCHED_FROM_STREETNAME": "QI ANDRE CITROEN",
          "DISTANCE_UNIT": "MILES"
        }
      },
      "ranges": []
    }
  ],
  "customValues": {}
}