Sign in
Address Validation

Get the available prompt sets.

post/address/promptsets/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.

datasetsstring[] required

The datasets of the promptset.

search_type'singleline' | 'typedown' | 'verification' | 'keyfinder' | 'intuitive_classic'

The available search type.

prompt_set'oneline' | 'default' | 'generic' | 'optimal' | 'alternate' | 'alternate2' | 'alternate3' required

The available prompt sets.

Example request

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

Response

OK

Example response

{
  "error": {
    "title": "Bad Request",
    "detail": "The request body was malformed."
  },
  "result": {
    "lines": [
      {
        "prompt": "Building number or name.",
        "suggested_input_length": 40,
        "example": "12"
      }
    ]
  }
}

Changes

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