Retrieve

Retreive the full address

This service is hosted in multiple countries. Select your preferred country to see the appropriate endpoint URLs.

Changing the hosting country does not affect the data returned by the service. However you may wish to select a particular country based on your data residency requirements or network latency.

JSON

Open API

SOAP

Description

Retrieve the full details of an address returned from a previous call to either the Search or DrillDown endpoints where the container property was set to false.

Credit Usage

Each request to this method consumes 1 PredictiveAddress credit for each request, except addresses from the Eircode data source which are charged at 3 credits each.

Parameters

The following parameters can be supplied to this method

username	username See the available authentication methods. If you are using username & password authentication, specify the username to authenticate as. If you are using API Key authentication and you are not using the JSON, Javascript or ADO APIs, use your API Key here with the prefix `apikey-`, e.g. `apikey-ABCD-1234-EFGH-5678`
password	password If you are using username & password authentication, specify the password to use for authentication. Otherwise leave this blank.
country	country The ISO-2 country code in which the address belongs.
id	id The `value` property from the response of previous requests from either the Search or DrillDown methods, when the `container` property was false, should be supplied here.
options	options An array of options that control further details of how this method operates. See the Advanced Options section below for more information.

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.

Common Options
Name	Description
ApplicationName	ApplicationName Gives the name of the calling application - used to break down usage by application in the usage reports on the dashboard
Address Formatting Options
There are a large number of options to control how the raw address details are combined & formatted for presentation. They are described in more detail with live interactive examples on the address formatting reference. A summary of the available options is also listed below.
Name	Description
Formatter	Formatter Pick from one of the available formatters to control how the raw address is converted into a human-readable address: `DefaultFormatter` `PAFStandardFormatter` `NoOrganisationFormatter`
MaxLines	MaxLines The number of lines to format the address over. An additional line will be included at the end of the results for the postcode
MaxLineLength	MaxLineLength The maximum number of characters that can appear in each address line
FixTownCounty	FixTownCounty `true` to ensure that the town and county are returned in the last two address lines, or `false` if they should appear in the first available line
FixBuilding	FixBuilding Ensures the building name/number is always placed in the first line
NormalizeCase	NormalizeCase Converts all text in the address except the town name to proper case
NormalizeTownCase	NormalizeTownCase Converts the town name to proper case
UseAnyAvailableCounty	UseAnyAvailableCounty Uses any available county to populate the formatted address, not just the postal county
ExcludeCounty	ExcludeCounty Excludes the county, if any, from the formatted address
UnwantedPunctuation	UnwantedPunctuation A string containing any punctuation characters to be removed from the formatted address
Geocoding Options
Note: Geocoding information is not available for all addresses. Some addresses (e.g. PO Boxes) do not represent a physical location, while for some countries (including Isle of Man and Channel Islands) the data is not currently available. The information requested by these options will be returned wherever possible, but is not guaranteed for all addresses.
Name	Description
IncludeLocation	IncludeLocation Includes location information (latitude/longitude, easting/northing and/or grid reference, depending on country) where possible
IncludeConstituency	IncludeConstituency Includes the UK parliamentary constituency the address is in where possible
IncludeCountry	IncludeCountry Include the ISO 2-character code and full name of the country
IncludeAdminArea	IncludeAdminArea Includes names & codes for the administrative areas the address is in where possible. For UK addresses this can include: `County` `CountyCode` `District` `DistrictCode` `Ward` `WardCode` `Country` For UK addresses, this option sets the `Country` field to the name of the nation within the UK, i.e. "England", "Scotland", "Wales" or "Northern Ireland". This overrides the `IncludeCountry` option that would otherwise set it to "United Kingdom" For US addresses the `County`, `CountyCode` and `District` fields can be populated.
Address Unique Reference Options
Note: Only one unique identifier for each address will be returned. An error will be returned if you set more than one of these options to `true`.
Name	Description
IncludeUDPRN	IncludeUDPRN Set to `true` to include the UDPRN for UK addresses
IncludeUPRN	IncludeUPRN Set to `true` to include the UPRN for UK addresses. This is not available by default and requires additional licensing - speak to your account manager for additional information. When this option is enabled, more accurate premise-level information is also used for the geocoding information used by the `IncludeLocation` option.
Dataset Options
Note: Each additional dataset requires additional licensing. If you attempt to use a dataset which your account is not licensed for an error will be returned. Please speak to your account manager to enable additional datasets
Name	Description
IncludeMR	IncludeMR Includes addresses from the UK Multiple Residency database, e.g. multiple flats behind a single letter box, university halls of residence
IncludeNYB	IncludeNYB Includes addresses from the UK Not Yet Built database, e.g. houses currently being developed
Service-Specific Options
Name	Description
PreferredLanguage	PreferredLanguage Set this to the ISO 639-1 code of the language to retrieve the address in where possible. For example, specify `cy` to retrieve addresses in Welsh, or `en` to prefer English. Not all languages are available for all addresses.
IncludeWhat3Words	IncludeWhat3Words Indicates if the coordinates of the what3words searched for by the user should be included in the response instead of the standard coordinates available for the address. This option consumes a what3words credit in addition to the standard PredictiveAddress credit.
UseFiveDigitZip	UseFiveDigitZip For US addresses, this option gives you control over the formatting of the zip code returned within the formatted address. Set the value to `true` to return zip codes in a 5 digit format (XXXXX) rather than the default format (XXXXX-XXXX).
IncludeEPC	IncludeEPC Includes the latest energy performance certificate rating and date as part of the `RawAddress.AdditionalData` list. You will be charged a separate Energy Performance Certificate credit when this data is returned.

Results

This method returns an object containing the following fields:

Status

Status	Status Indicates whether the method call was successful, or if some error occurred. If the `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 `Address` field, and a structured version of the address is available in the `RawAddress` field.

Status

Indicates whether the method call was successful, or if some error occurred. If the 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 Address field, and a structured version of the address is available in the RawAddress field.

Live Demo

country

id

options

Name	Value
Common Options
ApplicationName
Address Formatting Options
Formatter
MaxLines
MaxLineLength
FixTownCounty
FixBuilding
NormalizeCase
NormalizeTownCase
UseAnyAvailableCounty
UnwantedPunctuation
Geocoding Options
IncludeLocation
IncludeCountry
IncludeAdminArea
Address Unique Reference Options
IncludeUDPRN
IncludeUPRN
Dataset Options
IncludeMR
IncludeNYB
Service-Specific Options
PreferredLanguage
IncludeWhat3Words
UseFiveDigitZip
IncludeEPC

Sample Code

// NOTE: A Service Reference to the web service must be added to use this sample code.
private void Retrieve(string country, string id)
{
    // Declare the required options.
    Option PreferredLanguage = new Option();
    PreferredLanguage.Name = "PreferredLanguage";
    PreferredLanguage.Value = "en";
    Option IncludeWhat3Words = new Option();
    IncludeWhat3Words.Name = "IncludeWhat3Words";
    IncludeWhat3Words.Value = "true";
    Option UseFiveDigitZip = new Option();
    UseFiveDigitZip.Name = "UseFiveDigitZip";
    UseFiveDigitZip.Value = "false";
    Option IncludeEPC = new Option();
    IncludeEPC.Name = "IncludeEPC";
    IncludeEPC.Value = "false";
    Option MaxLines = new Option();
    MaxLines.Name = "MaxLines";
    MaxLines.Value = "6";
    Option FixTownCounty = new Option();
    FixTownCounty.Name = "FixTownCounty";
    FixTownCounty.Value = "true";
    Option IncludeLocation = new Option();
    IncludeLocation.Name = "IncludeLocation";
    IncludeLocation.Value = "true";
    // Invoke the web service method.
    PredictiveAddressSoapClient proxy = new PredictiveAddressSoapClient();
    PredictiveAddressRetrieveResponse results = proxy.Retrieve("your-username", "your-password", country, id, new Option[] {
                PreferredLanguage,
                IncludeWhat3Words,
                UseFiveDigitZip,
                IncludeEPC,
                MaxLines,
                FixTownCounty,
                IncludeLocation});
    // Check that the call succeeded, and show the error message if there was a problem.
    if ((results.Status.Success == false))
    {
        MessageBox.Show(("Error: " + results.Status.ErrorMessage));
    }
    else
    {
        // TODO: Process method results here.
        // Results can be extracted from the following fields:
        // result.Result
        //   An object containing full details of a complete address. A formatted version of each address in the array is available in the `Address` field, and a structured version of the address is available in the `RawAddress` field.
    }
}

'NOTE: A Service Reference to the web service must be added to use this sample code.
Private Sub Retrieve(ByVal country As String, ByVal id As String)
    'Declare the required options.
    Dim PreferredLanguage As [Option] = New [Option]()
    PreferredLanguage.Name = "PreferredLanguage"
    PreferredLanguage.Value = "en"
    Dim IncludeWhat3Words As [Option] = New [Option]()
    IncludeWhat3Words.Name = "IncludeWhat3Words"
    IncludeWhat3Words.Value = "true"
    Dim UseFiveDigitZip As [Option] = New [Option]()
    UseFiveDigitZip.Name = "UseFiveDigitZip"
    UseFiveDigitZip.Value = "false"
    Dim IncludeEPC As [Option] = New [Option]()
    IncludeEPC.Name = "IncludeEPC"
    IncludeEPC.Value = "false"
    Dim MaxLines As [Option] = New [Option]()
    MaxLines.Name = "MaxLines"
    MaxLines.Value = "6"
    Dim FixTownCounty As [Option] = New [Option]()
    FixTownCounty.Name = "FixTownCounty"
    FixTownCounty.Value = "true"
    Dim IncludeLocation As [Option] = New [Option]()
    IncludeLocation.Name = "IncludeLocation"
    IncludeLocation.Value = "true"
    'Invoke the web service method.
    Dim proxy As PredictiveAddressSoapClient = New PredictiveAddressSoapClient()
    Dim results As PredictiveAddressRetrieveResponse = proxy.Retrieve("your-username", "your-password", country, id, New [Option]() {PreferredLanguage, IncludeWhat3Words, UseFiveDigitZip, IncludeEPC, MaxLines, FixTownCounty, IncludeLocation})
    'Check that the call succeeded, and show the error message if there was a problem.
    If (results.Status.Success = false) Then
        MessageBox.Show(("Error: " + results.Status.ErrorMessage))
    Else
        'TODO: Process method results here.
        'Results can be extracted from the following fields:
        'result.Result
        '  An object containing full details of a complete address. A formatted version of each address in the array is available in the `Address` field, and a structured version of the address is available in the `RawAddress` field.
    End If
End Sub

Request Format

{
  "country": "GB",
  "id": "PChT7czv4i9nVSZqB4VpYBjQ",
  "options": {
    "PreferredLanguage": "en",
    "IncludeWhat3Words": true,
    "UseFiveDigitZip": false,
    "IncludeEPC": false,
    "MaxLines": 6,
    "FixTownCounty": true,
    "IncludeLocation": true
  }
}

Results Format

{
  "Status": {
    "Success": true,
    "CreditsRemaining": 1000
  },
  "Result": null
}

Depending on your chosen authentication method you will need to modify this request slightly: