Download Postman Collection
Release Notes
Back to All

25.1 Major Release

March 15th, 2025

šŸš§

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

Associates & Milestones (new)

The following API endpoint has been added that enables you to update milestone dates for a specified loan.

EDC-1069

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.

EDC-1119

SCHEMA

V3 Get Field Schema (update)

A new ā€œfieldLockā€ attribute has been added to the contract for the following API endpoint. This attribute indicates a standard calculated field that Encompass shows with a padlock icon.

šŸ“˜

The V1 version of this API was not updated with this enhancement.

EDC-1102

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.

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.

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.

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 print form groups.

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.

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.

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 values for each filter condition, enabling you to retrieve results that match any of the specified values. Example: (ā€™user1ā€™, 'user2', 'user3')

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 updated to return new response attributes including "taskTypeId" and "taskTypeName". The taskTypeName is stored in the metadata object. To retrieve the taskTypeName (if exists), pass the query parameter metadata=true.

EDC-1112, EDC-1115

WEBHOOKS

A new section has been added for webhook subscriptions that document the Default and Extra Payload Event Attributes.

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. In addition, added a new Accessing Borrower Pairs in SSF section to the guide.

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.
  • EDC-1127 - For the V1 Update a Business Contact API, the following validations were added:
    • If the logged in user does not have access, then updating business contacts is not allowed by that user.
    • A private contact cannot be assigned to a public group.
    • A user cannot update a read-only contact.
    • A user cannot update a contact in a public group when that user does not have access to that public group.
    • A user can only update a private contact that the user created.
    • If a user has partial access to a public group, the user cannot update a business contact. User should have access to all public groups that belong to the contact before being able to update that contact.
    • Duplicate entries are not allowed in request payload for Contact Group, Category Custom Fields, and Custom Fields.
  • EDC-1129 ā€“ Fixed an issue in the V3 Update Internal User API when the peerLoanAccess and subordinateLoanAccess attributes were not passed in the body of the update, the API was resetting the attributes to "ReadOnly" even if the user already had those attributes set to ā€œReadWriteā€. With this fix, when the peerLoanAccess and subordinateLoanAccess attributes are not passed, the original values will be retained.

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.
  • EDC-1128 - In the upcoming 25.2 release, a known issue will be fixed for an issue where the V3 Get eFolder History API is not converting the timestamp value to UTC correctly.

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.

  • 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