Using Loqate to resolve addresses

You can resolve WhenFresh Postal Address File Keys using the loqate Address Verification API.

Using the Capture Find API 1.1 will return a list of address.

The response will look like the below.

[
  {
    "Id": "GB|RM|B|51384070",
    "Type": "Address",
    "Text": "Flat 4, De Vecti House, Westgate",
    "Highlight": "0-6,8-22,24-32",
    "Description": "Peterborough, PE1 1PX"
  }
]

Using the Id field, you can then use the Capture Retrieve API 1.2 to retrieve the Royal Mail PAF UDPRN and UMRRN.

Note that to retrieve the UMRRN, you will have to activate the Multi-residency option on your loqate account.

You can then craft your GET request and specify you wish to retrieve the UDPRN and UMRRN fields by appending the key, the ID from above, and the Field1Format and Field2Format querystring parameters, as follows"

GET https://api.addressy.com/Capture/Interactive/Retrieve/v1.2/json3.ws?Key=yourapikey&ID=GB|RM|B|51384070&
    Field1Format={UDPRN}&Field2Format={UMRRN}

[
  {
    "Id": "GB|RM|B|51384070",
    "DomesticId": "51384070",
    "Language": "ENG",
    "LanguageAlternatives": "ENG",
    "Department": "",
    "Company": "",
    "SubBuilding": "Flat 4",
    "BuildingNumber": "",
    "BuildingName": "De Vecti House",
    "SecondaryStreet": "",
    "Street": "Westgate",
    "Block": "",
    "Neighbourhood": "",
    "District": "",
    "City": "Peterborough",
    "Line1": "Flat 4",
    "Line2": "De Vecti House",
    "Line3": "Westgate",
    "Line4": "",
    "Line5": "",
    "AdminAreaName": "Peterborough",
    "AdminAreaCode": "",
    "Province": "Cambridgeshire",
    "ProvinceName": "Cambridgeshire",
    "ProvinceCode": "",
    "PostalCode": "PE1 1PX",
    "CountryName": "United Kingdom",
    "CountryIso2": "GB",
    "CountryIso3": "GBR",
    "CountryIsoNumber": 826,
    "SortingNumber1": "51112",
    "SortingNumber2": "",
    "Barcode": "(PE11PX1TG)",
    "POBoxNumber": "",
    "Label": "Flat 4\nDe Vecti House\nWestgate\nPETERBOROUGH\nPE1 1PX\nUNITED KINGDOM",
    "Type": "Residential",
    "DataLevel": "Premise",
    "Field1": "51384070",
    "Field2": "",
    "Field3": "",
    "Field4": "",
    "Field5": "",
    "Field6": "",
    "Field7": "",
    "Field8": "",
    "Field9": "",
    "Field10": "",
    "Field11": "",
    "Field12": "",
    "Field13": "",
    "Field14": "",
    "Field15": "",
    "Field16": "",
    "Field17": "",
    "Field18": "",
    "Field19": "",
    "Field20": ""
  }
]

You can now use the UDPRN and UMRRN to deduce the postal address key as described in the Addresses page.