Event Stream Documentation

SocialSecurityNumberChanged event

A SocialSecurityNumberChanged event will be raised when:

a new social security number is added
any property relating to an existing social security number is changed
a social security number is deleted

Field definitions for this event;

Field Name	Data Type	Additional information
personId	guid	n/a
personalReference	string	max-length: 20
socialSecurityNumber	string	max-length: 80
legislationCode	string	max-length: 40; reference-data

Example of this event

{
  "personId": "",
  "personalReference": "",
  "socialSecurityNumbers": [{
      "socialSecurityNumber": "",
      "legislationCode": ""
    }
  ]
}

SensitiveInformationChanged event

A SensitiveInformationChanged event will be raised when:

a person's sensitive information is added or changed

Field definitions for this event;

Field Name	Data Type	Additional information
personId	guid	n/a
personalReference	string	max-length: 20
dateOfBirth	date	The dateTime is in ISO format and should be in coordinated universal time (UTC) (e.g. 2019-05-02T15:17:00Z)
countryOfCitizenshipCode	string	max-length: 40; reference-data
religionCode	string	max-length: 40; reference-data
countryOfBirthCode	string	max-length: 40; reference-data
nationalityCode	string	max-length: 40; reference-data
genderCode	string	max-length: 40; reference-data
sexualOrientationCode	string	max-length: 40; reference-data
maritalStatusCode	string	max-length: 40; reference-data
selfCertifiedDisabilityDescription	string	max-length: 255
legalGenderCode	string	max-length: 40; reference-data
regionCode	string	max-length: 40; reference-data
usEthnicOriginCode	string	max-length: 40; reference-data
singaporeanEthnicOriginCode	string	max-length: 40; reference-data
ukEthnicOriginCode	string	max-length: 40; reference-data
veteranStatusCode	string	max-length: 40; reference-data

Example of this event

{
  "personId": "",
  "personalReference": "",
  "dateOfBirth": "",
  "countryOfCitizenshipCode": "",
  "religionCode": "",
  "countryOfBirthCode": "",
  "nationalityCode": "",
  "genderCode": "",
  "sexualOrientationCode": "",
  "maritalStatusCode": "",
  "selfCertifiedDisabilityDescription": "",
  "regionalSensitiveInformations": [{
      "regionCode": "US",
      "usEthnicOriginCode": "",
      "veteranStatusCode": "",
      "legalGenderCode": ""
    },
    {
      "regionCode": "Singapore",
      "singaporeanEthnicOriginCode": "",
      "legalGenderCode": ""
    },
    {
      "regionCode": "UK",
      "ukEthnicOriginCode": "",
      "legalGenderCode": ""
    }
  ]
}

SocialSecurityNumberChanged event

SensitiveInformationChanged event

Looking for something specific?