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.
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
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.
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.
Single Sign On (SSO) Support for TPO External Users - Lenders can now setup SSO for the external users such as Brokers and Sellers to access TPO Connect portal using their IDP credentials.
Update to SAML Single Sign On Setup Screen in Encompass Developer Connect - A new dropdown option was added in the “Application Name” field to support the TPO Connect Broker/Seller SSO setup.
Updated SSO Setup Guide - The Setting Up Single Sign-On for Encompass Connect Products guide has been updated to include instructions for setting up SSO for TPO Connect external users and is available in Encompass Developer Connect.
Other SAML Single Sign On Setup Screen Updates
The dropdown options in the "Application Name" were updated to support branding requirements for the Encompass products.
APIs available in Preview mode are for planning and feedback purpose only.
For the current list of APIs currently in Preview mode refer to the API Previews page.
Cursor Based Loan Pipeline API Preview
The Cursor Based Loan Pipeline API provides a basis for generating reports from an Encompass pipeline that can be accessed through a cursor for reliable paginated data based on a snapshot of a loan pipeline.
The first call is made without cursor ID, which generates a new cursor with the provided filter criteria. The generated cursor ID is returned in the response header 'X-Cursor'. The subsequent calls are made with the cursor ID provided in the query parameters along with start / limit for pagination.
Usage Notes
The filter criteria is cached on the server side and does not need to be passed in when the call is made with cursorId.
This endpoint is only for report generation. For all real time pipeline results, loan pipeline end point (~/v3/loanPipeline/) should be used
EDC-896
New APIs
SCIM 2.0 User Provisioning API
The System for Cross-domain Identity Management (SCIM) User Provisioning APIs enable assignment of users and organizations to Encompass user groups for purposes of provisioning access to loans and shared Encompass resources (such as Templates and other items configurable on the User Group level).
SCIM is an open standard, REST and JSON based protocol that simplifies the user identity lifecycle management process by enabling automation between cloud-based identity providers (e.g., Okta) and service providers (e.g., Encompass). With SCIM, user identities are created and managed in a single user directory (identity and HR systems) and the user provisioning and deprovisioning changes are communicated across different applications such as Encompass.
The Encompass SCIM APIs are compliant with version 2.0 of the SCIM specification, which supports standard CRUD (Create, Retrieve, Update, Delete) operations.
A JSON schema is provided that represents the user based on the Encompass user management requirements. The schema parameters passed in the request body tells the SCIM provisioning service how to provision users for Encompass. See SCIM API contract attributes for more details.
The following SCIM API endpoints are added in this release:
A new SCIM User Provisioning User Guide was added to provided an overview of the SCIM User Provisioning service including supported use cases, available schemas, listing of API endpoints, API usage notes and payload samples.
Known Issues
Get User and Get Users APIs
The userIndicators attribute indicating if a user is a Super Admin, Admin, or Top-level user currently includes two enums for Super Administrator. One is misspelled (SuperAdminnistrator) and will be removed in a future release. EBSP-51145.
GET Users and GET User Groups APIs
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 will be corrected in the 24.1 major release to return the max limit of 100 records if the count is greater than the allowed 100 ,ax limit. EBSP-51359, EBSP-51361.
Workflow Task Instance Management Bulk Update API
A new endpoint is added to the Task Instance Management API which provides the ability to do bulk updates of workflow tasks. Using this endpoint, an update can be made to multiple fields with different values for each field for a subset of workflow tasks.
This API is similar to the existing /v1/tasks PATCH calls; however, the v1/tasks/bulk allows the user to pick and choose multiple tasks that need to be updated with the given updates as a bulk update, versus updating a specific task or all tasks based on specific query parameters.
New contract attributes are added to support the Bulk update API.
A new endpoint is added to the Webhook API to retrieve all events associated with a resource. Using the resourceName path parameter, a user can query the associated resource events available for subscription. The response contains an array of events for the specified resource.
Object ID is added to the V3 Create Attachment API Response
The V3 Create Attachment API documentation is updated to include a new contract attribute “objectID”.
The “Try It” response samples are updated for the V3 Create Attachment API endpoint to reflect the new attribute.
EDC-894
Encompass Docs API Updates
Added Support for the Opening Package Mavent Compliance Audit- Beta Release
The Send Encompass Docs API now supports the Opening Package Compliance Audit by Mavent. A compliance audit can be included with the Create Loan Audit for Opening Order, if the Encompass admin has enabled a new eDisclosure Packages setting "Include Compliance Report With Data Audit”.
The new “Include Compliance Report With Data Audit” flag is located on the Docs Setup > eDisclosure Packages page > Compliance Review Report section in Encompass settings. This setting is hidden unless the following conditions are met:
One Time Password (OTP) is enabled
📘
Enable OTP Setting for Your Encompass Instance
Please note that we are gradually transitioning away from using authorization codes for eDisclosure. Some API features will only be available to OTP users. It is recommended for the Encompass Docs API users to migrate to OTP.
Please work with your ICE MT support representative to enable this setting for your environment.
In addition, when the “Include Compliance Report With Data Audit” flag is set, a new eFolder persona setting is available for eDisclosures “Web Order Disclosures even with Compliance Review Failures”. If unchecked, and there are failures in the Compliance report, the user cannot proceed with the disclosure order unless the failures are addressed. On the other hand, when checked, the user can continue with the document order even if there are Compliance failures present.
The “Try It” response samples and the postman samples are updated to reflect this change.
❗️
Beta Release - Not Available for General Production Use
Please note, disclosures on the web is currently in Beta mode, not yet generally available for production use.
We will make an announcement in Encompass Developer Connect when this feature becomes generally available.
EDC-900
New Contract Attributes added to the Get Plans Codes API to support custom and alias Plan Codes
New attributes are added to the Plan Code Response Contract including “Id”, “SourceId” and “isCustom” to support custom plan codes.
A new Enhanced Field Change webhook event is added for the Loan resource. When subscribing to the Enhanced Field Change event, lenders are notified when field changes occur, including which field changed, old value, and new value. This data can be used to drive downstream processes and update the reporting data warehouse with field delta data.
This event is separate from the existing “Field Change” event and requires a new subscription. If subscribed to this event, webhooks will occur on all loan field change events, filtering by Field ID is not possible.
Beta Release - Not Available for General Production Use
Please note, this webhook event is currently in Beta mode, not yet generally available for production use.
We will make an announcement in Encompass Developer Connect when this feature becomes generally available.
🚧
Documentation Revision - 1/19/2024
As part of this release, an enhancement was made to the fieldchange webhook event no longer requiring fields to be added to the Audit Trail Database.
Prior to this release, when subscribing to the fieldchange webhook event and specifying the field to listen to using the filters.attributes, the subject field had to be first added to the Audit Trail Database. When the webhook would fire, the notification payload would include the subject field plus any other Audit Trail Database field that has been updated as a result of the subject field change.
As part of the 23.3 release, when subscribing to the fieldchange webhook event, the subscriber can specify any field in the loan file to listen to using the filters.atributes. The subject field does not need to be added to the Audit Trail Database. When the webhook fires, the notification payload will now include the subject field plus any other field in the loan file that has been updated as a result of the subject field change. Because of this, subscribers of the fieldchange webhook event may see a bigger notification payload.
New Webhooks Added Internal and External User Management
Encompass Developer Connect now supports webhook subscriptions to InternalUsers management events. In addition, a new webhook event was added for the existing ExternalUsers resource. Subscribing to the new webhook events enables integrated lenders to receive notifications when a new user is created, updated, or deleted.
New Encompass Persona settings are being released in 23.3 to control access to webhook data.
“Subscribe to Webhook” - allows API users to subscribe to all webhooks, except Enhanced Field Change.
“Enhanced Field Change” - Includes “Subscribe to Webhook” entitlements. Also, allows API users to subscribe to “Enhanced Field Change” webhooks.
Encompass Admins automatically can subscribe to any webhook.
Refer to the Persona Settings section on the Webhook Subscriptions page for additional details.
Implementation Considerations
IMPORTANT - New Webhook Subscriptions after Encompass v23.3 is implemented.
Encompass Admin users can subscribe to any new webhooks. No change.
API Users that are not Encompass Admins must be granted one, or both, of the persona settings noted above to create new webhook subscriptions.
Existing Webhook subscriptions created prior to 23.3 are not impacted by this persona control.
Review all API User Persona settings
Once Encompass 23.3 is implemented in your instance, ensure that the new Persona settings above are updated appropriately so that you can continue to subscribe to new Webhooks.
Use caution when determining which non-admin personas should have Webhook subscription access, especially Enhanced Field Change since it provides loan-level data, including PII.
EDC-899
Add Your Webhook Destination Domain to the ICE Allow-list
In keeping with security requirements at ICE MT, the webhook destination endpoint domain must be added to the ICE firewall for outbound notifications. Effective October 16th, 2023, new lenders and partners subscribing to webhook events must submit a request to ICE to add the destination endpoint domain to the allow-list for the receiving endpoints.
There are no changes to existing webhook subscriptions using your existing domain. Action is not required unless your current domain changes.
Impacted Webhook Subscribers
This change impacts webhook subscriptions for new or changing domains.
If you are a new customer or partner subscribing to receive webhook notifications you will need to first submit a support ticket to ICE Mortgage Technology to add your domain to the ICE allow-list to receive webhook notifications.
If you are already subscribing to webhook notifications and your receiving endpoint domain is planned to change (For example, current domain for your subscriptions is https://webhooknotifications.mybank.com to https://webhooknotifications.correspondent.mybank.com) on or after October 16th, 2023, you will need to first submit a support ticket to ICE Mortgage Technology to add your new domain to the ICE allow-list.
It may take up to five business days for your domain name to be approved prior to receiving webhook notifications at the new domain. If you wish to redirect subscriptions to the new domain, please cancel your existing subscription and create a new subscription to the new endpoint (no change to this process).
Adding your domain to the ICE allow-list is not the same as whitelisting your IP
Please note, this is not IP whitelisting. If your IP address changes, however, your domain URL stays the same, you do not need to submit a request to ICE.
Important Notices
Possible Breaking Change (with 23.3 Major Release)
Loan Schema updates (EDC-923, CBIZ-52826)
To help ensure the logic to populate the Counseling Confirmation and Counseling Format type information on the Fannie Mae ULDD XML adheres to Fannie Mae’s Appendix D requirements, the loan-level First-Time Homebuyer field (field ID 934) on the ULDD/PDD input form has been replaced with two new borrower-level fields: Borrower First-Time Homebuyer (field ID 4973) and Co-Borrower First Time Homebuyer (field ID 4974). Utilizing these two new borrower-level fields enables Encompass to capture separate values for the borrower and co-borrower as opposed to capturing just one value for first-time borrower status with the singular loan-level field. The field ID 934 is still provided on other Encompass input forms, such as the Borrower Summary - Origination, Property Information, Fannie Mae Additional Data, and Freddie Mac Additional Data input form forms, however, this field is now padlocked.
Impact to API Users
Starting with the 23.3 release, this will be a breaking change if you are currently writing to the First Time Home Buyers field ID 934. If you need to update field ID 934 via the loan update API, you can do so using one of the following options:
Option 1 (Recommended)
Send the corresponding borrower (field ID 4973) or coborrower (field ID 4974) first time home buyer indicator fields in the payload in order for Encompass to calculate the value of field ID 934.
Possible Breaking Changes (with 24.1 Major Release):
V1/V3 All Loan APIs (EBSP-40379): Restrict editing of fields with allowEdit=0 in all loan APIs in v1 and v3.
Refer to V3 Get Field Schema API, which returns the standard field definitions in a loan. When running this API, the field IDs in the response that indicate "readOnly :true" are impacted by this change. Starting in 24.1, you will no longer be able to edit those fields.
🚧
Please note that since this publication, this change is being deferred to a future release, release has not been assigned at this time.
Loan Field Reader API (EBSP-45807): 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”.
🚧
Please note that since this publication, this change is being deferred to 24.2 Major Release.
Possible Breaking Changes (with 24.2 Major Release)
V3 Loan APIs (EBSP-49691): 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.1 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
Postman Collection Updates
The following update were made to the 23.3 Postman Collection.
New folder was added to include the SCIM Provisioning samples
SCIM Provisioning in EDC
The Workflow Tasks > End User Flow folder was updated to include a sample orchestration for the Bulk Update API
Bulk Update API
New webhook subscription samples were added to the Webhooks folder to demonstrate how to subscribe to the Internal and External user events.
PATCH:/v3/loans/{loanId}/milestones/{milestoneId}
Use this API to update particular milestone log. You can also pass milestone details in the payload and assign loan associate user using this API.
User Pipeline View APIs (EDC-853): When viewing loans on the Pipeline tab, documents and conditions in the eFolder, contacts on the Contacts tab, or trades and contracts on the Trades tab, you can control the information that is displayed for the active user and how it is displayed using these POST and PUT APIs
Get Custom Fields (EDC-825): Returns a list of all custom fields defined in the system. field ids query parameter filters the response to return specific field definitions for specified loan custom fields
Audit Trail (EDC-884): Use this API to pull field audit data from Encompass Reporting Database
Update Loan (EDC-885): Updated loan error for custom field value change
Webhook Updates:
enableSubscription Flag (EDC-857): Use the optional enableSubscription flag, at the time of subscription creation, to indicate whether your subscription is enabled or disabled
Webhook Alert Change Event (EDC-867): New Webhooks for Encompass Loan Alert Events (Compliance Alerts only) - Limited Availability
Some lenders and partners now have the ability to subscribe to Encompass Loan Resource events to notify lenders when an Encompass Loan alert is opened (active) or cleared. With this release, only Encompass Loan Alerts that are identified as a compliance Alert Type can generate Webhooks. The remaining non-Compliance, and/or Custom Alert Types, will be enabled for Webhooks in a future release.
For more information, see the Encompass Loan Alert Webhooks Knowledge Article.
New product and pricing settings to enable lenders to leverage void functionality previously allowed only on Correspondent Best Efforts loans. To support this update, Void Lock API has been added for Retail and Wholesale Channels.
Important Notices
Possible Breaking Change (with 24.1 Major Release):
V1/V3 All Loan APIs (EBSP-40379): Restrict fields with allowEdit=0 to S2S only in all loan APIs in v1 and v3
Refer to V3 Get Field Schema API, which returns the standard field definitions in a loan. When running this API, the field IDs in the response that indicate "readOnly :true" are impacted by this change. Starting in 24.1, you will no longer be able to edit those fields.
Notice of Change:
Loan Schema updates (EDC-883): Index Rate attribute updates in the Loan Schema. The indexRate attribute increased from 3 decimals to support up to 5 decimals, with this release. This attribute will be calculated and stored based on your Encompass Settings, and the indexRate will be returned in the correct resulting precision when loans are accessed by API.
Notice of Upcoming Changes with the 24.1 Major Release:
Loan Field Reader API (EBSP-45807): 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 query parameter=true
New Knowledge Articles
The following new knowledge article has been added to the ICE Mortgage Technology Resource Center:
The Developer Connect Postman collection has been updated to include the new and updated APIs introduced with this release. It also includes the following additional changes:
Webhooks - Updated POST and PUT methods to include enableSubscription attribute.
E-mail Address Variable - Sample e-mail addresses provided in Message Request body were previously hardcoded e-mail addresses. With this release, those e-mail addresses have been replaced with a new variable EMAIL_ADR. The default e-mail address for this variable is [email protected].
To Do:
- Once provided, download the 23.2 Postman Collection and Postman Environment JSON files.
- Update the ENV_Developer_Sharing Environment (see Testing with Postman).
- For new variable EMAIL_ADDR, replace Initial Value and Current Value [email protected] with the e-mail address you wish to use.
NOTE: APIs with an e-mail address in the Message Request Body use the EMAIL_ADDR variable.
Open Access Developer Portal
Access requirements have been lifted from the developer portal. The developer portal is now available to all developers. Developers no longer need to create an account or log in to view the Developer Connect API reference and other documentation. Note that usage of APIs is still restricted to ICE Mortgage Technology customers and partners and requires Super Admin access to request API keys.
Enhancements Made to Improve Developer Experience
With this release we have introduced a new user experience for the developer portal API reference and guides. We’ve made the new design easier to view and access content by creating separate spaces for API reference and guides. The new top navigation menu provides easy access these spaces.
Improved Organization of API Reference
The API Reference has been organized alphabetically according to API category. Categories include:
Consumer Engagement
Encompass Contacts
Encompass Docs
Encompass Loan
Secondary and Trades
Services
Settings and Utilities
Webhook
Workflow Management
The API contracts and attributes pages have also been updated. The new Contracts page includes all API contracts and attributes for each set of APIs. The Contracts page is listed directly under the name of the API set in the left navigation menu.
The API Reference area is accessible by clicking the API Reference menu button at the top of any developer portal page.
Encompass Developer Portal: API Reference
V1 and V3 API Reference Integration
The V1 and V3 API reference documentation has been integrated into one API Reference page. This change was made to improve visibility of the V3 APIs and to expand the search functionality to all content in the developer portal. With this change, you will notice the APIs with an /encompass endpoint URL are preceded by “V1” and “V3” in the navigation menu. For example, Get a List of Disclosure Tracking Logs are listed as “V1 Get a List of Disclosure Tracking Logs” and “V3 Get a List of Disclosure Tracking Logs”.
Encompass Developer Portal: V1/V3 API Integration
New Area for Guides
The Release Notes, Notices, Resources content has been moved to the new Guides area. The Guides area is accessible by clicking the Guides menu button at the top of any developer portal page.
Encompass Developer Portal: Guides
Developer Forum Moved to the Resource Center
The developer forum is reserved for ICE Mortgage Technology customers and partners. Although developers will no longer need to login to the developer portal to view API reference and documentation, access to the developer forum will be managed through the ICE Mortgage Technology Resource Center. To learn more about this move, see Get Access to the Developer Forum.
New APIs
Loan Advisor Data Share API
This API is a lightweight integration that provides clients a streamlined method to access Freddie Mac Loan Advisor® request and response data for a given loan. With Loan Advisor Data Share system-to-system access, approved Freddie Mac seller/servicers and related third parties can access API services via a system-to-system call and response methods.
Loan Advisor Data Share supports the following data sets:
Loan Product Advisor®: Response XML and feedback certificate PDF
Loan Quality Advisor®: Response XML and feedback certificate PDF
Loan Closing Advisor®: Response XMLs and Closing Disclosure PDFs
Summary Results: Summary of assessment results from each of the above tools
📘
The Loan Advisor Data Share API contracts and documentation will be available after the 23.1 release. Encompass Developer Connect customers will be notified by email when the contracts and documentation are available.
Print On-Demand APIs
The V1 Print on Demand APIs provide the ability to generate standard and custom forms available in the Encompass Print menu. The Print on Demand API supports:
Generating individual custom and standard forms as displayed on the Standard and Custom Forms tabs in the Print Menu
Generating forms with borrower data
Converting a form to a PDF
Generate a print order by sending the Print On Demand Contract in the request payload.
POST /encompassdocs/v1/documentOrders/ondemand
A unique ID for the print order is returned in the response. Retrieve the print order by passing the order ID in the GET call.
GET /encompassdocs/v1/documentOrders/ondemand/{ID}
The response contains the URL for accessing the snapshot for viewing or printing.
EDC-790
Updated APIs
Updates Made to V3 Disclosure Tracking API to Support Multiple Delivery Platforms
The V3 Disclosure Tracking API (2015) has been enhanced to support recording of eConsent, Disclosure Delivery (including recording fulfillment of delivered disclosures if not able to deliver electronically), and capture of Intent to Proceed for delivery platforms outside of Encompass Consumer Connect.
Consent - Provides eConsent from an external delivery platform to be stored with the Disclosure Tracking record and the loan file.
Delivery and Receipt - Provides documentation of when, how and to whom the disclosed list of documents were provided. If the provider needs to perform manual fulfillment, then provides document fulfillment activities on selected tracking record.
Intent - Collects and provides documentation of Intent to Proceed for the selected loan estimate after the loan estimate has been delivered.
There are no changes to the V3 Disclosure Tracking (2015) contract; however, the following contract attributes will be used to capture external provider details and perform timeline calculations.
ATTRIBUTE
DESCRIPTION
provider
string
By default, the service provider is identified as Other.
Applicable to ServiceToServiceOnly and CreateOnly.
providerDescription
string
Name of the service provider responsible for creating and
maintaining the record.
contents
Arraydata": {
List of key documents associated with the record. For example, LE, Service Provider List, and so on. Identifies whether the package contains a Loan Estimate or Closing Disclosure. The timing and prior number of disclosure records with LE or CD will be used to calculate whether the record is an Initial or Revised record.
Provides the disclosed method, actual received date (at receipt), and Tracking eConsent details (at send, if consent available, update if received after send) of each recipient. The Disclosure Recipients themselves will be calculated by the API. Disclosure records cannot be split to deliver disclosures individually to recipients on the same application.
intentToProceed
IntentToProceedContract
The Intent to Proceed indicator. Includes the Intent to Proceed date, the name of the user who received the disclosure, and the method by which the user received the intent to proceed. This should be captured on the disclosure tracking record associated with the Loan Estimate the borrower is accepting.
fulfillments
Arraydata": {
"h-0": "
Provides the disclosed method, the user who ordered fulfillment, the date/time the fulfillment was processed, and recipient information.
Constraints and Recommendations
Disclosure Tracking entries for packages delivered through Encompass Consumer Connect cannot be updated via the API.
The loan must be documented as having External Consent (field 4499: externalEConsent should be set to fullExternaleConsent) to prevent synchronization with Consumer Connect which can override loan level consent.
The loan can have external consent for initial disclosures and can be combined with Encompass eClose, but eConsent will be captured again for eClose due to the scope of legal language associated with each consent agreement. Consent will be reflected in each related Disclosure Tracking entry.
If using Encompass Documents for generating disclosures, the barcodes are not usable for wet signed documents.
Recommendation: For the loan officer to sign the application, they must be assigned to the loan prior to ordering documents (since the documents contain the signature for the assigned loan officer at time of generation). If the loan officer is not assigned to the application, the API User who generates the documents will be assigned to the documents.
Updates Made to V3 Disclosure Tracking API to add Manual Fulfillment
A new endpoint was added to the V3 Disclosure Tracking API which provides the ability to add a manual fulfillment after the Disclosure Tracking log has been created.
Manual fulfillment can be created using:
POST /encompass/v3/loans/{{loanid}}/disclosureTracking2015Logs/{{disclosureLogId}}/fulfillments
The maximum number of fulfillments in a Disclosure Tracking log is limited to one
Works with both Enhanced and Standard Disclosure Tracking logs
The fulfillment recipient list is limited to the borrower associated with the disclosure tracking record. The recipient id is automatically populated from the Disclosure Tracking log where the manual fulfillment is added and therefore is RetrieveOnly.
Known Issue
Although the recipients object is optional in the FulfillmentContract, if it’s not passed when adding fulfillment, clients may see an error saying “Fulfillment must contain at least one recipient” due to a known issue. As a workaround, when adding a manual fulfillment to a Disclosure Tracking log, the recipient’s object must be passed, even if its empty. This issue will be resolved as part of the 23.3 release.
EBSP-47056
Updates Made to V3 Get Loan Response
The V3 Get Loan response contract has been updated to include Milestones collection with both view=entity and view=logs.
EBSP-41945
Limitation Placed on the Number of Borrower Pairs Created for VOE and VOR Loan Entities
To help ensure optimum Encompass performance, the number of items that can be added via the V1/V3 Create Loan APIs to Verification of Employment (VOE) or Verification of Residence (VOR) loan entities cannot exceed 198 for a given loan file. Exceeding this limit will return a 409 error (Conflict).
EBSP-40211
Change Made Export Attachment API
As part of this release, ICE Mortgage Technology is making an infrastructure change to optimize our Skydrive cloud storage. As part of this change, you will notice an increase in the number of characters returned in the jobId string used in the eFolder: Export Attachment API.
V1 Submit a Rate Lock Request
Additional request and response samples are being made available for all Rate Lock actions.
Updates to DDM or Business Rules for Field 3142
Starting with Encompass 23.1, the Application Date (field ID 3142) cannot be changed via the API unless the field is locked for editing. In addition, users can no longer use a DDM rule to update the Application Date (field ID 3142) without having the field open for editing. This can be achieved by using a business rule to open the field for editing.
CBIZ-47334
Fixed Issues
V3 Delete Loan API
The Delete Loan API now returns “404 Not found” instead of “401 - Unauthorized” if the loan to be deleted does not exist.
EBSP-38868
Known Issue
v1 Screen Calculator API is Not Returning loan.emailTriggerLogs in Response
Clients may see that newly added email triggers are not returned in Create and Update loan for view=entity call. The emails will be sent and the logs will be visible when the loan is retrieved through Get Loan or accessed in Encompass. This behavior will be patched in a future release.
EBSP-44718
Important Notices
Change to V3 Loan Contract
As noted in the Breaking Changes section of the Developer Portal, the attribute type for V3 Loan contract attributes ApplicantType and isBorrower is changing to ReadOnly with the release of 23.1. ICE Mortgage Technology recommends removing usage of these fields as soon as possible.
EBSP-39067
Upcoming Change to the Loan Schema in 23.2
A change is being made in the 23.2 release to the Index Rate attribute in the Loan Schema. With this future release, the indexRate attribute will increase support from 3 to 5 decimals.
Whitelist New IP Addresses to Continue to Receive Webhook Notification
Starting mid-2023, ICE Mortgage Technology’s webhooks will be sent from new IP addresses. If your company subscribes to webhook notifications (including Developer Connect, Investor Connect, AIQ, Partner Connect), you’ll need to update your IP Address Whitelist, and add the new IP addresses to ensure uninterrupted receipt of ICE Mortgage Technology webhook notifications. Please do not remove the current IP addresses from your whitelist. Please refer to Knowledge Article #114677 for the new IP addresses.
New Knowledge Articles
The following new knowledge articles are being added to the ICE Mortgage Technology Resource Center:
The Developer Connect Postman collection has been updated to include the new and updated APIs introduced with this release. It also includes the following additional changes:
Updates Made to EPPS Samples - All EPPS samples in our Postman collection have been updated to ensure "Bearer" is added in the authorization header.
Updates Made to V1 Rate Lock Samples - V1 Rate Lock samples have been added for each action type.
Added Samples for New and Updated APIs - The Developer Connect Postman collection has been updated to include the new and updated APIs introduced with this release.
Encompass GSE Services 22.3 November Critical Patch
ICE Mortgage Technology released the Encompass GSE Services 22.3 November Critical Patch on November 15, 2022. This critical patch addresses several issues including the following issue observed in Encompass Developer Connect.
Fannie Mae Services: Desktop Originator
DO orders for FHA/VA loans were not returning the Findings text file. This has been fixed so that the response now returns UNDERWRITING_FINDINGS_XML file.
EVP-29763
New Search API
The Search API provides the ability to search the web version of Encompass for forms containing a given field ID and to retrieve fields within a given form.
POST /encwsearch/v1/search?key=form_fields
Given that the search is on forms/fields, search requests use the “form_fields” key, as shown above.
The form/field search supports use cases such as:
Governance –
Return a list of all the custom forms that contain a given custom field.
Return a list of all the fields in a given custom form.
Custom Navigation – Return all forms (standard, custom, standard tools) that contain the given field. This will come in handy if you are building a custom workflow for validating fields for running AUS or sending disclosures; this API in conjunction with the navigation methods in the ICE Secure Scripting Framework is useful to direct your users to the appropriate form that has the field.
Usage Notes:
The Search API is not for searching for forms or fields independently. When performing a field search, the search returns all the forms where the specified field exists. When performing a form search, the search returns a list of fields within the form.
Search results can provide insight into how your custom fields are leveraged in custom forms and which fields are used in a custom form, but should not be used to take an entire inventory of custom fields or custom forms.
Fields and forms NOT included in search results are:
Custom forms and custom fields that only exist in the desktop version of Encompass.
A custom field used only in a calculation or in business rules and not in custom forms in the web version of Encompass.
Custom Tools and Global Tools.
Filtering and Sorting:
The Search API allows Encompass users to filter search results by a given property, such as a form name, form type, field id, field type, modified date, and so on. The filter criteria for the results is passed in the query object of the search request. This API supports both full and partial text searches for standard and custom forms, and full text search on standard and custom fields.
ENCW-57806
Loan
Validation Added to Prevent More Than Six Borrower Pairs from Being Added to Loans via V1/V3 Create Loan APIs
To match the Encompass Smart Client and SDK borrower pair limit, lenders can now add only six borrower pairs on loans created with the V1/V3 Create Loan APIs. If more than six borrower pairs are added to a loan file via Create Loan APIs, a 400 error (Bad request) error will be returned. ICE Mortgage Technology recommends that lenders and partners review their automated testing and test cases to ensure loan files do not exceed the limits established for Developer Connect.
EBSP-26918
Property Names Converted to Camel Case in V3 Error Responses
Property names returned in the Summary section of error responses have been converted to camel case. This change does not impact the API camel casing itself; it is limited to the consistency in error messages.
Property names that have changed to camel case are:
Disclosure Tracking
External Users
External Org
eClose Log creation
Milestones
Loan Recipients
Conversation Logs
Roles
Loan Versions API
Company Settings
{
"summary": "Bad Request",
"details": "Request Payload has errors",
"errors": [
{
"summary": "disclosureRecipients[0].disclosedMethod",
"details": "'DisclosedMethod' for recipient can only be 'eClose' for 'eClose' logs."
}
]
}
EBSP-38414
New Enum Value CountOnly Available for CalculateTotalCount Query Parameter in V3 Loan Pipeline and Query Engine
The CalculateTotalCount query parameter for Pipeline and Query Engine now supports a new option for CountOnly in addition to the prior options (NoCount, WaitForCount, NoWait). When using this option to call the APIs, Developer Connect will return only a count of the loans matching the provided criteria.
Price Concessions Supported on Lock Request Operations
The priceConcessionIndicator (field ID 4789), extensionIndicator (field ID4790), priceConcessionRequestStatus (field ID 4791) have been added to the V1 Rate Lock snapshot. These attributes will not be exposed on the UI but will be available via the API for use in reporting if desired. This change impacts the following endpoint:
GET /v1/loans/{loanId}/ratelockRequests/{requestId}/snapshot
EBSP-37079
V1 Loan: Added Support for Field Trigger Advanced Code Method Fields.ExecuteCalculation()
When the Field Writer API is used to change the value of a field, field triggers may execute based on the field value changing as well as any other criteria associated with the rule. If the executed field trigger contains advanced code method Fields.ExecuteCalculation(), it will now also run. When a rule is triggered via the Field Writer API, calculations will run without having the loan open. All calculations associated with the Get MI button on the Get MI Form will also run, populate the loan, and be saved in the loan file.
EBSP-41239
Disclosure Tracking
Added Support for Legacy Disclosure Tracking Logs Created via Smart Client and SDK
This release introduces support for legacy logs created through the Encompass Smart Client and SDK. Previously, the Update Disclosure Tracking Logs API in V3 was limited to the Enhanced Disclosure Tracking logs, which are the ones created using the V3 APIs or through Encompass eClose.
This enhancement provides the ability to update and manage legacy disclosure tracking logs via V3 Disclosure Tracking Logs APIs. A notable benefit to this support is the ability to update the UseForUCDExport flag in any disclosure tracking log for use in UCD Automation. The UseForUCDExport flag determines whether a Closing Disclosure is selected as the disclosure to send for UCD. Previously, this flag could only be updated via the V3 APIs if the log was created using V3 APIs.
For the callers already using V3 Disclosure Tracking Logs APIs, this change will be transparent. The update will be seamless without differentiating between legacy and enhanced Disclosure Tracking logs.
EBSP-38233
Added Ability to Pass eConsent Data
Enhancements have been made to the V3 Update Loan and V3 Update 2015 Disclosure Tracking APIs to enable integrations other than Encompass to update eConsent fields. With these updates, eConsent data can be provided to update both the loan and selected Disclosure Tracking records.
Loan - eConsent data can be updated in the loan using:
PATCH /encompass/v3/loans/{loanId}
Disclosure Tracking records - eConsent data can be updated in selected Disclosure Tracking records delivered outside of Consumer Connect using:
Disclosure Tracking record data, including eConsent status, delivery type and sent/receipt dates will be taken into account by Encompass when calculating the compliance timeline for the loan. See Working with 2015 RESPA-TILA Regulations in the Encompass online help for the usage of these fields within Encompass for purposes of TRID compliance.
Constraints:
The loan field eConsentType (field ID 4499) must be set to FullexternaleConsent. This value controls whether the loan level eConsent fields will be updated by Consumer Connect. If this value is not set and the instance is using consent data provided from a partner or from the client’s own systems, the data in these fields may be overwritten.
Disclosure Tracking records for packages disclosed through Consumer Connect are not eligible for having eConsent values updated.
The disclosure tracking UI will not display eConsent data from the API until the 23.1 release but data will be accessible via an API request.
Disclosure Tracking records can be created using:
POST /encompass/v3/loans/{loanId}/disclosureTracking2015logs
These records have the following constraints:
The snapshot created will represent the state of Encompass data at the point the record is created (equivalent to creation of a manual disclosure tracking log)
The log entry must include a reference to its creator.
EBSP-40082
External Organizations
Behavior Change for CompanyNetWorth Attribute in Get External Organization API Contract
The CompanyNetWorth attribute in the Get External Organization API contract has been made nullable. With this change, if a value is not passed for CompanyNetWorth when an organization is created or updated, the value for CompanyNetWorth will be stored as NULL and the attribute will not be returned in the response. Previously, if a value was not passed for this attribute, it was stored as “0” and returned as 0 in the response.
For all new or updated External Organization data, when a null value is passed for CompanyNetWorth, the value will be stored as NULL and CompanyNetWorth will not be returned in the response.
For existing External Organization data, when a null value is passed for CompanyNetWorth, the value will be stored as “0”, and returned in the response as 0.
These changes apply to V1/V3 Update Document APIs.
EBSP-41574
Correspondent Trades
Improved Pagination when Retrieving Trades Pipeline Data
To improve pagination in Trades, the total number of trades will be passed in X-Total-Count of response header when calling the Get Trades Pipeline API (without pagination).
Updates to Trades Statistics Response Payload
Two attributes, Purchased Loan Amount and Purchased Loan Amount Percentage, have been added to the Correspondent Trades Statistics response payload.
Updates to Correspondent Trades Pipeline API
Same two attributes mention above, Purchased Loan Amount and Purchased Loan Amount Percentage, have been added to the Correspondent Trades Pipeline body and response payloads.
SEC-23158
Point of Sale Framework
With this release, ICE Mortgage Technology introduces Point of Sale Framework APIs for ICE Mortgage Technology Partners. Our Point of Sale Framework enables Partners to build custom solutions for Encompass lenders.
If you have not already registered as a Partner offering Point of Sale services, see Become an ICE Mortgage Technology Partner, or contact your ICE Mortgage Technology Partner Alliance Manager to register. Your Partner Alliance Manager will also provide guidance and help step you through building and onboarding your integration.
Encompass eClose Integration
This initial release offers our Point of Sale Framework APIs for building custom Encompass eClose integrations. Encompass lenders can leverage these integrations to provide their borrowers with a seamless eClose document management and eSign experience. This solution is also compatible with Encompass Consumer Connect borrower portal and widgets.
Our Point of Sale Framework APIs for building custom Encompass eClose integrations include:
Create a Package Event
Creates an eClose package event. This is a synchronous webhook listener allowing Delivery Partner integration to hook into package creation and observe data and replace the email content and portal linking.
POST https: //{Partner Point of Sale Framework API root}/packages
Create a Delivery Room Session
Creates a Delivery Room session for a recipient in a Partner portal. The Create Package Event payload provides details to the Partner system that determine whether to resolve a user or create a user in the Partner portal.
POST /pos/v1/sessions
IMTI-329
Fixed Issues
V3/V1 Loan: Resolved Issue with Loan Lock Error
Some lenders experienced an issue with when creating a loan folder where the loan would lock with an error message stating, “the loan was currently locked because Capsiloniq was currently editing it”. This issue occurred when concurrent calls were made for Update Loan API and Resource Locks API (with an exclusive locks). In this case, both a shared and exclusive lock would be acquired, respectively. This issue was resolved.
EBSP-39146
V3 Loan: Log Collections No Longer Returned in Every Default Get Loan Response
InvestorDeliveryLogs and EncompassToEncompassLogs were being returned with every GET loan view=entity response. Starting with this release, log collections are only returned with view=logs and view=full.
EBSP-41843
V3 Loan: LegacyId in Vesting Entity Contract was Changed to ReadOnly
The application.legacyId attribute in the Vesting Entity contract was changed to readOnly since it is an auto populating field. Previously, the API accepted the legacyId in request payload even though the value was ignored. This change impacts the following endpoint:
V3 Loan: Resolved Issue with Comp Total Fields Not Populating when Compensation Plan is Applied
When a compensation plan was applied to a loan via the V3 Create or Update Loan APIs, the loan officer Compensation Tool fields LCP.X8 and LCP.X14 were not calculating or populating for a TPO loan. This issue was resolved and now the LCP.X8 and LCP.X14 fields are calculated and populated as expected with the V3 Create and Update Loan APIs.
EBSP-29246
V1 Loan: Resolved Issue with Folder Name Case-Sensitivity when Moving a Loan
When moving a loan via the Move Loan to Folder API, the target loan folder name is no longer case-sensitive. Previously, the move operation would fail if the case of target folder name specified in the request did not match the actual target folder.
EBSP-10506
V1 Loan: Resolved Issue with Field Trigger Business Rules Not Running when Value in Activation Field is Removed
An issue existed with Field Trigger business rules configured to run when a field value is modified. With this issue, the Field Trigger business rules would not run if a field value was removed from the activation field via V1 Loan API. This issue was resolved.
EBSP-40358
V1 Loan: Resolved Issue with the Assign a Loan Associate API
When assigning a user to the underwriter role via the Assign a Loan Associate API, the UWID field was not being updating in the loan file. This issue was resolved and now the Assign a Loan Associate API updates the UWID field as expected.
EBSP-39651
Important Notices
Manage External Users API is Temporarily Unavailable
The V3 Manage External Users API is temporarily unavailable while we work on several improvements.
PATCH /encompass/v3/externalUsers
Change to V1 Loan Contract
With the release of Developer Connect 22.2, the attribute type for V1 Loan contract attributes ApplicantType and BorrowerIndex was changed to ReadOnly. These attributes now have the same behavior as other ReadOnly properties in V1 Create/Update Loan.
EBSP-38831
Upcoming Change to V3 Loan Contract
The attribute type for V3 Loan contract attributes ApplicantType and isBorrower will change to ReadOnly with the release of Developer Connect 23.1. ICE Mortgage Technology recommends removing usage of these fields prior to the 23.1 release.
The following error will be thrown if either attribute is passed in the payload after the release of 23.1.
{
"summary": "Bad Request",
"details": "Request Payload has errors",
"errors": [
{
"summary": "loanContract.applications[0].borrower.applicantType",
"details": "The ApplicantType field is readonly."
},
{
"summary": "loanContract.applications[0].borrower.isBorrower",
"details": "The IsBorrower field is readonly."
}
]
}
EBSP-39067
New and Updated Developer Resources
New GitHub Repository
Our GitHub URLs have changed. All of the Developer Connect open source files and project files now point to the new ICE Mortgage Technology repository at https://github.com/IceMortgageTechnology.
eFolder API Tips & Tricks
This new Best Practices resource provides helpful tips and tricks from our developers for managing eFolder attachments using APIs. See the eFolder API Tips & Tricks.
The API Explorer (aka The "Try It!" button)
The API Explorer in the Developer Connect portal allows developers to run requests directly from the browser and view an actual response from the API. This new guide describes how Developer Connect users can get started using the API Explorer. See the API Explorer Guide.
V1 vs V3 APIs, what’s the difference?
This Blog Post describes the technological and functional differences between our V1 and V3 APIs and provides answers to the most frequently asked questions. Read the blog post: V1 vs V3 APIs, what’s the difference?
Postman Collection Updates
The Developer Connect Postman collection has been updated to include the new and updated APIs introduced with this release. The Postman Environment JSON has also been updated.
© ICE Mortgage Technology, Inc. All rights reserved.