IsDeceased - Deceased • Data8 Web Services API Documentation

IsDeceased

Identify deceased individuals with a name and/or address.

Description

Use this method to get a flag indicating if someone with a given name and address has passed away.

The service can only be used for flagging or removing records from a marketing list.

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/Deceased/IsDeceased.json
OPEN API	OPEN API https://webservices.data-8.co.uk/swagger/Deceased/swagger.json
SOAP	SOAP https://webservices.data-8.co.uk/deceased.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.
record	record Contains properties for the Name and Address that is currently known for the person
marketing	marketing Indicates whether the request is being made to prevent sending marketing materials.
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

Gives the name of the calling application - used to break down usage by application in the usage reports on the dashboard.

Service Specific Options

MatchLevel

The minimum match level between the name supplied in the input record and the name in our reference data files. This can be one of the following values:

Value	Description
`S`	This allows matching to be made at Surname level. This means that the person is assumed to be deceased if anyone with the same surname at the supplied address is found to have deceased. This is useful where you have a large number of missing or possibly inaccurate initials or forenames, but is not generally recommended as it can lead to a high number of false positives.
`I` (default)	This forces matching to be made at Initial level. This means that the first initial must match as well as the surname. Where no first initial is passed into the service then no match can be made. This provides a more accurate match but can lead to a lower hit rate compared to surname level matching.
`F`	This forces matching to be made at Forename level. The entire forename as supplied to the service must match the forename on our deceased data. If no forename or only an initial is passed into the service then no match can be made. This provides the most accurate match but gives a much lower hit rate, as many of the records on our deceased data only include initials.

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.
Result	Result Indicates if the person is found to be deceased

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.

Result

Indicates if the person is found to be deceased

Credit Usage

Each request to this method consumes 1 Deceased credit for each request where either the "record.Marketing" option is true, or a match is found.

Sample Code

Request Format

{
  "record": {
    "Name": {
      "Title": "Mr",
      "Forename": "John",
      "MiddleName": "",
      "Surname": "Smith"
    },
    "Address": {
      "Lines": [
        "Unit 2",
        "Venture Point",
        "Stanney Mill Road",
        "Chester",
        "CH2 4NE"
      ]
    }
  },
  "marketing": false,
  "options": {
    "MatchLevel": "I"
  }
}

Response Format

{
  "Status": {
    "Success": true,
    "CreditsRemaining": 1000
  },
  "Result": 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/Deceased/IsDeceased.json?key=your-api-key
and do NOT include the username or password properties in the request JSON document.