Overview

Find & Retrieve address

The findAddress and retrieveAddress methods allow you to search for and retrieve structured address data using the REST API. These methods work together to enable accurate address lookup, validation, and standardization.

Key Points

  • First, use findAddress to get potential address matches. Then, use retrieveAddress to get the full structured details of a selected address.
  • The API provides validation advice (GREEN, AMBER, or RED) and supports geolocation with latitude and longitude.
  • Using the container ID, retrieval ensures data accuracy without requiring repeated full address searches.
  • AddressOptions allow you to adjust how house numbers and additions are structured in the response.