0151 355 4555



Finds a list of formatted PAF addresses that are in the requested postcode, and match the optional building search criteria. The postcode parameter is required, but the building parameter is optional. If the building parameter is not specified, every address in the postcode is included in the results.

This method provides the fastest and most accurate method of retrieving an address if you know the postcode.

The returned address can be formatted in a number of different ways. Please refer to the address formatting page for further details.

This method supports the following options:

  • AllowMissingBuilding. If this is set to True and the building parameter is specified, this method will first attempt to return only addresses in the postcode that match the building. However, if no addresses match the building, all addresses in the postcode will be returned.
  • IncludeUDPRN. If this is set to True, each address returned will have its UniqueReference field set to the UDPRN of the address.
  • ReturnResultCount. If this is set to True, the ResultCount field will be populated with the number of addresses included in the Results field.
  • IncludeNYB. If this is set to True, addresses from the Not Yet Built database will be included in the results (requires additional licensing).
  • IncludeMR. If this is set to True, addresses from the Multiple Residency database will be included in the results (requires additional licensing).

View all Address validation methods

Code Samples

<!-- Import the Integr8 Ajax API -->
<!-- NOTE: Get your own API key to use in the following script tag from: -->
<!-- http://www.data-8.co.uk/integr8/Admin/Ajax.aspx -->
<script src="https://webservices.data-8.co.uk/Javascript/Loader.ashx?key=your-api-key" type="text/javascript">

<script type="text/javascript">

function loadIntegr8() {
  // Load the AddressCapture Integr8 service

function GetFullAddress(licence, postcode, building) {
  /// <param name="licence">string. One of the following values: WebServerFull, WebClickFull, WebClickThoroughfare, InternalUserFull, InternalUserThoroughfare, SmallUserFull, SmallUserThoroughfare, Lookup, InternalServerFull, InternalServerThoroughfare, FreeTrial, FreeTrialThoroughfare, InternalUserFullArea, InternalUserThoroughfareArea, WebServerThoroughfare</param>
  /// <param name="postcode">string</param>
  /// <param name="building">string</param>
  var addresscapture = new data8.addresscapture();
      new data8.option('MaxLines', '5'),
      new data8.option('FixTownCounty', 'true')

function showGetFullAddressResult(result) {
  // Check that the call succeeded, and show the error message if there was a problem.
  if (!result.Status.Success) {
    alert('Error: ' + result.Status.ErrorMessage);
  else {
    // TODO: Process method results here.
    // Results can be extracted from the following fields:
    // result.ResultCount
    //   Contains the number of addresses in the Results field. This field is only populated if the ReturnResultCount option is set to True
    // result.Results
    //   Contains an array of addresses that match the query.
    //   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.