FINS Bank Loans 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 Bank Loans Process API specification. It supports the following functionalities:
- Retrieves loan applications from Loan Origination System API
- Processes new loan applications by checking the credit score of the individuals, sending the documents for e-signatures, and storing the copy of documents sent for signing
- Retrieve details for an existing loan application.
- Update details for an existing loan application and creates new customers and loan accounts when loan document signatures are received. Returns a complete version of the updated application.
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 Bank Accounts Process API
- FINS Customers Process API
- FINS Credit Bureau System API
- FINS DocuSign 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.
Create 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-loan-document-update-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.
| API name | Endpoint | Action |
|---|---|---|
| FINS Bank Accounts Process API | put:/api/accounts | Upsert a Loan Account |
| FINS Customers Process API | put:/api/individuals | Upsert Individuals |
| FINS Customers Process API | put:/api/customers | Upsert Customers |
| Accelerator MariaDB Global Party System API | get:/api/individuals/{individualId} | Retrieve an individual |
| Accelerator MariaDB Global Party System API | get:/api/customers | Lookup customers |
| Accelerator MariaDB Global Party System API | get:/api/customers/{customerId} | Retrieve an Customer |
| FINS Credit Bureau System API | get:/api/reports/creditScores | Retrive credit score |
| FINS DocuSign System API | post:/api/envelopes | Create an envelope |
| FINS DocuSign System API | get:/api/envelopes/{envelopeId}/documents/{documentId} | Retrieve envelope contents |
| FINS Loan Origination System API | get:/api/loans/applications | Lookup loan applications |
| FINS Loan Origination System API | get:/api/loans/applications/{loanApplicationId} | Retrieve a loan application |
| FINS Loan Origination System API | post:/api/loans/applications | Create loan application |
| FINS Loan Origination System API | patch:/api/loans/applications | Update loan application |
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 for this application to reflect the target deployment environment.
| Property Name | Description |
|---|---|
| Property Name | Description |
| ---- | ---- |
| api.autodiscoveryID | Required if using API Manager to secure this API |
| global-party-sys-api.host | Accelerator MariaDB Global Party System API HostName |
| global-party-sys-api.port | Accelerator MariaDB Global Party System API Port |
| global-party-sys-api.base-path | Accelerator MariaDB Global Party System API Base path |
| global-party-sys-api.ping-path | Accelerator MariaDB Global Party System API Ping path |
| bank-accounts-prc-api.host | Bank Accounts Process API HostName |
| bank-accounts-prc-api.port | Bank Accounts Process API Port |
| bank-accounts-prc-api.base-path | Bank Accounts Process API Base path |
| bank-accounts-prc-api.ping-path | Bank Accounts Process API Ping path |
| bank-loans-prc-api.http-client.client-id | Client Id provided for Bank Loans Process API to interact with all System APIs |
| bank-loans-prc-api.http-client.client-secret | Client Secret provided for Bank Loans Process API to interact with all System APIs |
| credit-bureau-sys-api.host | Credit Bureau System API HostName |
| credit-bureau-sys-api.port | Credit Bureau System API Port |
| credit-bureau-sys-api.base-path | Credit Bureau System API Base path |
| credit-bureau-sys-api.ping-path | Credit Bureau System API Ping path |
| customers-prc-api.host | Customers Process API HostName |
| customers-prc-api.port | Customers Process API Port |
| customers-prc-api.base-path | Customers Process API Base path |
| customers-prc-api.ping-path | Customers Process API Ping path |
| docusign-sys-api.host | DocuSign System API HostName |
| docusign-sys-api.port | DocuSign System API Port |
| docusign-sys-api.base-path | DocuSign System API Base path |
| docusign-sys-api.ping-path | DocuSign System API Ping path |
| loans-sys-api.host | Loans Originating System API HostName |
| loans-sys-api.port | Loans Originating System API Port |
| loans-sys-api.base-path | Loans Originating System API Base path |
| loans-sys-api.ping-path | Loans Originating System API Ping path |
| accelerator-mq.client-id | Client Id of the Anypoint MQ |
| accelerator-mq.client-secret | Client Secret of the Anypoint MQ |
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.