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 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
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
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.
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.
The V3 Get External Organization API has been enhanced to return Fee Setup information including TPO Fees collection and Late Fees settings for a given organization. The following new "entities" filters were added:
TpoFees
LateFees
FeeSetup - Includes both TpoFees and LateFees
EDC-1110
Webhooks
The following new events were added to the ServiceOrder Webhook resource:
deliveryFailed
fulfillmentFailed
EDC-1136
Fixed Issue
EDC-1139 - An issue was observed in certain situations when working with a rate lock request that has been extended multiple times (usually 3 or more). When updating the Buy Side section with the V1 Update a Rate Lock Request API, the latest Buy Side lock price adjustments can be replaced with values from the original Buy Side lock extension price adjustment.
With this fix, the following scenarios now occur:
If the user includes buyside.LockExtendPriceAdjustment (field 3365) in the payload, it will be set to the last extension adjustment in the 'buySide.adjustments' object.
If the user does not include buyside.LockExtendPriceAdjustment (field 3365) in the payload, the extension adjustments in the 'buySide.adjustments' object will be set in the order in which they were provided in the request payload.
📘
Best Practice
When updating a rate lock extension request, the Buy Side data will automatically be updated on the extension request based on the extension request submitted. Therefore, there is no need to submit Buy Side data when updating a rate lock extension request. If you do send Buy Side data in a rate lock extension request, the buyside adjustments should ideally be provided in the sequential order in which the extension requests originally occurred. Retrieve the Rate Lock Request to get the sequential order of the adjustments.
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:
NOTICE 1: With the scheduled Release to Test (R2T) of Encompass 25.1 on February 15, 2025, ICE will be implementing a temporary change to API error responses for large loan sizes exceeding 6 MB in the 25.1 R2T environment. For more details, review the following Knowledge Article: API Error Response Change for Large Loan Sizes in 25.1 R2T
NOTICE 2: As part of ongoing efforts to modernize Encompass and to further assist with our Encompass SDK Transition, ICE Mortgage Technology is releasing in limited availability a Plugins 2.0 initiative that enables clients to Integrate Encompass Web Plugins with Encompass Desktop. This initiative enables you to
run your Encompass web plugins within Encompass desktop.
❗️
At this time, not all Encompass web interface plugin features are supported in the Encompass desktop interface, and vice versa.
use the modern, widely supported scripting language JavaScript for coding plugins.
access a new Plugin 2.0 Trace Viewer in the Encompass desktop Help menu to view real-time messages and events to troubleshoot your plugins.
The following API endpoint has been added that enables you to calculate a date based on one of the Compliance calendars available in Encompass Settings.
A new “fieldLock” attribute has been added to the contract for the following API endpoint. This attribute indicates a standard calculated field that Encompass shows with a padlock icon.
The V1 version of this API was not updated with this enhancement.
EDC-1102
SERVICES APIs
Encompass Compliance Service (new)
The following API endpoint has been added that enables you to manage the “Order Report” and “Clear Report” permissions for users in Compliance Settings.
The following API endpoints have been added that enable you to retrieve a list of custom fields, categories, and custom category fields for Business Contacts in Encompass Settings.
The following API endpoints have been added that enable you to retrieve global TPO fees, TPO fee details, and TPO late fees for external organizations.
The following API endpoints have been added that enable you to retrieve a list of standard and custom print forms, a list of standard print forms for a loan, and details of print form groups.
The following API endpoints have been added that enable you to retrieve a list of milestone settings currently configured in the system and retrieve details for specific milestone settings based on a given milestone ID.
The following API endpoints have been added that enable you to retrieve a list of Encompass roles, details for a specific Encompass role based on a given role ID, and the mapping between fixed roles (designatedRole) and predefined Encompass roles.
The V3 Get a List of Internal Users API has been enhanced to enable using the IN operator to filter by multiple values for each filter condition, enabling you to retrieve results that match any of the specified values. Example: (’user1’, 'user2', 'user3')
EDC-1096
Settings: External Users (update)
The External Users Contract has been enhanced to include a new ‘designatedRoleRefs’ attribute. This replaces the existing attribute ‘DesignatedRoles’ which will be deprecated in the upcoming 25.3 release scheduled for Q4 of 2025. The field format of the entityId in the new ‘designatedRoleRefs’ attribute is made consistent with other APIs like V3 Get Role Mappings.
EDC-1100
WORKFLOW MANAGEMENT APIs
Tasks and Task Templates (updates)
The following API endpoints have been updated to return new response attributes including "taskTypeId" and "taskTypeName". The taskTypeName is stored in the metadata object. To retrieve the taskTypeName (if exists), pass the query parameter metadata=true.
The ‘designatedRoles’ attribute in the External Users Contract will be deprecated in the upcoming 25.3 release scheduled for Q4 of 2025. This attribute is being replaced with the ‘designatedRoleRefs’ attribute.
Deprecating "status" Attribute in eFolder Document Contract
ICE Mortgage Technology will be deprecating the "status" attribute in the eFolder Document Contract in the upcoming 25.3 release scheduled for Q4 of 2025. The following API endpoints now use the more relevant "documentStatus" attribute in favor of the "status" attribute:
PSS-84937 – Fixed an issue where the response payload for the SCIM GET (Get User) and POST (Create User) API endpoints included an empty array when a phone number was absent or removed from the user profile (e.g, "phoneNumbers": []). Now when this scenario occurs, the empty array will not be included in the response payload.
If the logged in user does not have access, then updating business contacts is not allowed by that user.
A private contact cannot be assigned to a public group.
A user cannot update a read-only contact.
A user cannot update a contact in a public group when that user does not have access to that public group.
A user can only update a private contact that the user created.
If a user has partial access to a public group, the user cannot update a business contact. User should have access to all public groups that belong to the contact before being able to update that contact.
Duplicate entries are not allowed in request payload for Contact Group, Category Custom Fields, and Custom Fields.
EDC-1129 – Fixed an issue in the V3 Update Internal User API when the peerLoanAccess and subordinateLoanAccess attributes were not passed in the body of the update, the API was resetting the attributes to "ReadOnly" even if the user already had those attributes set to “ReadWrite”. With this fix, when the peerLoanAccess and subordinateLoanAccess attributes are not passed, the original values will be retained.
KNOWN ISSUES
Summary of the Known Issue:
Enhanced Field Change Webhook Truncation Due to Field Size Limit
SUP-54292 – When the Enhanced Field Change webhook payload contains an excessively large string field of approximately 55KB, the webhook drops the entire extra payload. Although the webhook notification is delivered to the given endpoint, it is sent with an empty payload. This issue will be resolved in a future release of Encompass.
EDC-1128 - In the upcoming 25.2 release, a known issue will be fixed for an issue where the V3 Get eFolder History API is not converting the timestamp value to UTC correctly.
POSTMAN FILE UPDATES
The following Postman files have been updated to support release 25.1. All new and updated samples are prefixed with "25.1R" for each reference.
A new Calculators section has been added to the ENCOMPASS LOAN category to contain all calculator APIs. The Loan Calculations API documentation has been moved from SETTINGS AND UTILITIES to this new location.
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 following API endpoints have been added that enable you to track the delivery status by retrieving all document packages by the group identifier, and retrieving a single document package by the package identifier:
Get Packages GET /delivery/v3/{groupNamespace}/{groupId}/packages
Get Package GET /delivery/v3/{groupNamespace}/{groupId}/packages/{packageId}
EDC-1050
ENCOMPASS LOAN APIs
Loan Management (update)
A new "preview" query parameter has been added to the following API. This new parameter enables you to retrieve a preview of the loan response, using the request payload provided, without actually saving and committing data to the loan. You can follow up with a subsequent PATCH loan call with the same request payload, and this parameter set to “false’ or not provided, to save and commit the changes to the loan.
The V3 Loan Pipeline for Reports API endpoint previously in preview mode has now been made generally available. This API provides a basis for generating reports from an Encompass loan pipeline that can be accessed through a cursor for reliable paginated data based on a snapshot of a loan pipeline.
This is a two-step orchestration for the same endpoint where the first call is made without cursorId, which generates a new cursor with the provided filter criteria. The subsequent calls are made with the cursorId provided in the query parameters along with start / limit for pagination.
This API endpoint is only for report generation. For all real-time pipeline results, loan pipeline end point V3 Loan Pipeline (with Pagination) should be used.
🚧
This API endpoint will be GA on December 15, 2024.
EDC-1051
Loan Pipeline (fixes and updates)
Fixed Issues
The APIs listed below have been updated with the following fixes:
The cursor maximum idle time is now being enforced and the cursor will expire after 5 minutes of inactivity.
If more than the maximum number of cursors allowed is attempted, a 409 Conflict error is returned.
Previously, the 10 cursor maximum limit was applied to Business Contacts API, Borrower Contacts API, and Loan Pipeline APIs combined. For example, you could only have 10 cursors across all three APIs. Now, only the Business Contacts and Borrower Contacts APIs share the 10 cursor combined limit. This enhancement allows you to scale your automation for Loan Pipeline APIs without sharing the bandwidth with other APIs. This enhancement affects the following APIs:
V1 Create Cursor POST /encompass/v1/loanPipeline?cursorType=randomAccess&limit=<count>
The following API endpoints have been added that enable you to retrieve a snapshot of a specified disclosure tracking log for a specified loan, and retrieve a list of all disclosure tracking log snapshots for a specified loan:
The following new attributes were added to the Disclosure Recipient Tracking Contract for the Disclosure Tracking (2015) APIs. These attributes are applicable to informational documents.
InformationalViewedDate - The date the initial informational documents were viewed.
InformationalCompletedDate - The date all the informational documents have been viewed.
InformationalViewedIP - The IP address where the initial informational document was viewed.
InformationalCompletedIP – The IP address where all the informational documents were viewed
These enhancements affect the following API endpoints:
A new Export Files Job Creator API has been added that supports export functionality for multiple attachment requests, which can include documents and conditions, in a single API call. Unlike the Export Attachments API that only supports a single job request, this new batch API supports multiple requests at a time. The maximum number of export requests is 10. This API returns multiple job IDs for each individual request.
Added the following attributes to the Rate Lock contract. These enable you to pull the settings for Zero Based Par Pricing.
Attribute
enableZeroParPricingRetail
enableZeroParPricingWholesale
EDC-1024
The following query parameters have been added to the API endpoints listed below. These parameters enable you to include loan data in the rate lock request snapshot and exclude the interest rate in the loan data copied to the snapshot.
The following API endpoint has been added that enables you to retrieve the global TPO custom field definitions. These custom fields can be added to one or more external organization configurations.
📘
This API replaces the custom field definitions that were being returned by V3 Get External Organization and V3 Update External Organization. This API will still return the references of the TPO custom fields added to an organization. However, it will no longer return the description, format and loanFieldId.
A new query parameter “orgTypes” has been introduced for the V3 Get External Organizations API endpoint. This parameter accepts comma-separated list of the following values: Company, CompanyExtension, Branch, BranchExtension.
EDC-1064
Settings: External Users (update)
The following API endpoint was updated to include "add" as a new possible value for the "action" parameter. A new sample code was added for the new “add” action.
In addition, the following new usage note was added that explains the restrictions when using the new “add” action:
📘
The “add” action is intended to work with SSO only. It doesn't include notification or password reset features.
EDC-1072
Settings: Documents (new)
The following API endpoints have been added that enable you to retrieve a list of eFolder document stacking templates and details for a specified eFolder document stacking template:
A new “assignRole” query parameter has been added to the following API endpoint. This enables setting the task assignee if the task template has a role assignment, and the milestone or milestonefree logs of the loan has a user assigned to the role mapped in the task template.
In this release, new webhook access controls are added to enable self-service for ICE MT partners to manage their webhook subscriptions. Leveraging the new access controls, partners can now update and delete the subscriptions that they have created using the Update Subscription API.
This applies to subscriptions that have been created after the 23.3 release of Encompass dated October 7, 2023. Webhook subscriptions created prior to this date continue to be managed by the administrator of the ICE MT customer environment.
EDC-1052
UPCOMING BREAKING CHANGES
Breaking Changes Effective 25.1 Release
Get External User API Change in Behavior when Query Parameter isRecursive=true
When external users are added to an external organization in one of the child orgs of type company extension, branch, branch extension, and if the “Visible in TPOWC site” check box is not set, then when calling the Get External Users API for a given orgId with a query parameter isRecursive=true, the users from the child orgs are not returned. However, when the TPOWC site checkbox is checked, all users for parent and the child orgs are returned.
The API behavior will be fixed to get external users from all companies, branches and extensions without having to mark the setting "Visible in TPOWC site" in the company settings. All external users including those that are added to a child organization will be returned when query parameter isRecursive=true is passed.
Currently, when external users are added to an external organization in one of the child orgs of type company extension, branch, branch extension, and if the “Visible in TPOWC site” check box is not set, then when calling the Get External Users API for a given orgId with a query parameter isRecursive=true, the users from the child orgs are not returned. However, when the TPOWC site checkbox is checked (or query parameter "includeInVisibleInTpowcSite=true”), all users for parent and the child orgs are returned.
The API behavior will be fixed to get external users from all companies, branches and extensions without having to mark the setting "Visible in TPOWC site" in the company settings (or having to pass "includeInVisibleInTpowcSite=true" as a query parameter). All external users including those that are added to a child organization will be returned when query parameter isRecursive=true is passed.
Example:
Before 25.1 Release
Example: /encompass/v3/externalUsers?orgId=6263&isRecursive=true&includeInVisibleInTpowcSite=true
After 25.1 Release
Example: /encompass/v3/externalUsers?orgId=6263&isRecursive=true
EBSP-53154, EDC-986
Channel Option Controls
When creating a new loan or updating an existing loan using V3 APIs, the “channel” request attribute currently accepts any value, including the options not enabled for use in the Encompass Loan Setup > Channel Options setup screen. Since this is not expected behavior, the V3 Loan API will be updated to enforce the validation of the Channel Options settings when creating or updating the loan via an API. If the user attempts to pass a Channel Option not enabled for use for your version of Encompass, an error will be returned.
EBSP-54046
DEPRECATION NOTICES
As mentioned earlier in the 24.2 release notes, the Task Group feature is being redefined and therefore the following Task Group-related API endpoints have been deprecated:
Added new categories and use cases to the Use Case Matrix section of Guides.
FIXED ISSUES
EDC-1060 - Corrected the error message phrasing that was appearing for the V3 Get List of HMDA Profiles API when an invalid value is passed in the “view” parameter.
EDC-1062 - Corrected an issue where create and update loan APIs were returning an error when the HMDA.X29 field was being updated directly using fieldLockData instead of using a calculated value.
EDC-1079 – Corrected a wrong Event name and description in the ICE Mortgage Technology Scripting Objects Reference page in the Encompass Customization Developer’s Guide. Corrected “commit” to “committed” and revised the Description for the Event accordingly.
EDC-1082 - Corrected issues in the Rate Lock management APIs where subsequent extension fees were showing incorrect values after a re-lock.
EDC-1083 - An issue has been resolved for the V1 Submit a Rate Lock Request API when submitting a rate lock request with the action=confirm. Prior to this release, when the request was submitted without sell side and execution comparison data, the new snapshot created had data from a previous snapshot or with data that was not assigned during creation. With this fix, the sell side and execution comparison data are no longer pulled into the snapshot unless they are included in the rate lock request.
EBSP-51436 - Prior to 24.3, when updating or revising a lock extension, the buyside.daysToExtend and buyside.lockExtendPriceAdjustment values were not correctly saving to the Rate Lock Request. With this fix, this issue has been resolved.
EBSP-53749 - Prior to 24.3, when updating a rate lock request, the buyside.onrpDate and buyside.onrpTime were not correctly saving to the Rate Lock Request. With this fix, this issue has been resolved.
EDC-1053 - The ICE PPE Contracts page was updated to reflect feature functionality.
POSTMAN FILE UPDATES
The following Postman files have been updated to support release 24.3. All new and updated samples are prefixed with "24.3R" for each reference.
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:
APIs available in Preview mode are for planning and feedback purpose only.
For the list of APIs currently in Preview mode, refer to the API Previews page.
The V3 Get Document Verification API previously in Preview mode is now internal only and is no longer available in preview mode.
EDC-1030
ENCOMPASS LOAN APIs
eFolder Documents
V3 Get eFolder History - New
A new API endpoint has been added that enables you to retrieve the eFolder history for a specified loan.
The V3 Get Download Attachment URL API has been updated to include a new contentType attribute in the response. The contentType attribute indicates the file format of the attachment (e.g. "application/pdf"). The contentType attribute will only be returned in the response when the "type" attribute in the body of the request is set to "Cloud".
EDC-981
V1 Get Attachment Metadata - New
A new API endpoint has been added to enable retrieving the metadata found on attachments of an Encompass loan. The response for the file provides details such as title, file size, owner, etc. The response also contains details for file page count and contentType of the file.
V1 & V3 Loan Pipeline API Support for Archived Loans
With release 24.2, the behavior of Loan Pipeline APIs are changing to now by default, return loan records that are not archived. This update is applicable to V1 and V3 APIs.
The following Loan Pipeline APIs have been enhanced to include the new includeArchivedLoans boolean attribute in the Request body. If user sets this attribute as true and they have the persona "AccessToArchiveLoans", then loans marked as archived will be returned. If user does not have that persona rights to archived loans, then API will not error, but instead will simply not return archived loans, if any exists.
The contract attribute ‘archived’ was added to the V1 and V3 loan contracts in the 24.1 release. The archived attribute identifies loans that have been marked as archived. These archived loans are excluded by default from loan pipelines to improve the performance of pipeline searches. The Persona Setting ‘Access to Archive Loans’ (Personas > Pipeline > Access to Archive Loans) is used to allow users to specify whether they want to include, or exclude, archived loans from their pipeline searches. In this 24.2 release, the ‘archived’ attribute is no longer read-only for all Loan APIs.
The following loan APIs now support the ability to update the ‘archived’ attribute (field ID: 5016), which when 'true', will mark a loan as archived for the purposes of pipeline searches:
V3 Field Reader POST /encompass/v3/loans/{loanId}/fieldReader
V3 Field Writer POST /encompass/v3/loans/{loanId}/fieldWriter
EDC-1002, EDC-990
Retitled the following API endpoints to better align with the purpose of the API:
Retitled V1 Get Field Values to V1 Field Reader POST /encompass/v1/loans/{loanId}/fieldReader
Retitled V3 Get Field Values to V3 Field Reader POST /encompass/v3/loans/{loanId}/fieldReader
Retitled V3 Update Loan Field Values to V3 Field Writer POST /encompass/v3/loans/{loanId}/fieldWriter
EDC-1044
Rate Lock
V1 Rate Lock APIs - Updated
The V1 Update a Rate Lock Request API has been updated to allow updating a pending Rate Lock Request multiple times before it is confirmed. Previously, a pending rate lock request could be updated only once, before confirming. With this change, the API is now in parity with Encompass Desktop "Save Progress" action in the Secondary Registration Tool.
In the V1 Get a Rate Lock Request API, when retrieving a Rate Lock Request, you will now see attributes related to Encompass Zero Based Par Pricing Settings (Secondary Set-up > Product and Pricing > Zero Based Par Pricing).
Resolved Issues
The V1 Get Snapshot of a Rate Lock Request response payload will now honor Loan Pricing Decimal Places settings (Secondary Set-up > Product and Pricing > Loan Pricing Decimal Places) for all fields listed on this Encompass settings screen. Options are 3 or 10 decimal places. Prior to this fix, some of the fields would return 10 decimal places, regardless of the option selected.
EDC-1022, EDC-1024, EDC-1025
Resolved issue where Confirmed Lock Cancellation request on the “lockStatus” property was not in parity with Encompass Smart Client. This issue has been resolved, and the lockStatus property will now correctly reflect “Cancelled” in this scenario.
EBSP-52105
SETTINGS and UTILITIES APIs
Settings: SCIM Provisioning - Updated
The SCIM User Provisioning service is now enforcing only one product schema to be passed for all CRUD operations, supporting user management for one product at a time. This applies to all APIs within the SCIM service including Users, Groups, and AccountLinks.
The “schemas” query parameter is renamed to “schema” for all GET and DELETE calls to support user management for one product at a time.
The structure of the error response payload is streamlined to support user management for one product at a time.
The core SCIM user schema 'urn:ietf:params:scim:schemas:core:2.0:User' must now be included for all POST/users, POST/accounts and PATCH/accounts API calls.
Example: (Encompass Internal User Schema): { "schemas": [ "urn:ietf:params:scim:schemas:core:2.0:User", "urn:ietf:params:scim:schemas:extension:ice:2.0:EncompassInternalUser" ] }
The API path for all endpoints in the SCIM service is now case insensitive.
The GET/user, GET/users and POST/user response is now returning the globalUserId in the response body.
The default behavior for DELETE/users API is modified to trigger a soft delete to deactivate the user profile in Encompass/DDA. Hard user delete is no longer feasible via the SCIM API.
Enhancements made to improve the handling of complex attributes for Encompass:
Personas - The "add" and "remove" operations now support the ability to add and remove a specific persona record, no longer expecting the entire list of records for a given user profile.
📘
At least one persona must be available.
Licenses - The "replace" and "remove" operations now support replacing and removing a specific license record, no longer expecting the entire record set for a given user profile.
📘
When removing a license record, the “selected” attribute is set to “false”, however, the record itself is not deleted.
Now enforcing path attribute for all remove operations when updating users and groups:
The value attribute is not applicable to the remove operation.
The path attribute is required for remove operation.
The path filter details inside the request body of what is to be removed must be sent as part of the path attribute.
The same logic applies to both /users and /groups PATCH calls.
Example: { "schemas": [ "urn:ietf:params:scim:api:messages:2.0:PatchOp" ], "operations": [ { "op": "remove", "path": "urn:ietf:params:scim:schemas:extension:enterprise:2.0:EncompassInternalUser:personas[entityId eq \"2\"]" } ] }
When updating a user phone number using the PATCH/users API, the phoneNumbers type is required to ensure the correct phone number is updated on the product side. There are no contract changes for the phone numbers in this release; the behavior was not previously called out in the documentation and hence now being added for awareness.
The SCIM GET User/Users API previously returned all SCIM and non-SCIM users in the response. The API response now only returns users with SCIM globalUserId.
Prior to this release, when retrieving all users using the GET/users call, by default, only the users that belong to the root organization were included in the response. In this release, the following new filter parameters are added to expand the search to the subfolders of the given organization to include all user data in the response:
enc_isRecursive will allow inclusion of subfolders to root folder (Administration). The users within those subfolders will be returned. The default is false and it returns just the root users.
enc_orgId (currently defined as 'organization' in Encompass schema) will allow the ability to filter by organization/folder. When not provided, the API assume all orgIds. When provided, the API filters to a specific orgId. In order to include sub-folders, this parameter must be used with enc_isRecursive eq true.
📘
The userName filter cannot be used in conjunction with enc_orgId and enc_isRecursive. The newly added filters work for use cases when retrieving a list of users.
The updates listed above impact the following SCIM Provisioning endpoints:
🚧
The Update User and Delete User APIs listed below require using Encompass version 24.2 or above.
In this release, we have extended the ICE Mortgage Technology SCIM service to manage account linking between the different ICE Mortgage Technology products that support cross-domain single sign-on.
For example, if the end user is logged into Encompass on the Web, and wants to launch the DDA Analyzers, the account linking service is able to look up the user accounts across multiple products that are linked to the same globalUserId so that the user does not need to perform a separate login to launch the integrated product.
Prior to this release, the globalUserId (a.k.a, SCIM GUID) was only generated when a user was created via the Create User API. In this release, the Account Linking APIs solve for this gap, and provide the ability to generate a SCIM GUID for an existing Encompass and/or DDA users. Once the GUID is generated for the existing users (created directly in Encompass), the lender can leverage the SCIM APIs to automate user lifecycle management across all enterprise products using an external IDP (e.g., Okta, Entra Id).
Account Linking APIs support the following use cases:
Retrieve all accounts tied to a given SCIM GUID.
Add a SCIM GUID to existing Encompass/DDA user that was created prior to SCIM.
Enables existing user management via SCIM APIs.
Resolve multiple GUID conflicts for the same employee in case a duplicate GUID was generated in error.
New Schemas
The following account link schemas are added for each supported ICE Mortgage Technology product to facilitate the account linking calls including:
Link ICE Mortgage Technology Supported Product user to the globalUserId.
EDC-1015
Settings: Documents - New
The eFolder Setup for Documents in Encompass enables administrators to create and manage the tracking information associated with loan documents, to set the conversion preferences used when document files are converted into image files in the eFolder, and to select the documents that are added to initial disclosure (i.e., eDisclosure) and closing document (i.e., Encompass Closer) packages based on specific criteria. A series of eFolder document settings APIs have been added that enable you to perform the following:
Retrieve the eFolder document settings configured for your instance.
Retrieve the eFolder document options configured for your instance.
A series of new V3 User Management APIs are now available that can be used to retrieve, create, update, and delete internal users from the Encompass system. A SCIM globalUserId is not used, or recognized, by these endpoints.
Use Cases
Retrieve a list of Encompass internal users in an organization.
Add an Encompass internal user .
Update profiles for existing internal user(s).
Delete an internal user profile from the system.
Retrieve and update the public profile details for specific internal users.
Update user compensation plans for specific internal users.
Additional use cases:
📘
These operations are only supported via v3 Users endpoints, and are not supported via SCIM.
Move users between organizations .
Retrieve and update user’s public profile .
Add/update/delete future user compensation plans .
Access Rights
Only administrators (admin account, Super Administrator persona, and/or Administrator persona) or non-admin users with the Settings “Organizations/User” persona can, create and update user accounts.
The calling user only has access to users within their same organization, or lower child organizations of their organization.
Use this API to perform an update in bulk to list of Encompass internal users or an update to a single Encompass internal user. Supported action is 'Move' - To move one or more users from their current organization to a new organization.
PUT /encompass/v3/users/{userId}/compensationPlans
Used to Add(assign), Update, or Delete future user compensation plans for a specified Encompass internal user.
EDC-978
Settings: Personas - Updated
The V3 Get a List of Personas API has been updated to include filtering on Persona Name and now supports pagination.
EDC-991
Settings: External Organizations - Updated
The V3 Get External Organization API has been updated to include a new query parameter to indicate which entities need to be returned.
In addition, new contract attributes were added to support the functionalities related to TPOC Setup, Commitments, Loan Criteria. This change affects the following endpoints:
The V3 Get External Organizations and V3 Get an External Organization APIs have been updated to return summary information when the user does not have access rights in persona settings for external organization data. Previously, the API was returning an error if user does not have proper access rights in persona settings.
EDC-1003
Settings: External Organizations - New
A new API endpoint has been added that enables you to retrieve a list of external organization summary details and child organization hierarchy.
A new API endpoint has been added that enables you to retrieve the commitment details for an external organization based on runtime calculators of the TPO commitments.
Settings: Loan Templates - New Transcript of Tax Templates APIs
Encompass administrators can create Transcript of Tax templates of predefined values for the three versions of IRS form 4506 and the new standard IRS form 8821. This enables users requesting tax transcripts to select the data as many times as needed at the loan level for IVES Participants, Third Party Designees, tax years, and tax form request information. A series of new APIs have been added to perform the following for Transcript of Tax templates:
Retrieve Transcript of Tax templates for a given template ID.
Retrieve a list of Transcript of Tax templates. The API includes the ability to filter by Form Version and it also supports pagination.
A new Encompass TaskComment webhook resource is added, including a new webhook eventType. By subscribing to the TaskComment update event, lenders can listen for new workflow task comments and changes in the workflow task disposition. The webhook notification payload for the TaskComment update event includes extra payload attributes enabling more efficient downstream processing.
resourceType: TaskComment
eventType: update
EDC 994
New Webhook Resource - DocumentDelivery
New DocumentDelivery webhook resource and events are added to support custom fulfillment and delivery APIs. By subscribing to this resource, lenders can receive a notification when a loan/disclosure package is posted for delivery by eClosing to be sent to borrowers and loan originators. The webhook notifications for the added webhook events include extra payload attributes enabling more efficient downstream processing.
resourceType: DocumentDelivery
eventType:
Packagecreated
Packageupdated
Fulfillmentcreated (limited availability)
Fulfillmentupdated (limited availability)
📘
The Fulfillmentcreated and Fulfillmentupdate events are being released in limited availability. For additional information on these webhook events, please reach out to your ICE Mortgage Technology Support Representative.
EDC-993
Updated Webhooks
Updated Webook Resource - serviceOrder
The serviceOrder webhook event has been updated to include extra payload in the webhook event notification. Using the added attributes in the notification payload, lenders can filter out webhooks that they need to work on based on the webhook itself, instead of polling the GET Service Order Status API for every serviceOrder webhook they receive.
This change is applicable to all serviceOrder webhook events.
The following attributes are added:
productListingName - The name of the product as listed by the EPC partner.
productId - The unique identifier of the EPC partner product.
partnerId - The unique identifier of the EPC partner.
EDC 1011
Updated Webhook Resource - enhancedfieldchange
The Enhanced Field Change (EFC) webhook event previously available in Beta mode is now generally available for production use. By subscribing to the EFC webhook event, lenders and partners can listen to changes on the Loan file. The webhook notification payload includes the previous and the new value of the field that was updated.
In addition to creating the subscription via the self-service subscription API, enabling this feature for your Encompass instance requires assistance from ICE Mortgage Technology support. Please see the EFC Webhook User and Setup Guide for instructions.
EDC - 996
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 log entities are currently being returned in the V3 Loan APIs response when no view parameters are passed OR if view=entity OR if view=full. These entities are not returned when view=logs. This is not expected behavior, and therefore a change will be made effective 24.2 release to return the mentioned entities only when view=logs or view=full. Log entities will not be included when view is not passed. If your application is counting on the presence of these entities, you can leverage the query parameter view=logs or view=full to receive the log data.
PostClosingConditions
PreliminaryConditions
UnderwritingConditions
LoanActionLogs
LockRequests
MilestoneFreeRoles
MilestoneTasks
LockDenials
LockConfirms
As a result of this update, users will experience a faster response time when using the V3 Loan APIs. For example:
The V3 Get Loan calls with includeEmpty=false were observed to be performing ~20% faster than includeEmpty=true.
📘
The includeEmpty=false query parameter is the default value for the V3 Get loan API.
The V3 Update Loan calls also show ~7% better response time with includeEmpty=false.
The V3 Create Loan calls show marginal improvement of ~1% with includeEmpty=false.
EBSP-49691, EBSP-51843, EDC-1004
Loan Field Reader API
The default value for invalid field behavior will be to fail the request, if invalid fields are provided, and the query parameters are not provided. If you need to provide invalid field IDs and receive a blank response back for any reason, field reader can be called with parameter “invalidFieldBehavior” as “Include”.
The following API endpoint page was updated with the “invalidFieldBehavior” parameter:
V3 Field Reader POST /encompass/v3/loans/{loanId}/fieldReader
Known Issue: The fieldReader API does not currently prevent the user from passing canonical fields as the input for fieldId. However, this is not expected behavior and will be corrected in a future release to invalidate canonical fields.
EDC-1007, EBSP-45807
SCIM Provisioning APIs
SCIM Encompass Internal User Schema Changes
The accountIndicators attribute in the Encompass Internal User Schema is deprecated effective in the 24.2 release. The accountIndicators attribute is being replaced with the following attributes already supported in the 24.1 release:
loginEnabled
AccountEnabled
This change impacts the POST, PATCH, and GET scim2/v1/users APIs.
EDC-1006
For a list of all the changes to SCIM APIs, see the SCIM Provisioning section described above.
EDC-928
External User State License Contract Correction for "stateAbbreviation"
The External User State License Contract is updated to correct a typographical error in the 24.2 release. The contract attribute "stateAbbrevation" is renamed to "stateAbbreviation" to correct the typographical error. The following APIs are impacted by this change:
GET /encompass/v3/externalOrganizations/tpos/{orgId}
EBSP-54853, EDC-985
Breaking Changes Effective 25.1 Release
Get External User API Change in Behavior when Query Parameter isRecursive=true
When external users are added to an external organization in one of the child orgs of type company extension, branch, branch extension, and if the “Visible in TPOWC site” check box is not set, then when calling the Get External Users API for a given orgId with a query parameter isRecursive=true, the users from the child orgs are not returned. However, when the TPOWC site checkbox is checked, all users for parent and the child orgs are returned.
The API behavior will be fixed to get external users from all companies, branches and extensions without having to mark the setting "Visible in TPOWC site" in the company settings. All external users including those that are added to a child organization will be returned when query parameter isRecursive=true is passed.
Currently, when external users are added to an external organization in one of the child orgs of type company extension, branch, branch extension, and if the “Visible in TPOWC site” check box is not set, then when calling the Get External Users API for a given orgId with a query parameter isRecursive=true, the users from the child orgs are not returned. However, when the TPOWC site checkbox is checked (or query parameter "includeInVisibleInTpowcSite=true”), all users for parent and the child orgs are returned.
The API behavior will be fixed to get external users from all companies, branches and extensions without having to mark the setting "Visible in TPOWC site" in the company settings (or having to pass "includeInVisibleInTpowcSite=true" as a query parameter). All external users including those that are added to a child organization will be returned when query parameter isRecursive=true is passed.
Example:
Before 25.1 Release
Example: /encompass/v3/externalUsers?orgId=6263&isRecursive=true&includeInVisibleInTpowcSite=true
After 25.1 Release
Example: /encompass/v3/externalUsers?orgId=6263&isRecursive=true
EBSP-53154, EDC-986
Channel Option Controls
When creating a new loan or updating an existing loan using V3 APIs, the “channel” request attribute currently accepts any value, including the options not enabled for use in the Encompass Loan Setup > Channel Options setup screen. Since this is not expected behavior, the V3 Loan API will be updated to enforce the validation of the Channel Options settings when creating or updating the loan via an API. If the user attempts to pass a Channel Option not enabled for use for your version of Encompass, an error will be returned.
EBSP-54046
UPCOMING DEPRECATION NOTICES
Encompass Developer Connect 24.3
Sunsetting Task Group APIs
ICE Mortgage Technology will be deprecating the following Task Group-related APIs in the upcoming 24.3 release scheduled for Q4 of 2024.
🚧
If you are currently using any of these API endpoints, please begin efforts to discontinue further usage of them before release 24.3.
API Name
Endpoint
Get All Task Group Templates
workflow/v1/templates/taskgroup/items
Get a Task Group Template
workflow/v1/templates/taskgroup/items/{id}
Create a Group Template
workflow/v1/template/taskgroup/items
Update All Group Templates
workflow/v1/templates/taskgroup/items
Update a Group Template
workflow/v1/templates/taskgroup/items/{id}
Delete a Group Template
workflow/v1/templates/taskgroup/items/{id}
Get All Task Groups
workflow/v1/taskgroups
Get a Task Group
workflow/v1/taskgroups/{id}
Create a Task Group
workflow/v1/taskgroups
Update All Task Groups
workflow/v1/taskgroups
Update a Task Group
workflow/v1/taskgroups/{id}
Delete a Task Group
workflow/v1/taskgroups/{id}
Get Comments for a Task Group
workflow/v1/taskgroups/{id}/comments
Add Comments to a Task Group
workflow/v1/taskgroups/{id}/comments
Assign All Tasks within a Task Group
workflow/v1/taskgroups/{id}/tasks?action=assignTo
EDC-1032
Sunsetting Persona Setting for Investor Services “Wells Fargo Funding” Integration
The Persona Pipeline Tasks views currently includes persona access to the Investor Services “Wells Fargo Funding’ SDK integration for the custom Default Setting view. This persona setting will be removed in Encompass in the 24.3 release and will also no longer be included in the response of the following API endpoints:
EDC-1036 - Token Max Life duration updated to 24 hours instead of 2 hours.
EBSP-54337 - In some cases, the “Purchased Loans” where the “Application Date” (HMDA.X29) could be reported as N/A were not retaining the “N/A” value. This issue was resolved in this release.
EBSP-45139 (EDC-1008) - An issue was resolved where a non-administrative user with the Create New Loan With Template persona right was no allowed to create or update a loan using the /encompass/v3/loans?loanFolder=My+Pipeline&view=entity&templateType=templateSet&templatePath=Public%3A%5C%5CCompanywide%5CConventional API path. The behavior was corrected to allow the user with the given persona right to create the loan with the template set.
EBSP-53927 - An issue occurred on TPO loans when a configured LO Compensation Plan had the TPO Registration Date (TPO.X3) as the Trigger Basis. When the TPO loan was registered via API and TPO Registration Date populated, the LO Compensation Plan was not being triggered automatically. With this fix, the LO Compensation Plan will now be triggered automatically when the TPO loan is registered via API, and the TPO Registration Date is the Trigger Basis.
EDC-1012 - Added additional code samples to the following API endpoints:
EDC-1039 - In V3 Get External Organizations, added BranchExtension that was missing from the possible values for the orgType parameter.
EDC-1040 - In the titles for the following Loan Pipeline API endpoints, the word “View” was changed to “Loan” to better reflect what the API endpoints enable you to perform:
EDC-1049 - The Partner Services Retrieve Raw XLM Files API has been enhanced to correct an issue where when there was no file, the API was returning the 200 response with an empty pre-signed URL. The API now returns error 404 with a response detail error code/message for file not found.
POSTMAN FILE UPDATES
The following Postman files have been updated to support release 24.2. All new and updated samples are prefixed with "24.2R" for each reference.
See Testing with Postman for more details and to download the latest versions of each Postman file.
UI-UX IMPROVEMENTS
Release Version Reference
Starting with this 24.2 release, API endpoint pages will begin displaying a note to indicate the release number an API endpoint page is added.
Quick Link to Download Postman Collection
A new button “Download Postman Collection” has been added in the top header for quick access to the latest postman collection in Encompass Developer Connect.
Guides Consolidation
Links to individual developer, setup and user guides have been consolidated under a single GUIDES category to provide better discoverability and navigation of these guides.
V3 Get Loan API No Longer Returning Empty Custom Date Field Value as 0001-01-01
An issue occurred with the V3 Get Loan API in loans when a custom field was populated with a date, and then the date was cleared from the field (manually or via a business rule or custom field calculation). When retrieving the loan with the V3 Get Loan API, the API returned a value of 0001-01-01 for the cleared custom date field instead of an empty string as expected. This issue has been resolved and the API now returns an empty string for cleared custom date fields.
EDC-992
Try It! Button Disabled
For added security, we have disabled the API Explorer (aka, the Try It! button) in Encompass Developer Connect. You can still see request and response samples for each endpoint; however, real-time calls to the sandbox server are no longer possible.
Attention Encompass customers who are using Duo Mobile Identity provider for MFA.
The Encompass Lending Platform supports Multifactor Authentication (MFA) using various identity providers. One of the supported providers includes Duo Mobile. Effective March 30, 2024, Duo Security will no longer support the traditional Duo Prompt. This means no longer supporting the iFrame experience currently integrated into the Encompass MFA for Duo Mobile.
The March 30, 2024 end-of-support milestone means that Duo teams will no longer be able to troubleshoot issues with the traditional Duo Prompt; however, the traditional Duo Prompt end-of-life date has yet to be determined.
The Encompass integration with the Duo Mobile has been updated to support the Universal Prompt experience as part of the 24.1 release.
Action Required
Following the 24.1 release of Encompass, impacted lenders must activate the Universal Prompt experience for Encompass applications to continue receiving uninterrupted support from Duo.
Please refer to the Duo Mobile Migration to Universal Prompt knowledge article for additional details and instructions on how to enable universal prompt experience for Encompass applications.
Please see the How To Set Up MFA for Encompass guide for general information on how to setup up MFA with your existing provider.
Webhook Service Security Update
The ICE Mortgage Technology webhook service has been updated to enhance security measures, as a result, webhook notifications are no longer deliverable to endpoints that support legacy TLS 1.2 renegotiation.
TLS renegotiation is the process of performing a new TLS handshake within an established TLS session, which can introduce security risks. To remove this vulnerability, webhook event notifications will result in failed delivery with the following error in the event history status.
TLS 1.2 customers that have legacy TLS renegotiation enabled must disable this feature or migrate to TLS 1.3 where legacy renegotiation is no longer supported to continue receiving webhook events for the impacted endpoints.
PREVIEW MODE APIs
🚧
APIs available in Preview mode are for planning and feedback purpose only.
For the list of APIs currently in Preview mode, refer to the API Previews page.
V3 Get Document Verification API Preview
A new endpoint has been added to retrieve ATR/QM (Ability to Repay/Qualified Mortgage Rule) document verification details such as employment, income, obligations and assets.
Preview: V3 Get Document Verification GET /v3/loans/loanId/documents/documentId/atrqmVerifications
EDC 977
ENCOMPASS LOAN APIs
Manage Non-Borrowing Owners - New
A new V3 Manage Non-Borrowing Owners API has been added to enable the retrieval and management of Non-Borrowing Owners on the existing loan. The following new endpoints are now available:
V3 Get Non-Borrowing Owners GET /v3/loans/{loanId}/nonBorrowingOwners
Retrieve all non-borrowing owners for the loan.
V3 Manage Non-Borrowing Owners PATCH /v3/loans/{loanId}/nonBorrowingOwners
Add, update, delete, re-order, or replace non-borrowing owners for the loan.
EDC 925
Associates & Milestones - New
Milestone Worksheet and Milestone Free Roles APIs were previously published in preview mode. With this release, these APIs are now generally available.
Milestone Worksheet:
V3 Get Milestone Logs List GET /v3/loans/{loanId}/milestones
Use this API to get a list of milestone logs for the selected loan.
V3 Get Milestone Log GET /v3/loans/{loanId}/milestones/{milestoneId}
Use this API to get the response for a particular milestone log.
V3 Update Milestone Log PATCH /v3/loans/{loanId}/milestones/{milestoneId}
Use this API to update a particular milestone log. You can also pass milestone details in the payload and assign loan associate user using this API.
Milestone Free Roles
V3 Get Milestone Free Role List GET /v3/loans/{loanId}/milestones/milestoneFreeRoles
Use this API to get a list of available milestone free roles.
V3 Update Milestone Free Role PATCH /v3/loans/{loanId}/milestones/milestoneFreeRoles
Use this API to assign a loan associate user to the Milestone Free Role.
EDC-932, EDC-822
Disasters Collection - New
A new API has been added to manage the Property Disaster Declarations collection in Encompass. Using this API, you can retrieve, add, update, delete, reorder and replace the collection items declared on a loan.
V3 Get Disasters GET /v3/loans/{loanId}/disasters
Retrieve all disasters for the loan, specified by the loan ID, if the user has access rights to the loan.
V3 Manage Disasters PATCH /v3/loans/{loanId}/disasters
Add, update, delete, re-order, or replace disasters for the loan.
EDC-955
V3 Manage Enhanced Conditions - Updated
The V3 Manage Enhanced Conditions API has been updated to include a new attribute to indicate how the condition was created for the loan. The sourceOfCondition is a readOnly attribute for users of Encompass Developer Connect. The sourceOfCondition is included in the response payload for the GET Conditions.
This update impacts the following endpoints:
V3 Get All Enhanced Conditions GET /v3/loans/{loanId}/conditions
Retrieve a list of enhanced conditions for a specified loan.
V3 Get an Enhanced Condition GET /v3/loans/loanId/conditions/conditionId
Retrieve a specified enhanced condition for a loan.
V3 Manage Enhanced Conditions PATCH /v3/loans/{loanId}/conditions\
Add, update, or remove enhanced conditions on a specified loan.
EDC-953
V3 Get Document API - Updated
The V3 Get Document API has been updated to retrieve ATR/QM document verification details such as employment, income, obligations and assets for a given document.
In addition, a new retrieve only attribute documentStatus has been added to the Document Contract to indicate the status of the document. This attribute is a replacement for the existing status attribute which will be deprecated in a future release.
The V3 View Pipeline (with Pagination) API has been updated to include loanFolders support for performance improvement. The loanFolders attribute is a list of folder names that a user can pass in the request body to perform a search within the specified folders.
New APIs has been added to create and manage external organizations (orgs) for third party originators such as brokers and correspondents, with whom the lender does business. Lenders that manage third party organizations can use these APIs to create, retrieve, update, and delete external organizations in Encompass. Additional API endpoints are also available to retrieve company status, company rating and price group details for managing external org settings.
External org APIs provide parity for pertinent SDK methods for external organization management. Using these APIs, lenders and partners can build custom TPO experiences, integrate with external systems, and customize Encompass TPO Connect to make Encompass even stronger.
The following Get API method has been replaced by a new V3 Get method which has been updated to address several gaps, optimized for improved performance, and aligned with RESTful standards. This endpoint will remain functional for 24.1, however, it will be deprecated in a future release. Customers currently using the following endpoint in production must update their integrations to call the new endpoint.
When calling V3 Create External Organization to create an external org under the root organization, you must pass "0" in the parentOrgId query parameter, passing a NULL value is not supported in the current release. However, "0" is not a valid entry for an OrgId. This behavior will be corrected in the 24.2 release to accept a NULL value for the parentOrgId query parameter when creating an org under the root organization. EBSP-53981
The EntityReference contract for the parentOrg object currently shows shows "Organization" instead of the expected "ExternalOrganization" value for the entityType attribute . This applies to all CRUD operations of the External Organization API. This will be corrected in the 24.2 release. EBSP-53982
EDC 946
Settings: External Users - New
V3 Manage External User
The V3 Manage External Users API was temporarily unavailable as we were working on making several enhancements. This API is now generally available for use with the following supported actions:
Update external user
Delete external user
Update External Users
The External Users API now enables client applications to update external users. PATCH /v3/externalUsers?orgid={org id}&action=update&View=entity
Delete External Users
The External Users API now enables client applications to delete external users. When a user is deleted through this API, the user gets deleted from Encompass. The user will no longer appear in the UI and will be removed from the database as well. With this initial release, this API supports the deletion of one external user per call. PATCH /v3/externalUsers?orgid={org id}&action=delete&View=entity
Usage Notes:
The caller must have persona access to update or delete an external user.
With this release, when deleting an external user, there is no validation for loan or contact reassignment. Any loans or contacts assigned to the user must be reassigned manually.
EDC-931
Settings: SCIM Provisioning - Updated
Encompass Internal User Schema Changes
New Attributes
The Encompass Internal User Schema has been updated to include new attributes that indicate the login and account status of the user in Encompass for added flexibility of user provisioning and deprovisioning.
These new attributes are added as a replacement for the existing accountIndicators attribute.
📘
Please note, the legacy accountIndicators attribute will be deprecated in the 24.2 release.
The following new attributes are added:
loginEnabled
AccountEnabled
This update impacts the following endpoints:
POST scim2/v1/users
PATCH scim2/v1/users/{userId}
Configuring Defaults for Encompas Internal User Schema
A System Administrator can configure default values for user Organization, Persona and Working Folder attributes in the Admin Tools > Server Settings Manager> Policies for a given instance of Encompass.
ENCOMPASS DOCS APIs
Generate Forms API - Updated
Using the Generate Forms API, users can generate on-demand forms and send documents that need to be executed by the recipients.
In addition to the standard and custom document types, the Generate On - Demand forms API now also supports "needed" and eFolder document types. The “needed” document templates can now be generated using this API with no additional changes to the contract attributes.
The Generate Forms Request contract has been updated to add the eFolder object. The eFolder attributes must be added in the API request to generate an on-demand eFolder document.
"eFolder": {
"documents":[
{
"id": "7bcbb899-75d2-4f83-aefa-c18987988882",
"partyIds": [
"Borrower-AdityaFN EDSQABorrower"
],
"signatureType": "wet sign or no signature required"
}
This update impacts the following endpoint:
Generate Forms POST /encompassdocs/v1/documentOrders/forms
Opening and On Demand Document Flows Now Generate Fax Coversheet
The Opening Docs API flow (a.k.a., Initial Disclosures), and the On Demand Doc Set API flow now generates a fax coversheet as part of the document package. The recipient of the document package will now see a coversheet whenever the Initial Disclosures and/or On Demand wet sign documents are sent to the consumer via the ICE Mortgage Technology supported signing portal. This behavior is enabled by default and does not require any additional setup.
A new attribute deliveryStatus was added to the Webhook Event History response payload. The deliveryStatus provides information on how ICE Mortgage Technology received the response for the webhook requests.
The Webhook Event Payload Attributes section of the Contracts page has been updated to include the new attribute, in addition, response samples have been added to the Event History API definition page to reflect this enhancement.
EDC 963
New Webhooks
New Webhook Resource - Scheduler Service
A new Scheduler Service webhook resource has been added to the Webhook API to support scheduled events in Encompass. Scheduler service supports loan manufacturing by providing ways to trigger events and automation based on the passage of time.
The Scheduler Service produces Webhook events for Created, Completed, Changed and Canceled loan-level schedulers. Clients and partners can subscribe to receive these webhooks and use them to build out additional automation.
A new User Groups webhook resource has been added to the Webhook API. Lenders subscribing to this webhooks will be notified when a user group has been created, updated or deleted.
EDC-974
LOAN SCHEMA CHANGES
The Encompass Loan Schema has been updated to include new fields. The following fields that were added to the loan schema cannot be updated using the API in the current release of Encompass. This issue will be resolved in the 24.2 release.
This impacts the following new fields in the loan schema:
New fields added on the 8821 Tax Information Authorization form.
Field 5016 (boolean) to indicate a loan is archive.
To learn more about the new fields that were added to the 8821 Tax Information Authorization form, please refer to the New Request for Transcript of Tax Features section in the Encompass 24.1 release notes.
EBSP-53933
UPCOMING BREAKING CHANGES
Upcoming API Changes for 24.2
Loan Field Reader API
The default value for invalid field behavior will be to fail the request if invalid fields are provided, and the query parameters are not provided. If you need to provide invalid field IDs and receive a blank response back for any reason, field reader can be called with parameter “invalidFieldBehavior” as “Include”.
EBSP-45807
V3 Loan APIs
Change to Payload Response Behavior
The following log entities are currently being returned in the V3 Loan APIs response when no view parameters are passed OR if view = entity OR If view = full. These entities are not returned when view = logs. This is not expected behavior, and therefore a change will be made effective in the 24.2 release to return the mentioned entities only when view = logs or view = full. Log entities will not be included when view is not passed. If your application is counting on the presence of these entities, you can leverage the query parameter view = logs or view = full to receive the log data.
PostClosingConditions
PreliminaryConditions
UnderwritingConditions
LoanActionLogs
LockRequests
MilestoneFreeRoles
MilestoneTasks
LockDenials
LockConfirms
EBSP-51843
Channel option controls
When creating a new loan or updating an existing loan using V3 APIs, the “channel” request attribute currently accepts any value, including the options not enabled for use in the Encompass Loan Setup > Channel Options setup screen. This is not expected behavior, and therefore, the V3 Loan API will be updated to enforce the validation of the Channel Options settings when creating or updating the loan via an API. If the user attempts to pass a Channel Option not enabled for use for your version of Encompass, an error will be returned.
EBSP-54046
SCIM Provisioning API
The SCIM User Provisioning API currently supports passing multiple product schemas in the same call, meaning a given employee profile can be created or updated for multiple ICE Mortgage Technology applications at the same time. Effective 24.2 release, only one product schema will be allowed for the POST and PATCH calls, supporting user management for one product at a time.
In addition, effective in the 24.2 release, the structure of the error response payload will be streamlined to support user management for one product at a time.
The default behavior for DELETE scim2/v1/users API will be modified to trigger a soft delete to deactivate the user profile in Encompass/DDA. Hard user delete will not be feasible via the SCIM API.
SCIM Schema Changes
The accountIndicators attribute in the Encompass Internal User Schema will be deprecated effective in the 24.2 release. The accountIndicators attribute is being replaced with the following attribute already supported in the 24.1 release.
loginEnabled
AccountEnabled
EDC-928
Correction for "stateAbbreviation"
The following pages and endpoints have typographical errors for "stateAbbrevation" that will be corrected to "stateAbbreviation" in release 24.2:
Concurrency Limits - This knowledge article provides a high level overview of API concurrency limits, how it works, and where to find the allocated concurrency limit for your Encompass instance.
EDC-969
Security Policy Changes for iFraming Login Pages - This knowledge article provides an important change notice regarding the use of third-party cookies in the Google Chrome browser, and an update to an ICE Mortgage Technology security policy for embedding login pages within iFrame.
New Resources and User Guides
Encompass Loan Data Dictionary Guide - This guide provides instructions for creating and maintaining your Encompass loan data dictionary using Encompass APIs to support your real-time data integration with Encompass.
EDC-950
ICE PPE Partner Setup & User Guide - ICE PPE (Product and Pricing Engine) Partner Setup & User Guide has been added to provide instructions for ICE Mortgage Technology partners who desire to integrate with PPE to retrieve product and pricing engine data using APIs.
EBSP-51359 - For SCIM Get User and Get User Groups APIs there is an optional "count" Parameter. When the count is greater than the max limit of 100, only 10 records are returned. This behavior has been resolved to return the max limit of 100 records if the count is greater than the allowed 100 max limit.
EDC-966 - Generate Forms Request Contract attributes have been corrected to align with current functionality. No underlying changes were made to the API code as part of this update.
EDC-968 - The V3 Delete Loan API description has been updated to align with current functionality. No underlying changes were made to the API code as part of this update.
EDC-971, EDC-970 - The V3 Importer to Update Loan API and the V3 Loan Converter API documentation have been updated to align with current functionality. No underlying changes were made to the API code as part of this update.
EDC-927 - An issue was resolved where the V3 External User API did not return the modified date for the existing users.
EDC-972 – The following overview pages have been revised to describe these APIs more accurately: eFolder Attachments, eFolder Documents, V3 APIs for Loan Attachments. No underlying changes were made to the API code as part of this update.
EDC- 973 - The following API endpoint documentation pages have been moved from a 'MISMO 3.4 Support' section to the 'Import from File' section and the Import from File overview page has been expanded to include MISMO 3.4 overview content:
o V3 Converter to Import New Loan
o V3 Importer to Update Loan
EDC-927 – An issue have been resolved where the V3 External User API was not returning a modified date for the existing users.
EDC-937 - The V3 Get Field Schema API description has been updated to align with current functionality. No underlying changes were made to the API code as part of this update.
EDC-984 - The V3 Update Loan endpoint has been revised to include tpoRegister as an additional possible value for the Action query parameter. In addition, updated descriptions provided for tpoSubmit and tpoResubmit values.
Removed content regarding support for Factual Data Credit (Partner ID 276521) from Credit Partners and Samples. Support for this partner ID was deprecated in an earlier release.
POSTMAN FILE UPDATES
The Encompass Developer Connect Postman Collection file has been restructured to align with the groupings of API catalogs in Encompass Developer Connect. In addition, new samples added to support the new APIs that were added.
The Encompass Developer Connect Postman Environment Variables file has been updated with new variables to support the new samples.
See Testing with Postman for more details and to download the latest versions of each Postman file.
UI-UX IMPROVEMENTS
Encompass Developer Connect Release notes and Blog Posts have been moved to a new location to improve navigation and visibility.
Users now see a new tab “Release Notes” in the top header of the page.
Blog Posts have been moved to the Guides area for improved visibility.
The Webhooks section has been reorganized for improved content flow.
© ICE Mortgage Technology, Inc. All rights reserved.