IsGoneaway
Checks if a person has moved from their address.
To connect to this service you'll need to use one of these endpoints:
Description
Checks if a person has moved from the address given in the input record. If so, the service returns true
. If not, the service returns false
.
Parameters
The following parameters can be supplied to this method
username |
username apikey- , e.g.
apikey-ABCD-1234-EFGH-5678
|
---|---|
password |
password |
record | record Contains properties for the Name and Address that is currently known for the person |
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 The minimum match level between the name supplied in the input
|
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 is found to be goneaway |