FindResidents
Retrieves the names of any people who can be found to be living at an address.
To connect to this service you'll need to use one of these endpoints:
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.
Parameters
The following parameters can be supplied to this method
| username |
username apikey-, e.g.
apikey-ABCD-1234-EFGH-5678
|
|---|---|
| password |
password |
| address | address Contains the address lines to get the people from. |
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.
| Common Options | |
|---|---|
| Name | Description |
| 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:
| Status |
Status 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 |