Encompass Integration - API

Connect Ocrolus with an ICE instance

To provide Classify and Capture support for common mortgage form types, integrate Ocrolus with your ICE Encompass Instance.

  1. The Lender supplies Ocrolus with the Encompass lender client ID (e.g. 30112…) and the lender client instance ID (e.g. BE112…). To avoid delays in lower environment testing, it is standard for Ocrolus to ask the Lender for UAT and Production keys simultaneously.
  2. Ocrolus emails ICE to receive an API User key and secret.
  3. Ocrolus provides the API User Client ID (not the client secret) and account email address to the Lender. Requesting a client instance ID can take 3-5 business days.
  4. The Lender adds the API User client ID as an API user in Encompass. For Information about how to complete this step, see "Add API user Client ID as an API User".

Set up an Ocrolus persona

After Ocrolus provides the API user client ID to the client Encompass Administrator, create a new persona within the client lender instance. The persona allows granular control of Ocrolus API's permissions.

  1. Access Encompass Settings.
  2. Expand Company/User Setup.
  3. Select Personas.
  4. Duplicate the Loan Officer persona.
  5. Rename the duplicate Loan Officer persona as “Ocrolus API - Loan Officer”.
The above image shows the location where you create the Ocrolus API - Loan Officer persona.The above image shows the location where you create the Ocrolus API - Loan Officer persona.

The above image shows the location where you create the Ocrolus API - Loan Officer persona.

Provide eFolder access to an Ocrolus API persona

After creating the "Ocrolus API - Loan Officer" persona, grant the persona access to the eFolder and Document Management Controls.

  1. Select the eFolder tab.
  2. On the General tab, select “Manage Access to Documents”.
  3. Select “Edit Document Details” and “Create New Document Name” in Unprotected Documents.
  4. Select “Edit Document Details” and “Create New Document Name” in Protected Documents.
  5. On the LO Connect tab, confirm access to LO Connect Mobile.
The above image shows the location where you manage Ocrolus API - eFolder access.The above image shows the location where you manage Ocrolus API - eFolder access.

The above image shows the location where you manage Ocrolus API - eFolder access.

Add API user Client ID as an API user

In the client, add the “Ocrolus API- Loan Officer” as a user using the email and clientId from Ocrolus.

  1. Check the API user box.
  2. Add “Ocrolus API- Loan Officer” as a user.
  3. Add the email and clientID from Ocrolus.
  4. Change the Working Folder to “Pipeline”.
  5. Click Save.
The above image shows the location where you add a user in an Encompass instance.The above image shows the location where you add a user in an Encompass instance.

The above image shows the location where you add a user in an Encompass instance.

The above image shows the interface where you add the Ocrolus API user.The above image shows the interface where you add the Ocrolus API user.

The above image shows the interface where you add the Ocrolus API user.

Access subordinate loans

After uploading the working folder, ensure that the Ocrolus API user can access the subordinate loans.

  1. Access the user details page for the Ocrolus API account.
  2. Ensure ‘Access to all loans in the same level’ is checked.
  3. Check ‘Edit’.
  4. Ensure ‘Edit Subordinates’ Loans’ is checked.
  5. Click Save.
The above image shows the proper settings for Subordinate Loan Access.The above image shows the proper settings for Subordinate Loan Access.

The above image shows the proper settings for Subordinate Loan Access.

Provide E-Document user access

To grant Ocrolus access to E-Documents, perform the following steps:

  1. Select Additional Services.
  2. Select E-Document Management.
  3. Check the box beside user ID.
  4. Click Save.
The above image shows the interface where you add the Ocrolus API user to E-Document Management.The above image shows the interface where you add the Ocrolus API user to E-Document Management.

The above image shows the interface where you add the Ocrolus API user to E-Document Management.

Grant user group access to loans

Create a user group and verify it has access to the appropriate loans.

  1. Select Company/User Setup.
  2. Select User Groups.
  3. Select the plus sign to create a new group and give it a title.
  4. On the Members tab, use the dialogue to add the Ocrolus API user.
  5. On the Loans tab, verify the loan folders for sending applications are included. We recommend that you grant access to all folders.
The above image shows how to create a User Group.The above image shows how to create a User Group.

The above image shows how to create a User Group.

The above image shows the folders that Ocrolus should have access to.The above image shows the folders that Ocrolus should have access to.

The above image shows the folders that Ocrolus should have access to.


See also

After Ocrolus set up has been completed, the Classification component of the Integration can be executed on. Information of Classification integration can be found here

Did this page help you?