FINS Customer Addresses Process API - Implementation Template
home
This API implementation template is a component of MuleSoft Accelerators, which accelerate the implementation of essential integration use cases.
The solution includes pre-built APIs, connectors, and integration templates that help unlock business-critical data from external systems and guide you in adopting best practices synthesized from thousands of customer implementations. Use these assets as is or extend them to meet your company’s unique needs.
Overview
This integration template implements the FINS Customer Addresses Process API specification.
This Process API will be responsible for querying and updating Contact Points (ContactPointAddress). It also can process an address change event for both Insurance and Banking Customers.
For a Banking Customer, when the Billing Address is updated, the address is validated by calling the FINS Address Validation System API and a Marketing email is sent to the Customer by calling the FINS Salesforce Marketing System API.
For an Insurance Customer, when the Billing Address is updated, the address is validated by integrating with the FINS Address Validation System API, the Core Logic System API is used to retrieve the Property Characteristics & risks and this information is used to create a Policy and Quote in Salesforce Insurance System using FINS Insurance System API. On success, a notification with the links to Quote and Policy is posted on the Slack channel customer-service-reps (configurable) using the Accelerator Slack System API.
For both Banking and Insurance Customers, whenever there is an update to Billing Address or Mailing Address, the addresses are validated and in case of an invalid address a notification message is posted on the Slack channel customer-service-reps(configurable) and the rest of the processing is skipped.
Note: Postal address validation will be processed only on address update of an existing active customer that exists in Global Data Service.
Getting started
|
The Getting Started with MuleSoft Accelerators guide provides general information on getting started with the accelerator components. This includes instructions on setting up your local workstation for configuring and deploying the applications. |
Once your workstation has been set up and the application template imported into Anypoint Studio, proceed with the Prerequisites section.
Prerequisites
This implementation template has the following dependencies:
- Anypoint MQ Destinations
- Accelerator MariaDB Global Party System API
- FINS Salesforce Financial System API (supports multiple deployments for separate FSC instances)
- FINS Salesforce Insurance System API
- FINS Address Validation System API
- FINS Core Logic System API
- FINS Salesforce Marketing System API
- Accelerator Slack System API
Please review the use cases described on the MuleSoft Accelerator for Financial Services solution pages for more information about dependencies on other APIs and services.
Anypoint MQ destinations
The following Anypoint MQ destinations must be created and accessible for this API:
- fins-address-update-queue
- fins-address-update-dl-queue
The FINS Common Resources asset contains a Postman collection, which can be used to create the destinations and client application required for use by accelerator applications.
API dependencies
The following table lists all endpoints used by this API (assuming all syncronization targets are enabled).
| API name | Endpoint | Action |
|---|---|---|
| Accelerator MariaDB Global Party System API | get:/partyRoles/{partyRoleId} | Retrieve an existing party role |
| Accelerator MariaDB Global Party System API | get:/customers | Search a customer party role |
| Accelerator MariaDB Global Party System API | get:/parties/{partyId} | Retrieve party along with contact points of an existing party |
| FINS Salesforce Accounts System API | get:/customers | Search a customer party role |
| FINS Salesforce Insurance System API | get:/policies | Retrieve policies related to the customer |
| FINS Salesforce Insurance System API | post:/quotes | Create a quote related to the customer |
| FINS Address Validation System API | post:/validators/postalAddresses | Validate the postal address |
| FINS Salesforce Marketing System API | post:/journeys | Create a new journey |
| FINS Core Logic System API | get:/properties/characteristics | Retrieve property characteristics of a specific address from CoreLogic |
| FINS Core Logic System API | get:/properties/risks | Retrieve property risks of a specific address from CoreLogic |
| Accelerator Slack System API | post:/messages | Create a new message to post to slack |
Deployment
Each Accelerator implementation template in Exchange includes Bash and Windows scripts for building and deploying the APIs to CloudHub. These scripts depend on repositories, global settings, deployment profiles, and associated properties configured in the Maven settings.xml file.
For additional details, please refer to the Application Deployment section of the Getting Started Guide.
Preparation
Ensure the Maven profile CloudHub-FINS-DEV has been properly configured in your settings.xml file. In particular, make sure the common properties for your environment have been provided (e.g., Anypoint Platform client ID and secret).
Required property overrides
At a minimum, the following properties must be customized to reflect the target deployment environment.
| Property Name | Description |
|---|---|
| api.autodiscoveryID | Required if using API Manager to secure this API |
| anypoint-mq.server-url | Anypoint MQ URL where the message Exchange, Topics, queues have been created |
| anypoint-mq.client-id | Anypoint MQ Client Id to access messages from MQ |
| anypoint-mq.client-secret | Anypoint MQ Client Secret to access messages from MQ |
| global-party-sys.host | Accelerator MariaDB Global Party System API HostName |
| global-party-sys.port | Accelerator MariaDB Global Party System API Port |
| global-party-sys.base-path | Accelerator MariaDB Global Party System API Base path |
| address-validation-sys.host | HostName of FINS Address Validation System API |
| address-validation-sys.port | Port of FINS Address Validation System API |
| address-validation-sys.base-path | Base Path of FINS Address Validation System APIs |
| slack-sys.host | HostName of Accelerator Slack System API |
| slack-sys.port | Port of Accelerator Slack System API |
| slack-sys.base-path | Base Path of Accelerator Slack System API |
| corelogic-sys.host | FINS Corelogic System API HostName |
| corelogic-sys.port | FINS Corelogic System API Port |
| corelogic-sys.base-path | FINS Corelogic System API Base path |
| salesforce-insurance-sys.host | FINS Salesforce Insurance System API HostName |
| salesforce-insurance-sys.port | FINS Salesforce Insurance System API Port |
| salesforce-insurance-sys.base-path | FINS Salesforce Insurance System API path |
| marketing-sys.host | FINS Salesforce Marketing System API HostName |
| marketing-sys.port | FINS Salesforce Marketing System API Port |
| marketing-sys.base-path | FINS Salesforce Marketing System API path |
| fsc-insurance-org-host-name | Hostname of the Salesforce FSC Insurance Org. This is used to create a link to Insurance Policy and Quote in Salesforce FSC Insurance Org from the Slack notification message |
Testing
Use Advanced Rest Client or Postman to send a request over HTTPS. The template includes a Postman collection in the src/test/resources folder. Update the collection variable(s) after successful import.
Additional resources
- The Data mappings tab describes how the request and response data structures are mapped between the API interfaces.
- Refer to the Accelerators documentation home for more information about the MuleSoft Accelerators.