This interface returns the suitability required check of an Agent. This is handled via a real time non-secure web service call to the external suitability system with agent details and contract information to get the agent’s suitability status. 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 suitability system will be triggered from below trigger points:
• Trigger 1 – This interface is tested through RuleGroup tester in IX.
Additional trigger points can be configured at the client level, if required.
Suitability check applies only to Primary selling agent. Based on the response from the web service, in case of application processing, ALIP business configuration will decide whether to process the application further or stop the application processing by generating applicable requirements for the application.
| TR ID# | Technical Requirements |
| TR1 | The interface will receive ALIP format XML from the above listed trigger points configured for agent suitability check. This ALIP XML will be converted to ACORD 21100 format, which will be sent by the interface to the external suitability system. |
| TR2 | ALIP will call the external suitability service with the required agent and app details mentioned in Request Data Elements. |
| TR3 | External suitability service will return the response with fields mentioned in Response Data Elements. |
| TR4 | The response from external suitability 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 suitability service 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 suitability Interface will be called from various trigger points on the basis of business rules as defined in client requirements. This interface will invoke the suitability services provided by the external system to fetch suitability information for selling agent. |
| BR2 | The response received from the external suitability service, is translated and sent back by the interface to the invoking trigger point. Business rules will further interpret this response, to either generate requirements or error messages, depending on whether the trigger point is during application submit.Respective client BRD will cover requirement details and Taskbox generation, if any. |
| BR3 | If the suitability service of the external system is unreachable or any exception is thrown while invoking the service, the interface will log an Integration Failure in the ALIP database. |
. ALIP system sends an agent suitability 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 suitability 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 error messages/requirements, based on the trigger point.
This interface performs Agent Suitability check externally.
. Agent suitability check will be triggered only for Primary selling producer.
. BUS-19A Agent Management business requirement document (BRD) will cover necessary details for the suitability check triggers and how the results (i.e. creation of necessary requirements) will be processed within ALIP.
. BUS-19A Agent Management business requirement document (BRD) will cover generation of requirements. It is a general guideline to business configurator’s that they should use the AgentSuitabilityRequired (Yes/No), and create necessary requirement containing Producer ID when AgentSuitabilityRequired is "Yes" for an agent, ALIP will ignore the presence of the Error Messages (if any). However, please note that whatever is documented in BUS-19A Agent Management business requirement document supersedes this comment.
. Any tasks to be generated for an agent suitability check is required will be covered as part of Task management business requirements.
. It is assumed that there is no trigger for Agent Suitability Integration for adding Primary selling agent from Contract role history page.
. Please note that Client is expected to manage the applications with agent suitability check requirements through a manual process i.e. there won’t be any automatic system functionality to find all the applications with pending ‘Agent Suitability Failure’ or ‘Agent Suitability Required’ requirements and trigger resubmission of applications.
. Client middleware will transform / translate ALIP standard payload to the destination system’s format if required i.e. ALIP ACORD 21100 to corresponding end state. If required, Client middleware will make one or multiple calls to their suitability provider service to perform agent suitability check.
. Please note that the reporting requirements are considered out of scope for this document. Any information related to integration database tables are not currently staged. It is assumed that Integration History page from ALIP (along with ALIP logs) will be used where needed to do the required triaging.
. 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.
. It is assumed that ALIP product code will be used as is by client services.
This interface can’t be tested end to end until relevant pieces of agent validation 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 Suitability check 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 Description | Message Type | Additional Comments |
| #1 | Agent Suitability Check Interface was not successful due to validation failure of the response received from the external validating webservice. | Internal Error | Fatal | |
| #2 | Agent Suitability Check Interface was not successful due to the webservice being down or timing out | Internal Error | NA |
. An average response time of 3 seconds (i.e. client external system needs to provide a response within this timeframe) is assumed for this interface.
A peak volume of around 200 applications will be submitted on a given day. So roughly around ~200 Agent