23.2 Major Release

Feature Enhancements

Preview Mode APIs

APIs available in Preview mode for planning and feedback purpose only (Try It option disabled, Postman Collection samples not provided).

• Milestone Worksheet (EDC-822):
  • GET: /v3/loans/{loanId}/milestones
    Use this API to get a list of milestone logs for the selected loan.
  • GET:/v3/loans/{loanId}/milestones/{milestoneId}
    Use this API to get the response for a particular milestone log.
  • 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.
• Milestone Free Roles (EDC-822):
  • GET: /v3/loans/{loanId}/milestones/milestoneFreeRoles
    Use this API to get a list of available milestone free roles.
  • PATCH: /v3/loans/{loanId}/milestones/milestoneFreeRoles
    Use this API to update milestone free roles in collection. You can also pass milestone free role details in the payload and assign loan associate user.
• 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
  • POST /v3/users/me/views/pipelineViews
  • PUT /v3/users/me/views/pipelineViews/{viewId}

New and Updated APIs

• V3 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.
• Rate Lock API: Void Lock (EDC-862):
  • 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:

• Encompass Loan Alert Webhooks: How to Enable the Feature

Postman Collection Updates

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.

Downloads
[Updated on June 9, 2023]

Download the 23.2 Developer Connect Postman Collection

[Download the 23.2 Postman Environment JSON](https://help.icemortgagetechnology.com/documentation/developer-connect/postman/ENV_Developer_Sharing_23_2.postman_environment.json