FINS Bank Loans Process API - Implementation Template

(0 reviews)
Component of the MuleSoft Accelerator for FINS

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

bulb.png 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.

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:

  1. 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 nameEndpointAction
FINS Bank Accounts Process APIput:/api/accountsUpsert a Loan Account
FINS Customers Process APIput:/api/individualsUpsert Individuals
FINS Customers Process APIput:/api/customersUpsert Customers
Accelerator MariaDB Global Party System APIget:/api/individuals/{individualId}Retrieve an individual
Accelerator MariaDB Global Party System APIget:/api/customersLookup customers
Accelerator MariaDB Global Party System APIget:/api/customers/{customerId}Retrieve an Customer
FINS Credit Bureau System APIget:/api/reports/creditScoresRetrive credit score
FINS DocuSign System APIpost:/api/envelopesCreate an envelope
FINS DocuSign System APIget:/api/envelopes/{envelopeId}/documents/{documentId}Retrieve envelope contents
FINS Loan Origination System APIget:/api/loans/applicationsLookup loan applications
FINS Loan Origination System APIget:/api/loans/applications/{loanApplicationId}Retrieve a loan application
FINS Loan Origination System APIpost:/api/loans/applicationsCreate loan application
FINS Loan Origination System APIpatch:/api/loans/applicationsUpdate 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 NameDescription
Property NameDescription
--------
api.autodiscoveryIDRequired if using API Manager to secure this API
global-party-sys-api.hostAccelerator MariaDB Global Party System API HostName
global-party-sys-api.portAccelerator MariaDB Global Party System API Port
global-party-sys-api.base-pathAccelerator MariaDB Global Party System API Base path
global-party-sys-api.ping-pathAccelerator MariaDB Global Party System API Ping path
bank-accounts-prc-api.hostBank Accounts Process API HostName
bank-accounts-prc-api.portBank Accounts Process API Port
bank-accounts-prc-api.base-pathBank Accounts Process API Base path
bank-accounts-prc-api.ping-pathBank Accounts Process API Ping path
bank-loans-prc-api.http-client.client-idClient Id provided for Bank Loans Process API to interact with all System APIs
bank-loans-prc-api.http-client.client-secretClient Secret provided for Bank Loans Process API to interact with all System APIs
credit-bureau-sys-api.hostCredit Bureau System API HostName
credit-bureau-sys-api.portCredit Bureau System API Port
credit-bureau-sys-api.base-pathCredit Bureau System API Base path
credit-bureau-sys-api.ping-pathCredit Bureau System API Ping path
customers-prc-api.hostCustomers Process API HostName
customers-prc-api.portCustomers Process API Port
customers-prc-api.base-pathCustomers Process API Base path
customers-prc-api.ping-pathCustomers Process API Ping path
docusign-sys-api.hostDocuSign System API HostName
docusign-sys-api.portDocuSign System API Port
docusign-sys-api.base-pathDocuSign System API Base path
docusign-sys-api.ping-pathDocuSign System API Ping path
loans-sys-api.hostLoans Originating System API HostName
loans-sys-api.portLoans Originating System API Port
loans-sys-api.base-pathLoans Originating System API Base path
loans-sys-api.ping-pathLoans Originating System API Ping path
accelerator-mq.client-idClient Id of the Anypoint MQ
accelerator-mq.client-secretClient Secret of the Anypoint MQ

Additional resources


Reviews

TypeTemplate
OrganizationMulesoft Inc.
Published by
MuleSoft Solutions
Published onNov 10, 2023
Asset overview

Asset versions for 2.1.x

Asset versions
VersionActions
2.1.4
2.1.3
2.1.1
2.1.0