This interface returns the list of Trail commission options for a Primary Agent. This is handled via a real time non-secure web service call to the external system with agent details and application information to get the agent’s Trail commission options. Below products are in scope for this operation.
• Deferred Annuity
• Immediate Annuity
• Term Life Insurance
• Universal Life
• Whole Life Insurance
The call to the external agent trail commission system will be triggered from below trigger points:
Trigger 1 – Submission of an application in ALIP during underwriting. Application submitted from ALIP front-end.
Additional trigger points can be configured at the client level, if required.
| TR ID# | Technical Requirements |
| TR1 | The interface will receive ALIP format XML from the above listed trigger points configured for agent trail commission options. This ALIP XML will be converted to ACORD 21100 format, which will be sent by the interface to the agent trail commission options. |
| TR2 | ALIP will call the external trail commission options service with the required Primary agent and app details mentioned in Request Data Elements. |
| TR3 | Agent Trail commission options interface will return the response with fields mentioned in Response Data Elements. |
| TR4 | The response from agent trail comm options service, will be in ACORD format. This will be converted into ALIP XML and returned by the interface to the trigger point that invoked this interface. |
| TR5 | The expected response time from the external trail comp options interface is 3 seconds or less. If there is no response received in that time, ALIP will retry 3 times before it considers this as an integration failure. |
| TR6 | The outgoing call must use REST with OAUTH2. An initial call should be made to get the token and the second call should be made for the agent suitability with the token. Please note that the required parameters will be part of the payload (as opposed to being supplied as parameter to GET operation). |
| BR ID# | Business Requirements |
| BR1 | Agent Trail commission options Interface will be called from various trigger points on the basis of business rules. This interface will invoke the external system to fetch Trail commission options for a Primary agent. Trigger 1 – Submission of an application in ALIP during underwriting. Application submitted from ALIP front-end. |
| BR2 | The response received from the external suitability service, is translated and sent back by the interface to the invoking trigger point. Business rules can further interpret this response, to either display option in UI, generate requirements or display low error messages, depending on where the trigger point is coming from. Note:- Required Response handling business configuration must be implemented as per client requirements. |
| BR3 | If the Trail comp Options external system is unreachable or any exception is thrown while invoking the service, the interface will log an Integration Failure in the ALIP database. Respective BRD(BUS-19A) will cover error details and requirement details. |
Proposed Interface Context Diagram
. ALIP system sends an agent trail commission options request to the ALIP request queues, from the configured trigger points.
. The process server routes this request to the appropriate interface, which translates the message to ACORD 21100 format and validates the same for mandatory fields and allowable values.
. Post input request validation, interface invokes an external system’s agent trail commission options service.
. The response message returned by the service is validated for mandatory fields and allowable values.
. The response is translated to ALIP format and sent back to the invoking trigger point.
. Business configuration will help further translate the response to UI display or error messages/requirements, based on the trigger point.
This interface fetches Primary Agent Trail commission options externally.
. It is assumed that Interface will return NO one Trail commission option.
. Please note that the samples attached in this document contain samples from out of box implementation. During design, the applicable samples will be updated with needed changes.
. This interface is configured to trigger during appsubmit underwriting process for testing purposes.Client needs to create customized BC configurations based on triggerpoints and requirements.
This interface can’t be tested end to end until relevant pieces of agent trail commission options functionality from BUS-19A Agent Management business requirement document (BRD) is implemented.
| Success | Success Scenario Description | Message Code | Message Description | Message Type | Additional Comments |
| #1 | Agent Trail Commission Options Interface executed successfully. | 1 | Success | Informational | The call to the external webservice is successful. Success entry will be logged on the integration history page. |
| Error | Error Scenario Description | Message Code | Message Description | Message Type | Additional Comments |
| #1 | Agent Trail Commission Options Interface was not successful due to validation failure of the response received from the external validating webservice. | 5 | Internal Error | Fatal | |
| #2 | Agent Trail Commission Options Interface was not successful due to the webservice being down or timing out. This will be a 'Low' severity error and a requirement will be generated for same, allowing user to continue with app submission. | 5 | Internal Error | NA |