Get Customer Summary

Request/Response & Json Schema

Overview

This interface returns the demographic information for a customer. The details returned include the addresses Home, Mailing and Physical or Seasonal if one is present on the profile, Email address and Phone number which can be Home, Mobile or Other. The Owner can be an Individual,Company or Trust.

Following products are in scope for this operation.

Deferred Annuity

Immediate Annuity

Term Life Insurance

Universal Life

Whole Life Insurance

Technical Requirements

TR ID# Technical Requirements
TR1 ACORDv2.36 shall be used to communicate.
TR2 ACORD Tx 204 “Party Inquiry transaction tc=204” should be used for receiving detailed Party information.
TR3 Interface must always return an error code and desc in the event of a processing failure in addition to HTTP response code.
TR4 For a successful transaction a return code of 200 is returned.

Business Requirements

BR ID# Business Requirements
BR1 Customer Summary returns the Address, Email Address, Phone information present on customer profile
BR2 Address can be for Mailing or Seasonal address only.
BR3 Phone number can be Home, Mobile or Other.
BR4 Policy Numbers associated with customer profile if present should be returned.
BR5 Product Names related to policy numbers if present should be returned.

Process Flow

The external system would fire the REST URL containing the input parameters for retrieving the customer summary on the request queue.

ALIP webadapters would pick up, process the message, convert it into XML format, and posts it onto the ALIP request queue.

ALIP process server will pick up the message, convert from ACORD to the canonical format, perform the necessary XSD validations, and other basic validations on the completeness of the customer information, existence of the client id in ALIP etc.

Post the necessary validations, it would invoke the necessary ALIP APIs to retrieve the necessary client information from the database based on clientID.

The customer information since it is a case of a “GET” request, would be generated in XML format, converted to ACORD format, and sent back to the REST layer

Here, it would be further converted back into the final JSON output format and returned back to the external system.

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

N/A

Assumptions

N/A

Dependencies

N/A

Request Data Elements

Request Parameters Description Mandatory Allowed values
Client ID A unique numeric ID that identifies customer within ALIP. Mandatory

Response Data Elements

Success/ Error Handling

Success Success Scenario Description Message Description Message Type Additional Comments
#1 The Get Customer summary call was successful with details being returned in the output Success Informational
#2 The Get Customer Summary call was NOT successful due to technical errors. Internal Error Fatal General ErrorSystem Error.
#3 The Get Customer Summarycall wasNOT successful due to client idnot existing in ALIP. Failure Warning General ErrorClient does not exist in ALIP.
#4 The Get Customer Summary request was NOT successful, due to XSD failure. Failure Warning General Error Text containing the respective XSD errors.

Overview

This interface returns the demographic information for a customer. The details returned include the addresses Home, Mailing and Physical or Seasonal if one is present on the profile, Email address and Phone number which can be Home, Mobile or Other.The interface also returns the policy numbers,unsubmitted applications, submitted applications and contract details if they are associated with the customer profile. The above details are retrieved for a configurable set of roles including Owner, Annuitant, Insured, Joint owner or Joint Annuitant. The Owner can be an Individual,Company or Trust.

Following products are in scope for this operation.

Deferred Annuity

Immediate Annuity

Term Life Insurance

Universal Life

Whole Life Insurance

Technical Requirements

TR ID# Technical Requirements
TR1 ACORDv2.36 shall be used to communicate.
TR2 ACORD Tx 204 “Party Inquiry transaction tc=204” should be used for receiving detailed Party information.
TR3 Interface must always return an error code and desc in the event of a processing failure in addition to HTTP response code.
TR4 For a successful transaction a return code of 200 is returned.

Business Requirements

BR ID# Business Requirements
BR1 Customer Summary returns the Address, Email Address, Phone information present on customer profile
BR2 Address can be for Mailing or Seasonal address only.
BR3 Phone number can be Home, Mobile or Other.
BR4 Policy Numbers associated with customer profile if present should be returned.
BR5 Product Names related to policy numbers if present should be returned.

Process Flow

The external system would fire the REST URL containing the input parameters for retrieving the customer summary on the request queue.

ALIP webadapters would pick up, process the message, convert it into XML format, and posts it onto the ALIP request queue.

ALIP process server will pick up the message, convert from ACORD to the canonical format, perform the necessary XSD validations, and other basic validations on the completeness of the customer information, existence of the client id in ALIP etc.

Post the necessary validations, it would invoke the necessary ALIP APIs to retrieve the necessary client information from the database based on clientID or Client ExternalID.

The customer information since it is a case of a “GET” request, would be generated in XML format, converted to ACORD format, and sent back to the REST layer

Here, it would be further converted back into the final JSON output format and returned back to the external system.

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

N/A

Assumptions

N/A

Dependencies

N/A

Request Data Elements

Request Parameters Description Mandatory Allowed values
ExternalID A number which uniquely identifies a customer in External system. Conditional mandatory
Client ID A unique numeric ID that identifies customer within ALIP. Conditional mandatory

Response Data Elements

Please refer to spreadsheet below for response mapping.

Success/ Error Handling

Success Success Scenario Description Message Description Message Type Additional Comments
#1 The Get Customer summary call was successful with details being returned in the output Success Informational
#2 The Get Customer Summary call was NOT successful due to technical errors. Internal Error Fatal General ErrorSystem Error.
#3 The Get Customer Summarycall wasNOT successful due to client idnot existing in ALIP. Failure Warning General ErrorClient does not exist in ALIP.
#4 The Get Customer Summary request was NOT successful, due to XSD failure. Failure Warning General Error Text containing the respective XSD errors.
#5 The Get Customer Summary request was NOT successful as Client ID and External ID are passed in input. Failure Warning General ErrorEither external id or client id must be provided
#6 The Get Customer Summarycall wasNOT successfulas External IDdid not exist in ALIP. Failure Warning General ErrorExternal ID does not exist in ALIP.