Download Postman Collection
Release Notes
Back to All

24.2 Major Release

August 17th, 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

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.

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.

New Endpoint

EDC-1027

V3 Get Download Attachment URL - Updated

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.

New Endpoint

EDC-983

Loan Pipeline - Updates

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.

EDC-1002, EDC-990

Disclosure Tracking (2015)

V3 Get Disclosure Tracking Log Email Messages - New

A new API endpoint has been added to enable retrieving the email messaging details of a Disclosure Tracking 2015 log for a specific loan.

New Endpoint

EDC-1021

Loan Management

V1 & V3 Loan APIs Now Supporting Archived Loans - Updated

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:

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.

EDC-1014

Settings: SCIM Account Linking - New

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:

  • 'urn:ietf:params:scim:schemas:extension:link:ice:2.0:EncompassInternalUser'
  • 'urn:ietf:params:scim:schemas:extension:link:ice:2.0:AIQUser'

New Endpoints

Endpoint TitleEndpoint Method / URIDescription
Create an Account LinkPOST /scim2/v1/accountLinksCreate globalUserId for the given user.
Get Linked AccountsGET /scim2/v1/accountLinks/{globalUserId}Get linked accounts associated with the given globalUserId.
Delete an Account LinkDELETE /scim2/v1/accountLinks/{globalUserId}Delete the given user associated with the link for globalUserId.
Link User to a SCIM GUIDPATCH /scim2/v1/accountLinks/{globalUserId}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.

New Endpoints

EDC-1038

Settings: Internal Users - New V3 APIs

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.

New Endpoints

Endpoint TitleEndpoint Method / URIDescription
V3 Get a List of Internal UsersGET /encompass/v3/usersReturns a list of Encompass internal users in the organization. You can use query parameters to filter the list of users.
V3 Create Internal UserPOST /encompass/v3/usersCreates an Encompass internal user.
V3 Update Internal UsersPATCH /encompass/v3/usersUse 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.
V3 Get Internal User ProfileGET /encompass/v3/users/{userId}Retrieves the Encompass internal user profile for the specified user.
V3 Delete Internal User ProfileDELETE /encompass/v3/users/{userId}Delete an Encompass Internal user profile from the system.
V3 Update Internal UserPATCH /encompass/v3/users/{userId}Update an Encompass internal user. Also, use this call to disable an Encompass user account.
V3 Get Internal User Public ProfileGET /encompass/v3/users/{userId}/publicProfileRetrieves an Encompass internal user’s public profile.
V3 Update Internal User Public ProfilePATCH /encompass/v3/users/{userId}/publicProfileUpdate an Encompass internal user’s public profile.
V3 Manage Internal User Compensation PlansPUT /encompass/v3/users/{userId}/compensationPlansUsed 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

EDC-989

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

EDC-1026

Settings: External Banks - New

  • A new API endpoint has been added that enables you to retrieve a list of external warehouse banks.

EDC-1017

Settings: HMDA Profile Settings - New

A series of new Home Mortgage Disclosure Act (HMDA) profile APIs have been added that enable you to perform the following:

  • Retrieve a list of HDMA profiles currently defined in the system.
  • Retrieve details on a specific HDMA profile.

New Endpoints

EDC-1020

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.

For more information about Transcript of Tax templates, see the New Request for Transcript of Tax Features section described in the Encompass 24.1 release notes.

New Endpoints

EDC-1000

WEBHOOKS

New Webhooks

New Webhook Resource - Encompass TaskComment

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:

UPCOMING BREAKING CHANGES

Breaking Changes Effective 24.2 Release

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

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:

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

In addition, the legacy V3 External Organizations and V3 Get an External Organization API response payload is updated to rename stateAbbrevation to stateAbbreviation. This change impacts the following endpoints.

  • GET /encompass/v3/externalOrganizations/tpos
  • 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.

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

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 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-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-1001

GUIDES

Best Practices and FAQs

The following new categories and topics have been added to the Best Practices section of Resources within Guides:

  • Custom Fields
  • eFolder Documents and Attachments
  • Pipeline Calls
  • Rate Lock Requests
  • Webhooks

Also moved the following categories under Best Practices:

  • Loan Data Formats
  • Streaming Large Files

A new Frequently Asked Questions section has been added to Resources within Guides. The new FAQs cover the following topics:

  • Access Tokens
  • API Requests
  • Documents and Attachments
  • Enhanced Conditions
  • Loan Locks

EDC-935

New ICE Mortgage Technology (MT) Identity Platform Guide

Consolidated all topics related to Encompass Developer Connect API authorization and ICE MT identity management to reside under a new section in Guides called ICE Mortgage Technology (MT) Identity Platform. The guide includes new sections devoted to Authorization, User Management, and Account Linking.

FIXED ISSUES

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

  • 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

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.

© ICE Mortgage Technology, Inc. All rights reserved. Terms of Use