NB Inquire

Request/Response & Json Schema

Overview

This interface provides the ability to inquire for an application existing within ALIP, via integration. As part of the New Business Inquire process, ALIP receives a request in ACORD XML format, from an external system and returns the required Application information as a response in the ACORD XML format to the calling external systems, based on the incoming ‘Case Name’ or ‘Contract Number’ or ‘Tracking ID’,

This Interface is applicable for various products available in ALIP. Generic application data like Application Summary, Application Details, Product Details and Client information sections of an application are Product Independent and are supported by this interface. However, other application details like Features, Riders, Benefits, Feature Options and Premium details are only supported for Deferred Annuity’s GIFT/FIA products.

We have created 2 URLs for fetching the application details as follows:

Case URL ACORD InquiryLevel Value
Pre-submit Details of an application application/{id}/preSubmit/details 2
Post-submit Details of an application application/{id}/postSubmit/details 3

Technical Requirements:

TR ID# Technical Requirements
TR1 ACORDv2.36 shall be used to communicate with the external system.
TR2 Client’s system will send a request to ALIP with the Source System Transaction Number or the Contract Number in the input XML to Inquire the Application. (TransType tc=”103” and TransSubType tc=”20300”)
TR3 ALIP will verify if either the Contract Number or the Source System Transaction Number is provided in the request, and load the application details based on the identified inquiry criteria.
TR4 ALIP will transform the loaded application information to ACORD format and send it back to the response queue.
TR5 Any errors during look up of the application using the Source System Transaction Number or Contract Number will be returned as a failure response and logged as an Integration Failure within ALIP.

Business Requirements

BR ID# Business Requirements
BR1 ALIP Interface Exchange provides the ability to inquire for an existing application.
BR2 ALIP expects to receive either the case number or the Contract Number pertaining to the application in the incoming request input. Only one input is expected at a given time.

Process Flow for NB Inquire:

Process Flow for ApplicationDetails:

Process Flow Description

An external system sends an application inquiry request in ACORD XML format to ALIP.

ALIP will receive the request, transform to ALIP format & identify the inquiry criteria viz. Contract Number or Case Number or TrackingID.

ALIP will invoke the necessary APIs to retrieve the application information from the ALIP database, transform it back to ACORD format, and send it back to the calling external system.

Impact on ALIP system

None

Assumptions

N/A

Dependencies

N/A

Request Data Elements

Request Parameters Description Mandatory Allowed values
Contract Number A number which uniquely identifies a contract within ALIP. Conditional Mandatory String
Case Name A number which uniquely identifies an application within ALIP Conditional Mandatory String
Tracking ID Application ID of an existing application within ALIP Optional String

Response Data Elements

Success/Error Handling

Error Error Scenario Description Message Description Message Type Additional Comments
#1 The NB Inquirerequest was successful withdetails beingreturned in theoutput. Success Informational
#2 The NB Inquirecall wasNOT successfuldue to technicalerrors. Internal Error Fatal General Data ErrorSystem Error
#3 The NB Inquire request was not successful, where Case number is given in ACORD request and no such application present in ALIP. Failure Warning General Data Error No Application is Found with the provided Source System Transaction Number
#4 The NB Inquire request was not successful, where contract number is given in ACORD request and no such application present for given input in ALIP. Failure Warning General Data Error No Application is Found with the provided Contract Number
#5 The NB Inquire request was not successful, where contract number and Source System transaction number is not given in ACORD request. Failure Warning General Data Error Either Source System transaction number or contract number is required.
#6 The NB Inquire request was not successful, where the request is not well formed. Failure Fatal General Data Error Validation Error[Validation Error] will correspond to the actual validation error being returned from the validator.
#7 The NB Inquirerequest was successful withdetails beingreturned in theoutput Success Informational
#8 The NB Inquire request was not successful, where application id passed for given input in ALIP is not valid. Failure Warning General ErrorValidation Error OccurredProcess failed: No applications found for the criteria
#9 The NB Inquire request was not successful, where the request is not well formed. Failure Fatal General Data Error Validation Error[Validation Error] will correspond to the actual validation error being returned from the validator.
#10 The NBInquire is not successful as the agent client id passed is not non- numeric or blank Failure “’ ‘is not a valid value for integer”