Download Postman Collection
Release Notes
Back to All

25.1 Major Release Preview

February 14th, 2025

🚧

Release Preview

This Release Preview is not the Release Notes. Release previews provide you with an early look at the new features and updates that will be provided in the upcoming release. However, in the weeks after this release preview is published, additional information (which can include new items, screen examples, expanded feature descriptions, and step-by-step instructions) will be added. Once all of the information for the release has been added, this "Release Preview" will be relabeled to "Release Notes" and no further planned updates will be made.

🚧

Clear Browser Cache

To ensure you are viewing the very latest of this website, best practice is to clear your browser's cache, especially after any major releases. For instructions on clearing cache, visit a link below for the browser you are using:

Table of Contents

IMPORTANT NOTICES

NOTICE 1: With the scheduled Release to Test (R2T) of Encompass 25.1 on February 15, 2025, ICE will be implementing a temporary change to API error responses for large loan sizes exceeding 6 MB in the 25.1 R2T environment. For more details, review the following Knowledge Article: API Error Response Change for Large Loan Sizes in 25.1 R2T

NOTICE 2: As part of ongoing efforts to modernize Encompass and to further assist with our Encompass SDK Transition, ICE Mortgage Technology is releasing in limited availability a Plugins 2.0 initiative that enables clients to Integrate Encompass Web Plugins with Encompass Desktop. This initiative enables you to

  • run your Encompass web plugins within Encompass desktop.

    ❗️

    At this time, not all Encompass web interface plugin features are supported in the Encompass desktop interface, and vice versa.

  • use the modern, widely supported scripting language JavaScript for coding plugins.
  • access a new Plugin 2.0 Trace Viewer in the Encompass desktop Help menu to view real-time messages and events to troubleshoot your plugins.
  • augment your Encompass SDK Transition work efforts.

📘

Contact your ICE Mortgage Technology relationship manager to learn how to participate in the Plugins 2.0 initiative.

EDC-1113

ENCOMPASS LOAN APIs

Calculators (new)

The following API endpoint has been added that enables you to calculate a date based on one of the Compliance calendars available in Encompass Settings.

  • V3 Compliance Calendar Date Calculator
    POST /encompass/v3/calculators/timerCompletion

EDC-1119

Loan Folder (new)

The following API endpoints have been added that enable you to manage your loan folders.

  • V3 Create Loan Folder
    POST /encompass/v3/loanFolders
  • V3 Delete Loan Folder
    DELETE /encompass/v3/loanFolders/{folderName}
  • V3 Update Loan Folder
    PATCH /encompass/v3/loanFolders/{folderName}

EDC-1070

SERVICES APIs

Encompass Compliance Service (new)

The following API endpoint has been added that enables you to manage the “Order Report” and “Clear Report” permissions for users in Compliance Settings.

  • V1 Manage Compliance Settings Report Permissions
    POST /ecs/v1/settings/user

EDC-1095

SETTINGS and UTILITIES APIs

Settings: Business Contacts (new)

The following API endpoints have been added that enable you to retrieve a list of custom fields, categories, and custom category fields for Business Contacts in Encompass Settings.

  • V3 Get Business Contacts Custom Fields
    GET /encompass/v3/settings/contacts/businessContacts/customFields
  • V3 Get Business Contacts Categories
    GET /encompass/v3/settings/contacts/businessContacts/categories
  • V3 Get Business Contacts Custom Category Fields
    GET /encompass/v3/settings/contacts/businessContacts/customCategoryFields

EDC-1097

Settings: External Organizations - TPO Settings (new)

The following API endpoints have been added that enable you to retrieve global TPO fees, TPO fee details, and TPO late fees for external organizations.

  • V3 Get Global TPO Fees
    GET /encompass/v3/settings/externalOrganizations/tpoFees
  • V3 Get Global TPO Fee Details
    GET /encompass/v3/settings/externalOrganizations/tpoFees/{feeId}
  • V3 Get Global TPO Late Fees
    GET /encompass/v3/settings/externalOrganizations/tpoLateFees

EDC-1122

Settings: Loan Print Forms (new)

The following API endpoints have been added that enable you to retrieve a list of standard and custom print forms, a list of standard print forms for a loan, and details of custom print form groups.

  • V3 Get List of Print Form Groups
    GET /encompass/v3/settings/loan/printFormGroups
  • V3 Get Custom Print Form Group Details
    GET /encompass/v3/settings/loan/printFormGroupDetail
  • V3 List of Standard Print Forms
    GET /encompass/v3/settings/loan/standardPrintForms
  • V3 Get List of Custom Print Forms
    GET /encompass/v3/settings/loan/customPrintForms
  • V3 Get List of Standard Print Forms for a Loan
    POST /encompass/v3/calculators/standardPrintForms

EDC-1103, EDC-1098

Settings: Milestones (new)

The following API endpoints have been added that enable you to retrieve a list of milestone settings currently configured in the system and retrieve details for specific milestone settings based on a given milestone ID.

  • V3 Get List of Milestones
    GET /encompass/v3/settings/milestones
  • V3 Get Details on Specific Milestone
    GET /encompass/v3/settings/milestones/{milestoneId}

EDC-548

Settings: Roles (new)

The following API endpoints have been added that enable you to retrieve a list of Encompass roles, details for a specific Encompass role based on a given role ID, and the mapping between fixed roles (designatedRole) and predefined Encompass roles.

  • V3 Get List of Roles
    GET /encompass/v3/settings/roles
  • V3 Get Specific Role Details
    GET /encompass/v3/settings/roles/{roleId}
  • V3 Get Role Mappings
    GET /encompass/v3/settings/roles/roleMappings

EDC-1106

Settings: Internal Users (update)

The V3 Get a List of Internal Users API has been enhanced to enable using the IN operator to filter by multiple user IDs in a single call. Example: (’userId1’, 'userId2', 'userId3')

EDC-1096

Settings: External Users (update)

The External Users Contract has been enhanced to include a new ‘designatedRoleRefs’ attribute. This replaces the existing attribute ‘DesignatedRoles’ which will be deprecated in the upcoming 25.3 release scheduled for Q4 of 2025. The field format of the entityId in the new ‘designatedRoleRefs’ attribute is made consistent with other APIs like V3 Get Role Mappings.

EDC-1100

WORKFLOW MANAGEMENT APIs

Tasks and Task Templates (updates)

The following API endpoints have been enhanced to include the ability to retrieve all tasks by a new ‘taskTypeName’ parameter and retrieve all task templates by new ‘taskTypeName’ or new ‘taskTypeId’ parameters.

The following API endpoints have been enhanced to take advantage of the new ‘taskTypeId’ attribute. This attribute can now be set when creating tasks/task templates or revised when updating tasks/task templates.

EDC-1112, EDC-1115

UPCOMING BREAKING CHANGES

Encompass Developer Connect 25.3

Settings: External Users

The ‘DesignatedRoles’ attribute in the External Users Contract will be deprecated in the upcoming 25.3 release scheduled for Q4 of 2025. This attribute is being replaced with the ‘designatedRoleRefs’ attribute.

Deprecating "status" Attribute in eFolder Document Contract

ICE Mortgage Technology will be deprecating the "status" attribute in the eFolder Document Contract in the upcoming 25.3 release scheduled for Q4 of 2025. The following API endpoints now use the more relevant "documentStatus" attribute in favor of the "status" attribute:

🚧

Please begin efforts to discontinue further usage of the "status" attribute before release 25.3.

EDC-1121

GUIDES

EDC-1086 – Updated the Encompass Customization Developer’s Guide to mention that the guide includes Encompass desktop (a.k.a., SmartClient) compatibility along with Encompass web.

FIXED ISSUES

PSS-84937 – Fixed an issue where the response payload for the SCIM GET (Get User) and POST (Create User) API endpoints included an empty array when a phone number was absent or removed from the user profile (e.g, "phoneNumbers": []). Now when this scenario occurs, the empty array will not be included in the response payload.

KNOWN ISSUES

Summary of the Known Issue:

Enhanced Field Change Webhook Truncation Due to Field Size Limit

SUP-54292 – When the Enhanced Field Change webhook payload contains an excessively large string field of approximately 55KB, the webhook drops the entire extra payload. Although the webhook notification is delivered to the given endpoint, it is sent with an empty payload. This issue will be resolved in a future release of Encompass.

POSTMAN FILE UPDATES

The following Postman files have been updated to support release 25.1. All new and updated samples are prefixed with "25.1R" for each reference. NOTE: Postman files are not updated during the release preview window.

  • Encompass Developer Connect Postman Collection
  • Encompass Developer Connect Postman Environment Variables

See Testing with Postman for more details and to download the latest versions of each Postman file.

UI-UX IMPROVEMENTS

  • In the API Reference section, the Schema APIs were moved out of the ENCOMPASS LOAN category to a new ENCOMPASS SCHEMA category to improve usability.
  • EDC-1118 – Updated the Credit Partners and Samples and AUS Partners and Samples pages to bring them up to date with the latest GSA Credit Provider Codes.
  • A new Calculators section has been added to the ENCOMPASS LOAN category to contain all calculator APIs. The Loan Calculations API documentation has been moved from SETTINGS AND UTILITIES to this new location.
© ICE Mortgage Technology, Inc. All rights reserved. Terms of Use