Get Contract Summary

Request/Response & Json Schema

There are two implementations of Get Contract Summary

GetContractSummary v1.0
GetContractSummary v1.1

Overview - Get Contract Summary v1.0

This interface retrieves contract summary information like Policy details, Product details, Application details, Payment details, Account Number, Payment Due Date, Coverage details, Requirement details, Investment and Banking details, Party details, Loan details and the Relationship details specified by the Contract Number,for all the contracts available in ALIP.

The Party details contain the basic information, address information and contact details. The Payment details contain the payment mode, payment amount etc. The Policy Details contains the policy value, surrender value, status, important dates related to the Policy etc. Annuity, Traditional and Non-Traditional blocks are returned for Annuity, Traditional and Non-Traditional Products respectively.

The following products are in scope:

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 203 “Holding Inquiry Transaction tc=203” is being used for getting the contract summary.
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 success, the response will provide the details for the provided contract number

Business Requirements

BR ID# Business Requirements
BR1 Get Contract Summary should provide the details for a given contract. Details include:Policy DetailsInvestment DetailsRole InformationLoan InformationPolicy Level Banking InformationRider InformationStream
BR2 The contract needs to be present in ALIP for the data to be returned.

Process Flow

Same as section 3.1.4

Impact on ALIP system

N/A

Assumptions

N/A

Dependencies

N/A

Exclusions

This interface does not fetch contract details for below contract status:

. Disability

. Extended Free Look

. Group Policy

. Issued

Request Data Elements

Request Parameters Description Mandatory Allowed values
Contract Number A number which uniquely identifies a contract number within ALIP. Y

Response Data Elements

Success/Error Handling

Success Success Scenario Description Message Code Message Description Message Type Additional Comments
#1 The Get Contract summarycall was successful with details being returned in the output 1 Success Informational TXLife/TXLifeResponse/TransResult/ResultCode/@tc =1

Error Error Scenario Description Message Code Message Description Message Type Additional Comments
#1 The Get Contract summary call was not successful due to a technical error or contract not found. 5 Internal Error Informational TXLife/TXLifeResponse/TransResult/ResultCode/@tc =5

Overview - Get Contract Summary v1.1

This interface retrieves contract summary information like Policy details, Product details, Application details, Payment details, Account Number, Payment Due Date, Coverage details, Requirement details, Investment and Banking details, Party details, Loan details and the Relationship details specified by the Contract Number or Application Number, for all the contracts available in ALIP.

The Party details contain the basic information, address information and contact details. The Payment details contain the payment mode, payment amount etc. The Policy Details contains the policy value, surrender value, status, important dates related to the Policy etc. Annuity, Traditional and Non-Traditional blocks are returned for Annuity, Traditional and Non-Traditional Products respectively.

The following products are in scope:

Deferred Annuity

Immediate Annuity

Term Life Insurance

Universal Life

Whole Life Insurance

For Annuity Products it would also fetch below mentioned details -

Stream Information

Requirement Information

Transaction Information

Withholding Information

Amendment Information

Technical Requirements

TR ID# Technical Requirements
TR1 ACORDv2.36 shall be used to communicate.
TR2 ACORD Tx 203 “Holding Inquiry Transaction tc=203” is being used for getting the contract summary.
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 success, the response will provide the details for the provided contract number

Business Requirements

BR ID# Business Requirements
BR1 Get Contract Summary should provide the details for a given contract. Details include:Policy DetailsApplication DetailsInvestment DetailsRole InformationLoan InformationPolicy Level Banking InformationRider InformationAdditional Data elements for Variable products are as follows : Stream InformationRequirement InformationTransaction InformationWithholding InformationAmendment InformationAlong with above details Quotes details on Active contract would be displayed when Inquiry Level Tag is 2 or else if Inquiry Level Tag 1 or by default it would always display above details.
BR2 The contract needs to be present in ALIP for the data to be returned.
BR3 The application number needs to be present in ALIP for the data to be returned.
BR4 Contract Number is of status Pending Issue, Period or Pending Awaiting Funds then only Application Details for Contract is displayed

Process Flow

Same as section 3.1.4

Impact on ALIP system

N/A

Assumptions

N/A

Dependencies

N/A

Exclusions

Request Data Elements

Request Parameters Description Mandatory Allowed values
Contract Number A number which uniquely identifies a contract number within ALIP. Conditional Mandatory String
Application Number A number which uniquely identifies the application within ALIP Conditional Mandatory Integer

Response Data Elements

Success/Error Handling

Success Success Scenario Description Message Code Message Description Message Type Additional Comments
#1 The Get Contract summary call was successful with details being returned in the output 1 Success Informational TXLife/TXLifeResponse/TransResult/ResultCode/@tc =1

Error Error Scenario Description Message Code Message Description Message Type Additional Comments
#1 The Get Contract summary call was not successful due to a technical error or contract not found. 5 Internal Error Informational TXLife/TXLifeResponse/TransResult/ResultCode/@tc =5