Point of Sale Integration Framework Guide

Encompass eClose Integration Overview

ICE Mortgage Technology offers the Encompass eClose product to all our lenders. The solution allows for lenders and settlement agents to securely collaborate on eClose packages. It also allows for borrowers to securely view and eSign the eSignable documents in a closing package from the Encompass Consumer Connect borrower portal or embedded borrower widgets.

For our Point of Sale (POS) Partners, ICE Mortgage Technology offers APIs for building custom Encompass eClose integrations. Encompass lenders can leverage these integrations to provide their borrowers with a seamless eClose document management and eSign experience. This solution is compatible with Encompass Consumer Connect borrower portal and widgets.

This guide is for ICE Mortgage Technology Point of Sale Partners who want to build and host an Encompass eClose third-party integration for Encompass lender sites and apps.

📘

Download This Guide

Click here to download a PDF version of the Point of Sale Integration Framework Guide.

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.
  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 Identity Provider (IdP) that is SAML 2.0 compliant.
  Single Sign-On (SSO) is used to grant borrowers access to view and eSign Encompass eClose packages without having to log into Encompass directly. If you already have an Encompass Consumer Connect IdP connection, you can leverage that. Otherwise, you will need to provide the SAML 2.0 metadata XML file from your IdP to your Partner Alliance Manager.

Partner Integrated eClose Flow

1. The Encompass closer approves the closing package for signing. The closer sets the dates when the borrower(s) can preview the closing package and electronically sign the package, then clicks Approve for eSign in Encompass.

2. After initial processing, the IMT platform sends the package creation webhook (createPackageEvent) notification to the Partner-hosted endpoint.

3. The Partner service synchronously responds to the webhook by returning package-recipient level email content set by the closer for every recipient that was sent for package completion or an error if the package could not be satisfied.

4. Success or failure is returned to the Closer immediately after processing the Partner response.

5. 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.

6. When the recipient receives the email, and clicks the link, they are prompted to log into the Partner portal.

7. The recipient authenticates and triggers the delivery room.

8. 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.

9. The IMT Platform verifies the session request and returns a Delivery Room Session URL to the Partner service.

10. The Partner service sends the session URL to the recipient.

11. The session URL is loaded into the recipient’s browser and loads (embed/redirect) the Delivery Room UI.

12. 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.

13. When tasks are completed and the recipient leaves the Delivery Room, the recipient is redirected to a status page provided by the Partner.

14. If desired, embedded status data can be used to display subsequent status updates.