Deprecation and Sunset Notices
This page provides the deprecation plans and sunset status for APIs and resources in Encompass Developer Connect. Review this page to determine the Encompass Developer Connect releases in which these items will be deprecated or sunset. Definitions of these terms are provided below.
Deprecated - The API or resource is no longer recommended for use and no longer actively supported by ICE. The API or resource remains functional and available for use, but it is strongly recommended that you do not use it with new integrations, as it will eventually be sunset (removed/discontinued) in a future Encompass Developer Connect release. When an API or resource is deprecated, a new version or recommended alternative is available. You are strongly encouraged to use the new or recommended alternative to avoid disruptions.
Sunset - The API or resource is no longer available for use. It will be/has been removed from the catalog with the specified Encompass Developer Connect release. You must use a new version or recommended alternative to continue the API or resource’s intended functionality (if available).
Encompass Developer Connect 26.3
Sunsetting V1 eFolder Attachment APIs
As part of a data center migration, the following V1 eFolder Attachment APIs will be sunset in the upcoming 26.3 release:
- V1 Get List of Attachments
GET /encompass/v1/loans/{loanId}/attachments
- V1 Get an Attachment
GET /encompass/v1/loans/{loanId}/attachments/{attachmentId}
- V1 Upload Attachment to eFolder
PUT /encompass/v1/loans/{loanId}/attachments/url
- V1 Get Attachment from eFolder
POST /encompass/v1/loans/{loanId}/attachments/{attachmentId}/url
- V1 Get Thumbnail of Page
POST /encompass/v1/loans/{loanId}/attachments/{attachmentId}/pages/{pageId}/thumbnail/url
- V1 Get Page of Attachment
POST /encompass/v1/loans/{loanId}/attachments/{attachmentId}/pages/{pageId}/url
- V1 Update Attachment
PATCH /encompass/v1/loans/{loanId}/attachments/{attachmentId}
Please begin efforts to discontinue further usage of these APIs in favor of V3 eFolder Attachment APIs.
EDC-1186
Encompass Developer Connect 24.3
Task Group APIs Deprecation
The Task Group feature is being redefined and therefore the following Task Group-related API endpoints have been deprecated:
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-1033
Encompass Developer Connect 24.2
Credit Partners and Samples
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.
Encompass Developer Connect 22.2
Sunset of Language Bindings
The .NET Language Bindings were sunset on January 8, 2022 with the 21.4 release. ICE Mortgage Technology will not continue to support them.
Encompass Developer Connect 21.2
EPPS V1 APIs
As of June 5, 2021, the EPPS V1 APIs are deprecated and are no longer supported by ICE Mortgage Technology. Please use the V2 EPPS APIs going forward to programmatically retrieve best-fit program and pricing information and to retrieve and select rates for Encompass loans.
Deprecated V1 APIs and New V2 Replacement APIs
The following table lists the deprecated EPPS V1 APIs and the new V2 replacements.
Rates
V1 | V2 |
---|---|
POST /epps/v1/loanQualifier | POST /epps/v2/loanQualifier |
POST /epps/v1/loans/{loanId}/rateSelector | POST /epps/v2/loans/{loanId}/rateSelector |
POST /epps/v1/loans/programs/{programId}/eligibility | POST /epps/v2/loans/programs/{programId}/eligibility |
POST /epps/v1/loans/programs/{programId}/adjustments | POST /epps/v2/loans/programs/{programId}/adjustments |
User Management
V1 | V2 |
---|---|
GET /epps/v1/userMappings | GET /epps/v2/userMappings |
PATCH /epps/v1/userMappings | PATCH /epps/v2/userMappings |
Guidelines
V1 | V2 |
---|---|
GET /epps/v1/programs/{programID}/guidelines | GET /epps/v2/programs/{programID}/guidelines |
Updated 12 days ago