Encompass Developer Connect 24.2

🚧

Breaking Change

Please review the notice and make the necessary changes to your integration before the specified release to avoid disruptions.

V3 Loan APIs (EBSP-49691): Change to payload response behavior

• The following log entities are currently being returned in the V3 Loan APIs response when no view parameters are passed OR if view = entity OR If view=full. These entities are not returned when view=logs. This is not expected behavior, and therefore a change will be made effective 24.1 release to return the mentioned entities only when view=logs or view=full. Log entities will not be included when view is not passed. If your application is counting on the presence of these entities, you can leverage the query parameter view=logs or view=full to receive the log data.
  • PostClosingConditions
  • PreliminaryConditions
  • UnderwritingConditions
  • LoanActionLogs
  • LockRequests
  • MilestoneFreeRoles
  • MilestoneTasks
  • LockDenials
  • LockConfirms

Loan Field Reader API (EBSP-45807): The default value for invalid field behavior will be to fail the request, if invalid fields are provided, and the query parameters are not provided. If you need to provide invalid field IDs and receive a blank response back for any reason, field reader can be called with parameter “invalidFieldBehavior” as “Include”.

Channel Option Controls (EBSP-54046): When creating a new loan or updating an existing loan using V3 APIs, the “channel” request attribute currently accepts any value, including the options not enabled for use in the Encompass Loan Setup > Channel Options setup screen. This is not expected behavior, and therefore, the V3 Loan API will be updated to enforce the validation of the Channel Options settings when creating or updating the loan via an API. If the user attempts to pass a Channel Option not enabled for use for your version of Encompass, an error will be returned.

SCIM Provisioning API (EDC-928):

• The SCIM User Provisioning API currently supports passing multiple product schemas in the same call, meaning a given employee profile can be created or updated for multiple ICE Mortgage Technology applications at the same time. Effective 24.2 release, only one product schema will be allowed for the POST and PATCH calls, supporting user management for one product at a time.
• In addition, effective in the 24.2 release, the structure of the error response payload will be streamlined to support user management for one product at a time.
• The default behavior for DELETE scim2/v1/users API will be modified to trigger a soft delete to deactivate the user profile in Encompass/DDA. Hard user delete will not be feasible via the SCIM API.

SCIM Schema Changes (EDC-928):

• The accountIndicators attribute in the Encompass Internal User Schema will be deprecated effective in the 24.2 release. The accountIndicators attribute is being replaced with the following attribute already supported in the 24.1 release.
  • loginEnabled
  • AccountEnabled

Credit Partners and Samples: Removed content regarding support for Factual Data Credit (Partner ID 276521) from Credit Partners and Samples. Support for this partner ID was deprecated in an earlier release.

Correction for "stateAbbreviation" (EDC-985): The following pages and endpoints have typographical errors for "stateAbbrevation" that will be corrected to "stateAbbreviation" in release 24.2:

• SCIM User Provisioning User Guide - (Create User code sample)
• Settings: SCIM Provisioning - Update User - (Updating State License Information section)
• Settings: External Users - V3 Contracts - (External User State License Contract attributes table)
• Settings: External Users - V3 Manage External Users - (Action=Update code sample)
• V3 Get an External Organization - (Response Body)

Additional Payload Added for EPC Service Order Resource (EDC-1011):

The Service Order webhook resource will be updated to include extra payload in the event notification. This change is applicable to all Service Order webhook events. Using the added attributes, lenders can filter out webhooks that they need to work on based on the webhook itself, instead of polling the GET Service Order Status API for every Service Order webhook they receive.

The following attributes will be added:

• productListingName - The name of the product as listed by the EPC partner.
• productId - The unique identifier of the EPC partner product.
• partnerId - The unique identifier of the EPC partner.

Subscribers of the Service Order webhook notifications need to update their implementation to account for the newly added attributes to avoid disruptions.

Encompass Developer Connect 23.3

🚧

Breaking Change

Please review the notice and make the necessary changes to your integration before the specified release to avoid disruptions.

Loan Schema updates (EDC-923, CBIZ-52826)

To help ensure the logic to populate the Counseling Confirmation and Counseling Format type information on the Fannie Mae ULDD XML adheres to Fannie Mae’s Appendix D requirements, the loan-level First-Time Homebuyer field (field ID 934) on the ULDD/PDD input form has been replaced with two new borrower-level fields: Borrower First-Time Homebuyer (field ID 4973) and Co-Borrower First Time Homebuyer (field ID 4974). Utilizing these two new borrower-level fields enables Encompass to capture separate values for the borrower and co-borrower as opposed to capturing just one value for first-time borrower status with the singular loan-level field. The field ID 934 is still provided on other Encompass input forms, such as the Borrower Summary - Origination, Property Information, Fannie Mae Additional Data, and Freddie Mac Additional Data input form forms, however, this field is now padlocked.

Impact to API Users

• Starting with the 23.3 release, this will be a breaking change if you are currently writing to the First Time Home Buyers field ID 934. If you need to update field ID 934 via the loan update API, you can do so using one of the following options:

Option 1 (Recommended)

Send the corresponding borrower (field ID 4973) or coborrower (field ID 4974) first time home buyer indicator fields in the payload in order for Encompass to calculate the value of field ID 934.

{
    "applications": [
        {
            "id": "{ApplicationId}",
            "borrower": {
                "firstTimeHomebuyerIndicator": true
            },
            "coborrower": {
                "firstTimeHomebuyerIndicator": false
            }
        }
    ]
}

OR

Option 2

Padlock the field ID 934 to write to the prior value by adding it to the FieldLockData collection.

{
    "firstTimeHomebuyersIndicator": true,
    "fieldLockData":[
        "loan.firstTimeHomebuyersIndicator"
    ]
}

{
    "firstTimeHomebuyersIndicator": true,
    "fieldLockData": [
        {
            //"lockRemoved": true,
            "modelPath": "loan.firstTimeHomebuyersIndicator"
            
        }
    ]
}

Encompass Developer Connect 23.1

🚧

Breaking Change

Please review the notice and make the necessary changes to your integration before the specified release to avoid disruptions.

Upcoming Changes to V3 Loan Contract Attributes

With the release of Developer Connect 23.1 in 2023, the attribute type for V3 Loan contract attributes ApplicantType and isBorrower will change to ReadOnly. 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."
        }
    ]
}

Encompass Developer Connect 22.2

🚧

Breaking Change

Please review the notice and make the necessary changes to your integration before the specified release to avoid disruptions.

Change Made 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.

❗️

Deprecation

Deprecated APIs will no longer be available after the specified release timeline. Please migrate your applications to the recommended alternative APIs before the deprecated timeline to avoid disruptions.

Retirement of Language Bindings

The .NET Language Bindings were retired on January 8, 2022 with the 21.4 release. ICE Mortgage Technology will continue to support them.

Encompass Developer Connect 21.2

❗️

Deprecation

Deprecated APIs will no longer be available after the specified release timeline. Please migrate your applications to the recommended alternative APIs before the deprecated timeline to avoid disruptions.

EPPS V1 APIs

As of June 5, 2021, the EPPS V1 APIs are deprecated and are no longer supported by ICE Mortgage Technology. Please use the V2 EPPS APIs going forward to programmatically retrieve best-fit program and pricing information and to retrieve and select rates for Encompass loans.

Deprecated V1 APIs and New V2 Replacement APIs

The following table lists the deprecated EPPS V1 APIs and the new V2 replacements.

Rates

User Management

Guidelines