Parameters
The following parameters can be supplied to this method
username |
username apikey- , e.g.
apikey-ABCD-1234-EFGH-5678
|
---|---|
password |
password |
country | country The ISO-2 country code in which the address belongs. |
id | id The |
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.
FixBuilding | FixBuilding Ensures the building name/number is always placed in the first line |
---|---|
FixPostcode | FixPostcode
|
FixTownCounty | FixTownCounty
|
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:
|
IncludeAdminArea | IncludeAdminArea For UK addresses, indicates that additional administrative area details should be included in the returned
Note that not all these fields are available for all addresses. When this option is set, the |
IncludeCountry | IncludeCountry Set to |
IncludeLocation | IncludeLocation Retrieve geocode information about the address such as |
IncludeMR | IncludeMR Includes addresses from the Multiple Residency database in the results (requires additional licensing). |
IncludeNYB | IncludeNYB Includes addresses from the Not Yet Built database in the results (requires additional licensing). |
IncludeUDPRN | IncludeUDPRN set to |
IncludeUPRN | IncludeUPRN set to |
MaxLineLength | MaxLineLength The maximum number of characters per line in the formatted address. Defaults to 255. |
MaxLines | MaxLines The number of lines to format the address over. If you use the |
PreferredLanguage | PreferredLanguage Set this to |
UnwantedPunctuation | UnwantedPunctuation a string containing any characters that should be excluded from the formatted address. |
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 An object containing full details of a complete address. A formatted version of each address in the array is available in the |