Sign in
Address Validation

Search for an address.

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

Transliterateboolean

Specify if transliteration is expected.

Add-Retentionboolean

Specify if retention is expected.

Request body

country_isostring required

The country ISO3 code of address.

datasetsstring[] nullable required

The datasets for address validation.

max_suggestionsinteger nullable

The maximum number of suggestions a search request should return. Please refer to the <a target="_blank" href="https://docs.experianaperture.io/address-validation/experian-address-validation/api-reference/api-specification/">documentation</a>.

locationstring nullable

Geographical location (latitude,longitude) to use as the center point for the search (USA only).

preferred_languagestring[] nullable

The datasets for address validation.

preferred_scriptstring[] nullable

The datasets for address validation.

streetstring nullable

The country ISO3 code of address.

townstring nullable

The country ISO3 code of address.

regionstring nullable

The country ISO3 code of address.

postal_codestring nullable

The country ISO3 code of address.

Example request

{
  "country_iso": "GBR",
  "datasets": [
    "au-address"
  ],
  "max_suggestions": 10,
  "components": {
    "unspecified": [
      "1 Main Street"
    ],
    "names": [
      "1 Main Street"
    ]
  },
  "location": "42.3529, -71.0578",
  "options": [
    {
      "name": "search_type",
      "value": "singleline"
    }
  ],
  "preferred_language": [
    "ja"
  ],
  "preferred_script": [
    "preserve_input"
  ],
  "street": "GBR",
  "town": "GBR",
  "region": "GBR",
  "postal_code": "GBR"
}

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 endpoint across all 1 revision of this API.