0151 355 4555



Checks if a person can be found to be living at an address. If so, the service returns true. Otherwise, it returns false.

Note that a return value of false does not necessarily indicate that the person does not live at the address given. A person may be opted-out of the edited electoral roll and may not appear on the other data sources used to supplement the electoral roll, but may still be a resident at the address.

Match Levels

By default, a match must be found at initial level. This can be altered by specifying an option with the name "MatchLevel" and one of the following values:

  • F - a full forename and surname match is required
  • I - the first initial and surname must match
  • S - only the surname has to match
  • P - any person at the same premise is allowed to match

Whichever match level is selected, this service will return either that match level or higher when a valid match is found, or None if no match or only matches at a lower than selected level are found.

View all Electoral Roll Name Append and Residency Verification (part of the Identity validation suite for year of birth and residency 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 NameAppend Integr8 service

function ConfirmResidency(record) {
  /// <param name="record">data8.inputrecord. Set up the Name, Address properties before calling this method.</param>
  var nameappend = new data8.nameappend();

function showConfirmResidencyResult(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.Result
    //   Indicates if the person has been verified to be living at the requested address.
    // result.MatchLevel
    //   Indicates the match level that the person has been verified to be living at the requested address. Forename, Initial, Surname, Premise or None