FindResidents - NameAppend • Data8 Web Services API Documentation

FindResidents

Retrieves the names of any people who can be found to be living at an address.

Description

Gets a list of all the people known to be resident at an address.

Note that the list returned may not be complete as some residents may have opted out of the edited electoral roll, and may not be present on the other data sources used to supplement the electoral roll.

Endpoint URLs

To connect to this service you'll need to use one of these endpoints:

Protocol	URL
JSON	JSON https://webservices.data-8.co.uk/NameAppend/FindResidents.json
OPEN API	OPEN API https://webservices.data-8.co.uk/swagger/NameAppend/swagger.json
SOAP	SOAP https://webservices.data-8.co.uk/nameappend.asmx

Parameters

The following parameters can be supplied to this method:

Name	Description
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.
address	address Contains the address lines to get the people from.
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.

Name	Description
Common Options
ApplicationName	ApplicationName Gives the name of the calling application - used to break down usage by application in the usage reports on the dashboard.

Results

This method returns an object containing the following fields:

Name Description

Status

Name	Description
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.
Results	Results A list of names that were found at the supplied `address`.

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.

Results

A list of names that were found at the supplied address.

Credit Usage

Requests to this method do not consume credits, but you must have some NameAppend credits available.

Sample Code

Request Format

{
  "address": {
    "Lines": [
      "Unit 2",
      "Venture Point",
      "Stanney Mill Road",
      "Chester",
      "CH2 4NE"
    ]
  },
  "options": {}
}

Response Format

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

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

API Key

Post the request to
https://webservices.data-8.co.uk/NameAppend/FindResidents.json?key=your-api-key
and do NOT include the username or password properties in the request JSON document.

Parameter	Value
Parameters
Address
address	Lines Add Remove
Common Options
ApplicationName	ApplicationName
Credits Remaining Today: 15 Try It Now!