CleanAddress
Cleanse a residential address
To connect to this service you'll need to use one of these endpoints:
Description
Formats, verifies and corrects a given address into a full address.
Non-UK addresses are also handled and produce a MatchLevel
in the result of NOK_Foreign
. See the options below to control how international addresses are handled.
Parameters
The following parameters can be supplied to this method
username |
username apikey- , e.g.
apikey-ABCD-1234-EFGH-5678
|
---|---|
password |
password |
address | address The address to clean. The best results will be obtained when individual parts of the address are supplied on separate lines or separated within a line by commas, but the service will make best attempts to match data supplied in any format. |
options | options |
Advanced Options
The following options can be specified as part of the option
parameter. Each option is specified
as a key/value pair. The list of available names is shown below, along with a description of the allowable values
for that name.
DefaultCountryCode | DefaultCountryCode An ISO 2-character code for the country to assume the address is in unless otherwise specified. |
||||||||
---|---|---|---|---|---|---|---|---|---|
DetectCountry | DetectCountry Set to |
||||||||
Country | Country If |
||||||||
IncludeCountry | IncludeCountry Includes the |
||||||||
FixTownCounty | FixTownCounty
|
||||||||
MaxLines | MaxLines The number of lines to format the address over. |
||||||||
Formatter | Formatter This option can be set to the name of a pre-defined formatting type that controls how the address is formatted. The following values are allowed:
|
Results
This method returns an object containing the following fields:
Status |
Status Success field is true , the other results described below can be used to get the results of the method.
If Success is false , some error occurred in calling the method, such as the authentication failed or the
account is out of credits. The details of the error can be obtained from the ErrorMessage field, and any other results should be ignored
|
---|---|
Result | Result Contains the formatted version of the requested address in the |
MatchLevel | MatchLevel Indicates how well the supplied address matched to PAF. Possible values are:
|
CountryName | CountryName The name of the country the address is in. This is only populated when the |