FINS Customers Process API - Implementation Template
Prerequisites
This implementation template has the following dependencies:
- Anypoint MQ Destinations
- Accelerator Global Party Process API
- FINS Salesforce Customers System API (supports multiple deployments for separate FSC instances)
- FINS Salesforce Marketing System API
- FINS Core Banking Customers System API
- FINS Loan Origination 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
In addition to the Anypoint MQ client application credentials, the following destinations must be created and made accessible to this API:
- fins-partyrole-update-queue
- fins-partyrole-update-dl-queue
- fins-party-update-queue
- fins-party-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 Global Party Process API | get:/individuals | Search a individual party |
| Accelerator Global Party Process API | get:/customers | Search a customer party role |
| Accelerator Global Party Process API | get:/organizations | Search an organization party |
| Accelerator Global Party Process API | get:households | Search an household party |
| Accelerator Global Party Process API | put:/individuals | Create or update an individual party |
| Accelerator Global Party Process API | put:/customers | Create or update a customer party role |
| Accelerator Global Party Process API | put:/organizations | Create or update an organization party |
| Accelerator Global Party Process API | put:/households | Create or update household party |
| Accelerator Global Party Process API | put:/parties/{partyId}/contactPoints | Update contact points for a party |
| Accelerator Global Party Process API | put:/parties/{partyId}/externalIds | Update external IDs for a party |
| Accelerator Global Party Process API | put:/partyRoles/{partyRoleId}/externalIds | Update external IDs for a party role |
| Accelerator Global Party Process API | get:/individuals/{individualId} | Retrieve an existing individual party |
| Accelerator Global Party Process API | get:/customers/{customerId} | Retrieve an existing customer party role |
| Accelerator Global Party Process API | get:/organizations/{organizationId} | Retrieve an existing organization party |
| Accelerator Global Party Process API | get:/households/{householdId} | Retrieve an existing household party |
| FINS Salesforce Customers System API | get:/customers | Search for an existing customer |
| FINS Salesforce Customers System API | post:/customers | Create a new customer |
| FINS Salesforce Customers System API | patch:/customers/{customerId} | Update an existing customer |
| FINS Salesforce Customers System API | get:/customers/{customerId} | Retrieve an existing customer |
| FINS Salesforce Marketing System API | get:/subscribers | Search for an existing subscriber or individual party |
| FINS Salesforce Marketing System API | post:/subscribers | Create a new subscriber or individual party |
| FINS Salesforce Marketing System API | patch:/subscribers/{subscriberId} | Update an existing subscriber or individual party |
| FINS Salesforce Marketing System API | get:/subscribers/{subscriberId} | Retrieve an existing subscriber or individual party |
| FINS Core Banking Customers System API | get:/customers | Search for an existing customer |
| FINS Core Banking Customers System API | post:/customers | Create a new customer |
| FINS Core Banking Customers System API | patch:/customers/{customerId} | Update an existing customer |
| FINS Core Banking Customers System API | get:/customers/{customerId} | Retrieve an existing customer |
| FINS Core Banking Customers System API | get:/customers/{customerId}/contactPoints | Retrieve contact points of an existing customer |
| FINS Core Banking Customers System API | put:/customers/{customerId}/contactPoints | Update contact points of an existing customer |
| FINS Loan Origination System API | get:/customers | Search for an existing customer |
| FINS Loan Origination System API | post:/customers | Create a new customer |
| FINS Loan Origination System API | patch:/customers/{customerId} | Update an existing customer |
| FINS Loan Origination System API | get:/customers/{customerId} | Retrieve an existing customer |
Next steps
The Deployment tab provides instructions on how to properly configure the application for running locally from Studio or deploying to CloudHub.