November 20.2 Major Release
New Enhanced Conditions V3 APIs
Encompass Developer Connect provides the following sets of V3 APIs to create and manage Enhanced Conditions: Manage Enhanced Conditions, Enhanced Conditions Settings, and the Automated Conditions Evaluator API.
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 following APIs are available to manage enhanced conditions in the loan:
Endpoint URL: /encompass/v3/settings/loan/loanId/conditions
- Get All Enhanced Conditions. Retrieve a list of enhanced conditions for a loan.
- Get an Enhanced Condition. Retrieve details about a specified enhanced condition.
- Manage Enhanced Conditions. Add, update, remove, or duplicate an enhanced condition in a loan.
Endpoint URL: /encompass/v3/settings/loan/loanId/conditions/conditionId/comments
- Get Comments. Retrieve comments for enhanced conditions.
- Manage Comments. Add, update, and remove comments for enhanced conditions.
Endpoint URL: /encompass/v3/settings/loan/loanId/conditions/conditionId/documents
- Get Documents. Retrieve documents of an enhanced condition.
- Manage Documents. Add, update, remove documents for an enhanced condition.
Endpoint URL: /encompass/v3/settings/loan/loanId/conditions/conditionId/tracking
- Get Status Tracking Entries. Retrieve the status of tracking entries for an enhanced condition.
Enhanced Conditions Settings
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.
The following APIs are available for managing Enhanced Conditions Settings in Encompass:
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.
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 a specified condition set.
Endpoint URL: /encompass/v3/settings/loan/conditions/templates
- Get All Enhanced Condition Templates. Retrieve a list of all condition templates.
- Get an Enhanced Condition Templates. Retrieve a list of all condition templates.
- Manage Enhanced Condition Templates. Add or update an enhanced condition template.
Automated Conditions Evaluator API
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.
Evaluate Automated Conditions
Endpoint URL: /encompass/v3/calculators/automatedConditions
- Evaluate Automated Conditions. Retrieve a list of condition templates that can be applied to the loan, based on the given the state of the loan.
Updated V3 APIs
Enhancement to Update Loan API
V3 Stateless Update Loan API has been updated enabling you to apply a loan program template to an existing loan.
New Settings API - Retrieve List of Loan Program Templates
New API to get the list of loan program templates, along with the full path, which can then be applied to an existing loan.
New and Updated V1 APIS
The following new and updated V1 APIs are available with the Encompass Developer Connect 20.2 November release.
Webhook Event History API
-
New Query Parameters Added to Webhook Get All Events API
Two new query parameters, subscriptionId and resourceId, have been added to the Webhook Get All Events API.
A subscription ID is the unique ID assigned to a subscription when it is created. You can now use the subscriptionId query parameter to return the event history for a specified subscription.
A resource ID is the unique ID of a resource (i.e. Loan); it is also known as the loan GUID. The resource ID can be associated with an event subscription. You can use the resourceId query parameter to return the event history of a specified loan. -
Query Parameters Now Case-Insensitive
The Webhook Event History query parameters are no longer case-sensitive. -
DeliveryAttempted Status for Events
To identify an undelivered notification, check for DeliveryAttempted status for events.
A DeliveryAttempted status is logged only when there is a failure from the subscription webhook endpoint. Check DeliveryAttempted statusDetails for an error response code and error response details from the subscription webhook endpoint.
Rate Lock Updates - Support for Applying the Loan Program Through Submit Rate Lock API
APIs have been updated with this release to support the application of a loan program through the existing Submit Rate lock API by passing the full path of the template with a new attribute.
If both Template and Payload are sent, and payload values are same as template, the values are retained. If payload values are different from the template values, payload values will replace the template values.
New EPPS V2 APIs
Deprecation Notice - EPPS V1 APIs
Ellie Mae will be deprecating EPPS V1 APIs to make way for our new EPPS V2 APIs. Our EPPS V1 APIs will continue to be supported until Q2 of 2021. We are making the EPPS V2 APIs available with this release to allow developers to get familiar with the APIs while maintaining the existing behavior as the APIs are backward compatible. For more information see the Deprecation Notice for EPPS V1 APIs.
The EPPS APIs are moving to V2. The V1 and V2 APIs are largely the same; however, we have made some changes in the V2 contracts. The most significant change was made to the Get Programs and Rates (/loanQualifier endpoint) and Get Rates (/eligibility endpoint) schemas. The standardProduct contract in these schemas has changed from a hard-coded list of Standard Products to an Array of Product IDs. You can use the Lookups API for Standard Products to get all possible values.
Example array:
“standardProducts": [1,5,2,3,4]
Lookups APIs
The Encompass Developer Connect 20.2 release introduces new EPPS Lookups APIs. Use the Lookups APIs to search for certain types of loan information across the Product and Pricing system.
Agency Approvals. Returns all Agency Approvals related to the user. The response contains key-value pairs.
Bankruptcy. Returns all records from the Bankruptcy table for the given user. The response contains key-value pairs.
Counties. Returns a list of counties available for a given state. The response contains key-value pairs.
Delivery Types. Returns Delivery Types available to the user. The response contains key-value pairs.
Encompass Elements. Returns the Encompass Elements set for the user. The response contains key-value pairs.
Foreclosure. Returns all records from the Foreclosure table for the given user. The response contains key-value pairs.
Investors. Returns all valid Investors for the user. The response contains key-value pairs.
Lien Position. Returns all the Lien Position options associated with the user. A list of key-value pairs is returned in the response.
Loan Terms. Returns all Product Options associated with the user. The response contains key-value pairs.
Loan Usage. Returns all the Loan Usage options associated with the user. A list of key-value pairs is returned in the response.
Lock Days. Returns all Lock Days related to the user. The response contains a list of lock days and VirtualLock.
Prepay Penalty Terms. Returns Prepay Penalty Terms. The response contains key-value pairs.
Product Options. Returns all Product Options associated with the user. A list of key-value pairs is returned in the response.
Property Type. Returns all Product Types associated with the user. A list of key-value pairs is returned in the response.
Property Use. Returns Property Use in the form of a list of key-value pairs for the given user.
Special Products. Returns all Special Products associated with the user. A list of key-value pairs is returned in the response.
Standard Products. Returns all Standard Products available to the user. A list of key-value pairs is returned in the response.
States. Returns all states available for a given user. Response includes State ID, State Name, and Abbreviation.
© ICE Mortgage Technology, Inc. All rights reserved.