Download Postman Collection
Release Notes
Back to All

24.3 Major Release

December 7th, 2024

🚧

Clear Browser Cache

To ensure you are viewing the very latest of this website, best practice is to clear your browser's cache, especially after any major releases. For instructions on clearing cache, visit a link below for the browser you are using:

Table of Contents

DOCUMENT DELIVERY APIs

Packages (new)

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.

EDC-1087

Loan Pipeline (new)

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.

New Endpoint

📘

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:

  1. The cursor maximum idle time is now being enforced and the cursor will expire after 5 minutes of inactivity.
  2. If more than the maximum number of cursors allowed is attempted, a 409 Conflict error is returned.

Updates

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:

EDC-1077

Added a page for V1 Loan Pipeline Contracts.

EDC-1046

Disclosure Tracking (2015) (new and updates)

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:

EDC-1059

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: 

EDC-1061

eFolder Export Attachments (new)

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.

EDC-1078

Rate Lock (updates)

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.

Parameter
copyLoanData
excludeInterestRateOnCopy

EDC-1055

SETTINGS and UTILITIES APIs

Settings: Loan Templates (new)

The following API endpoint has been added that enables you to retrieve all settings for a specific closing cost template:

EDC-1057

Settings: External Organizations (new and update)

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.

EDC-1090

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:

EDC-1081

WORKFLOW MANAGEMENT APIs

Task Instance Management (update)

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.

WEBHOOKS

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.

Access Control Added for the following endpoint:

📘

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.

What is changing?

API Endpoint: V3 Get All External Users

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:

API NameEndpoint
Get All Task Group Templatesworkflow/v1/templates/taskgroup/items
Get a Task Group Templateworkflow/v1/templates/taskgroup/items/{id}
Create a Group Templateworkflow/v1/template/taskgroup/items
Update All Group Templatesworkflow/v1/templates/taskgroup/items
Update a Group Templateworkflow/v1/templates/taskgroup/items/{id}
Delete a Group Templateworkflow/v1/templates/taskgroup/items/{id}
Get All Task Groupsworkflow/v1/taskgroups
Get a Task Groupworkflow/v1/taskgroups/{id}
Create a Task Groupworkflow/v1/taskgroups
Update All Task Groupsworkflow/v1/taskgroups
Update a Task Groupworkflow/v1/taskgroups/{id}
Delete a Task Groupworkflow/v1/taskgroups/{id}
Get Comments for a Task Groupworkflow/v1/taskgroups/{id}/comments
Add Comments to a Task Groupworkflow/v1/taskgroups/{id}/comments
Assign All Tasks within a Task Groupworkflow/v1/taskgroups/{id}/tasks?action=assignTo

EDC-1033, EDC-1041

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.

  • Encompass Developer Connect Postman Collection
  • Encompass Developer Connect Postman Environment Variables

See Testing with Postman for more details and to download the latest versions of each Postman file.

UI-UX IMPROVEMENTS

  • EDC-1076 - Moved the USE CASES category above the GUIDES category in the left-hand navigation menu to improve usability of the Guides section.
  • EDC-1055 – Moved the Point of Sale Integration Framework contracts and API endpoint pages to reside under a new DOCUMENT DELIVERY category.
  • EDC-1088 - Reorganized the Encompass Customization Developer’s Guide for better usability.
© ICE Mortgage Technology, Inc. All rights reserved. Terms of Use