T2A Web Service

T2A

Click here for a complete list of operations.

deceased

Check your data against our deceased persons data.

This method is used to screen your existing data against our deceased persons data.

Use this service to ensure contact with deceased persons is not attempted. This will help to minimise the distress caused to relatives and help your organisation avoid any negative publicity.

Where available, the method returns the date of death.

Test

To test the operation using the HTTP POST protocol, click the 'Invoke' button.

Parameter	Value
api_key:
client:
surname:
forename:
premises:
street:
postcode:

SOAP 1.1

The following is a sample SOAP 1.1 request and response. The placeholders shown need to be replaced with actual values.

POST /soap/t2a.asmx HTTP/1.1
Host: api.t2a.io
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "https://api.t2a.io/soap/deceased"

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <deceased xmlns="https://api.t2a.io/soap">
      <api_key>string</api_key>
      <client>string</client>
      <surname>string</surname>
      <forename>string</forename>
      <premises>string</premises>
      <street>string</street>
      <postcode>string</postcode>
    </deceased>
  </soap:Body>
</soap:Envelope>

HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <deceasedResponse xmlns="https://api.t2a.io/soap">
      <deceasedResult>
        <person_deceased_list>
          <person_deceased>
            <date_of_death>string</date_of_death>
            <date_of_death_estimated>string</date_of_death_estimated>
            <forename>string</forename>
          </person_deceased>
          <person_deceased>
            <date_of_death>string</date_of_death>
            <date_of_death_estimated>string</date_of_death_estimated>
            <forename>string</forename>
          </person_deceased>
        </person_deceased_list>
        <date_of_death>string</date_of_death>
        <date_of_death_estimated>string</date_of_death_estimated>
      </deceasedResult>
    </deceasedResponse>
  </soap:Body>
</soap:Envelope>

SOAP 1.2

The following is a sample SOAP 1.2 request and response. The placeholders shown need to be replaced with actual values.

POST /soap/t2a.asmx HTTP/1.1
Host: api.t2a.io
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <deceased xmlns="https://api.t2a.io/soap">
      <api_key>string</api_key>
      <client>string</client>
      <surname>string</surname>
      <forename>string</forename>
      <premises>string</premises>
      <street>string</street>
      <postcode>string</postcode>
    </deceased>
  </soap12:Body>
</soap12:Envelope>

HTTP/1.1 200 OK
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <deceasedResponse xmlns="https://api.t2a.io/soap">
      <deceasedResult>
        <person_deceased_list>
          <person_deceased>
            <date_of_death>string</date_of_death>
            <date_of_death_estimated>string</date_of_death_estimated>
            <forename>string</forename>
          </person_deceased>
          <person_deceased>
            <date_of_death>string</date_of_death>
            <date_of_death_estimated>string</date_of_death_estimated>
            <forename>string</forename>
          </person_deceased>
        </person_deceased_list>
        <date_of_death>string</date_of_death>
        <date_of_death_estimated>string</date_of_death_estimated>
      </deceasedResult>
    </deceasedResponse>
  </soap12:Body>
</soap12:Envelope>

HTTP GET

The following is a sample HTTP GET request and response. The placeholders shown need to be replaced with actual values.

GET /soap/t2a.asmx/deceased?api_key=string&client=string&surname=string&forename=string&premises=string&street=string&postcode=string HTTP/1.1
Host: api.t2a.io

HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<deceased_res xmlns="https://api.t2a.io/soap">
  <person_deceased_list>
    <person_deceased>
      <date_of_death>string</date_of_death>
      <date_of_death_estimated>string</date_of_death_estimated>
      <forename>string</forename>
    </person_deceased>
    <person_deceased>
      <date_of_death>string</date_of_death>
      <date_of_death_estimated>string</date_of_death_estimated>
      <forename>string</forename>
    </person_deceased>
  </person_deceased_list>
  <date_of_death>string</date_of_death>
  <date_of_death_estimated>string</date_of_death_estimated>
</deceased_res>

HTTP POST

The following is a sample HTTP POST request and response. The placeholders shown need to be replaced with actual values.

POST /soap/t2a.asmx/deceased HTTP/1.1
Host: api.t2a.io
Content-Type: application/x-www-form-urlencoded
Content-Length: length

api_key=string&client=string&surname=string&forename=string&premises=string&street=string&postcode=string

HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<deceased_res xmlns="https://api.t2a.io/soap">
  <person_deceased_list>
    <person_deceased>
      <date_of_death>string</date_of_death>
      <date_of_death_estimated>string</date_of_death_estimated>
      <forename>string</forename>
    </person_deceased>
    <person_deceased>
      <date_of_death>string</date_of_death>
      <date_of_death_estimated>string</date_of_death_estimated>
      <forename>string</forename>
    </person_deceased>
  </person_deceased_list>
  <date_of_death>string</date_of_death>
  <date_of_death_estimated>string</date_of_death_estimated>
</deceased_res>