New APIs

The Developer Connect August Major release introduces the following new APIs:

Rate Lock APIs
The Rate Lock Management API allows you to submit a rate lock request for a loan and view rate lock information, extend, re-lock, cancel or update an existing rate lock.

• Get All Rate Lock Requests retrieves all rate lock requests for the specified loan.
• Get a Rate Lock Request retrieves rate lock information for a specified request ID in a loan.
• Get Snapshot of a Rate Lock Request returns the loan snapshot associated with the specified Rate Lock Request.
• Submit a Rate Lock Request creates a new rate lock request if you are a Loan Officer, and allows a Secondary user to confirm/ extend, re-lock/ cancel a new rate lock request.
• Update a Rate Lock Request updates the rate lock request of a specified request ID for a loan.
• Confirm a Rate Lock Request confirms a rate lock request.
• Cancel Lock Request cancels an existing lock.
• Deny a Rate Lock Request denies a rate lock request for the specified request ID.

Loan Field Reader

• Get Field Values retrieves the values for the specified field IDs within a loan.

Loan Import from File

• Create Loan from Import File creates a loan from import file. For this release, it creates a new loan in Encompass using loan data imported from a Fannie Mae 3.x loan file.

Personas

• Get a List of Personas returns the list of all personas on the Encompass instance.
• Get a Specific Persona returns details for a specified persona along with the access rights assigned to the persona.

Enhancements

Change Made to the lockDays Attribute in EPPS APIs
The lockDays attribute passed in the Get Programs and Rates and Get Eligible Rates APIs has changed. The lockDays attribute is now and array with multiple values. Previously, it was an integer value. To learn more about the lockDays attribute, see the EPPS Loan Qualifier Attributes.

The Developer Connect February Major release introduces the Encompass Product and Pricing Service (EPPS) APIs. These APIs can be used to create a rates search web app so borrowers can search for best fit program and pricing information without creating a loan application.

New EPPS APIs

User Mapping APIs
To retrieve rates and programs from EPPS, a mapping must be established between Encompass and the EPPS user. To establish this mapping, the following APIs are provided:

• Get User Mapping retrieves the currently logged in Encompass user’s mapping to the EPPS user.
• Map EPPS User for mapping an Encompass user to an EPPS user.

Rates APIs

• Get Programs and Rates retrieves a list of loan programs and rates for a given loan information.
• Get Guidelines retrieves a specified Pricing program.
• Select Rate returns the rates and adjustments that can be applied to a loan within EPPS.
• Get Eligible Rates for determining whether a given program for a loan is eligible for Trade and fetches the eligible rates.
• Get Adjustments for determining the adjustments for Trade and fetches LLPA and SRP pricing details.

Encompass API Enhancements

• Create Loan API now supports the assignment of Loan Officer to the loan at the time of creation.

December 18.4 Service Pack

Support for IP Access and Restrictions
The Encompass Developer Connect December Service Pack release introduces support for the IP access and restrictions feature in Encompass Admin Tools. The Allow access from certain IPs option in the Encompass Admin Tools allows administrators to indicate specific IP addresses from which users are allowed to access Encompass Developer Connect and Encompass Loan Officer Connect. Please review these steps in the Encompass online help for more information about this feature.

🚧

Action Required

For Encompass 18.4 or newer: The IP access and restrictions feature is configurable in Encompass Admin Tools. As described in the Encompass online help, you will have to explicitly apply this feature to Developer Connect. When configured, only the Encompass 18.4 Developer Connect clients using a specified IP address or within a specified IP range will be allowed to access Encompass.

For Encompass 18.3 or older: IP access and restrictions are configurable only with Encompass 18.4. However, the IP access and restrictions configured with Encompass 18.4 will apply automatically to Developer Connect clients running Encompass 18.3 or older. When using the IP access and restrictions feature with Encompass 18.3 clients, ensure the API application IP addresses and corresponding users are configured accordingly.

NEW APIS

• AUS Tracking Logs for retrieving, creating, and updating tracking logs, and for retrieving a snapshot of a tracking log.
• Conversation Log for retrieving conversation logs from loans.
• Transient Calculator for previewing loan calculations for a specified loan. The calculations are not saved to the loan, but can be used to preview or estimate the daily interest, down payment monthly payments and so on.

NEW APIS
The Encompass Developer Connect October Major release introduces the following new APIs for Encompass instances upgraded to 18.4:

• Organizations APIs for retrieving information about your company and viewing the hierarchy of your company and it's suborganizations or branches.
• Users APIs for viewing the user accounts with which your employees access Encompass. For retrieving the profile and group information to which a user belongs, as well as the user's compensation plans, licenses and access permissions.
• Disclosure Tracking 2015 Logs for retrieving log tracking entries for the Loan Estimate, Closing Disclosure, Settlement Service Provider, and Safe Harbor disclosures.

ENHANCEMENTS
Webhook API

• New Elli-SubscriptionId Header
  A new header, Elli-SubscriptionId, is being introduced in this release. This new header contains a unique subscription ID that is assigned when the subscription is created.

• New Subscription Signing Key
  A subscription signing key is also being introduced in this release. Every subscription will have either a custom or default signing key when it is created. When a webhook notification is received, the signing key serves as a password that maps to the subscription's ID to validate the notification. A subscription’s signing key is defined by the signingkey attribute in the subscription object. For more information about the signing key, see the Subscription Signing Key section under Subscriptions.

Conditions API
The following new Conditions APIs and methods are being introduced in this release:

• Underwriting API now supports additional methods for creating and managing underwriting conditions, comments and documents.
• Preliminary Conditions now supports additional methods for creating and managing preliminary conditions, comments and documents.
• Post-Closing Conditions now supports additional methods for creating and managing post-closing conditions, comments and documents.

BEFORE UPGRADING TO ENCOMPASS 18.4
Disabled API Update of Consent-Related Attributes
With the 18.4 release of Encompass Developer Connect, we are disabling the ability to directly update consent-related attributes within the loan via the loan update API due to the potential impact this may have in making loans non-compliant. Consent data within Encompass must be updated by one of the approved workflows, such as the ones happening via Encompass WebCenter or Encompass Consumer Connect. The consent information obtained in an external system and sent via APIs cannot be validated by the service, thereby, making the loans non-compliant. Hence, we are disabling direct updates to those attributes.

If your application is currently updating these consent-related fields, we highly recommend that you modify it before you upgrade to Encompass 18.4.

API Contract Change Within the Loan Object
As part of 18.4, we would like to notify you of an API contract change within the Loan object. We have moved three loan-level attributes to a borrower level. We made this change to address a calculation-related defect within the USDA fields.

If you are using these three attributes within your application, we recommend that you to update your application to accommodate this change before you upgrade to Encompass 18.4.

"usda": {
        "adjustedAnnualIncome": 133344,
        "annualIncome": 133344,
        "borrowerBaseIncome": 133344,
        ...
}

"applications": [
"borrower": {
                ...
                "adjustedAnnualIncome": 133344,
                "annualIncome": 133344,
                "baseIncome": 133344
            } ]

NEW APIS
New Loan Schema APIs
The following two new APIs have been added to Loan Schema:

• The Path Generator API returns JSON paths for the field IDs or field names specified. You can use the response for specifying filters attributes when subscribing to a change event webhook.
• The Contract Generator API generates a sample JSON contract.

ENHANCEMENTS

• Support for CoreLogic Flood Service
  The Services API now supports CoreLogic Flood Service for submitting Flood Service requests and retrieving Flood reports/certificates.

• New Product Names to Support Resource_Transaction Object for Services
  The Services API now allows you to retrieve the service provider report content in raw form. Raw service provider content is available only with products that support Transaction_Resource object in the response.

• Enhanced Error Reporting for Fannie Mae Desktop Underwriter
  The Services API now supports fully qualified error details as returned by Fannie Mae's Desktop Underwriting service.

• New Query Parameter Added to the Get Attachments API
  The Get Attachment API includes a new generateURL query parameter that returns the URL for attached media files in the response.

ENHANCEMENTS

• New Event Type Added to Webhooks API
  New change event type has been added to the Webhooks API. The change event type allows you to subscribe to attribute level changes on the loan file.

• Updates to Milestones API
  The Milestones APIs now supports retrieving and managing comments.

NEW APIS
The Encompass Developer Connect May release introduces the following new APIs:

• The Applications API now supports swapping the position of borrowers in a loan application. For more information see, Move Borrower Pair.
• Loan Custom Fields API for retrieving all pre-defined and user-defined custom loan fields on the Encompass instance.
• Contact Groups API for working with group contacts in the Encompass contacts database. The Groups API provides a set of methods to create, view, and manage information for contact groups.
• Conditions API for retrieving all underwriting, preliminary, and post-closing conditions.

ENHANCEMENTS
The following enhancements have been made to existing Encompass Developer Connect APIs:

• The Borrower Contacts API and Business Contacts API now support querying and paginating through contacts lists. For more information, see View Borrower Contacts with Pagination and View Business Contacts with Pagination.
• Create/Update Loan APIs for linking existing borrower and business contacts to loans. To learn more, see Linking Contacts to a Loan.

May Critical Patch

Critical Patch
This Critical Patch addresses a limitation with viewing non-native files. To address this limitation, we have made an enhancement to the Services API so that viewable eFolder documents and attachments as well as native file formats returned by the service provider can be viewed using the Developer Connect API.

The enhancement includes the addition of a response schema, Resource_Transaction, for the Services API. The Resource_Transaction object makes both viewable file formats and native file formats returned by the Partner available within its resources attribute by providing a URL. To learn more about the new Resource_Transaction schema, see the Services API.

This Critical Patch applies to Fannie Mae Desktop Underwriter (DU) only.
We will be transitioning all other service categories and products to the new Resource_Transaction schema in a future release. Until then, all other service categories and products will continue using the existing Transaction object.

ENHANCEMENTS
Updated the Ellie Mae .Net Language Bindings for Developer Connect APIs to support TLS 1.2 capabilities. This update automatically adds TLS 1.2 to API calls for clients that are using the language bindings.

You can access the .NET Language Bindings via https://github.com/EllieMae/developerconnect-dotnet-bindings.

If you choose to bypass the language bindings and write programs that directly call the APIs, ensure they are TLS 1.2 compatible.

This update only impacts the .Net Language Bindings. There are no changes to the Developer Connect APIs.