Setting up Encompass support

Here's what you need to use Ocrolus and Encompass together.

Ocrolus helps lenders accelerate mortgage decisions by streamlining document-driven workflows and validating data. With our Ocrolus plugin for Encompass, data validation is made easy thanks to document classification and capture capabilities that streamline your loan processing workflows. You don't even have to write any code!

In this guide, we’ll walk you through the process of connecting Ocrolus to your Encompass instance. We'll start by providing Ocrolus with the necessary credentials. After that, we'll create an Ocrolus persona within Encompass that has the permissions it needs. Then we'll create a user with that persona assigned. Finally, we'll install the custom forms that underpin our DocSnapshot and DocIncome features.

Connecting with Ocrolus

First and foremost, you'll need to ensure that Ocrolus has permission to access your data in Encompass. Here are the steps for that:

  1. Provide your account executive with your Encompass client ID (e.g. 30112...) and instance ID (e.g. BE112...).
  2. We'll use this information to request API credentials for Encompass on your behalf. This may take a few business days.
  3. Once we have the Encompass credentials ready, we'll pass them along to you. The rest of this guide explains what you need to do next.


Don't lose your key!

For all practical purposes, the credentials we give you are a password. Only share them with people who need to access your Encompass instance! If your credentials are lost or stolen, contact us and we'll help you replace them.

Create an Ocrolus Persona

You can manage your Ocrolus connection and its permissions by creating a dedicated Encompass persona. Here are the steps for that:

  1. Navigate to the Encompass Settings menu.
  2. Expand the Company/User Setup section.
  3. Select the Personas menu.
  4. Duplicate the Loan Officer persona.
  5. Rename the duplicated persona to something that makes sense to you. For the purpose of this guide, we'll name it Ocrolus API - Loan Officer.

See the Encompass user guide for more details.


The Personas menu in the Encompass Settings window. A persona named "Loan Officer" is highlighted, after having just been copied into a persona named "Ocrolus API - Loan Officer".

Configuring the Ocrolus Persona

You'll need to configure your new Ocrolus persona with access to your eFolder and the document management controls. Select the eFolder tab and adjust the settings as follows:

  • In the General section, enable these permissions:
    • Manage Access to Documents
    • Remove Access From Protected Roles
    • Create/Duplicate Documents
  • In the Unprotected Documents and Protected Documents sections, enable these permissions:
    • Edit Document
    • Edit Document Details
    • Create New Document Name
    • Remove Files from Document

The eFolder tab within the Personas menu, detailing access rights for the newly-created persona. The permissions that should be enabled are highlighted.

Create an Ocrolus API User

Now that you've got an Ocrolus persona set up, we'll create a new user and assign this persona to it. Here's how you can do that:

  1. Navigate to the Encompass Settings menu.
  2. Expand the Company/User Setup section.
  3. Select Organization/Users
  4. Click the Add User button on the user list. Configure the new user as follows:
    • Check the API User box.
    • Enter a User ID that makes sense to you.
    • Enter the API Client ID provided by Ocrolus.
    • Enter a First Name, Last Name, and Email that make sense to you.
    • Add the persona that you previously created to the Personas section.
    • Set the Working Folder to Pipeline.
    • Enable the Access to all loans in the same level setting, and grant Edit access.
    • Enable the Edit Subordinates' Loans setting.
  5. Close the window with the Save button.

The User Details window for a newly-created Encompass user. The fields that must be properly configured for Ocrolus compatibility are highlighted.

Configuring the Ocrolus User

  1. Select Additional Services
  2. Select E-Document Management
  3. Check the box next to the user ID you created earlier.
  4. Save your settings.

The E-Document Management menu, which lists several available users. Many of the listed users have the E-Document Management feature enabled. The user with the ID of "ocrolus-api" is highlighted.

See also

Once your Encompass instance has been connected to Ocrolus, the next step is to configure and map your Encompass folders so Ocrolus can classify uploaded mortgage documents.