Get Customer Contracts

Request/Response & Json Schema

Overview

The GetCustomerContracts API retrieves contract information specified by the Customer idfor all the contracts available in ALIP for which the customer is the owner.

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 302 “Holding Search Transaction tc=302” is being used for getting the details for a contract.
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 contract details for a given contract.

Business Requirements

BR ID# Business Requirements
BR1 The GetCustomerContractsAPIshould provide all the contract details associated with the provided customer id. The details include:Fund informationTransaction informationParty(Customer) Information
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

Request Data Elements

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

Response Data Elements

Response details are provided in spreadsheet below.

Success/Error Handling

Success Success Scenario Description Message Code Message Description Message Type Additional Comments
#1 The GetCustomerContractscall 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 GetCustomerContracts call was not successful due to a technical error or contract not found. 5 Internal Error Informational TXLife/TXLifeResponse/TransResult/ResultCode/@tc =5