Client On-boarding of ECC Disclosures Integration

These are the required steps to set up an ICE docs integration with the POS to allow borrowers to review and sign ICE generated documents like disclosures.

ECC ICE Docs Setup Client Requirements

An Encompass Super Admin from the client partner must complete the following steps to enable Maxwell POS to integrate with ICE documents.

If you would like to set up a walk through of this process to ensure that you are completing all the steps correctly we'd be happy to walk you through the setup with a live screenshare. Please reach out to [email protected] to set up a video call.

ICE Docs Setup Steps


1. Pre-requisites Super Admin User in Encompass

To set up ICE disclosures a super admin user will be required to:

  1. Add an SAML SSO connection for Auth0 to sign in to Encompass securely from the Maxwell POS app

  2. Set up and configure Consumer Connect settings for the Encompass instance

  3. Complete UAT and debug docs experience

To set up and Encompass admin go to Encompass Admin portal, go to user management and assign the user a super admin role.

2. Configure SSO Provider in Developer Connect

In order for borrowers to securely connect from the Maxwell POS to Encompass Consumer Connect (ECC) to sign their documents, we need to set up a Single Sign On (SSO) connection between Maxwell and Encompass Consumer Connect sites. This requires Maxwell to provide a SAML metadata file from the identity provider we use login/user management, and for the Encompass admin to upload that document into your Encompass Dev Connect portal.

  1. Reach out to [email protected] via email to request your metadata file.

    1. subject: SSO set up in Developer Connect and in the body of the email

    2. Body: Request the SAML metadata file from Auth0 for {insert organization name}

  2. The Maxwell admin will respond with a .xml file containing your SAML metadata

  3. Go to https://developer.elliemae.com/

  4. At the top right you will see a button with "My Account". Click on the SAML SSO option. In the new page Click Sign In. Log in using Encompass Credentials for the target Encompass instance.

You can do the same from the Encompass Home page in the desktop application. Navigate to Settings > Company/User Setup > Company Information. On the right-hand side, click the Configure SSO button. This will open the SAML Single Sign-On Setup page too.

  1. Click “Add Connection”

  2. Set a unique Connection Name - dashes are not allowed

  3. Set Application Name to “Borrower Portal”

  4. Get .xml SAML Metadata file that was provided by the Maxwell admin in step 2 and upload in the “Upload SAML2.0 metadata file”

  5. Click Save and verify that there are no validation errors

3. Enable Consumer Connect for the Encompass Tenant

  • From the Encompass Home page > Resource Center > Product Solutions > Consumer Engagement > Encompass Consumer Connect > Walk Through Decision Tree link

  • To make sure you have Consumer Connect turned on you can check on the client’s home page and look to see if there is a section for Consumer Connect

4. Configure Consumer Connect to use the SSO provider set up in Dev Connect

After you've set up the SSO Provider and Enabled the Consumer Connect tenant outlined in steps 2 & 3 you can connect your SSO provider to consumer connect.

  1. From your Encompass desktop app (Smartclient) Home tab, look for Consumer Connect Administration on the right side column towards the bottom.

    • If this is not present, then ICE needs to enable Consumer Connect for your Encompass instance.

    • You may be able to enable consumer connect yourself by: Completing the Decision Tree in the Resource Center for this test instance? (From the Encompass Home page > Resource Center > Product Solutions > Consumer Engagement > Encompass Consumer Connect > Walk Through Decision Tree link)

    • If you cannot you'll need to put in an ICE support ticket

  2. Click “Manage your Consumer Connect Portal” - this should open a browser window

  3. Delete any existing sites on the Website Builder Tab

  4. On the Website Builder Tab, enter the url pointing to your POS site and click “Enable SSO”

  5. Check the box that you understand and click continue

  6. Submit a support ticket to ICE with your Encompass instance ID to activate your site. This may take a couple business days for them to activate. A sample request is available in the "Additional Resources" section for reference.

  7. After ICE activates your site, SSO should be enabled for Consumer Connect. If you revisit the developer connect My Account -> SAML SSO, you should see that the SSO connection is now Completed and Activated.

5. Create Consumer Connect Widget

  1. Still in Consumer Connect Admin > Website Builder > Add widgets to your existing website

  1. Under “Please enter the URL of your company website”, enter the Maxwell Borrower Hub site domain

  2. Set Recipient's name and Encompass folder to any value you want, these settings will not be used

  3. Click Create My Widget, verify success

  4. Go to the website builder tab, and click the Icon next to “Copy the borrower portal code snippet”. Paste this code into a text editor. Look for the data-site-id number in the snippet. This is the Consumer Connect Site ID. You will need to provide this ID to your Maxwell on-boarding specialist in phase 6 below.

  1. Turn on the setting for Direct borrowers to SSO Website and click Save

  2. Go to Borrower Loan Portal Tab, and set the following settings to your oganization standards, default settings are below:

    • General Settings / Allow general uploads outside of tasks OFF

    • General Settings / Allow borrowers to upload, eSign, fax or complete a task if status is not Active Loan, Loan Originated or Pre-approval request approved but not accepted? OFF

    • General Settings / Show Create Account button on login page? OFF

    • Navigation Settings / Show navigation menu in borrower portal? OFF

    • Navigation Settings / Show Back link on package details page OFF

    • Contact Settings / Display contact information to borrower? OFF

  3. Click Save, verify success

Do Not Set the Encompass settings for the Encompass tenant to use the Consumer Connect Site.

6. Configure Encompass disclosures settings for email notifications and other workflows

  1. In Encompass -> settings

  2. Go to eFolder Setup -> HTML Email Templates

  3. Find the template for eDisclosures with the Consumer Connect “check”

  1. Modify email to your liking

7. Notify your Maxwell Admin that ECC set up is complete

At this point your Encompass site set up should be complete on your end. Notify your Maxwell on-boarding team that so they can complete the following activities on their end.

  1. In the email provide the "Consumer Connect Site ID" you saved in step 4 of Creating Consumer Connect widget.

  2. Configure Encompass webhooks and pushback endpoints

  3. Complete Auth0 app set up to allow ICE doc urls

8. Complete end to end acceptance testing of Disclosures workflow

  1. Create a loan app in Maxwell POS

  2. Complete the loan app and sync to Encompass

  3. Log into Encompass go to Pipeline tab and select the file (you can search for the borrower name or the loan id)

  4. In the upper right corner of the file click eFolder and select the "eDisclosures" button select product and order eDisclosures

  5. Complete fields identified in auditing checkpoints

  6. Send disclosures

  7. As a borrower in the POS log in to view the disclosures task

  8. SSO into ECC, provide Auth Code, eConsent and open the disclosure doc

  9. Sign docs and complete task

  10. View the Encompass disclosure tracking logs to verify that view and signed events are updated by the borrower

  11. Check the POS task to confirm borrower status is signed (this may require a few moments and a page refresh after the task was completed).

Once your team has completed a satisfactory amount of tests you are ready to use ECC disclosures.

Additional Resources

How to keep a Consumer Connect Client Partner who wants to keep an instance of consumer Connect alongside Maxwell's site

ECC Supports enabling an SSO Connection, but disabling it for existing ECC Sites.

To do this you need to put in a support case for this request. It has to be done on the back end of Encompass setup. An example support ticket for this request is below.

Example Encompass Support Ticket

Description: The following Dev Portal SSO connection for DEBE11136172 needs to be activated for SSO:

Connection ID: (the SSO Connection ID per Dev Connect Portal. Example d73e1905-b1f7-4802-9976-4a58faaaaa>

The following two existing EEC websites on the same Encompass instance, DEBE11136172, need to be disabled for SSO so they will continue to work as normal after SSO is enabled.

i. siteId - 123123123 - admin.mymortgage-online.com

ii. siteId - 456456456 - alexilnicki.mymortgage-online.com

Any of the sites where SSO is disabled will look like the following in the ECC Admin Portal:​​​

Note, you can only disable SSO for existing sites. YOU CANNOT CREATE NEW ECC SITES ONCE SSO IS DISABLED.​

Last updated