Skip to main content

How to supply events

You will first need to generate an access token, as described in How to generate an access token.

All requests to the below endpoint must be authorised by including an Authorization: Bearer <access_token> header.

Service API urls

environment url
integration https://life-events.integration.account.gov.uk

Basic procedure

  1. Call POST /events/deathNotification to supply an event

Supply an event

life-events-deployment v1.0

Servers

/events/deathNotification

post

Request Body

Description Schema 
{
  "RegistrationID": 1,
  "RegistrationType": 1,
  "RecordLockedDateTime": "2023-08-01 14:55:00 +0000",
  "RecordUpdateDateTime": "2023-08-01 14:59:22 +0000",
  "RecordUpdateReason": 1,
  "DeceasedName": {
    "PersonNameTitle": "Ms",
    "PersonGivenName": [
      {
      }
    ],
    "PersonFamilyName": "Adams",
    "PersonNameSuffix": "esquire"
  },
  "DeceasedAliasName": [
    {
      "PersonNameTitle": "Ms",
      "PersonGivenName": [
        {
        }
      ],
      "PersonFamilyName": "Adams",
      "PersonNameSuffix": "esquire"
    }
  ],
  "DeceasedAliasNameType": [
    {
    }
  ],
  "DeceasedMaidenName": "Smith",
  "DeceasedGender": 2,
  "DeceasedDeathDate": {
    "PersonDeathDate": "2023-08-01",
    "VerificationLevel": "03"
  },
  "PartialMonthOfDeath": 12,
  "PartialYearOfDeath": 2023,
  "QualifierText": "On or around",
  "FreeFormatDeathDate": "Early 2021",
  "DeceasedBirthDate": {
    "PersonBirthDate": "1941-03-25",
    "VerificationLevel": "03"
  },
  "PartialMonthOfBirth": 12,
  "PartialYearOfBirth": 1964,
  "FreeFormatBirthDate": "Estimated mid 1960's",
  "DeceasedAddress": {
    "Flat": "string",
    "Building": "string",
    "Line": [
      {
      }
    ],
    "Postcode": "string"
  }
}
 DeathNotification

Responses

StatusDescriptionSchema
201

Event accepted
400

Bad request. Object body failed validation.

Schemas

DeathNotification

NameTypeRequiredDescriptionSchema
RegistrationID integer false
RegistrationType integer false
RecordLockedDateTime string false
RecordUpdateDateTime string false
RecordUpdateReason integer false
DeceasedName object false DeceasedName
DeceasedAliasName array false DeceasedName
DeceasedAliasNameType array false
DeceasedMaidenName string false
DeceasedGender integer false
DeceasedDeathDate object false DeceasedDeathDate
PartialMonthOfDeath integer false
PartialYearOfDeath integer false
QualifierText string false
FreeFormatDeathDate string false
DeceasedBirthDate object false DeceasedBirthDate
PartialMonthOfBirth integer false
PartialYearOfBirth integer false
FreeFormatBirthDate string false
DeceasedAddress object false DeceasedAddress

DeceasedName

NameTypeRequiredDescriptionSchema
PersonNameTitle string false
PersonGivenName array false
PersonFamilyName string false
PersonNameSuffix string false

DeceasedDeathDate

NameTypeRequiredDescriptionSchema
PersonDeathDate string false
VerificationLevel string false VerificationLevel

DeceasedBirthDate

NameTypeRequiredDescriptionSchema
PersonBirthDate string false
VerificationLevel string false VerificationLevel

DeceasedAddress

NameTypeRequiredDescriptionSchema
Flat string false
Building string false
Line array false
Postcode string false

VerificationLevel