Download Postman Collection
API Reference

Loan Enhanced Conditions

The Enhanced Conditions feature was introduced in Encompass 20.2. Enhanced conditions provide lenders with the ability to customize conditions at a condition level and field level, and to enable condition reports to be generated across multiple loans (both of which are not currently supported by the standard conditions provided in earlier versions of Encompass).

To learn more about enhanced conditions and prerequisites for enabling and using enhanced conditions, refer to the Working with Enhanced Conditions: Setup and User Guide.

Enhanced Conditions API Sets

Encompass Developer Connect provides the following sets of APIs to create and manage Enhanced Conditions:

  • The APIs for Managing Enhanced Conditions allow Encompass Web and Encompass TPO Connect to access Enhanced Conditions metadata for managing loan and document conditions in a loan file. These APIs provide methods to retrieve, add, remove, update and delete enhanced conditions in a condition set, to manage condition comments, and to assign or unassign condition documents. The Enhanced Conditions APIs are described in detail in the next section, APIs for Managing Enhanced Conditions. Note that there is a loan level indicator (Field ID: ENHANCEDCOND.X1, json path: loan.useEnhancedConditionIndicator) which denotes if the loan is using Standard or Enhanced Conditions. If the attribute is set to true, then the loan uses Enhanced Conditions. If set to false, Standard Conditions are used in the loan, for which separate APIs are available.

  • The APIs for Enhanced Conditions Settings define condition types, statuses, sources, recipients, and Prior To values, as well as define which actions can be taken on a given condition template based on multiple factors, including the user’s role. To learn more about the Enhanced Condition Settings, see APIs for Enhanced Conditions Settings.

  • The Automated Conditions Evaluator API evaluates the Automated Enhanced Conditions Business Rules set up in Encompass Settings and returns the list of condition templates that can be applied to the loan, given the state of the loan. For more information, see Automated Conditions Evaluator API.

Enhanced Conditions Settings

The APIs for Enhanced Condition Settings allow you to manage Enhanced Condition types, sets, and templates. Use these APIs define condition types, statuses, sources, recipients and Prior To values, as well as define which actions can be taken on a given condition template based on multiple factors, including the user’s role.

The following APIs are available for managing Enhanced Conditions Settings in Encompass:

Enhanced Condition Types

Endpoint URL: /encompass/v3/settings/loan/conditions/types

  • Get All Enhanced Condition Types. Retrieve a list of all condition types.
  • Get an Enhanced Condition Type. Retrieve a specified condition type.
  • Manage Enhanced Condition Types. Adds, updates, or removes a condition type.

Enhanced Condition Sets

Endpoint URL: /encompass/v3/settings/loan/conditions/set

  • Get All Enhanced Condition Sets. Retrieve a list of all condition sets.
  • Get an Enhanced Condition Set. Retrieve details for a specified condition set.

Enhanced Condition Templates

Endpoint URL: /encompass/v3/settings/loan/conditions/templates

  • Get All Enhanced Condition Templates. Retrieve a list of all condition templates.
  • Get an Enhanced Condition Template. Add or update an enhanced condition template.
  • Manage Enhanced Condition Templates. Retrieve a list of all condition templates.
© ICE Mortgage Technology, Inc. All rights reserved. Terms of Use