Download Postman Collection
Release Notes
Back to All

22.2 Major Release

June 11th, 2022

New and Updated APIs

V1 Encompass Compliance Service APIs

The Encompass Compliance Service (powered by Mavent) provides an instant loan file check and determines if a loan complies with selected state and federal regulations. The Encompass Compliance Service APIs provide lenders with the ability to programmatically order and retrieve a full compliance review or preview reports for a given loan.

  • View Compliance Reports
    The Get Compliance Report API retrieves the latest compliance review report for a loan. The complianceReport response contract contains details for each review that was performed and provides the result of each review. When a compliance issue occurs, the data (or missing data) causing the issue is also described in the report. 

    GET   ecs/v1/compliancereports

  • Order a Compliance Report
    The Order a Compliance Report API runs a set of compliance reviews in areas such as TILA tolerance, federal/state/local high cost thresholds, federal higher-priced mortgage loan thresholds, GSE fee limits, and Ability-to-Repay/Qualified Mortgage (ATR/QM) requirements. The types of reviews performed on a loan will depend on which services have been set up in Encompass and the type of loan being reviewed.

    POST   ecs/v1/compliancereports

V3 Borrower Vesting APIs

The Borrower Information - Vesting form available in Encompass Loan Officer Connect enables users to enter borrower information, define the ownership rights for the property, enter corporation and trust information, if needed, and create the vesting statement that is used in loan documents. The Borrower Information - Vesting form data can also be viewed and managed programmatically with the Encompass Developer Connect Borrower Vesting APIs.

Borrower Vesting APIs include the following:

  • View Vesting Entities - Returns the borrower vesting entities on a loan.

    GET   /v3/loans/{loanId}/closingDocument/vestingEntities?view=entity

  • Manage Vesting Entities - Adds, deletes, replaces, reorders, and updates the vesting entities for a borrower or co-borrower.

    PATCH   /v3/loans/{loanId}/closingDocument/vestingEntities

EBSP-35905

EPPS Lookups APIs

The EPPS Lookups API set has been expanded to search for and return more types of loan information across the Product and Pricing system. The new Lookups APIs include the following:
GET /epps/v2/lookups/state/{stateId}/counties
GET /epps/v2/lookups/states
GET /epps/v2/lookups/agencyapprovals
GET /epps/v2/lookups/lockdays
GET /epps/v2/lookups/prepayPenaltyTerms
GET /epps/v2/lookups/deliveryTypes
GET /epps/v2/lookups/encompassElements
GET /epps/v2/lookups/customFields
GET /epps/v2/lookups/documentationTypes
GET /epps/v2/lookups/citizenship
GET /epps/v2/lookups/buydownType
GET /epps/v2/lookups/nonQMDocLevel
GET /epps/v2/lookups/buydownContributorType
GET /epps/v2/lookups/NODTypes
GET /epps/v2/lookups/zipcodes/{zipCode}/locations
GET /epps/v2/lookups/loans/{LoanID}/loanlimits
GET /epps/v2/lookups/UnitTypes
GET /epps/v2/lookups/CommitmentTypes
GET /epps/v2/lookups/clientSettings
GET /epps/v2/lookups/investors
GET /epps/v2/programs/{programID}/guidelines/details/{qualificationID}

V3 Get All Milestone Logs API

The new V3 Milestones API retrieves all milestone logs for a given loan.

GET  /v3/loans/{loanId}/milestones

EBSP-35437

V1 Webhook Enhancements

New Webhook for Exclusive Loan Lock and Unlock Events
Encompass Developer Connect now supports webhook subscriptions for exclusive lock and unlock events against the Loan resource. Subscribing to exclusive lock and unlock events, enables integrated lenders and partners to receive notifications when loans are exclusively locked and unlocked in the platform and respond accordingly.

❗️

Important

As with all webhook events, webhook notifications are not guaranteed to be in real-time. There will be a delay for a webhook notification to be sent after a triggering loan lock/unlock event occurs. Due to this, there is the potential for an intervening lock event between the emission of the notification and your application's attempt to gain a new lock on the file. Implementation of the loan lock/unlock events subscription will not eliminate the need to handle retries, but it can assist in limiting the amount of polling that your applications have to do in order to access loan files after a user releases a lock.

For additional details about subscribing to Lock and Unlock events, see Subscribing to Loan Lock and Unlock Events.

Delete Event Now Supported for Enhanced Condition Template and Enhanced Condition Type
The Webhook API now supports the delete event for the Enhanced Condition Template and Enhanced Condition Type resources. Create a subscription to the delete event to receive notifications when an Enhanced Condition Template and Enhanced Condition Type is permanently deleted from Encompass.

New Webhooks for AIQ Resources and Events — Limited Availability
Some lenders and partners who are using AIQ with their Encompass instance will be able to subscribe to AIQ resources and events to notify lenders when documents are propagated from AIQ Sync to the Encompass eFolder, and when new updates to the loan file (made in AIQ) are available.
NOTE: This enhancement is not generally available. Lenders who use AIQ with Encompass may see AIQ resources and events, however, will not be able to subscribe via self-service. For more information about this enhancement, please contact your ICE Mortgage Technology Relationship Manager.
PSS-60364

Updates Made to V3 Loan API

Null Check Performed to Exclude Empty Arrays
Starting with this release, the V3 Loan API performs an is-empty check to exclude empty arrays from the Get Loan response. Our V3 JSON schema does not mark these collection/array properties as required, which means it already allows them to be omitted. These changes impact only V3 APIs, for example, the Get Trade API.
EBSP-37683

AltId Returned Only with Create Loan Response
The altId (string) attribute in the CorrOtherInsuranceContract will be generated with the Create Loan response only.
EBSP-37583

Update Made to V3 Update Loan API to Support Investor Templates
A new query parameter, templateType=Investor, has been added to the Loan API. This parameter assigns an Investor Template to an existing loan file.
EBSP-37532

New Query Parameter Added to V3 Pipeline API
A new query parameter, calculateTotalCount, has been added to the Loan: Pipeline API. This parameter specifies how long the query can take to calculate the total loan count for pagination.
Possible values are:

  • NoWait (default): Calculate total count, but if not returned in 3 seconds, then return without calculation.
  • WaitForCount: Wait for total count to be returned before returning response.
  • NoCount: Skip calculation and return pipeline query result (fastest option).

EBSP-36950

Update Made to V3 Enhanced Conditions API
A new attribute, SourceOfConditions, has been added to the EnhancedConditions contract to capture the source of the condition. Possible values are the AUS options: DUFindings, EarlyCheck, Findings, PAFindings, FHAFindings.
EBSP-37239

Updated Documentation to Reflect Current EPPS Contracts

The Rates Contracts and Attributes tables have been updated to reflect the current contracts in EPPS. The updated contracts include Loan Qualifier, Lock, and Eligible Rates.

Postman Collection Updates

The Developer Connect Postman collection has been updated to include the new and updated APIs introduced with this release. Example use cases for these APIs are available in the collection. The Postman Environment JSON has also been updated.

  • Download the 22.2 Developer Connect Postman Collection

  • Get the 22.2 Postman Environment JSON

API Reference Updates

The following changes have been made to the left-navigation menu in the API reference:

  • The Services APIs for ordering and getting credit, electronic verification, AUS, appraisal, and flood reports are now listed under Services: Partner.
  • The EPPS V2 APIs for searching for best-fit program and pricing information with Encompass Product and Pricing Service are now listed under Services: EPPS.
  • The new Encompass Compliance Service APIs for ordering and retrieving full compliance reviews and preview reports are listed under Services: ECS.
© ICE Mortgage Technology, Inc. All rights reserved. Terms of Use