Download Postman Collection
Release Notes
Back to All

25.3 Major Release

August 8th, 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

❗️

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.

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.

EDC-1174

Request for Transcript of Tax (new)

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.

EDC-1178

ENCOMPASS CONTACTS APIs

Business Contacts (updates)

The V1 Update a Business Contact API has been updated to now support the Business Category Additional Fields.

EDC-1157

SETTINGS and UTILITIES APIs

Settings: Business Contacts (update)

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.

EDC-1169

Settings: External Organizations / External Users (update)

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.

APIResponse Change
- V3 Get External Organization
GET /encompass/v3/settings/externalOrganizations/tpos/[orgId]		When Org ID = 0 is provided, this API response returns ID = 0 and Name = Third Party Originators.
- V3 Update External Organization
PATCH /encompass/v3/settings/externalOrganizations/tpos/[orgId]

- V3 Get All External Users
GET /encompass/v3/externalUsers

- V3 Manage External Users
PATCH /encompass/v3/externalUsers		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:

PropertyDescription
previousLoanFolderThe folder where the loan resided before the move event occurred.
newLoanFolderThe 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.
    • Sample Payload 
      {     
    "modifiedField": "CX.ERRORLOG" 
    "parentField": "CX.ERRORLOG", 
    "fieldChangeMessage": "Field values excluded from payload.  Value(s) exceed 32K." 
            "encompass": { 
              "previousValue": "", 
              "newValue": "" 
            }, 
            "v3LoanModel": { 
              "previousValue": "",  
              "newValue": "" 
    }

❗️

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

GUIDES

EDC-1170 - In release 25.3, plugins are now supported for Encompass TPOC Connect®. See Encompass TPO Connect Plugins to learn more.

BREAKING CHANGES

Breaking Change for 25.3

Important Fix to Access Controls

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"

📘

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:

EDC-1184

Settings: V3 Get External Organizations

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.

EDC-1185

See Breaking Change Notices for previously posted notices.

DEPRECATION NOTICES

Upcoming Deprecations for 26.3

Deprecating V1 eFolder Attachment APIs

As part of a data center migration, the following V1 eFolder Attachment APIs will be deprecated in the upcoming 26.3 release:

🚧

Please begin efforts to discontinue further usage of these APIs in favor of V3 eFolder Attachment APIs.

EDC-1186

See Deprecation Notices for previously posted notices.

FIXED ISSUES

EDC-1164 - Coming Soon: Update to Address Issue with the Encompass Password Policy

The Force user to change password and the password expiration policy in Encompass were not being honored in certain applications and users were permitted to log in with their expired Encompass password. In the Encompass 25.4 release currently targeted for November 2025, this issue will be addressed. This may result in many users being blocked from logging into their application until they change their password as soon as their company upgrades to Encompass 25.4 in Production environments. 

Details and Impacted Users: 

When the Encompass administrator selects the Force user to change password option on a user’s profile, or if the password has expired based on the Password Expiration policy (# of Days to Expiration option managed in Admin Tools > Server Settings Manager > Password), the next time the user attempts to log into an application they should be prevented from logging in until the password is changed. However, this setting was not being enforced for Encompass users logging into the following applications with their expired Encompass password:

  • Encompass web interface
  • Encompass Consumer Connect Admin portal 
  • Encompass Data Connect
  • Encompass TPO Connect website
  • Encompass TPO Connect Admin Portal
  • Encompass Developer Connect API (OAuth Token response)
  • Encompass Developer Connect Portal (API Keys, SSO Setup, MFA setup)
  • Insights
  • ICE Mortgage Technology Resource Center (Login with Encompass via Access Login)
  • Marketplace (login with Encompass via Access Login) 

In addition, the password expired policy was also not being enforced for external TPO users logging into their assigned TPO Connect websites. If the administrator reset the TPO user password, or if the password had expired based on the Password Expiration policy (# of Days to Expiration managed in Admin Tools > Server Settings Manager > Password), the TPO user was still able to log in with their temporary or expired password.

Starting with the Encompass 25.4 release, if the Encompass user’s password has expired or if the Force user to change password option has been selected on their user profile, the user will be prevented from logging into the applications listed above until their password is changed. The users will be required to change their password by logging into the Encompass desktop interface and then following the steps in the resulting change password pop-up notification. They may also contact their Encompass system administrator for assistance.

External TPO users will also receive a change password pop-up notification when they try to log into their TPO Connect website. They must follow the steps in the notification to change their password. 

📘

Please note, this change does not impact Encompass desktop interface users, nor users who are signing in with their company SSO.

KNOWN ISSUES

Settings: SCIM Provisioning - Get Users

See the Usage Notes section in the Get Users API endpoint for details of a known issue and the timeline for a fix.

POSTMAN FILE UPDATES

The following Postman files have been updated to support release 25.3. All new and updated samples are prefixed with "25.3R" 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.

© ICE Mortgage Technology, Inc. All rights reserved. Terms of Use