Sign in
Address Validation

Lookup an address based on a key.

post/address/lookup/v2

Headers

Reference-Idstring

Optional identifier that will be returned in the response to help you track the request.

Timeout-Secondsinteger

Maximum time you are prepared to wait for a response, expressed in seconds. Acceptable values: 2-15. If a timeout occurs, an HTTP status code of 408 - Request Timeout will be returned.

Add-Addressesstring

If true an addresses field will be populated with concrete addresses in response.

Add-FinalAddressboolean

If true an addresses_formatted field will be populated with concrete custom formatted addresses in response.

Request body

country_isostring required

Gets or sets the country ISO3 code of address.

datasetsstring[] nullable required

Gets or sets the datasets for address validation.

max_addressesinteger nullable

Gets or sets the maximum number of addresses a search request should return.

max_suggestionsinteger nullable

Gets or sets the maximum number of suggestions a search request should return.

preferred_languagestring[] nullable

Gets or sets the preferred language.

preferred_scriptstring[] nullable

Gets or sets the the preferred script.

layoutsstring[] nullable

Custom layout name.

Example request

{
  "country_iso": "GBR",
  "datasets": [
    "gb-address"
  ],
  "max_addresses": 10,
  "key": {
    "type": "postal_code",
    "value": "NN14 4RX"
  },
  "names": [
    "1 Main Street"
  ],
  "layouts": [
    "default"
  ]
}

Response

OK

more_results_availableboolean

Gets or sets a value indicating whether property that there are more suggestions available than the results provided.

confidencestring nullable

Gets or sets the outcome (confidence level) of the validation.

suggestions_keystring nullable

Gets or sets the suggestions key for address suggestion refinement.

suggestions_promptstring nullable

Gets or sets the prompt to display to the user, indicating what information they should enter next.

Example response

{
  "confidence": "Verified match",
  "suggestions_prompt": "Enter selection",
  "addresses_formatted": [
    {
      "layout_name": "QADefault",
      "address": {
        "AmexStreet": "1 Main St",
        "AmexTown": "Surbiton",
        "AmexCountry": "United Kingdom",
        "gas_meters": [
          {
            "mprn": "52902306"
          },
          {
            "mprn": "52902307"
          }
        ]
      }
    }
  ]
}

Changes