Download Postman Collection
Release Notes
Back to All

22.3 Major Release

October 15th, 2022

New and Updated APIs

Search Service

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. 

  /v3/queryEngines/loan?calculateTotalCount=CountOnly 

  /v3/loanPipeline?calculateTotalCount=CountOnly

EBSP-39022

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: 

       PATCH /v3/loans/{loanId}/disclosureTracking2015Logs/{disclosureLogId}

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: 

  PATCH /v3/loans/{{LoanId}}/closingDocument/vestingEntities?action=add&view=entity

EBSP-38062

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.

For example, the Sample Plugin is now located here:
https://github.com/IceMortgageTechnology/exp19-custom-plugins
And
The Sample Custom Tool is now located here:
https://github.com/IceMortgageTechnology/loconnect-custom-tool-sample

Be sure to update your bookmarks and favorites.

New Guides & Blog Posts

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

To learn how to import the Postman collection and environment JSON, see Testing with Postman.

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