Parameters
| Parameter | Type | Format | Description |
|---|---|---|---|
| Deaths | Array | Array of ValidIdDeathscreenDeathResult, see below |
ValidIdDeathscreenDeathResult
| Parameter | Type | Format | Description |
|---|---|---|---|
| Forename | String | Forename of the subject in the matched record | |
| SecondName | String | Second name of the individual in the death record found | |
| ThirdName | String | Third initial of the individual in the death record found | |
| FourthName | String | Forth initial of the individual in the death record found | |
| Surname | String | Surname of the subject in the matched record | |
| District | String | District the death was registered in | |
| DOB | DateTime | ISO 8601 | Date of birth of the individual in the death record found |
| DOD | DateTime | ISO 8601 | Date of death of the individual in the death record found |
| DOR | String | Date of Registration of the death MM/YYYY | |
| VolumeNo | String | Death registration volume number of the death record found | |
| DistNo | String | Death registration district number of the death record found | |
| PageNo | String | Death registration page number of the death record found | |
| RegNo | String | Death registration number of the death found | |
| EntryNo | String | Death registration entry number of the death found | |
| PlaceOfBirth | String | Place of Birth of the death found | |
| MaidenName | String | Mother's maiden name for the death found | |
| GROReference | String | GRO Reference number for the death found, used for deaths post 2007 | |
| Address1 | String | Address line 1 for death found | |
| Address2 | String | ||
| Address3 | String | ||
| Address4 | String | ||
| Address5 | String | ||
| PostCode | String | Postcode for death found | |
| MatchType | String | MatchType to show how the death record was matched. |
Match Type flags
| Flag | Description |
|---|---|
| NAME, ADDRESS AND DOB | The name, address and DOB all matched against the subject details |
| NAME AND ADDRESS | The name and address matched but DOB was not provided or not contained within the death record. The system will not match to conflicting DOBs. |
| NAME AND DOB | The name and DOB provided a match but the address was different or missing from either subject or matched record. |