🚧

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 Contacts
• Encompass Documents
• Encompass Loan
• Services
• Settings and Utilities
• Workflow Management
• Webhook Custom Auth
• Upcoming Breaking Changes
• Fixed Issues
• Postman File Updates

IMPORTANT NOTICES

Transitioning from Encompass SDK to Developer Connect APIs

ICE will be transitioning from legacy Encompass SDK (Software Development Kit) integrations in October 2025. This enables our clients, partners and ICE to continue to innovate and automate by eliminating legacy integrations and focusing on modern technology. ICE is transitioning clients and partners off SDK-based applications and plug-ins (lender, partner and ICE created) by October 31, 2025.

• 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

Planned Fixes for Plugins 2.0

Here is a list of the known Plugin issues that will be addressed in upcoming Encompass releases.

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

• V1 Get a Business Contact
  GET /encompass/v1/businessContacts/{contactId}
• V1 Update a Business Contact
  PATCH /encompass/v1/businessContacts/{contactId}

EDC-1133

ENCOMPASS DOCUMENTS APIs

Create Loan Audit for Opening Order (update)

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

• V3 Get List of Resource Locks
  GET /encompass/v3/resourceLocks
• V3 Get a Resource Lock
  GET /encompass/v3/resourceLocks/{lockId}
• V3 Lock Resource
  POST /encompass/v3/resourceLocks

EDC-1149

UCD Fields

The following API endpoint has been added to return the list of LE and CD fields for a specified loan.

• V3 Get UCD Fields
  GET /encompass/v3/loans/{loanId}/ucdfields

EDC-1168

SERVICES APIs

Partner Services (new)

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.

• V3 Get Business Contacts Category Fields
  GET /encompass/v3/settings/contacts/businessContacts/customCategoryFields

EDC-1146

Settings: External Users (update)

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.

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

WORKFLOW MANAGEMENT APIs

Task Instance Management (update)

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):
• Custom Headers
• Custom Headers with Token Request

Endpoints Added

• Create Webhook Custom Auth Function
  POST /webhook/v1/functions/auth
• Get Webhook Custom Auth Function List
  GET /webhook/v1/functions/auth
• Update Webhook Custom Auth Function
  PUT /webhook/v1/functions/auth/{functionId}
• Delete Webhook Custom Auth Function
  DELETE /webhook/v1/functions/auth/{functionId}
• Update Webhook Custom Auth Credentials
  PATCH /webhook/v1/functions/auth/{functionId}
• Link Custom Auth Function to Webhook Subscription
  PATCH /webhook/v1/subscriptions/{subscriptionId}/functions/auth/{functionId}
• Remove Custom Auth Function from Webhook Subscription
  DELETE /webhook/v1/subscriptions/{subscriptionId}/functions/auth/{functionId}
• Get Custom Auth Functions for Webhook Subscription
  GET /webhook/v1/subscriptions/{subscriptionId}/functions/auth
• Test Webhook Custom Auth Parameters
  POST /webhook/v1/functions/auth/{functionId}/test

Usage Notes
The enablement of the custom function for webhook subscriptions is a two-step process which includes the following:

1. The super administrator first creates the custom auth function using the following endpoint:
   • Create Webhook Custom Auth Function
     POST /webhook/v1/functions/auth
2. 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:
   • Link Custom Auth Function to Webhook Subscription
     PATCH /webhook/v1/subscriptions/{subscriptionId}/functions/auth/{functionId}

🚧

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

  See API Pagination - Response Payload Size Limit for more details.

EDC-1099

• EditBidTapeManagement Persona Rename

  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.
  • V3 Get a Persona
    GET /encompass/v3/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-1130

• Disclosure Tracking ‘contents’ Array Error Handling

  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:
  
  
  Duplicate Values Error - 'contents' Array

  {
      "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 either the summary or 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.

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