This interface provides the ability to connect to an external system using REST or SOAP connection to fetch Client External ID(s) for the provided client(s) in ACORD format. The External Client Id received from external system will be then updated at client entity level in ALIP, by the invoking business process in ALIP.
The following trigger points have been currently configured for this interface. These are extensible as per client requirements.
New Application Submit through ALIP User Interface (UI)
Application Post Submit through ALIP UI
Adding or updating of a role via Contract Role history.
ALIP business configuration supports the trigger of this interface, if it satisfies the below two conditions -
The client associated with the application or contract, does not have an external id already mapped in ALIP.
The client is mapped to a preconfigured set of roles, on the application/contract. This set currently includes Owner, Joint Owner, Annuitant, Joint Annuitant, and is extensible for additional roles as per future client requirements.
Apart from the interface triggering, the business configuration is also currently configured to take care of the following:
Update of the external client id into the database.
Data Audit of the updated external client id
| TR ID# | Technical Requirements |
| TR1 | ACORDv2.36 is used to communicate with the external system. |
| TR2 | ACORD Tx 204 “Party Inquiry transaction to=204” is used to query the External Client ID from the external system by employing REST, JSON and OAUTH2 or SOAP. |
| TR3 | Business Configuration is responsible for triggering the interface that obtains External Client Id from the external system. |
| TR4 | If the interface is able to obtain External Client Id, the ALIP interface should return a Success Response. |
| TR5 | In case there is any error while obtaining external clientid form external system an error response is returned by ALIP interface. |
| TR6 | Multiple client ids can be part of the same request |
| BR ID# | Business Requirements |
| BR1 | Trigger points for this interface are New Application Submit through ALIP User Interface (UI)Application Post Submit through ALIP UIAdding or updating of a role via Contract Role history. |
| BR2 | This interface supports assigning of External Client IDs for multiple clients in a single request |
| BR3 | Any time a client (for selective roles) is associated with an application (during Submit or Resubmit) or a contract (during add/update roles), and if the client does not already have an External Client ID, ALIP will obtain the External Client ID from External System and save that information at the client entity level within ALIP. The above trigger should happen for the below configurable set of client roles on an application or on a contract.OwnerJoint OwnerAnnuitantJoint Annuitant |
| BR4 | Any changes made by this interface, are associated with a user called ‘ALIP System’ in the ALIP database.The update to the External Client ID should be audited. For NBSubmit and Post Submit flow data audit will be performed at Application level. Application level audit will show role details, for Role history flow audit will be done at client level. |
| BR5 | If the external service call returns external Id, the integration history records a successful outbound integration |
| BR6 | If a failure occurs while obtaining or saving of External Client ID within ALIP during Application underwriting workflow due to below reasons.ALIP is unable to reach external system The handshake between ALIP and external system failed due to authentication failureThere is a failure when an external system is serving the request for one or more clientsExternal system didn’t return the response within the expected time. An XSD failure occurred while this interface validates the incoming responseALIP is unable to save the external client id.ALIP creates ‘Client External Identification Code Failure’ pre-issue requirement with created by as ‘ALIP System’. One requirement is created regardless number of clients having the failure.The notes section contains the client First Name, Last Name for Individual(if it is available), if name is not available notes will be generated with Client Tax ID for Individual, Company and Trust that have this failure along with the failure reason. For a generic error (except C), the notes should contain the generic error. As an example: ALIP is unable to reach external system.For XSD error, notes will contain the detail of XSD failure.For a specific error tied up to one or more clients (for C), the notes should contain the error and respective client names that had the problem. As an example: Client Name: Manuel Vincent Lanzini Error: Failure due to incorrect or insufficient data received from Business Configuration in input request.Client Tax ID: 875765789: Failure due to incorrect or insufficient data. received from Business Configuration in input request.If the Notes field reaches the maximum of 2000 characters, the content of the Notes field will be removed, and the new failure information is recorded. For case C, Interface will save the external ID of the clients which are received successfully. For eg.If three clients were part of request and two clients were able to get external ID’s, those will be saved in ALIP, and a requirement will be generated along with notes for the third client not having external ID.Integration logs must capture the necessary failure details to triage the issue.Production support needs to triage these failures and take applicable actions. |
| BR7 | If a failure occurs while adding a role due to the same reasons mentioned in BR4.High errors must be displayed upon clicking Continue on Role Summary for each client (that had an error) with the text from what happened (i.e. A, B, C, D, E and F). Users should not be able to move forward. Error details will be same as notes details in BR6.Integration logs must capture the necessary failure details. Production support needs to triage these failures and take applicable actions. |
This interface will result in updating of the External Client ID at the Client Entity level. If there are any failures that occur during the processing of this interface can result in either creation of a pre-issue requirement (on an application side) or generation of a high error (during add/update of a client role).
External Client Id applies to Individual, Company and Trust client types.
Mock service will be used to generate External Client ID’s for testing purpose, this can be later replaced with client specific service. Client service should follow the same request/response structure as of mock to use the interface out of box
None
The details of the Request Data elements are provided in the embedded XLS.
| Success | Success Scenario Description | Message Code | Message Description | Message Type | Additional Comments |
| #1 | Submit an application through New Business UI with below roles and supply different clients where possible.OwnerJoint OwnerAnnuitantJoint AnnuitantBeneficiaryAgent Exchange Replacement Company | 1 | Success | Informational | External Client ID should be updated at the Client Entity level for all clients except the clients that are associated with Beneficiary, Agent and Exchange replacement company. As these roles are not configured to Obtain external ID.Last updated by should be ‘ALIP System’ and there should be an audit for the External Client ID update at application level. Audit at application level will be perfomed for all existing or new clients.The integration history should record a successful outbound integration.This scenario will produce same result for all trigger points. |
| #2 | Submit an application through New Business UI with below roles and supply different clients where possible. Ensure all the client’s already have the External Client ID’s (except Beneficiary and Agent)OwnerJoint OwnerAnnuitantJoint AnnuitantBeneficiaryAgent | 1 | Success | Informational | No External Client ID should be updated at the Client Entity level for all clients. There should not be any integration going out for any of the clients since all the applicable clients have the External Client ID’s.This scenario will produce same result for all trigger points. |
| #3 | Add a role that is not a beneficiary and not an agent. Ensure the client does not already have an External Client ID.The integration trigger should occur upon clicking the continue button on the Additional Info Page. Please note that this comment applies to all scenarios that deals with adding a role. | 1 | Success | Informational | External Client ID should be updated at the Client Entity level for all clients except that clients associated with Beneficiary and Agent roles. Last updated by should be ‘ALIP System’ and there should be an audit for the External Client ID update at client level. Client level audit will be performed for existing clients only and not for new clients.The integration history should record a successful outbound integration. |
| #4 | Add a role that is not a beneficiary and not an agent (i.e add a pre-configured role which is eligible to get external ID). Ensure the respective client already has External Client ID within ALIP. | 1 | Success | Informational | No External Client ID should be updated at the Client Entity level for all clients. There should not be any updates by ‘ALIP System’. There should not be any integration going out for any of the clients since all the applicable clients have the External Client ID’s. |
| Error | Error Scenario Description | Message Code | Message Description | Message Type | Additional Comments |
| #1 | A failure occurs when obtaining or saving of External Client ID within ALIP during Application underwriting workflow.ALIP is unable to reach external system The handshake between ALIP and external system failed due to authentication failureThere is a failure when an external system is serving the request for one or more clientsExternal system didn’t return the response within the expected time. An XSD failure occurred while this interface validates the incoming response.ALIP is unable to save the external client id. | 100 | Internal Error | Fatal | ALIP must create ‘Client External Identification Code Failure’ pre-issue requirement with created by as ‘ALIP Systems. One requirement must be created regardless number of clients having the failure.The notes section contains the client First Name, Last Name for Individual(if it is available), if name is not available notes will be generated with Client Tax ID for Individual, Company and Trust that have this failure along with the failure reason. For a generic error (except C), the notes should contain the generic error. As an example: ALIP is unable to reach external system. For XSD error, notes will contain the detail of XSD failure.For a specific error tied up to one or more clients (for C), the notes should contain the error and respective client names that had the problem. As an example: Client Name: Manuel Vincent Lanzini Error: Failure due to incorrect or insufficient data received from Business Configuration in input request.Client Tax ID: 875765789: Failure due to incorrect or insufficient data received from Business Configuration in input request. If the Notes field reaches the maximum of 2000 characters, the content of the Notes field will be removed, and the new failure information is recorded. Integration logs must capture the necessary failure details to triage the issue.Production support needs to triage these failures and take applicable actions. |
| #2 | A failure occurs when adding of a role.ALIP is unable to reach external systemThe handshake between ALIP and external system failed due to authentication failureExternal system didn’t return the response within the expected time. There is a failure when an external system is serving the request.An XSD failure occurred while this interface validates the incoming responseALIP is unable to save the external id. | 100 | Internal Error | Fatal | High errors must be displayed upon clicking Continue on Role Summary for each client (that had an error) with the text from what happened (i.e. A, B, C, D, E and F). Error description will be same as notes details mentioned in Scenario #1 Users should not be able to move forward. Integration logs must capture the necessary failure details. Production support needs to triage these failures and take applicable actions. |