Address Validation

Get the available datasets for the supplied country.

get/address/datasets/v1

Query parameters

country_isostring

3-letter ISO code for country.

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.

Response

Example response

{
  "error": {
    "title": "Bad Request",
    "detail": "The request body was malformed."
  },
  "result": [
    {
      "country_iso_3": "GBR",
      "country_name": "United Kingdom",
      "datasets": [
        {
          "id": "au-address-datafusion",
          "name": "Australia Enhanced Address"
        }
      ],
      "valid_combinations": [
        [
          "gb-additional-electricity",
          "gb-additional-gas"
        ],
        [
          "gb-additional-names",
          "gb-additional-notyetbuilt"
        ]
      ]
    }
  ]
}

Changes

No recorded changes to this endpoint across all 1 revision of this API.