Update Personal Information Interface

Request/Response & Json Schema

Overview

UpdatePersonalInformation interface allows the update Client personal information such as first name, last name, middle name, date of birth, prefix, suffix, tax it etc. for given client ID or the External Client ID or the combination of the Tax ID and the Client Type (Individual, Company Trust). If for any given mandatory tag, corresponding values are not provided, it will update those values with a blank value.A indicator will be sent in the request that will determine If a Task needs to be generated for a data change(DOB,TaxID and Gender). If the indicator is sent in the request then only the Task will be created and there wont be any changes to the underlying data.

Technical Requirements

TR ID# Technical Requirements
TR1 ACORDv2.36 will be used to communicate between ALIP and Client systems
TR2 ACORD Tx186 “UpdatePersonalInformation tc=186” Service will provide the ability to update a given party's personal information in ALIP based on the party id / External ID (ACORD message 186).
TR3 Apart from the ALIP Client ID and External Client ID, Interface will also have the ability to update the personal information based on the combination of Tax ID and the Client Type ID (Individual, Company or Trust)
TR4 Indicator called as “UpdateIndicator” will be added to the request. This indicator will indicate If a task needs to be created for a critical data change.The possible values asPersonal Info Update (Default)DOB UpdateTaxIDUpdateGender Update
TR5 If the UpdateIndicator (DOB Update, TaxID Update and Gender Update) is sent in the request, the interface will only generate the Task and therewont be any update to the ALIP data. The interface will update client data If UpdateIndicator is “Personal Info Update”.

Business Requirements

BR ID# Business Requirements
BR1 The update of the personal information for the given party applies to all contracts and to all roles that this party is associated with.
BR2 Any changes made by this interface, will be associated with a user called ‘Interface User’ in the ALIP database.
BR3 UpdatePersonalInformationwill provide the ability to update and resubmit the application automatically when DOB and Gender of Party is updated and party is as a Role(Annuitant,JointAnnuitant,Owner, JointOwner,Insured,JointInsured,RiderInsured) on any application.
BR4 A Task will be generated If theUpdateIndicator is sent in the request. Interface will not update any of the Personal data and only create a Task in ALIP.

Process Flow

The external system would post the message containing the personal information to be updated on the request queue.

ALIP process server will pick up the message, perform the necessary XSD validations, and other basic validations on the existence of the client id /external id in ALIP etc.

Post the necessary validations, it would invoke a workflow to update the personal information for the client id/ external id with the provided information. If DOB or Gender of the party is been changed then application will be resubmitted.

Workflow will also generate a Informational Task. This task would only be created If the UpdateIndicator(DOB, TaxID or Gender) is sent in the request. The data in ALIP wont be updated with the data that is present in the request and interface will only create a corresponding Task.PolNum in request is used only to populate Task Description and has no other relevance in the interface. This PolNum will be used in the Task Description.

The status of the personal information update would be posted back to the response queue.

Impact on ALIP system (applicable for add/update operations)

None

Assumptions

N/A

Dependencies

N/A

Request Data Elements

Request Parameters Description Mandatory Allowed values
Party Identifier/ Client ID An internal identifier (CRM ID) of ALIP. Conditional Mandatory
ExternalID A number which uniquely identifies a customer in External system. Conditional mandatory
Tax ID and Client Type ID A combination of Tax Id and Client Type ID unqielyidenties a client. Conditional mandatory
Party Details to be Updated The list of fields associated to the party. Y
User ID Service User ID Y

Response Data Elements

Success/Error Handling

Success Success Scenario Description Message Code Message Description Message Type Additional Comments
#1 The UpdatePersonalInformation call was successful with details being returned in the output 1 Success Informational

Error Error Scenario Description Message Code Message Description Message Type Additional Comments
#1 The UpdatePersonalInformation call was NOT successful due to technical errors 100 Internal Error Fatal Any system error
#2 The UpdatePersonalInformation interface failed due to Client ID or the External Client Id or the Combination of the Tax Id and Client Type ID mentioned in the request is not present in ALIP system 100 Failed Error General ErrorEither Client id or External ID or the Combination of Tax ID and Client Type must be provided in the input
#3 The UpdatePersonalInformation interface failed due to Client ID mentioned in the request is not present in ALIP system 100 Failed Error General Error Client id is not present in ALIP
#4 The UpdatePersonalInformation interface failed due to absence of mandatory fields for individual/company/trust client types etc. 100 Validation Error Fatal Validation errors on the mandatory fields.
#5 The UpdatePersonalInformation updates DOB and Gender, applications associated were resubmitted successfully 1 Success Informational
#6 The UpdatePersonalInformation contains the UpdateIndicato r with value “Personal Info Update 1 Success Informational System should not genera te any task.
#7 The UpdatePersonalInformation contains the UpdateIndicato r with value “DOB Update” or “TaxID Update” and “Gender Update” 1 Success Informational System should create a informational Task in ALIP. Only the Task will be created and NO data will be updated in ALIP.