🚧

Release Preview

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.

🚧

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:

• Google Chrome™
• Microsoft Edge™
• Mozilla Firefox™

Table of Contents

• Important Notices
• Encompass Software Development Kit (SDK)
• Encompass Documents APIs
• Encompass Loan APIs
• Services APIs
• Settings and Utilities APIs
• Breaking Changes
• Deprecation and Sunset Notices
• Fixed Issues
• Loan Schema Changes
• Postman File Updates
• UI-UX Improvements

IMPORTANT NOTICES

API Reference Reorganization

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:

• Loan: Loan Metadata
• Settings: SCIM Provisioning and Account Linking
• Webhooks: Event History

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.

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:

NICE-54908, NICE-54910

ENCOMPASS DOCUMENTS APIs

Send Encompass Docs APIs (update)

A behavior introduced with a new response attribute to the Get Opening Order Status and Get Closing Order Status APIs in release 23.2 has been added to Encompass Developer Connect.

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).

• V3 Get Good Faith Fee Variance Violations
  GET /encompass/v3/loans/{loanId}/goodFaithFeeVarianceViolations

EDC-1193

Populating TPO Loan Entity Fields (update)

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.

• Get Programs and Rates
  POST /epps/v2/loanQualifier

The following new objects/attributes needed for the Mission Score have been added to the Loan Qualifier Attributes section of the contract:

• applicationReceivedDate - The date the lender receives a loan application from the borrower.
• rentalUnits - Array of rental unit attributes.
• unitNumber - The rental unit number.
• bedroomCount - The rental bedroom count.
• rentAmount - The rental amount.

EDC-1199

SETTINGS and UTILITIES APIs

Settings: External Organizations - TPOs (new)

The following API has been added that enables you to manage site URLs for external organizations:

• V3 Manage External Organization Site URLs
  PATCH /encompass/v3/settings/externalOrganizations/tpos/{orgId}/externalurls

EDC-1192

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.

V3 Get External Organizations
GET /encompass/v3/settings/externalOrganizations/tpos

Refer to the use case scenarios mentioned below for more details:

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.

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

Refer to the use case scenarios mentioned below for more details:

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.

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

The following scenarios are now supported:

• 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:

• V3 Get Disclosure Tracking Settings
  GET /encompass/v3/settings/loan/disclosureTracking

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.

EDC-1210

Settings: Personas (update)

The following API has been enhanced to increase the maximum records per page from 100 to 1000:

• V3 Get a List of Personas
  GET /encompass/v3/settings/personas

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

Disclosure Tracking Settings Update

The following API has 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.

• V3 Get Disclosure Tracking Settings
  GET /encompass/v3/settings/loan/disclosureTracking

EDC-1227

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.

• V3 Get Loan
  GET /encompass/v3/loans/{loanId}

EDC-1194

Value for 'entityType' Change - External Users

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 External User contract will return as "ExternalOrg" instead of "Organization" to distinguish between an internal and external organization. This affects the following APIs:

• V3 Get All External Users
  GET /encompass/v3/externalUsers
• V3 Get an External User
  GET /encompass/v3/externalUsers/{userId}
• V3 Manage External Users
  PATCH /encompass/v3/externalUsers

EDC-1185 / EDC-1196

“Send Files to Lender” Persona Setting Removal

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:

• V3 Get a Persona
  GET /encompass/v3/settings/personas/{id}
• V1 Get a Specific Persona
  GET /encompass/v1/settings/personas/{id}
• V1 Get User's Effective Rights
  GET /encompass/v1/company/users/{userId}/effectiveRights
• V3 Get Effective Rights of External User
  GET /encompass/v3/externalUsers/{userId}/effectiveRights

EDC-1207

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.

• V3 Get Loan
  GET /encompass/v3/loans/{loanId}
• V3 Create Loan
  POST /encompass/v3/loans
• V3 Update Loan
  PATCH /encompass/v3/loans/{loanId}

🚧

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.

• V1 Get List of Global CDOs
  GET /encompass/v1/company/customObject

EDC-1220

DEPRECATION and SUNSET NOTICES

Partner Services Integration Deprecations

As of release 25.4, the following Partner Services integrations have been deprecated and are no longer supported in Encompass Developer Connect:

• Appraisal
• Electronic Verifications
• Flood

🚧

Please discontinue using these Partner Services integrations in the Order Services and Get Service Order Status APIs.

EDC-1201, EDC-1203

Sunset of ‘designatedRoles’ Attribute

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:

1. The Log ID is not included in the payload, so the user does not know which log was updated.
2. If a field ID is updated multiple times, in some cases only the latest update is captured.
   1. 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.
   2. 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:

• V1 Get All AUS Tracking Log - To get a list of all AUS logs.
• V1 Get an AUS Tracking Log - To get a specific AUS log, or V1 Get AUS Tracking Log Snapshot to get a specific AUS log snapshot with Encompass field IDs.

---

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.

---

EDC-1222 - Fixed an issue with the V1 View Borrower Contacts (with Pagination) and V1 View Business Contacts (with Pagination) APIs where some non-datetime field values were incorrectly returned in datetime format; however, remained in the correct format in the database. Examples:

• 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:

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:

• 25.4 Replication: Encompass Data Connect (Replication) 25.4 Release Notes
• 25.4 Hosted: Encompass Data Connect (Hosted) 25.4 Release Notes
• 25.4 Direct Write: Encompass Data Connect (Direct Write) 25.4 Release Notes

POSTMAN FILE UPDATES

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

Added Missing 'assignedTo' Object

Added the assignedTo object that was missing in the Enhanced Condition Template Contract for the V3 Manage Enhanced Condition Templates API.

EDC-1218