Point of Sale Framework (POSF) Integration Guide

Encompass POSF Integration Overview

ICE Mortgage Technology (MT) offers products and solutions to support the many aspects of the loan origination process. For example, the Encompass eClose solution enables lenders and settlement agents to securely collaborate on eClose packages. The solution allows borrowers to securely view and eSign the eSignable documents in a closing package from the Encompass Consumer Connect borrower portal or embedded borrower widgets.

ICE Mortgage Technology offers a Point-of-Sale Framework (POSF) along with Application Programming Interfaces (APIs) that enable our point-of-sale (POS) partners to integrate ICE MT products and solutions into their POS solutions. This allows our partners to expand the capabilities they deliver to borrowers through their familiar user experience. This framework is compatible with Encompass Consumer Connect borrower portal and widgets.

The Point-of-Sale Framework (POSF) supports the following workflows:

Disclosures
Pre-Closing
eClosing
Request/Send Documents

🚧
The eConsent Request workflow is not supported in the Point-of-Sale Framework (POSF).

The Point-of-Sale Framework (POSF) supports the following Security Assertion Markup Language (SAML) flows:

Consumer Connect - Leverages an existing Encompass Consumer Connect Borrower Portal Connection metadata file.
Stand Alone - Does not leverage the Encompass Consumer Connect Borrower Portal Connection. Instead, uses its own connection metadata file.

This guide is for ICE Mortgage Technology POS Partners who want to build and host integrations for Encompass lender sites and apps.

Requirements

Your organization must be registered as a Partner with ICE Mortgage Technology.
If you have not already registered as a Partner offering Point of Sale services, see Become an ICE Mortgage Technology Partner, or contact your ICE Mortgage Technology Partner Alliance Manager to register. Your Partner Alliance Manager will also provide guidance and help step you through building and onboarding your integration.
Your organization must be enabled for Encompass eClose if you wish to develop an integration that supports the eClosing workflow.
If you wish to develop an integration that supports eClosing, then ensure that your organization has completed the Encompass eClose signup process and ICE Mortgage Technology has enabled the Encompass eClose product for your Encompass instance(s). If you are not sure, consult with your Partner Alliance Manager about this signup process.
You must have an Identify Provider (IdP) that is SAML 2.0 compliant.
Single Sign-on (SSO) is used to grant borrowers access to view and sign (including electronically) packages without having to log into Encompass directly. If you already have an Encompass Consumer Connect IdP connection, you can leverage that connection. Otherwise, you will need to register a Stand Alone connection and provide a SAML 2.0 metadata XML file from your IdP to your Partner Alliance Manager.

Partner POSF Integration Workflow

One of the following happens:
1. In the Encompass desktop application in the eFolder, the Encompass User selects Web Document Flows > Disclosures or Request/Send or Pre-Closing. In the modal window that appears, the user completes the form to send the package for consumer completion.
2. In the Encompass desktop application for eClose, the user must select the RegZ - CD form and select eClose. In the modal window that appears, the user completes the Create Closing Package steps to send package for consumer.
3. In the Encompass web application, all POSF workflows use the web document flows by default.
  📘
  The Partner may provide an option to perform step 1 above using the Encompass Developer Connect Send Document Package APIs in their point-of-sale (POS) website.
After initial processing, the ICE MT platform sends the package creation webhook (createPackageEvent) notification to the Partner-hosed endpoint with each consumer recipient in the package (examples: Borrowers and Non-Borrowing Owners).
The Partner service synchronously responds to the webhook by returning a Response contract that includes the Recipients contract.
Success or failure is returned to the Encompass User immediately after processing the Partner response.
When a package is ready to view or to be completed, an email is sent to each recipient. The email contains content from the Partner and includes a link to the Partner portal. Pertinent details of the related package may be passed as path or query parameters in the Partner portal URL.
When the recipient receives the email, and clicks the link, they are prompted to log into the Partner portal.
The recipient authenticates and triggers the delivery room.
The Partner service makes a POST API call to create a signing room session. The call includes UI-style and customization details, and a redirect URL for the recipient after completing the closing package tasks.
The ICE MT Platform verifies the session request and returns a Delivery Room Session URL to the Partner service.
The Partner service sends the session URL to the recipient.
The session URL is loaded into the recipient’s browser and loads (embed/redirect) the Delivery Room UI.
At this point, the SAML flow is triggered to provide borrower access to the Delivery Room via SSO. SAML authenticates using the Partner Identity Provider and binds the recipient so they can complete their tasks.
When tasks are completed and the recipient leaves the Delivery Room, the recipient is redirected to a status page provided by the Partner.
If desired, embedded status data can be used to display subsequent status updates.