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 GetFullAddress method would normally be used instead of this one as it includes both the full raw PAF format address and formatted version ready to display to a user.

This method supports the following options:

  • IncludeUDPRN. If this is set to True, each address returned will have its UniqueReference field set to the UDPRN of the address.
  • 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 GetFullRawAddress(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();

function showGetFullRawAddressResult(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.Results
    //   Contains an array of addresses that match the query.
    //   Each field in the items in the array contains a specific address element defined by
    //   the Royal Mail.