Cleanses a batch of international addresses (and can also be used for single addresses). To enable the best customer experience, the recommendation is to send batches of less than 100 records which are homogenous in terms of the location. Grouping the requests into countries enables the Verify engine to manage its resources more effectively.
Base URL
https://api.addressy.com/Cleansing/International/Batch/v1.00/
JSON
https://api.addressy.com/Cleansing/International/Batch/v1.00/json4.ws
Note: A REST endpoint with a JSON payload is the only call style supported.
Each request to the web service requires a number of parameters, all of which are listed below. All requests require a key which can be generated in your account.
| Name | Description |
|---|---|
| Key Required |
The key you want to use to authenticate with the service (you can request we create one for you or create one in your account section) |
| Geocode Boolean |
Whether you want geo-coordinates to be appended to your results (if available). There is an additional cost associated with enabling this option. |
| Addresses Required |
An array of addresses that you want to verify. The country field must contain a valid ISO2 or ISO3 country code. We recommend that you use the structured fields (i.e. building/thoroughfare etc) over the address line input fields if the data you are cleansing is already structured. To enable the best customer experience, the recommendation is to send batches of less than 100 records which are homogenous in terms of the location. Grouping the requests into countries enables the Verify engine to manage its resources more effectively. |
| Options Object |
Used to specify various options and override processes. Comprised of the following:
|
| Name | Description |
|---|---|
| Input | A copy of the address that you input in the request "Addresses" array. |
| Matches | An array of matched records including:
|
Below are the errors which are specific to this web service. If an error occurs, an error table like the one below will be returned. To check for an error response, test for a 4 column table with columns "Error", "Description", "Cause" and "Resolution" containing a single row.
For a list of errors applicable to all APIs, have a look at the list of common errors.
| Id | Error | Cause | Resolution |
|---|---|---|---|
| 1000 | Invalid JSON object | The JSON object in the POST body was invalid. | Try again sending a valid JSON request object in the POST body. |
| 1001 | No address supplied | No addresses supplied. | Ensure you send at least one address in the request for cleansing. |
| 1002 | Batch processing failed | Error cleansing your records. | There was a server error whilst processing your batch. Please try again shortly. |
| 1003 | Batch processing timeout | Your batch took too long to process and timed out. | Please reduce the batch size or increase the quality of the input in order to ensure your requests don't time out. |
| 1004 | Too many addresses supplied | Address input limit reached. | Please limit input length to 100 records or less. |