Major 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 Major Release Preview is published, the release preview page may change with items being added, modified, or removed. When a final draft of the Major Release is published, the “Preview" label is removed and no further planned updates are made to it.
As part of a modernization effort for ICE API documentation, the layout of API Reference is undergoing reorganization. Over time, you will see API endpoints moved to more logical categories and groupings. In addition, the standalone contract pages will be slowly going away, and the details of the request and response bodies will be contained within each endpoint definition. The following API endpoints are a few examples:
Update PingID® Mobile App to Maintain Push Authentications on Android
Starting March 6, 2026, an Android security update from Google will impact older versions of the PingID® mobile app. If you’re using the Android edition of the PingID® mobile app with a version earlier than 3.3.1, you will not be able to approve login requests via push notifications.
Who is affected - Encompass customers who use the Android edition of the PingID® mobile app as their multi-factor authentication (MFA) provider when logging into Encompass or other ICE Mortgage Technology applications.
What You Need to Do - To keep logging in without interruptions, update the PingID® mobile app to version 3.3.1 or later on your Android device.
🚧
After March 6, 2026, older versions will no longer support push notifications.
SSO and MFA Administration Changes Coming in Release 26.2
Currently, administrators managing their company's Single Sign-On (SSO) and Multi-Factor Authentication (MFA) setup and preferences utilize the setup screens located in Encompass Developer Connect. With the Encompass 26.2 release currently planned for July 2026, these settings will be removed from Encompass Developer Connect. Beginning in 26.2, these settings will now be provided in the Encompass web interface's Admin portal, in addition to Encompass desktop interface. Existing setup and configuration settings will not be impacted and hence administrators will not be required to reconfigure their existing SSO and MFA setup. More information will be provided about this update in the coming weeks.
EDC-1270
ENCOMPASS SOFTWARE DEVELOPMENT KIT (SDK)
❗️
SDK to API Transition Deadline Change
The deadline to transition from legacy Encompass SDK (Software Development Kit) integrations to APIs (as previously announced in the 25.2 release notes) has changed. Please see the latest deadline information published in the official Encompass SDK Transition page.
CONSUMER ENGAGEMENT APIs
New Pre-population Use Cases Added to Create Invitation URL API (update)
The Create Invitation URL API has been enhanced to include two new pre-population use cases. The API will now perform the following:
Pre-populate and map borrower residential address with subject property address.
Pre-populate the HELOC fields on the loan details screen.
EDC-1259
ENCOMPASS LOAN APIs
Pagination and View Added to Get Attachment APIs (update)
New pagination and view parameters have been added to the following APIs for improved performance:
V3 Get an Attachment GET /encompass/v3/loans/{loanId}/attachments/{attachmentId}
EDC-1241
Restricted Attribute Added for Resource Lock APIs (update)
📘
Your company must be participating in Encompass desktop Shared Lock Limited Availability feature to receive this functionality.
A new 'restricted' attribute has been added to the contracts for the following Resource Lock APIs. This attribute indicates that the resource lock is restricted for certain operations because the loan is also open in Encompass desktop. Restricted loan operations are prohibited by the API user, while the loan remains open in Encompass desktop. The restricted operations include the following: Create or Delete Borrower Pair, and Swap/Move Borrowers
New Query by Compliance Fields Import Option (update)
The following API has been updated to include a new 'complianceFieldsImportOption' query parameter to specify import options of Correspondent Compliance fields from the MISMO 3.4 loan file (i.e., Mavent fields).
You can specify one of the following options with this query parameter:
IncludeComplianceFields - The default value and indicates import all fields.
ComplianceFieldsOnly - Use for importing only compliance fields.
SkipComplianceFields - Use for skipping compliance fields while importing.
EDC-1267
New Borrower Associations and Verification Validations (update)
The following API has been enhanced to retrieve borrower/coborrower associations and URLA verification record associations. To facilitate these new enhancements, new 'borrowers' and 'verifications' attributes have been added.
These new attributes are currently in beta mode and are not ready for production use.
EDC-1262
SECONDARY and TRADES APIs
New Loan Trade APIs (new)
The following APIs have been added to enable creating/managing Loan Trades, assigning/updating loans on a Loan Trade and managing Loan Trade documents:
Create Loan Trade POST /secondary/v1/trades/loanTrades
Get Loan Trade GET /secondary/v1/trades/loanTrades/{tradeId}
Get Trade Document Upload URL POST /secondary/v1/trades/urlGenerator
Get Trade Document Download URL POST /secondary/v1/trades/downloadUrlGenerator
New Update Assigned Loans for Correspondent Trade API (new)
The following new endpoint has also been added to the Correspondent Trade APIs:
Update Assigned Loans in a Correspondent Trade PUT /secondary/v1/trades/correspondent/{tradeId}/loans/update
Trade API Enhancements (update)
As part of these trade API enhancements, the following endpoints have been updated to include options to retrieve by Loan Trade in addition to Correspondent Trade:
Get Trade Pipeline of Correspondent Trade retitled to Create Trade Pipeline POST /secondary/v1/tradePipeline
The following API has been added that enables retrieving eFolder document group settings.
V3 Get eFolder Document Groups GET /encompass/v3/settings/eFolder/documentGroups
EDC-1272
SETTINGS - EXTERNAL COMPANY SETUP APIs
New Get List of Available External Site URLs API (new)
The following new API endpoint has been added that enables you to retrieve a full list of TPO Connect site URLs that are not marked as deleted and are available to add to an external organization:
V3 Get List of Available External Site URLs GET /encompass/v3/settings/externalOrganizations/tpoSettings/externalUrls
EDC-1238
New Sort and Filter Functionality for Get External Orgs (update)
The following API has been enhanced to support new 'filter' and 'sort' query parameters.
The API results can now be sorted and filtered for certain attributes/scenarios. See details in the table below:
Query Parameter
Description
filter
Use to filter the results by any of the following:
- siteId- The ID of the site URL.
- Name- The name of the org.
- companyName - The name of the org when the org type is 'company'.
- branchName - The name of the org when the org type is 'branch'.
- siteId- The ID of the site URL.
- Name- The name of the org.
- companyName - The name of the org when the org type is 'company'.
- branchName - The name of the org when the org type is 'branch'.
The API results can now be sorted and filtered. See details in the table below:
Query Parameter
Description
filter
Use to filter the results by any of the following:
- OrgName - The organization name associated to the user.
- CompanyName - The company name associated to the user.
- BranchName - The company branch name associated to the user.
- FirstName - The user's first name.
- LastName - The user's last name.
- EmailId - The user's email address.
- Phone - The user's phone number.
- PersonaId - The Persona IDs associated to the user.
- PersonaName - The Persona Names associated to the user.
- siteId - The ID of the site URL for the organization associated to the user.
- DesignatedRoleId - The Designated Role IDs associated to the user.
- DesignatedRoleName - The Designated Role Names associated to the user.
- RoldId - The Role IDs associated to the user.
- RoleName - The Role Names associated to the user.
sort
Use to sort the results by any of the following:
- OrgName - The organization name associated to the user.
- CompanyName - The company name associated to the user.
- BranchName - The company branch name associated to the user.
- FirstName - The user's first name.
- LastName - The user's last name.
- EmailId - The user's email address.
- Phone - The user's phone number.
- PersonaId - The Persona IDs associated to the user.
- PersonaName - The Persona Names associated to the user.
- siteId - The ID of the site URL for the organization associated to the user.
- DesignatedRoleId - The Designated Role IDs associated to the user.
- DesignatedRoleName - The Designated Role Names associated to the user.
- RoldId - The Role IDs associated to the user.
- RoleName - The Role Names associated to the user.
EDC-1271
SETTINGS - LOAN SETUP APIs
New ICE BI Dashboard Indicator for Loan Folder APIs (update)
The contracts for the following Loan Folder API endpoints have been enhanced with a new 'includeInIceBiDashboard' attribute. This new boolean attribute indicates when the loan folder is included in the ICE Business Intelligence (BI) dashboard.
This 'includeInIceBiDashboard' attribute requires having the ICE BI Dashboard feature enabled. Contact Client Support for more information about this feature.
EDC-1265
New Loan Folder APIs (new)
The following new API endpoints have been added that enable you to manage your loan folders.
V3 Create Loan Folder POST /encompass/v3/loanFolders
The following API has been added that enables retrieving Area Median Income (AMI) limit settings configured in Encompass > Settings > Table and Fees > Affordable Lending > AMI Limits.
V3 Get Area Median Income Limit Settings GET /encompass/v3/settings/fees/affordableLending/amiLimits
EDC-1264
New API to Retrieve MFI Limit Settings (new)
The following API has been added that enables retrieving Median Family Income (MFI) limit settings configured in Encompass > Settings > Table and Fees > Affordable Lending > MFI Limits.
V3 Get Median Family Income Limit Settings GET /encompass/v3/settings/fees/affordableLending/mfiLimits
EDC-1263
TASK APIs
Soft Delete Enhancement for Task Instance Management APIs (update)
The following API endpoints have been enhanced to no longer include tasks and subtasks associated with soft and hard deleted loans.
Get a Subtask GET /workflow/v1/tasks/{taskId}/subtasks/{subTaskId}
All the endpoints listed above will include a new 'isSoftDeleted' attribute in their contracts to indicate when the loan the task and/or subtask is associated to has been soft or hard deleted.
EDC-1258
WEBHOOKS
Loan Resource Webhook Events (new)
A new Loan resource DisclosureTracking webhook event has been added.
❗️
This new webhook event is currently only in beta mode and not generally available.
EDC-1249
BREAKING CHANGES
👍
Be sure to visit the Breaking Change Notices page to see a list of ALL breaking changes documented for past and future releases.
Breaking Changes for 26.1 Release
Enhancing Error Message Descriptions for Updating Custom Fields
As previously mentioned in the 25.4 Release Notes as upcoming 26.1 breaking changes, a series of APIs have been updated to enhance error message descriptions for errors involving Custom Field updates. This is to better align with error messaging standards. For details regarding the APIs involved and the new errors, see the full notice in the 26.1 section of the Breaking Change Notices page.
As previously mentioned in the 25.4 Release Notes as upcoming 26.1 breaking changes, the following APIs have been updated to enforce persona controls. The calling user must have a super admin persona to retrieve a list of Custom Data Objects (CDOs). To ensure that partners without admin access can create and manage their own CDOs, the access controls for the V1 Create or Replace Global CDO endpoint has also been updated to remove the admin persona check. These updates represent breaking changes.
Deprecating "status" Attribute in eFolder Document Contract
As previously mentioned in the 25.1 release notes, the "status" attribute in the eFolder Document Contract has been deprecated with this 26.1 release. The following API endpoints now use the more relevant "documentStatus" attribute in favor of the "status" attribute:
Discontinue usage of the "status" attribute in favor of the "documentStatus" attribute.
EDC-1121, EDC-1235
Breaking Changes for 26.2 Release
Removal of ‘fundingFees’ Attribute in Loan Contract
As previously mentioned in the 25.4 Release Notes as upcoming breaking changes, the following APIs will now be updated in upcoming release 26.2 to no longer return the ‘fundingFees’ attribute inside the fundingFees object in the loan contract. This represents breaking changes to these APIs.
V3 Loan APIs to Return Custom Fields as "null" Instead of Empty
Beginning with release 26.2, the responses on the following APIs will begin returning "null" instead of empty strings on Custom Fields when the 'includeEmpty' attribute is true and the Custom Fields have no value. This represents a breaking change to these APIs.
The breaking change performance improvements regarding V3 Get All External Users mentioned in earlier release notes as an upcoming 26.1 breaking change has been moved to release 26.3. The default behavior of this API will be updated with the following enhancements for improved performance:
The API will return the response with minimal data as summary when the entities query parameter is not passed. See sample code below:
The API will return only 10 records as default response when there are no pagination query parameters passed.
EDC-1143, EDC-1256
DEPRECATION and SUNSET NOTICES
👍
Be sure to visit the Deprecation and Sunset Notices page to see a list of ALL deprecations and sunsets documented for past and future releases.
Deprecations and Sunsets for 26.1 Release
Settings: Disclosure Tracking
A series of Disclosure Tracking settings objects have been deprecated. For details regarding the specific objects and affected APIs, see the full notice in the 26.1 section of the Deprecation and Sunset Notices page.
EDC-1210, EDC-1233
Deprecating V1 Loan Importer to Create Loan API
As of release 26.1, the following endpoint will be deprecated and will no longer be supported:
V1 Loan Importer to Create Loan POST /encompass/v1/importers/loan
🚧
Discontinue using this API endpoint and transition to using the V3 Converter to Import New LoanPOST /encompass/v3/converter/loans endpoint instead.
EDC-1250
Deprecations and Sunsets for 26.3 Release
Sunsetting V1 eFolder Attachment APIs
As part of a data center migration, a series of V1 eFolder Attachment APIs will be sunset in the upcoming 26.3 release. For more details, see the Deprecation and Sunset Notices page.
EDC-1186
GUIDES
Plugin Best Practices (new)
A new series of best practices regarding Plugins has been added to the Best Practices section. See Plugin Best Practices.
EDC-1260
FIXED ISSUES
EDC-1252 - Fixed an issue where the V3 Get Loan API was not honoring the 'Persona Access to Loan" business rule and was allowing access to loan "Edit Custom Access" objects the rule was restricting. The API no longer returns these loan objects the business rule is restricting.
EDC-1244 - Prior to release 26.1, the loan attribute 'useEnhancedConditionIndicator' in the Loan Contract was not writable after loan creation. From release 26.1 forward, this attribute can be changed if no conditions (enhanced or standard) exist in the loan. Prior to release 26.1, there was an issue with the following standard conditions endpoints where the APIs were allowing to create standard conditions even when the loan was enabled for enhanced conditions. Starting with the 26.1 release, the APIs will fail with a 500 error if the 'useEnhancedConditionIndicator' attribute in the loan is set to true. This 500 error will be corrected to a 4xx error in an upcoming release.
EDC-1274 - As part of the 25.4 December Service Pack 2 release, an update was made to the SCIM Get Users API to retrieve a list of users for the DDA schema. An issue occurred with this update where the API response was by default returning a list of disabled users only if the 'enabled' filter was not set to true. As part of this fix, the API response now returns both the enabled and disabled DDA SCIM users when the 'enabled' filter is not sent.
KNOWN ISSUES
EDC-1253 - When attempting to move the borrower to co-borrower on an application using V1 Move Borrower Pair, the system enforces both Persona Access to Loan (PAL) and Persona Access to Fields (PAF) rules. As a result, the move application operation may fail even when the user has valid permission to move the application and borrower pair. In upcoming release 26.2, this issue is being fixed. The expected behavior after the fix is if the user has access to the loan, the user can move the borrower to co-borrower on an application.
EDC-1276 - Field Change webhook events may not be delivered in specific scenarios where the loan creation or update that triggers the event contains a payload larger than 250 KB. When this occurs, subscribers may not receive the corresponding Field Change webhook notification. This issue will be resolved in the 26.2 major release.
LOAN SCHEMA CHANGES
The Encompass Loan Schema is updated with every major release to include new fields and update existing fields to support new features and to stay up-to-date with regulatory requirements. For the full list of the added and update fields, please refer to the following links:
The following Postman files have been updated to support release 26.1. All new and updated samples are prefixed with "26.1R" for each reference. NOTE: Postman files are not updated during the release preview window.
The SCIM Get Users API for the EncompassInternalUser schema is being enhanced to include a new query parameter called 'attributes' to support the inclusion of personas and license objects in the response.
In addition, the SCIM Get Users API for the AIQUser (DDA) schema is being enhanced to support the retrieval of a user list in the response. Prior to this change, you could only retrieve one user at a time from the DDA product by passing the userName filter in the Get Users API. Now, the userName filter is not required when retrieving the user list for the AIQUser schema.
The following fixed issues were resolved as part of this Service Pack.
PSS-88957 - Previously, when creating a SCIM user via the POST /scim2/v1/users API, the system returned a 201 status code indicating success, even if the user limit had been exceeded and the user was not actually created in Encompass.
With this fix, the API now returns an error response if the user limit is exceeded and the user record cannot be created in Encompass.
PSS-88646 - Previously, the SCIM Create User API returned a 201 Created response when the entityId field in the Organization object was provided as an unquoted integer (e.g., 7) instead of a string (e.g., "7"), as required by the API specification. The API did not return a validation error and responded with an empty body ({}), while no user was created in Encompass. With this fix, the API now validates the entityId format and returns an appropriate error if the value is not a string.
The following APIs have been enhanced to support fulfillment delivery based on the selection made in the Schedule Fulfillment For setting in Encompass. This setting can be enabled in the Additional Services > eDisclosure Fulfillment Settings.
Send Opening Package POST /encompassdocs/v1/documentOrders/opening/{docSetOrder_id}/delivery
Send Forms POST /encompassdocs/v1/documentOrders/forms/{docSetOrder_id}/delivery
Usage Notes
When the All Borrowers and NBOs option is selected in the ‘Schedule Fulfillment For’ setting, the request payload for Send Opening Package must include the borrower contact details in both the fulfillments (array of objects) and package object.
When the Primary Borrower Only (per pair) option is selected in the ‘Schedule Fulfillment For’ setting, the request payload for Send Opening Package must include the primary borrower contact details in both the fulfillments (array of objects) and package object.
If the contact details are not included in both the fulfillments (array of objects) and package object, the recipient will not receive the physical print package. However, if the contact details are included only in the package object and not the fulfillments (array of objects), the recipient will still receive the digital package.
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:
As part of a modernization effort for ICE API documentation, the layout of API Reference is undergoing reorganization. Over time, you will see API endpoints moved to more logical categories and groupings. In addition, the standalone contract pages will be slowly going away, and the details of the request and response bodies will be contained within each endpoint definition. The following API endpoints are a few examples:
The deadline to transition from legacy Encompass SDK (Software Development Kit) integrations to APIs (as previously announced in the 25.2 release notes) has changed. Please see the latest deadline information published in the official Encompass SDK Transition page.
Updated Versions of RestSharp and Other DLL Files
DLL files for Encompass have been updated to newer versions. If you are using the Encompass SDK and have specific versions of these DLLs referenced in your SDK, then the applications will break. Please refer to the table below for the impacted files and the new versions, and upgrade the files accordingly to avoid issues with the SDK:
“NoDiff”, “Diff” “Removed” Note: This attribute is included in the response when the document order is regenerated for a given loan.
If you initially generated an Opening Doc Set or a Closing Doc Set on a given loan using the Generate Opening Doc Set or Generate Closing Doc Set endpoints and later regenerated the Opening Doc Set or Closing Doc Set for the same loan due to changes in the loan data, some documents may have been removed from the updated document set.
If the response from the Get Opening Order Status GET/encompassdocs/v1/documentOrders/opening/{orderId} for the given Opening Doc Set, includes the attribute "difference": "removed" for any of the documents included in the Order Status, the documents denoted as "removed" MUST NOT be included in the Send Opening Package POST/encompassdocs/v1/documentOrders/opening/{docSetOrder_id}/delivery API request. Otherwise, an error will occur in document delivery.
If the response from the Get Closing Order Status GET/encompassdocs/v1/documentOrders/closing/{orderId} for the given Closing Doc Set includes the attribute "difference": "removed" for any of the documents included in the Order Status, the documents denoted as "removed" MUST NOT be included in the Send Closing Package POST/encompassdocs/v1/documentOrders/closing/{docSetOrder_id}/delivery API request. Otherwise, an error will occur in document delivery.
EDC-1226
ENCOMPASS LOAN APIs
Good Faith Fee Variance Violations (new)
The following API has been added that enables you to retrieve detailed information about Good Faith Fee Variance violation alerts on a loan (i.e., the final cost of certain settlement fees exceeds the amount estimated on the Loan Estimate, – cannot change more than 10 percent by category).
All loan APIs have been enhanced to automatically populate TPO loan entity fields from TPO external organization settings when certain fields are changed. For example, changes to any of the following fields (directly or through Business Rules) will trigger a copy from the external organization settings data down to the TPO entity on the loan:
TPO.X15 (Company ID)
TPO.X39 (Branch ID)
TPO.X62 (Loan Officer ID)
TPO.X75 (Loan Processor ID)
TPO.X96 (Correspondent ID)
This functionality was previously implemented by calling Create Loan and Update Loan APIs with the 'tpoRegister' loan action. Now, the copy of the external org settings to the loan will be accomplished by updating one or more of the fields mentioned above in the payload.
EDC-1206
SERVICES APIs
FNMA Mission Score Support for ICE PPE (update)
The following ICE PPE API has been enhanced to support the Fannie Mae Mission Score API.
Updated Default Behavior for External Orgs (update)
The default behavior for external organizations has been updated. As of release 25.4, the following API has been updated to filter the orgs when accessed by an external user (TPO) and internal users with the "sales rep/AE" persona. By default, external users will be limited to the API response data associated to the org they are assigned to. If the logged in user is an external user, the API will only return the list of orgs that the user is associated with and any child orgs (if isRecursive=true). For internal users with "sales rep/AE" persona, the list of organizations will be limited to organizations for which they are assigned as "sales rep/AE". For additional details regarding the new behavior, see the table below.
Refer to the use case scenarios mentioned below for more details:
Scenario
Existing Behavior
New Behavior
Current user is external user.
User can see all external orgs in API response.
User can see external orgs in its hierarchy, above its current org, and all child orgs if 'isRecursive' is True.
Current user is external user and has "sales rep/AE" persona.
User can see all external orgs in API response.
User can see external orgs in which current logged-in user is added as sales rep/AE.
Current user is internal user and has "sales rep/AE" persona.
User can see all external orgs in API response.
User can see external orgs for the organizations for which they are assigned as "sales rep/AE".
EDC-1205
Settings: External Users (updates)
Updated Access Controls to Retrieve External Users
The following API has been enhanced to limit the number of records returned in the API response when accessed by an external user. With this release, external users are limited to seeing the list of users within their org hierarchy. For additional details regarding the new behavior, see the table below.
Refer to the use case scenarios mentioned below for more details:
Scenario
Existing Behavior
New Behavior
Current user is external user.
User can see all external users in API response.
User can see external users within the user's current org, and all child orgs if 'isRecursive' is True. If the user passes the query orgId parameter outside their org hierarchy, an empty result set is returned.
Current user is external user and has "sales rep/AE" persona.
User can see all external users in API response.
User can see external users for organizations where they are added as a sales rep/AE.
EDC-1179, EDC-1205
Support for Org ID Value = 0 (Not Ready for Production Use)
The following API has been enhanced to allow orgId = 0 or no value in the 'orgId' query parameter. However, please note that this feature is not ready for production use.
When 'orgId' and 'tpoId' parameters are not provided, the API now defaults the parameters to 0 instead of returning an error.
If orgId=0 and isRecursive=false, the API now returns all users of the organization(s) from which the logged-in user has access, including users from the Branch and Extension.
❗️
Known Issue
The support for orgId = 0 has a known performance issue when the data is retrieved without pagination. This issue will be fixed in an upcoming release. In the meantime, when testing this feature, the API must always be used with pagination parameters with page size not exceeding 1000.
EDC-1209
Settings: Disclosure Tracking (update)
The following API has been enhanced to include a new property to indicate the default delivery method when disclosures are printed:
The following new objects have been added to enable supporting nested, parent/child settings relationships:
RecordingOfDisclosures - Replacing the existing 'disclosureRecordingTriggers' object planned for deprecation in release 26.1. Describes how disclosure entries are added to the Disclosure Tracking tool.
CopyOfDisclosures - Replacing the existing 'saveDisclosureCopy' object planned for deprecation in release 26.1. Defines whether Encompass is to save a local copy of a disclosure document when it is printed or sent electronically from within the eFolder.
ChangeInCircumstances - Replacing the existing 'changedCircumstances' object planned for deprecation in release 26.1. Indicates whether fee level disclosures are required to indicate a changed circumstance reason for each revised fee prior to sending a revised disclosure.
EarliestClosingDate - The earliest closing date.
OptInForSundayClosings- (boolean) Indicate True to opt in for Sunday closings.
OptInForFederalHolidayClosings - (boolean) Indicate True to opt in for federal holiday closings.
EDC-1210
Settings: Personas (update)
The following API has been enhanced to increase the maximum records per page from 100 to 1000:
The records per page is determined by the following:
If the 'limit' parameter value is not provided, the API defaults to 100 records per page.
If the 'limit' parameter value provided is between 1 and 1000, the API returns that number of records per page, up to 1000.
If the 'limit' parameter value provided is greater than 1000, the API returns up to 1000 records per page.
EDC-1211
BREAKING CHANGES
V3 APIs No Longer Return Empty Collections
A series of V3 APIs have been enhanced to align with the standard V3 API pattern to not return empty collections in the response. Prior to this fix, empty collections (i.e., no records in the array) were returned in the response. Starting with the 25.4 release, no empty collections will return.
Enhancing Error Message Descriptions for Updating Custom Fields
In the upcoming 26.1 release, changes are being made to a series of APIs to enhance error message descriptions for errors involving Custom Field updates. This is to better align with error messaging standards. For details regarding the APIs involved and the new errors, see the full notice in the 26.1 section of the Breaking Change Notices page.
EDC-1223, EBSP-62917
Get Loan Returning EncompassToEncompassLogs and InvestorDeliveryLogs
The following API endpoint has being enhanced to return EncompassToEncompassLogs and InvestorDeliveryLogs collections with view=entity versus previously being considered logs collections that returned with view=logs. This update represents a breaking change to this endpoint. If you need to retrieve these logs, please update the parameter view=entity to avoid disruptions.
As mentioned earlier in the 25.3 release notes and the Breaking Changes Notices, as of release 25.4, the value for the 'entityType' attribute in the Organization Entity Ref property of the External User contract will return as "ExternalOrg" instead of "Organization" to distinguish between an internal and external organization. This affects the following APIs:
The eFolder persona setting “Send Files to Lender” was recently removed from Encompass. Therefore, starting with release 25.4, the following APIs will no longer return the “SendFilesToLender” persona setting:
Removal of ‘fundingFees’ Attribute in Loan Contract
With the recent release of V3 Get Funding Fees and V3 Update Funding Balances APIs, the following API endpoints will no longer return the ‘fundingFees’ attribute inside the fundingFees object in the loan contract as of upcoming release 26.1. This represents a breaking change to these APIs.
Please begin efforts to discontinue further usage of the "fundingFees" attribute in these APIs by release 26.1. Begin using V3 Get Funding Fees and V3 Update Funding Balances APIs as alternatives.
EDC-1217
Admin Control Enforcement
The following API is being updated in release 26.1 to enforce persona controls. The calling user must have a super admin persona to retrieve a list of Custom Data Objects (CDOs). To ensure that partners without admin access can create and manage their own CDOs, the access controls for the V1 Create or Replace Global CDO API (PUT /encompass/v1/company/customObjects/{objectName}) will also be updated in release 26.1 to remove the admin persona check. This will represent a breaking change.
As previously documented, the ‘designatedRoles’ attribute in the External Users Contract was deprecated in 25.3 release and was replaced with the ‘designatedRoleRefs’ attribute. In release 25.4, the ‘designatedRoles’ attribute will be sunset and removed completely.
EDC-1208
Deprecating Get a Compliance Report API
As of release 25.4, the following endpoint has been deprecated and is no longer supported. Please discontinue using this API endpoint and transition to using Get Compliance Reports instead.
Get a Compliance Report GET /ecs/v1/compliancereports/{loanId}
EDC-1216
FIXED ISSUES
EDC-1225 - Fixed Issues for Enhanced Field Change for AUS Tracking Fields
Before Fix: Some Enhanced Field Change (EFC) webhooks were failing to generate because of errors in the EFC process. These errors occurred when certain AUS tracking fields are updated. The EFC process was unable to complete, and the entire EFC event was lost.
After Fix: The AUS field issues have been fixed, so the process can successfully generate these EFC events. Note: ICE MT does not support recovering or replaying the previously unsent events prior to the fix.
Known Issue with EFC and AUS field Changes: For AUS field changes, the EFC Payloads has the following issues:
The Log ID is not included in the payload, so the user does not know which log was updated.
If a field ID is updated multiple times, in some cases only the latest update is captured.
Example: I have two AUS Tracking logs, one for DU, and one for LP. Both logs were updated within the same loan save event. Field ID AUSF.X1 (Underwriting Risk Assess Type) was updated with values: "LP" in the first log, and "DU" in the second log.
Result: In the EFC payload, only the latest value of "DU" is captured for field AUSF.X1. The first value of "LP" was not captured.
As a result of this known issue, AUS field change data is incomplete and ICE MT suggests that it not be relied upon, except to indicate that some change to the AUS log occurred. In a future release, ICE MT will remove the ambiguous AUS field values from the EFC payload.
To retrieve current AUS log data, you can call the following APIs:
EDC-1195 - An issue has been corrected for the V3 Update Loan API where the data type for the PriorDisclosureDate (CORRESPONDENT.X57) and PriorApplicationDate (CORRESPONDENT.X62) attributes did not match the Encompass field definition. The fields have been correctly defined as Date Only format instead of DateTime.
EDC-1197 - Fixed a known issue for the V3 Get Business Contacts Category Fields and V1 Update a Business Contact APIs. Corrected an issue where negative values in the ID fields were causing the inability to differentiate internal fields from user-defined fields. To remedy this problem, the APIs now perform the following:
Returns a new attribute ‘fieldType’ as Internal.
Returns the id as INTERNAL_ (e.g., previously returned -7, now returns as INTERNAL_7).
📘
For the V1 Update a Business Contact API, the internal fields are read-only, and the ‘LegacyId’ field must be usable for all custom category fields including the new additional internal fields.
EDC-1215 - The following Known Issue posted in the Get Users API in release 25.3 has been resolved in release 25.4:
If your Encompass instance includes both SCIM and non-SCIM users (internal users without a SCIM GUID), the GET scim2/v1/users API response may not include a full list of SCIM users due to a known issue with pagination. As a workaround, generate a SCIM GUID for Encompass users created directly in Encompass (via the Encompass user interface, or via the POST/encompass/v3/users API) using the POST/scim2/v1/accountLinks API.
EDC-1221 - Fixed an issue with the V3 Get Loan API where the Valuation IDs were not being returned in the Correspondent Entity response when the 'entities' parameter was equal to Correspondent.
Before Fix: "10-000003" returned as "0003-10-01T00:00:00.000Z"
After Fix: "10-000003" remains "10-000003"
CBIZ-66320 - Update to Enable Interim Servicing Fields to be Updated via V1 APIs
When attempting to perform an update to some Interim Servicing fields by executing a PATCH V1 API from Encompass Developer Connect, users received the following error and the fields did not update:
Unable to write to the read-only InterimServicing entity
The same update was successful when using the V3 API, but the V1 API was not working successfully because all of the Interim Servicing fields were read-only for the V1 APIs. The Interim Servicing fields have been updated so that they can be updated via V1 APIs (for example, Interim Servicing Servicer Loan Number (SERVICE.X108), Interim Servicing Sub-Servicer (SERVICE.X110), and Interim Servicing Sub-Servicer Loan Number (SERVICE.X111)), except for the following fields which have remained as read-only:
The Encompass Loan Schema is updated with every major release to include new fields and update existing fields to support new features and to stay up-to-date with regulatory requirements. For the full list of the added and update fields, please refer to the following links:
Fixed Issues for Enhanced Field Change for AUS Tracking Fields
Before Fix: Some Enhanced Field Change (EFC) webhooks were failing to generate because of errors in the EFC process. These errors occurred when certain AUS tracking fields are updated. The EFC process was unable to complete, and the entire EFC event was lost.
After Fix: The AUS field issues have been fixed, so the process can successfully generate these EFC events. Note: ICE MT does not support recovering or replaying the previously unsent events prior to the fix.
Known Issue with EFC and AUS field Changes: For AUS field changes, the EFC Payloads has the following issues:
The Log ID is not included in the payload, so the user does not know which log was updated.
If a field ID is updated multiple times, in some cases only the latest update is captured.
Example: I have two AUS Tracking logs, one for DU, and one for LP. Both logs were updated within the same loan save event. Field ID AUSF.X1 (Underwriting Risk Assess Type) was updated with values: "LP" in the first log, and "DU" in the second log.
Result: In the EFC payload, only the latest value of "DU" is captured for field AUSF.X1. The first value of "LP" was not captured.
As a result of this known issue, AUS field change data is incomplete and ICE MT suggests that it not be relied upon, except to indicate that some change to the AUS log occurred. In a future release, ICE MT will remove the ambiguous AUS field values from the EFC payload.
To retrieve current AUS log data, you can call the following APIs:
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:
The deadline to transition from legacy Encompass SDK (Software Development Kit) integrations to APIs (as previously announced in the 25.2 release notes) has changed. Please see the latest deadline information published in the official Encompass SDK Transition page.
ENCOMPASS DOCUMENTS APIs
Send Document Package (update)
The following API endpoints have been enhanced to include additional attributes to specify the Encompass 'entityId' (Encompass User ID) and 'entityType' for the package sender. For this release, these attributes are optional; however, in a future release, these attributes will be required.
Send Opening Package POST /encompassdocs/v1/documentOrders/opening/{docSetOrder_id}/delivery
Send Forms POST /encompassdocs/v1/documentOrders/forms/{docSetOrder_id}/delivery
Send Closing Package POST /encompassdocs/v1/documentOrders/closing/{docSetOrder_id}/delivery
EDC-1159
ENCOMPASS LOAN APIs
Loan APIs Enhancement
V3 Loan APIs have been enhanced to run Calcs and Business Rules configured to be triggered on virtual fields. This includes Audit Custom Fields configured to audit Virtual Field updates and Business Rules that are triggered when a virtual field is updated. Along with Create / Update Loan APIs, this enhancement also applies to log APIs such as Documents, Enhanced Conditions, Milestones, etc.
❗️
This enhancement has been deferred to a future release for Documents, Enhanced Conditions and Milestones APIs. The enhancement is Generally Available for Loan APIs where Audit Custom Fields or Business Rules are configured using Virtual Fields.
EDC-1158
eFolder Export Attachments (update)
In the 25.3 release, the value of the 'entityId' attribute in the response of the Export Attachments API has been updated. However, the API contract has not been modified. Up until release 25.3, the 'jobId' and 'entityId' properties always had matching values. As of release 25.3, there will be cases where the values for the two properties are different. Always use the value from the 'jobId' parameter when using the Get Export Status API. If you have been using the 'entityId' in any job orchestrations, you need to begin using the 'jobId' parameter going forward to ensure you can continue obtaining the export job status successfully.
❗️
This update is effective with the R2T release of Encompass scheduled for July 12, 2025.
EDC-1175
Loan Funding (new)
New APIs have been added that enable you to retrieve a list of Funding Fees from the Funding Worksheet, select fees to deduct from the Loan Amount, and retrieve Funding Balances.
The following API endpoints have been added that enable you to retrieve/update the Request for Transcript of Tax records/forms in Encompass. The data provided can be used to order services for IRS Tax Requests (forms 4506-C, 4506-T, and/or 8821). These IRS forms authorize the Lender to access tax return transcript data for borrowers, co-borrowers, or other individuals or entities via the Income Verification Express Service (IVES).x return transcripts from the borrower, co-borrower (or both), or other individuals or entities.
📘
The V3 Get Request for Transcript of Tax endpoint is in Preview Mode.
The following API has been enhanced to add a new ‘includeLegacyId’ parameter. When this optional parameter is set to true, the API will return the Legacy ID. Use this Legacy ID to update custom category fields using the V1 Update a Business Contact API. The custom category field IDs are different between V1 and V3 business contact-related APIs; therefore, the Legacy ID is only applicable to the V1 Update a Business Contact API.
In addition, this API has been updated to return all records that include the Business Category Additional Fields.
KNOWN ISSUE: The additional fields are currently being returned with negative field ID values. In a future release, this will be fixed to return proper field ID values.
In Encompass Settings > External Company Setup, the application provides folder levels for Third Party Originators (TPO) (where Org ID = 0). This folder level can be used when you need to provide a TPO root level organization. The following APIs have been updated to support the read-only TPO org ID 0.
Org ID = 0 is not allowed and when provided, these APIs return 400 error responses to indicate that Third Party Originators cannot be updated.
EDC-1180
SERVICES APIs
Partner Services (update)
The Order Services API has been enhanced with a new 'options.creditSubReportType' attribute to support a new customer setup request option called Use Cases that Lenders can use when defining what options should be checked/unchecked or locked/unlocked on the Encompass partner integration user interface. The new Use Cases option will replace a dynamic user interface configuration. NOTE: If the new Use Cases option is not used, the API will continue to work as is with no breaking change.
EDC-1177
WEBHOOKS
Loan Resource Webhook Events (update)
The “move” event in the Loan Resource webhook events has been enhanced to include extra payload for loan folder source and target paths. You can now add previous and new loan folder properties to the payload to capture the folder the loan was in before the move event occurred, and the folder the loan was moved to after the move event.
The following new properties can now be included in the “move” event for loan resources:
Property
Description
previousLoanFolder
The folder where the loan resided before the move event occurred.
newLoanFolder
The folder the loan was moved to after the move event.
📘
These properties apply to both non-archive and archive folders.
EDC-1152
New 'fieldChangeMessage' for Enhanced Field Change Webhooks Event (update)
Current Issue
Enhanced Field Change (EFC) webhook payloads have a size limitation of 220,000 (214 KB) for each webhook event, or chunk. When Encompass fields have excessively large string values, the EFC process is unable to create the payload chunks. This occurs when the combined length of the previous and new field value exceeds 214 KB. This will result in EFC webhooks that have empty payloads.
Solution
With this update, the EFC process will be enhanced so that it will be able to generate the payload chunks, when Encompass fields have excessively large string values. In order to keep the payload within the 214 KB limit, the EFC payload will be modified when the combined length of the previous and new field value exceeds 220,000 bytes. See below for more details:
We will remove values and truncate large string data as follows:
If the length of the field value, previous or new, is greater than 32KB:
Insert the following property and value into the payload:
fieldChangeMessage: "Field values excluded from payload. Value(s) exceed 32KB"
The encompass object values, previousValue and newValue, are not provided. The values will be empty.
The v3LoanModel object values, previousValue and newValue, are not provided. The values will be empty.
This change impacts all subscribers of the Enhanced Field Change webhook event. This includes customers on the 25.2, 25.3 and future versions of Encompass.
An important fix to access controls has been released. The following API was allowing users to retrieve field ID values when “Persona Access to Field” business rules were set to deny access to those respective field IDs. When this business rule is used and the user is part of rule’s denied access, the API now hides the values for the field ID in the response or provides the following message in the response: "User doesn't have access"
V3 Field Reader POST /encompass/v3/loans/{loanId}/fieldReader
📘
Before upgrading to release 25.3, if you are using V3 Get Loan or V3 Field Reader to retrieve all loan fields, you may need to call the API using a user persona that does not have field ID restrictions by a business rule.
EDC-1182
Breaking Changes for 25.4
Value for 'entityType' Change - External Users
Starting in release 25.4, the value for the entityType attribute in the Organization Entity Ref property of External User contract will return as "ExternalOrg" instead of "Organization" to distinguished between internal and external organization. This affects the following APIs:
Currently, the V3 Get External Organizations API returns a list of all org data for both internal and external users. Starting with release 25.4, the API will be updated to filter the list of orgs when accessed by an external user (TPO).
By default, external users will be limited to the API response data associated to the org they are assigned to. If the logged in user is an external user, the API will only return the list of orgs that the user is associated with and any child orgs (if isRecursive=true).
In addition, a new query parameter ‘aeManagedOnly’ will be added in release 25.4 that will override the default behavior to retrieve a list of orgs that roll up to the Account Executive. More information will be provided in the 25.4 release.
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:
Transitioning from Encompass SDK to Developer Connect APIs
ICE will be transitioning from legacy Encompass SDK (Software Development Kit) integrations. This enables our clients, partners and ICE to continue to innovate and automate by eliminating legacy integrations and focusing on modern technology. For more details and transition timelines, visit the official Encompass SDK Transition page.
Standalone SDK modules (transition to Developer Connect APIs)
SDK loan plugins (migrate to SSF framework and NG plugin framework)
APIs for the most common SDK functions and native Encompass functionality will eliminate the need for many legacy SDK use cases. Encompass APIs are interoperable across web and desktop, as both user interfaces sit on top of the same underlying Encompass loan file. Alternatives to SDK functionality are available with more coming. There may not be 100% parity, but we will provide the most common functions and alternatives. For more information, refer to the Transitioning from SDKs and Legacy Integrations - FAQs.
Enhancements for Plugins 2.0
Enhancements for Plugins 2.0
Encompass Release for Enhancement
Auth Object - getAccessToken()
In the upcoming release, Auth Object getAccessToken() now retrieves an access token (NICE-53971)
25.2
In the upcoming 25.4 release, plans are to enhance the Application Object Method openModel() to display a Dialog with custom title, content and call to actions (ENCW-123135)
25.4
Planned Fixes for Plugins 2.0
Here is a list of the known Plugin issues that will be addressed in upcoming Encompass releases.
Known Issue
Targeted Encompass Release for Fix
SSF getField() method must match case of custom field name or error is returned (ENCW-122154)
25.3
Reload Plugins 2.0 in Encompass desktop interface without having to log out and back in (NICE-53847)
25.3
Plugins 2.0 premilestoneComplete event not allowing cancel in Encompass desktop interface (NICE-53463)
25.3
Plugins 2.0 precommit event not allowing cancel in Encompass desktop interface (NICE-53421)
25.3
Plugins 2.0 precommit event not returning Data parameter in Encompass desktop interface (NICE-53422)
25.3
Plugins 2.0 premilestoneComplete event not returning Data parameter in Encompass desktop interface (NICE-53462)
25.3
Webhook Subscriptions
🚧
Important Maintenance Information
ICE regularly reviews webhook subscriptions and will automatically delete bad webhook subscriptions which have undeliverable endpoints (and are more than 30 days old, generate more than 1,000 events per week, have a delivery status of 5XX, errors, and timeouts). Please be sure to regularly review your active webhook subscriptions for an optimal user experience.
ENCOMPASS CONTACTS APIs
Business (update)
To continue our efforts supporting the Encompass SDK Transition, the following APIs have been enhanced to include the Custom Fields for Business Contacts. A new ‘customFields’ object attribute has been added to the Business Contacts Contract page. For more information regarding these custom fields, also see the following Encompass Help topic: Business Custom Fields
The Create Loan Audit for Opening Order API has been enhanced with improved error handling. With this enhancement, the API now returns the following use case-specific error messages for the company-conditional package Control Option:
Use Case #1: No Packages Selected in Settings - If Admin settings are incomplete, meaning that no packages have been selected, the following error message will return: "There are no disclosure packages available to send to this borrower pair at this time."
Use Case #2: All Packages Were Previously Sent - If conditions were met for all packages and have already been sent, the following error message will return: “Borrower pair has already received all available disclosures.” NOTE: Although the packageTypes attribute is not applicable to company-conditional package types, you can include the package type in the request payload to override the conditional logic, if needed.
Use Case #3: No Package Type Conditions Have Been Met - If no conditions have been met for any packages, meaning no packages are in the payload, the following error message will return: "There are no disclosure packages available to send to the borrower at this time."
📘
If conditions are met for packages that have not yet been sent, those packages will be delivered without an error response.
EDC-1124
Send Encompass Docs (documentation update)
The description for the ‘package.options.notifyOnNoReceiptDate’ attribute located in the Send Document Package section of the Send Encompass Docs contract page has been updated to include the following requirement that was undocumented:
NOTE: This attribute requires including the three-digit milliseconds within the typical date/time value. Format: yyyy-MM-dd'T'HH:mm:ss.SSS'Z'
EDC-1155
ENCOMPASS LOAN APIs
eFolder Documents
The V3 Get List of Documents API has been enhanced to introduce pagination with new query parameters ‘start’ and ‘limit’. The default limit is to return all the records, which is the same as the existing behavior.
Both V3 Get List of Documents and V3 Get a Document APIs have been enhanced with new query parameter ‘view’, which has three values: Summary, Detail and Full. The default value is Detail, which is the same as the existing behavior. The existing API behavior was to not include a list of comments. With 'view' equal to Full, you can now retrieve the list of comments along with the rest of the details.
👍
It is encouraged to begin using these new parameters, when possible, to improve performance.
In addition, both V3 Get List of Documents and V3 Get a Document APIs have been enhanced to now support the following read-only attributes: lastAttachmentDate and updatedDate
EDC-1147, EDC-1150
Resource Lock
The following API endpoints have been enhanced to return the full name and user type of the Encompass user locking the resource. The response payload now supports the following new attributes: fullName and userType
The Order Services API has been enhanced to support the Freddie Mac Affordable Check integration. The enhancement enables you to submit a preliminary assessment for Freddie Mac affordable product eligibility prior to submitting a full application to Freddie Mac’s Loan Product Advisor®.
EDC-1068
SETTINGS and UTILITIES APIs
Settings: Business Contacts (update)
The following API endpoint has been enhanced to include a new query parameter ‘ignoreInvalidCategories’ that enables you to enforce validation on invalid category names or IDs. If the parameter is set to False, the API will not ignore invalid category names or IDs, and the API will return an error. If the query parameter is not passed or is set to True, the API will ignore invalid category names or IDs.
The response payload for the following API endpoints has been enhanced to return a full list of state licenses supported in Encompass for external users within the collection, even if they are not selected. For the states which are not selected, the "selected" attribute will be returned and set to false.
The Get All Tasks API has been updated to include the following new query parameters:
completedDate
fromCompletedDate
toCompletedDate
EDC-1132
WEBHOOK CUSTOM AUTH APIs
New Webhook Custom Auth APIs have been added that enable ICE Mortgage Technology (ICE MT) Lenders to create a custom authentication function for receiving webhook events from ICE MT. This enforces custom authentication to validate and secure incoming webhook requests before processing them.
This feature does not replace the standard signing key validation for webhook subscriptions to verify the identity of the sender and integrity of the message upon receiving the notification. The signing keys remains the recommended best practice for subscribing to webhook events.
📘
PREMIUM APIs
These are premium APIs for Encompass customers only (for Lender use). Access requires special licensing entitlements. Please reach out to your ICE MT Account Team for more information.
Supported Webhook Custom Authentication Types
OAuth2 Token (Client Credentials Flow)
OAuth2 Token (Client Assertion using Private Key & Certificate as per RFC 7523):
The super administrator then maps the custom auth function to the webhook subscriptions that need to follow the given custom auth policy using the following endpoint:
Webhook Custom Auth Migration from Legacy Implementations
Encompass Retail Customers with legacy Webhook Custom Auth implementations created prior to March 2025, previously facilitated through ICE MT PSO, must now manage their configurations via self-service by reconfiguring it through these Webhook Custom Auth APIs. Once configured through these APIs, the legacy implementation will be disabled, ensuring a smooth transition to the new Webhook Custom Auth service.
EDC-1134
UPCOMING BREAKING CHANGES
Breaking Changes for 25.2 Release
40 MB Loan File Size Limitation
All API endpoints that require opening the loan file have been updated to limit read/write operations to loan file sizes less than 40 MB. The following error will be returned if the limit is reached: EBS-5006 - Loan file size exceeded max limit
The possibility of reaching this limit is very low. However, if you do receive this error, you can still retrieve the loan using the Encompass desktop application.
📘
The supported loan file size limit is different from the gateway response payload limit. No matter the loan file size, Encompass Developer Connect APIs cannot send a response that exceeds 6 MB.
Although uncommon, you may run into a situation where the response payload for a loan PATCH call is greater than the 6 MB limit, but less than 40MB loan file size. In this scenario, the loan will be successfully updated as indicated in the request, however, you will see a 400 "Response exceeds maximum size (6 MB)" error indicating that the response is too large.
Therefore, it is encouraged to compress the response by sending the Accept-Encoding: gzip header in the HTTP request. If the header is present, the response will be compressed using gzip and will include the Content-Encoding: gzip header in the response. You will then decompress the response before processing.
Please note, the compression doesn't always result in dramatic reductions - like shrinking a 35MB file down to 5MB, the savings depend on the content type and if its already in compressed mode (e.g., documents).
The following API endpoints have been updated to have the "BidTapeManagement" personas renamed to "EditBidTapeManagement" in the response payload to comply with a recent Encompass Admin enhancement that renamed the Edit Bid Tape Management tab to Edit Bid Tape Acquisitions.
Previously, the V3 Add a Disclosure Tracking Log and V3 Update a Disclosure Tracking Log APIs had no error handling to ensure that items in the 'contents' array in the request payload be unique. This could lead to subsequent errors in displaying disclosure tracking records in the Encompass user interface. In release 25.2, these APIs have been updated to include ‘contents’ array error handling. If duplicate values are provided in the ‘contents’ array, the APIs will now return the following error:
{
"summary": "Bad Request",
"details": "Request Payload has errors",
"errors": [
{
"summary": "contract.contents",
"details": "Items in the collection should be unique. The value 'LE' appears multiple times in the collection."
}
]
}
EDC-1148
Breaking Changes Scheduled for 25.3 Release
Extra Payload for ‘move’ Webhook Event
In the upcoming 25.3 release, extra payload is being added to the 'move' event that is part of the Loan Resources Events for webhooks. Extra payload will include the previous loan folder (previousLoanFolder) and new loan folder (newLoanFolder). This will enable you to see the folder that the loan was in before, and after, the move event occurred. No change is needed to any existing 'move' event subscriptions. Once this change is released in 25.3, the extra payload will be included in any 'move' event received from that point forward. Customers and partners that strictly validate the webhook schema to reject unknown fields will need to adopt their process to retrieve the extra payload in the ‘move’ webhook event.
EDC-1144
New 'fieldChangeMessage' for Enhanced Field Change Webhooks Event
In the upcoming 25.3 release, an additional property is being added to the 'Enhanced Field Change' event that is part of the Loan Resources Events for webhooks. Extra payload will include the attribute 'fieldChangeMessage'. This property provides specific messaging about data being returned in the webhook for that specific field, only in exception circumstances. For example, we will provide a message when field values in the payload include excessively large strings, and therefore the value must be omitted from the payload. No change is needed to any existing 'Enhanced Field Change' event subscriptions. Once this change is released in 25.3, the extra payload will be included in any 'Enhanced Field Change' event received from that point forward. Customers and partners that strictly validate the webhook schema to reject unknown fields will need to adopt their process to incorporate this new attribute.
📘
This change impacts all subscribers of the Enhanced Field Change webhook event. This includes customers on the 25.2, 25.3 and future versions of Encompass.
EDC-1166
Breaking Change Scheduled for 25.4 Release
Performance Improvements - Get External Users
In the upcoming 25.4 release, the V3 Get All External Users API is scheduled for the following enhancements for improved performance:
The API will return the response with minimal data. A new query parameter will be added to retrieve the full payload.
The pagination for this API will be enhanced to enforce a maximum limit.
The default list response will exclude disabled users. A new query parameter will be added to enable retrieving all users, including disabled users.
EDC-1143
FIXED ISSUES
EDC-1145 - Fixed an issue with the V3 Loan Pipeline for Reports API where archived loans were not being returned when filtering on the loan GUID and including archived loans in the filter. Now when filtering on the loan GUID, loans will be returned regardless of whether they are archived or not. The ‘includeArchivedLoans’ request parameter is now ignored when filtering on the loan GUID. If the loan GUID is provided in the filter, it is assumed that the loan will be returned no matter the archived status. NOTE: To retrieve information for specific loans, the best practice for better performance is to pass the list of loan IDs in the 'loanIds' attribute instead of passing them inside the filter criteria.
POSTMAN FILE UPDATES
The following Postman files have been updated to support release 25.2. All new and updated samples are prefixed with "25.2R" for each reference.
ICE Mortgage Technology recently released an update for its Developer Connect webhook notifications. This update introduced a new header, Content-Length, which specifies the size of the payload in the webhook notification. However, it was discovered that when the payload includes special characters, the Content-Length header value is undercalculated. This discrepancy can lead to malformed messages being sent to clients' webhook endpoints, causing failures in processing these notifications.
To address this issue, ICE Mortgage Technology has scheduled a Critical Patch during the maintenance window on April 24, 2025. This patch will ensure that the Content-Length header accurately reflects the size of the payload, including any special characters. All messages delivered to clients' webhook endpoints will be complete and correctly formatted.
For any additional questions, please reach out to ICE Mortgage Technology Client Support.
Developer Connect Webhook Critical Patch to Remove "Transfer-Encoding" Header
As part of the recent Encompass Webhook release, ICE Mortgage Technology has identified an issue related to Developer Connect webhook notifications.
Due to the upgrade of a development library, the "Transfer-Encoding" header with a value of "chunked" is now being added to Developer Connect webhook notifications. This header was not included in webhook notifications prior to this release.
The inclusion of the "Transfer-Encoding":"chunked" header has been observed to cause issues for clients' webhook endpoints that are not expecting this header. Specifically, these endpoints may not be able to process the notifications correctly, leading to a potential disruption.
Additionally, client webhook endpoints hosted in Azure have been found to not return the notification request bodies when the "Transfer-Encoding":"chunked" header is included. This can result in incomplete or failed webhook notifications.
To address these issues, a Critical Patch will be applied during our maintenance window on April 22, 2025. This patch will explicitly pass the "Content-Length" header and remove the "Transfer-Encoding" header from our webhook notifications. By doing so, we aim to ensure compatibility with all clients' endpoints and restore the expected behavior of our webhook notifications.
For any additional questions, please reach out to ICE Mortgage Technology Client Support.
© ICE Mortgage Technology, Inc. All rights reserved.