23.1 Major Release

Developer Portal Enhancements

New Developer Portal URL 
The developer portal has moved to the new ICE Mortgage Technology developer domain: https://developer.icemortgagetechnology.com. Users will be redirected to the new URL automatically when opening the old developer portal https://docs.developer.elliemae.com.

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.

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

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.

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.

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
  

Both the FulfillmentContract and the FulfillmentRecipientContract were updated to denote required fields when adding a manual fulfillment to an existing Disclosure Tracking log.

Usage Notes

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

• Product and Pricing: Setting the Rate and Price Adjuster Details in the Lock Request Form under Detailed Lock
• Character Encoding Used in Encompass

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:

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

Downloads:

Download the 23.1 Developer Connect Postman Collection (updated on March 23, 2023)

Download the 23.1 Postman Environment JSON

---

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

For the full list of issues resolved with this release, see the Encompass GSE Services 22.3 November Critical Patch release notes.