Download Postman Collection
Release Notes
Back to All

23.3 Major Release

October 7th, 2023

🚧

Documentation Revision - 1/19/2024

Please note - the release notes for the 23.3 release have been revised since the initial publication.

Refer to the Updated Webhooks section for more details.

What’s in This Release

Highlights of this release include the following:

Preview Mode APIs

APIs available in Preview mode are for planning and feedback purpose only.

For the current list of APIs currently in Preview mode refer to the API Previews page.

Cursor Based Loan Pipeline API Preview

The Cursor Based Loan Pipeline API provides a basis for generating reports from an Encompass pipeline that can be accessed through a cursor for reliable paginated data based on a snapshot of a loan pipeline.

The first call is made without cursor ID, which generates a new cursor with the provided filter criteria. The generated cursor ID is returned in the response header 'X-Cursor'. The subsequent calls are made with the cursor ID provided in the query parameters along with start / limit for pagination.

Usage Notes

  • The filter criteria is cached on the server side and does not need to be passed in when the call is made with cursorId.
  • The cursor expires after 5 minutes of inactivity.

POST encompass/v3/loanPipeline/report

📘

Use for Report Generation Only

This endpoint is only for report generation. For all real time pipeline results, loan pipeline end point (~/v3/loanPipeline/) should be used

EDC-896

New APIs

SCIM 2.0 User Provisioning API

The System for Cross-domain Identity Management (SCIM) User Provisioning APIs enable assignment of users and organizations to Encompass user groups for purposes of provisioning access to loans and shared Encompass resources (such as Templates and other items configurable on the User Group level).

SCIM is an open standard, REST and JSON based protocol that simplifies the user identity lifecycle management process by enabling automation between cloud-based identity providers (e.g., Okta) and service providers (e.g., Encompass). With SCIM, user identities are created and managed in a single user directory (identity and HR systems) and the user provisioning and deprovisioning changes are communicated across different applications such as Encompass.
The Encompass SCIM APIs are compliant with version 2.0 of the SCIM specification, which supports standard CRUD (Create, Retrieve, Update, Delete) operations.

Schema Body Parameters

A JSON schema is provided that represents the user based on the Encompass user management requirements. The schema parameters passed in the request body tells the SCIM provisioning service how to provision users for Encompass. See SCIM API contract attributes for more details.

The following SCIM API endpoints are added in this release:

POST scim2/v1/users

• This API supports creating an Encompass User and an Encompass User linked with a Data & Document Automation (previously known as AIQ) user.

GET scim2/v1/users

• This API retrieves a list of Users.

GET scim2/v1/users/{userId}

• This API retrieves details for a Specific User.

PATCH scim2/v1/users/{userId}

• This API supports modifying attributes of the User Profile.

DELETE scim2/v1/users/{userId}

• This API supports deletion of a User. Use with caution.

GET scim2/v1/groups

• This API supports retrieving the Encompass User Group List.

GET scim2/v1/groups/{groupId}

• This API supports retrieving a specific Encompass User Group.

PATCH scim2/v1/groups/{groupId}

• This API supports assigning Encompass Users and Organizations to User Groups and removing Encompass Users and Organizations from User Groups.

EDC-858

SCIM User Provisioning User Guide

A new SCIM User Provisioning User Guide was added to provided an overview of the SCIM User Provisioning service including supported use cases, available schemas, listing of API endpoints, API usage notes and payload samples.

Known Issues

  • Get User and Get Users APIs
    • The userIndicators attribute indicating if a user is a Super Admin, Admin, or Top-level user currently includes two enums for Super Administrator. One is misspelled (SuperAdminnistrator) and will be removed in a future release. EBSP-51145.
  • GET Users and GET User Groups APIs
    • For SCIM Get User and Get User Groups APIs there is an optional "count" Parameter. When the count is greater than the max limit of 100, only 10 records are returned. This behavior will be corrected in the 24.1 major release to return the max limit of 100 records if the count is greater than the allowed 100 ,ax limit. EBSP-51359, EBSP-51361.

Workflow Task Instance Management Bulk Update API

A new endpoint is added to the Task Instance Management API which provides the ability to do bulk updates of workflow tasks. Using this endpoint, an update can be made to multiple fields with different values for each field for a subset of workflow tasks.

This API is similar to the existing /v1/tasks PATCH calls; however, the v1/tasks/bulk allows the user to pick and choose multiple tasks that need to be updated with the given updates as a bulk update, versus updating a specific task or all tasks based on specific query parameters.

New contract attributes are added to support the Bulk update API.

EDC-910

Webhook Resource Events API

A new endpoint is added to the Webhook API to retrieve all events associated with a resource. Using the resourceName path parameter, a user can query the associated resource events available for subscription. The response contains an array of events for the specified resource.

GET/webhook/v1/resources/{{resource_name}}/events

EDC-918

Updated APIs

V3 Create Attachment URL API Updates

Object ID is added to the V3 Create Attachment API Response

EDC-894

Encompass Docs API Updates

Added Support for the Opening Package Mavent Compliance Audit- Beta Release

  • The Send Encompass Docs API now supports the Opening Package Compliance Audit by Mavent. A compliance audit can be included with the Create Loan Audit for Opening Order, if the Encompass admin has enabled a new eDisclosure Packages setting "Include Compliance Report With Data Audit”.
  • The new “Include Compliance Report With Data Audit” flag is located on the Docs Setup > eDisclosure Packages page > Compliance Review Report section in Encompass settings. This setting is hidden unless the following conditions are met:
    • One Time Password (OTP) is enabled

      📘

      Enable OTP Setting for Your Encompass Instance

      Please note that we are gradually transitioning away from using authorization codes for eDisclosure. Some API features will only be available to OTP users. It is recommended for the Encompass Docs API users to migrate to OTP.

      Please work with your ICE MT support representative to enable this setting for your environment.

      To learn more about the OTP borrower experience, please see the Borrower Account Authentication and Loan Linking Opt-In Guide.

    • Company Settings / Policies include attribute for
      • 'EnableSendDisclosureENCW' or
      • 'EnableSendDisclosureSmartClient' or
      • 'EnableSendDisclosureTPOC'
  • In addition, when the “Include Compliance Report With Data Audit” flag is set, a new eFolder persona setting is available for eDisclosures “Web Order Disclosures even with Compliance Review Failures”. If unchecked, and there are failures in the Compliance report, the user cannot proceed with the disclosure order unless the failures are addressed. On the other hand, when checked, the user can continue with the document order even if there are Compliance failures present.
  • The “Try It” response samples and the postman samples are updated to reflect this change.

❗️

Beta Release - Not Available for General Production Use

Please note, disclosures on the web is currently in Beta mode, not yet generally available for production use.

We will make an announcement in Encompass Developer Connect when this feature becomes generally available.

EDC-900

New Contract Attributes added to the Get Plans Codes API to support custom and alias Plan Codes

  • New attributes are added to the Plan Code Response Contract including “Id”, “SourceId” and “isCustom” to support custom plan codes.
  • New attribute “isAlias” is added to the Plan Code Response Contract to support alias plan codes.

EDC-901

Get Document Audit API is updated to include Compliance Review Result Object

EDC-904

Miscellaneous Updates

EDC-905

Updated Webhooks

Enhanced Field Change Event - Beta Release

A new Enhanced Field Change webhook event is added for the Loan resource. When subscribing to the Enhanced Field Change event, lenders are notified when field changes occur, including which field changed, old value, and new value. This data can be used to drive downstream processes and update the reporting data warehouse with field delta data.

This event is separate from the existing “Field Change” event and requires a new subscription. If subscribed to this event, webhooks will occur on all loan field change events, filtering by Field ID is not possible.

See the Subscribing to Enhanced Field Change Events - Beta Release section on the Webhook Subscriptions Contracts page for feature details and webhook event notification sample.

❗️

Beta Release - Not Available for General Production Use

Please note, this webhook event is currently in Beta mode, not yet generally available for production use.

We will make an announcement in Encompass Developer Connect when this feature becomes generally available.

🚧

Documentation Revision - 1/19/2024

As part of this release, an enhancement was made to the fieldchange webhook event no longer requiring fields to be added to the Audit Trail Database.

Prior to this release, when subscribing to the fieldchange webhook event and specifying the field to listen to using the filters.attributes, the subject field had to be first added to the Audit Trail Database. When the webhook would fire, the notification payload would include the subject field plus any other Audit Trail Database field that has been updated as a result of the subject field change.

As part of the 23.3 release, when subscribing to the fieldchange webhook event, the subscriber can specify any field in the loan file to listen to using the filters.atributes. The subject field does not need to be added to the Audit Trail Database. When the webhook fires, the notification payload will now include the subject field plus any other field in the loan file that has been updated as a result of the subject field change. Because of this, subscribers of the fieldchange webhook event may see a bigger notification payload.

The Webhook - Overview page was revised to reflect the update.

New Webhooks Added Internal and External User Management

Encompass Developer Connect now supports webhook subscriptions to InternalUsers management events. In addition, a new webhook event was added for the existing ExternalUsers resource. Subscribing to the new webhook events enables integrated lenders to receive notifications when a new user is created, updated, or deleted.

The following resources and events are added:

New Encompass Persona settings are being released in 23.3 to control access to webhook data.

  • “Subscribe to Webhook” - allows API users to subscribe to all webhooks, except Enhanced Field Change.
  • “Enhanced Field Change” - Includes “Subscribe to Webhook” entitlements. Also, allows API users to subscribe to “Enhanced Field Change” webhooks.
  • Encompass Admins automatically can subscribe to any webhook.

Refer to the Persona Settings section on the Webhook Subscriptions page for additional details.

Implementation Considerations

  • IMPORTANT - New Webhook Subscriptions after Encompass v23.3 is implemented.

    • Encompass Admin users can subscribe to any new webhooks. No change.
    • API Users that are not Encompass Admins must be granted one, or both, of the persona settings noted above to create new webhook subscriptions.
    • Existing Webhook subscriptions created prior to 23.3 are not impacted by this persona control.

  • Review all API User Persona settings

    • Once Encompass 23.3 is implemented in your instance, ensure that the new Persona settings above are updated appropriately so that you can continue to subscribe to new Webhooks.
    • Use caution when determining which non-admin personas should have Webhook subscription access, especially Enhanced Field Change since it provides loan-level data, including PII.

EDC-899

Add Your Webhook Destination Domain to the ICE Allow-list

In keeping with security requirements at ICE MT, the webhook destination endpoint domain must be added to the ICE firewall for outbound notifications. Effective October 16th, 2023, new lenders and partners subscribing to webhook events must submit a request to ICE to add the destination endpoint domain to the allow-list for the receiving endpoints.

There are no changes to existing webhook subscriptions using your existing domain. Action is not required unless your current domain changes.

Impacted Webhook Subscribers

This change impacts webhook subscriptions for new or changing domains.

  • If you are a new customer or partner subscribing to receive webhook notifications you will need to first submit a support ticket to ICE Mortgage Technology to add your domain to the ICE allow-list to receive webhook notifications.
  • If you are already subscribing to webhook notifications and your receiving endpoint domain is planned to change (For example, current domain for your subscriptions is https://webhooknotifications.mybank.com to https://webhooknotifications.correspondent.mybank.com) on or after October 16th, 2023, you will need to first submit a support ticket to ICE Mortgage Technology to add your new domain to the ICE allow-list.
  • It may take up to five business days for your domain name to be approved prior to receiving webhook notifications at the new domain. If you wish to redirect subscriptions to the new domain, please cancel your existing subscription and create a new subscription to the new endpoint (no change to this process).

See the Adding Your Webhook Destination Domain to the ICE Allow-list Knowledge Article for additional details.

A new section was also added on the Webhook Endpoint Requirements page for future reference.

📘

Adding your domain to the ICE allow-list is not the same as whitelisting your IP

Please note, this is not IP whitelisting. If your IP address changes, however, your domain URL stays the same, you do not need to submit a request to ICE.

Important Notices

Possible Breaking Change (with 23.3 Major Release)

  • 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"
            
        }
    ]
}

Possible Breaking Changes (with 24.1 Major Release):

  • V1/V3 All Loan APIs (EBSP-40379): Restrict editing of fields with allowEdit=0 in all loan APIs in v1 and v3.
    • Refer to V3 Get Field Schema API, which returns the standard field definitions in a loan. When running this API, the field IDs in the response that indicate "readOnly :true" are impacted by this change. Starting in 24.1, you will no longer be able to edit those fields.

🚧

Please note that since this publication, this change is being deferred to a future release, release has not been assigned at this time.

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

🚧

Please note that since this publication, this change is being deferred to 24.2 Major Release.

Possible Breaking Changes (with 24.2 Major Release)

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

Postman Collection Updates

The following update were made to the 23.3 Postman Collection.

  • New folder was added to include the SCIM Provisioning samples
    • SCIM Provisioning in EDC
  • The Workflow Tasks > End User Flow folder was updated to include a sample orchestration for the Bulk Update API
    • Bulk Update API
  • New webhook subscription samples were added to the Webhooks folder to demonstrate how to subscribe to the Internal and External user events.
    • Create an InternalUsers Webhook Subscription
    • Create an ExternalUsers Webhook Subscription

Downloads

Encompass Developer Connect Postman Collection

Encompas Developer Connect Postman Variables JSON

Fixed Issues

  • EDC 920 - Update the Get Order Status API to include the user constraint for getting order status
  • EDC 919 - The Get Order Status API is showing a wrong URL
  • EDC 914 - Rate Lock API Contract Missing Object definitions
  • EDC 902 - Update Notify on Receipt & Date Attributes
  • EDC 895 - Specific EPPS API Response Examples not present and/or incorrect
  • EDC 886 - Error when adding documents to Disclosure2015TrackingLog
  • EDC 874 - V3 FieldWriter update documentation to clarify that not all fields can be updated using FieldWriter
  • EDC 871 - eFolder Document contract missing a few attributes
  • EDC 856 - Broken links
© ICE Mortgage Technology, Inc. All rights reserved. Terms of Use