Sign in
Address Validation

Get the available layouts for the supplied country.

post/address/layouts/v1

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.

Request body

country_isostring required

The country ISO3 code of address.

datasetsstring[] required

The datasets for address layout.

Example request

{
  "country_iso": "AUS",
  "datasets": [
    "au-address"
  ]
}

Response

OK

Example response

{
  "error": {
    "title": "Bad Request",
    "detail": "The request body was malformed."
  },
  "result": [
    {
      "name": "QADefault",
      "country_iso_3": "GBR",
      "datasets": [
        "gb-address"
      ]
    }
  ]
}

Changes

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