ConfirmResidency
Checks if a person can be verified as living at an address.
To connect to this service you'll need to use one of these endpoints:
Description
Checks if a person can be found to be living at an address.
Note that a Result
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 resident at the address.
Parameters
The following parameters can be supplied to this method
username |
username apikey- , e.g.
apikey-ABCD-1234-EFGH-5678
|
---|---|
password |
password |
record | record Details of the name and address to check against the electoral roll. This value as the following properties:
|
options | options |
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 |
Service-Specific Options | |
Name | Description |
MatchLevel | MatchLevel Indicates the level of match that is required. Can be set to the following values:
Whichever match level is selected, this service will return either that match level or higher when a valid match is found, or |
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
|
---|---|
Result | Result Indicates if the person has been verified to be living at the requested address |
MatchLevel | MatchLevel Indicates the level of match that was made to the electoral roll. Will be one of the following values:
|