Address Suggest

The Address Suggest API returns address suggestions. Use this API only if the Address Validate API fails to validate an address and returns a 400 error. This API itself does not validate addresses; it returns suggestions based on the information submitted in the request.

Important Notes

  • In response, the address object outside the suggestions object, including the status field, must be ignored as it does not provide valid address data.

  • Only the addresses listed under the suggestions.addresses array should be considered for further action.

Key Considerations

  • Some suggestions, especially for range suggestions, might not be valid delivery points may not guarantee delivery. For example, if the suggested valid range for a street is 1-100, the API may suggest and validate all numbers in the range, even if only 12, 24, and 36 are actual deliverable addresses.

  • The API returns a maximum of 20 suggestions.

  • The suggestions are not sorted by best match.

  • Some requests might return no suggestions.

  • If no suggestions are available, the suggestions object is not included in the response.

SecuritybearerAuth
Request
Request Body schema: application/json
required
object
Responses
200

The address is suggested to use.

400

Invalid request.

401

The request could not be authorized.

500

The request could not be completed due to an internal error.

post/api/v1/address/suggest
Request samples
application/json
{
  • "address": {
    }
}
Response samples
application/json
{
  • "address": {
    },
  • "suggestions": {
    }
}