Clearmatch integration - overview

Clearmatch integration - overview

1.  Introduction

The Clearmatch platform consists of the following external facing application components:

1. Single Sign On – The single sign on service is a central service where registered users are authenticated. Additionally, the service can also be integrated with external OpenId connect authentication providers.

2. Customer Portal UI – A customer self-service portal (web-based) that is available publicly. Borrowers, Investors and others use this portal to create new applications, bid on applications and transfer money to fund accounts, etc.

3. Clearmatch Backend UI – This is a back-office application (web-based) only accessible to the finance company and originator group staff. This application enables back office staff to perform most functionality currently available in the customer portal and additional functionality not available to the general public like underwriting, loan administration, collections etc.

4. Public API – REST based API that provides a subset of Clearmatch functionality to enable partners to integrate their systems with Clearmatch.

5. Notifications (Hooks) – the Clearmatch platform can send out events to partners using a notification system. Partners need to setup Partner Process Manager (Controller service) in their environment and Clearmatch will send notification for events as configured in the backend.

6. SmartFund BOTS - SmartFund is the application that bids on application on behalf of investors.

7. Datawarehouse – SQL server database with separate databases for different Asset Classes.

8. Customer maintained Extensions (optional) – After notifications reach Partner Process Manager (Controller service) this event information and any additional data from Clearmatch API can be created, configured and implemented to orchestrate partner specific logic. For example, notifications can be setup for application/listing status changes and this data combined with other application details, can easily be exported to Google GTM.

9. Customer maintained Application pages (optional) – Customers who would like to maintain their own customised version of application pages can use the Clearmatch API to build bespoke UI journeys (NOTE : this is work in progress)



In order to achieve a full integration with Clearmatch, partners should manage the following application components:
1. Process Manager (Controller service) - This is a HTTP/JSON endpoint that can receive notifications from Clearmatch. This service should only act as process manager and avoid doing any heavy lifting. Data received from Clearmatch is optionally stored in a durable store and acknowledged. Follow on business processes on the partner's side can carry on without dependency on Clearmatch.

2. Peripheral services – These are bespoke services that integrate data from Clearmatch into Lines of Business applications. These services sit behind the process manager and do not make direct calls to Clearmatch, instead state is read from persistent store.

During the initial setup, firewall rules need to be setup at Clearmatch and at the Partner's site if/when necessary.

2.  Environment Setup details

The following environmental details will need to be provided in order for the integrations to be tested and implemented successfully:

#


Item


Sandbox


Production


1


Partner Portal IP Address






2


Partner Notification Endpoint URL






3


Partner Notification Endpoint Authentication






4


Partner Notification Endpoint Username






5


Partner Notification Endpoint Password






6


SSO Client ID




7


SSO Client Secret




8


API Service User Name




9


API Service Password




10


API URL




11


Swagger Spec URL




12


Single SignOn Service URL





    • Related Articles

    • Clearmatch integration - partner process

      1. Introduction The purpose of this document, is to provide a high-level walk-through of different components involved in a Finance Company's integration with Clearmatch API focusing on the following: Partner Process Manager Notification Processor ...

    • Clearmatch integration - API

      1.  Introduction The purpose of this document is to provide a high-level explanation on how the Clearmatch Public API is used by a partner. Clearmatch provides a REST based API to retrieve information from the platform. Some highlights include: The ...

    • Clearmatch integration - notification

      1.  Introduction The purpose of this document is to provide a high-level explanation on how Clearmatch Notifications are used by a partner.           A Clearmatch platform can be setup to send notifications when a certain “event” happens. For ...

    • SmartFund BOTS - Technical Overview

      Introduction This document outlines the BOT (Smartfund) investor bidding process in full, including sample files and field/column descriptions. Process Overview Fully Automated Version Environment 1- Clearmatch Application API triggers a ‘come and ...

    • Overview of the Clearmatch members portal

      The Clearmatch members portal is a website that is available for the following participants to access in order to view and manage their details: Borrowers can sign in to: Update their personal details Set personal notification settings for emails and ...