FINS Thought Machine Customers System API - Implementation Template
home
This asset is a component of the MuleSoft Accelerator for Financial Services, which accelerates 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 Core Banking Customers API specification. This API is for working with the Thought Machine provider.
It supports the following functionalities:
- Create/Update Customer in Thought Machine system
- Get Customers from Thought Machine system
- Create/Update Contact Points in Thought Machine system
- Get Contact Points from Thought Machine system
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:
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.
API dependencies
The following table lists all endpoints used by this API.
| API Endpoint | Thought Machine - Connector |
|---|---|
| get:/customers/{customerId} | Get Customer, List Customer Addresses |
| get:/customers | List Customers, List Customer Addresses |
| post:/customers | Create Customer, Create Customer Address |
| patch:/customers/{customerId} | Update Customer, Update Customer Additional Details, Update Customer Address |
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.
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. In particular, make sure the common properties for your environment have been provided in the CloudHub-DEV profile (e.g., Anypoint Platform client ID and secret).
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 |
|---|---|
| thoughtmachine.base-uri | Host for connecting to Thought Machine Service |
| thoughtmachine.token | Token for connecting to Thought Machine Service |
Implementation notes
- Creation of Customer with partyType as Individual and Organization is supported.
- Search with customerId and emailAddress are only supported.
- externalId field for Creating a customer in Thought Machine is mapped to the external_customer_id in the request.
- Multiple ContactPoints are not supported.
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.