Download Postman Collection
Release Notes
Back to All

24.1 Major Release

March 5th, 2024

Table of Contents

Duo Mobile Migration to Universal Prompt

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 Setting Up MFA on the Encompass Lending Platform 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.

“EPROTO B8150000:error:0A000152:SSL routines:final_renegotiate:unsafe legacy renegotiation disabled"

Action Required

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:

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:

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.

This update impacts the following endpoint:

V3 Get a Document
GET /v3/loans/{loanId}/documents/{documentId}

EDC 929

V3 View Pipeline (with Pagination) API - Updated

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.

This update impacts the following endpoint:

V3 View Pipeline (with Pagination)
POST /v3/loanPipeline

EDC-976

SETTINGS and UTILITIES APIs

Manage Custom Fields - New

The Custom Fields API has been updated to add a new PATCH call to enable the user to create, update and remove custom fields.

V3 Manage Custom Fields
PATCH /v3/settings/loan/customFields

EDC-898

Settings: Loan Templates - New

V3 Get Loan Program Template Settings

A new V3 Get Loan Program Template Settings API has been added to retrieve all settings for a specific loan program template.

V3 Get Loan Program Template Settings
GET v3/settings/templates/loanProgram/items

EDC-897

Settings: Fee Management - New

V3 GET Itemization Fee Management Settings

A new V3 GET Itemization Fee Management Settings API has been added to retrieve all settings for Itemization Fee Management.

V3 Get Itemization Fee Management
GET /v3/settings/fees/itemization

EDC-897

Settings: External Organizations - New

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 new endpoints are now available:

Existing API Slated for Deprecation

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.

Legacy API (slated for deprecation)New API
V3 Get an External OrganizationV3 Get External Organization

Known Issues:

  • 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.
  • The Send Encompass Docs Guide and Send Encompass Docs API Reference overview pages have been updated to call out this enhancement.

EDC-964, EDC-930, EDC-965

WEBHOOKS

Event History API - Updated

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.

To learn more about the Scheduler Service, please see the Encompass Scheduler Best Practices Guide for more information.

EDC-961

New Webhook Resource - userGroups

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:

EDC-985

GUIDES

New Knowledge Articles

  • 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

  • EPPS Partner Setup and User Guide - Encompass Product and Pricing Service (EPPS) Partner Setup and User Guide has been added to provide instructions for ICE Mortgage Technology partners who desire to integrate with EPPS to retrieve product and pricing data using APIs.

EDC 934

Updated Guides

EDC-943

FIXED ISSUES

  • 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. Terms of Use