Address Validation

Gets an address layout.

get/address/layouts/v2/{name}

Path parameters

namestring required

Layout name

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": {
    "layout": {
      "applies_to": [
        {
          "country_iso": "GBR",
          "datasets": [
            "au-address"
          ]
        }
      ]
    }
  }
}

Changes

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