EXexperianaperture
Address Validation

Step into a suggestion.

get/address/suggestions/stepin/v1/{global_address_key}

Request

Path parameters

global_address_keystring required

Global address key.

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

OK

Example response

{
  "error": {
    "title": "Bad Request",
    "detail": "The request body was malformed."
  },
  "result": {
    "confidence": "Verified match",
    "suggestions_prompt": "Enter selection",
    "suggestions": [
      {
        "text": "Level 6  549 St Kilda Road, MELBOURNE  VIC  3004",
        "matched": [
          [
            17,
            22
          ],
          [
            11,
            15
          ],
          [
            3,
            10
          ],
          [
            0,
            2
          ]
        ],
        "dataset": "Multiple Residence",
        "additional_attributes": [
          {
            "name": "flatten",
            "value": "true"
          }
        ]
      }
    ]
  }
}

Changes

No recorded changes to this operation across all 4 revisions of this API.