W2 DATA MORTALITY UK 035

A verification service to find people on the UK mortality register.

W2 DATA MORTALITY UK 035 Service

W2 Data Mortality Uk 035 is a UK identity verification service that checks data against a variety of different sources to determine if the person is deceased.
If there are multiple matches, it provides a list of them, up to a limit of 10.

Contents

The following properties pertain to this service, please note that the fields MUST be in the same order as shown below.

Property Name Type Length Optional/Mandatory Notes
DayOfBirth Integer 2 Mandatory  
Forename String 15 Mandatory  
Flat String 55 Optional  
HouseName/HouseNumber String 55 Mandatory Either house name or house number must be supplied may also include Flat number i.e. Flat 1, 4
MiddleNames String 15 Optional  
MonthOfBirth Integer 2 Mandatory  
Postcode String 8 Mandatory  Must be a valid Uk postcode. 
Surname String 30 Mandatory  
YearOfBirth Integer 4 Mandatory  

Request

These are example requests when calling the W2 Data Mortality Uk 035 Service:

SOAP
<QueryData>
  <DayOfBirth>16</DayOfBirth>
  <Forename>Brandon</Forename>
  <HouseNameNumber>1 HANOVER GRANGE</HouseNameNumber>
  <MonthOfBirth>11</MonthOfBirth>
  <Postcode>YO167BX</Postcode>
  <Surname>Truman</Surname>
  <YearOfBirth>1945</YearOfBirth>
</QueryData>
REST
  "Data": {
    "DayOfBirth": 16,
    "Forename": "Brandon",
    "HouseNameNumber": "1 HANOVER GRANGE",
    "MonthOfBirth": 11,
    "Postcode": "YO167BX",
    "Surname": "Truman",
    "YearOfBirth": 1945
  }

Response

The following shows the basic schema for the <W2DataMortalityUk035Result> object that is returned in the <ServiceResult> Section of the <ProcessRequestResult> object.

SOAP
<W2DataMortalityUk035Result>
<ServiceResult>
    <MortalityResponse>
        <MatchData>
            <AddressMatch>true</AddressMatch>
                <DobMatch>true</DobMatch>
                <NameMatch>true</NameMatch>
                <PostcodeMatch>true</PostcodeMatch>
            </MatchData>
          <Person>
            <Address1>1 HANOVER GRANGE</Address1>
                <Address2>BRIDLINGTON</Address2>
                <Address3>EAST RIDING OF YORKSHIRE</Address3>
                <Address4>Y016 7BX</Address4>
                <Address5/>
                <DateOfBirth>1945-11-1600:00:00</DateOfBirth>
                <DateOfDeath>2019-09-1900:00:00</DateOfDeath>
                <Forename>BRANDON</Forename>
                <MiddleName>LEWIS</MiddleName>
                <Postcode>Y0167BX</Postcode>
                <Score>9</Score>
                <Surname>TRUMAN</Surname>
                <Title>MR</Title>
                <UniqueReferenceNumber>06186191</UniqueReferenceNumber>
            <Person>
        </MortalityResponse>
</ServiceResult>
</W2DataMortalityUk035Result>
REST
"W2DataMortalityUk035Result" : {
"MortalityResult" : {
"MortalityResponse"
"MatchData" {
            "AddressMatch" : "true",
                "DobMatch" : "true",
                "NameMatch" : "true",
                "PostcodeMatch" : "true
            },
            "Person" {
            "Address1" : "1 HANOVER GRANGE",
                "Address2" : "BRIDLINGTON",
                "Address3" : "EAST RIDING OF YORKSHIRE",
                "Address4" : "Y016 7BX",
                "Address5" : "",
                "DateOfBirth" : "1945-11-1600:00:00",
                "DateOfDeath" : "2019-09-1900:00:00",
                "Forename" : "BRANDON",
                "MiddleName" : "LEWIS",
                "Postcode" : "Y0167BX",
                "Score" : "9",
                "Surname" : "TRUMAN",
                "Title" : "MR"
                "UniqueReferenceNumber" : "06186191"
            } 
       }
    }
}

Transaction Result

After performing the search, the <TransactionInformation> will be part of the <ProcessRequestParameters> returned for the service call.

The following shows the basic schema for the <TransactionInformation> object that is returned in the <ProcessRequestResult> object.

<TransactionInformation>
<InterpretResult>NotApplicable</InterpretResult>
    <ServiceCallReference>96edada3-b5f7-40d0-869a-c37a6266b50a</ServiceCallReference>
    <ServiceTransactions>
    <ServiceTransactionInformation>
        <FailedOverTo>null</FailedOverTo>
            <HaltTriggered>false</HaltTriggered>
            <Service>W2_DATA_MORTALITY_UK_035</Service>
            <ServiceInterpretResult>OneResult</ServiceInterpretResult>
<ServiceTransactionResult>Success</ServiceTransactionResult>
            <ServiceTransactionResultMessage>One Match Found</ServiceTransactionResultMessage>
            <ServiceValidationDetails>null</ServiceValidationDetails>
            <ValidationResult>Pass</ValidationResult>
        </ServiceTransactionInformation>
    </ServiceTransactions>
</TransactionInformation>
FailoverOverTo Did the service encounter a third party error, and fail over to an alternate service? (Not applicable for this service).
HaltTriggered Was there a halt condition included in the bundle that has been triggered.
ServiceInterpretResult
  • OneResult
  • MultipleResults
  • NoResults
  • NotPerformed - An error occurred and the search was not performed
ServiceTransactionResult
  • Success
  • SuccessNoResults
  • SuccessIncompleteResults - Too many matches generated, results truncated
  • ClientErrorInsufficientInformation Required field not supplied
  • ClientErrorInformationFormatInvalidInvalid format in field
  • ServerErrorGeneralError Error with third party service
ServiceTransactionResultMessage
  • One Potential Match Found
  • Multiple Potential Matches Found
  • No Potential Matches Found
ServiceValidationDetails Shows the messages related to a validation error if applicable.
ValidationResult
  • NotApplicable - No search occurred to match against
  • Fail MissingMandatoryField or PatternNotMatched

Sandbox

Sandbox mode can be used to test the service. By setting the following query option and sending some the below query data we will return a pre-configured response without actually calling our suppliers.

SOAP
<QueryOptions>
    <KeyValueOfstringstring>
        <Key>Sandbox</Key>
        <Value>true</Value>
    </KeyValueOfstringstring>
</QueryOptions>
REST
"options": {
	"sandbox": "true"
}

If the Sandbox query option is set to "true" then the following queries will return results. The result of the verification will depend on the configuration of the matching set up during the on-boarding process.

To see the details of the service response of each sandbox case, simply click on it in the table below:

Forename Surname Day Of Birth Month Of Birth Year Of Birth Flat House Name Number Street Postcode
Alex Goodwin 11 3 1941 81 Crescent Avenue PA33 7WB
Eve Hale 23 2 1963 14 Russell Road PE31 3AH
Oliver Marsh 14 5 1969 5 Dover Road AB52 1RZ
(Click on a sandbox case to see the service result data here)