May 20.1 Service Pack

Loan Opportunities APIs

Ellie Mae is offering a new service to access V1 APIs in Developer Connect for creating and managing Opportunities-Loan Scenario tool. This service provides the APIs to create and update loan opportunities, compare up to 10 loan scenarios, convert a loan scenario into a loan, run EBS calculation on the loan scenario object, and ability to email scenario(s), and Eligibility letter to the borrower using the Loan Opportunity notification service.

The following Loan Opportunities APIs are available in this release:

Loan Opportunity Management
Endpoint URL: /encompass/v1/loanOpportunities

• Get All Loan Opportunities retrieves opportunities with search criteria in a paged list.
• Get an Opportunity retrieves information about a specified opportunity.
• Create Opportunity creates a new opportunity.
• Convert to Opportunity Contract converts a loan contract to a loan opportunity contract.
• Update an Opportunity updates an existing opportunity.
• Delete an Opportunity removes a specified opportunity.

Document Management for an Opportunity
Endpoint URL: /v1/loanOpportunities/{OpportunityId}/documents

• Create a Document creates a new document for a specified opportunity.
• Get a Document retrieves an existing document from an opportunity.
• Replace a Document updates an existing document for an opportunity.

Notification Request
Endpoint URL: /v1/loanOpportunities/{OpportunityId}/notifications

• Send Notification Request triggers a notification request to be sent to the recipient.

Scenario Management
Endpoint URL: /v1/loanOpportunities/{OpportunityId}/scenarios

• Get All Scenarios retrieves all scenarios for a specified opportunity.
• Get a Scenario retrieves an existing scenario from an opportunity.
• Create Scenario creates a new scenario for a specified opportunity.
• Update a Scenario updates an existing scenario for an opportunity.
• Delete a Scenario removes a specified scenario from an opportunity.
• Convert Scenario to Loan converts the information in the opportunity and scenario to a loan contract.

Loan Opportunity Selector
Endpoint URL: /v1/loanOpportunitySelector

• Get Loan Opportunities retrieves specific details of opportunities with search criteria in a paged list.

Loan Opportunity Settings APIs

The Loan Opportunity Settings API provides the ability to configure settings related to the Scenario Comparison Tools feature.

Affordability Qualification Settings
Affordability Qualification APIs configure the housing and debt ratio limitations based on the product type. When an opportunity is created and the income and liabilities for the borrowers have been entered, the scenario reflects if the current data is within the defined limitations set.

Endpoint URL: /v1/settings/affordabilityQualification

• Get Affordability Qualification Settings retrieves Affordability Qualification settings.
• Create Affordability Qualification creates settings to determine affordability.
• Update an Affordability Qualification updates an existing Affordability Qualification setting.
• Delete an Affordability Qualification removes a specified Affordability Qualification setting.

Email Template Management
The Email Templates APIs configure the email template for when the user emails the generated Scenarios or Eligibility letter to a borrower.

Endpoint URL: /v1/settings/emailTemplates

• Get Email Templates retrieves email templates filtered by various criteria.
• Create Email Template creates a new email template.
• Get an Email Template retrieves a specified email template.
• Update an Email Template updates an existing email template.
• Delete an Email Template removes a specified email template.

Feature Management
The Feature Management APIs manage the feature and feature settings for Loan Opportunities.

Endpoint URL: /v1/settings/featureManagement

• Get Feature Management Settings retrieves Feature Management settings for the specified category and feature.
• Create New Feature creates a new Feature entry for a specified category.
• Update a Feature Management Setting updates an existing Feature Management Setting.
• Update a Feature updates an existing Feature.
• Delete a Feature Management Setting removes a Feature Management Setting.

Letter Template Management
The Letter Template APIs manage the template that is used to generate Eligibility Letters within an opportunity.

Endpoint URL: /v1/settings/letterTemplates

• Get Letter Templates retrieves Letter Templates filtered by various criteria.
• Create Letter Template creates a new Letter Template.
• Get a Letter Template Details retrieves a specified Letter Template.
• Update a Letter Template updates an existing Letter Template.
• Delete a Letter Template removes a specified Letter Template.

Fixed Issue

Loan Schema

Resolved: Incorrect contractPath for DISCLOSURE.X1188 in Standard Fields API
A discrepancy was observed between the contract path for DISCLOSURE.X1188 in Standard Fields API and Loan API response. This discrepancy prevented the loan data for DISCLOSURE.X1188 from parsing successfully.

Endpoint URL: .../encompass/v3/schemas/loan/standardFields?ids=DISCLOSURE.X1188

This issue is resolved with the 20.1 May service pack.CBIZ-31210

New V3 APIS

The Encompass Developer Connect 20.1 April release introduces the following new V3 APIs:

External Organizations and Users APIs

Use the External Organizations and Users APIs to create and manage lenders, brokers, and third party originators (TPO) with whom your company does business.

External Organizations

• Get External Organizations API retrieves a list of external organizations. Query parameters can be used to filter results.
• Get an External Organization API returns information about a specified TPO company or branch.

External Users APIs

• Get External Users API retrieves details about all external TPO users. Use query parameters to filter results.
• Get an External User API returns information about a specified TPO user.
• Get Effective Rights of External User API returns information about the effective rights of a specified TPO user.

Loan Pipeline APIs

The Loan Pipeline APIs provides methods to search for loans on the Pipeline. The View API returns all loans in the Pipeline to which the user has access. The results can be filtered and sorted to return more precise results.

• Query Pipeline (with Pagination) API retrieves pages of loan IDs (GUIDs) and specified fields from loans on the Pipeline.
• Get Canonical Names API retrieves the loan pipeline field definitions.

Schema APIs

A loan schema specifies the entities and data elements in a loan resource. Use the Schema APIs to retrieve all schema information, a certain set specified by field ID, and virtual field definitions for a loan.

• Get Loan Schema API retrieves the schema for a loan.
• Get List of Virtual Fields APIsretrieves virtual field definitions for a loan.

Loan Folder APIs

Loan folders allow lenders to organize loans into groups. Loan folders can be created to group loans by categories such as month of origination, loan status, or loan type. The Loan Folder APIs provide methods for creating and managing loan folders.

• Get Loan Folders API returns a complete list of loan folders; including the Trash folder to which the user has access rights.
• Get a Loan Folder API returns information about a specified loan folder.

New and Updated V1 APIS

The following new and updated V1 APIs are available with the Encompass Developer Connect 20.1 April release:

Correspondent Trades API

Ellie Mae is now offering a new service to access V1 APIs in Developer Connect for managing your Correspondent Trade needs. Developers will be able to make new API calls for creating and updating correspondent trades as well as making calls for loan assignments. In addition, there are APIs for calling the Trade Details and Trade Pipeline. There are also APIs for retrieving the Notes, History and loan assignment metrics of a correspondent trade. These new APIs can be used in the 20.1 version along with the latest features being introduced in the release for Authorized Trader, supporting new delivery types, updating commitment statues, and new pair-off functionality. Making these APIs available on Developer Connect will remove restrictions of solely working with .net applications.

Trade Pipeline
The Trade Pipeline APIs provides methods to search the Pipeline for correspondent trades. The View API returns all loans in the Pipeline to which the user has access. The results can be filtered and sorted to return more precise results.

• Get Trade Pipeline of Correspondent Trade API retrieves Pipeline for a correspondent trade.
• Get Field Definitions API retrieves specific field definitions to populate the Trade Pipeline.

Trade Management

• Create a Correspondent Trade API creates a correspondent trade.
• Get Correspondent Trade API retrieves information about a specified correspondent trade.
• Update Correspondent Trade API updates the commitment status or edit a single correspondent trade.
• Get Event History API retrieves the event history of a correspondent trade.
• Assign Loans to Correspondent Trade API assigns and updates loans to a correspondent trade.
• Get Correspondent Trade Notes API retrieves the notes from a correspondent trade.
• Get Correspondent Trade Statistics API retrieves the loan assignment metrics for a correspondent trade.

Webhooks API

Enhanced Support for Webhook Notifications for clients on 20.1
Webhooks provide a way to send notifications when certain events occur on a loan resource. For example, your client application can subscribe to receive notifications when a new loan is created or when contact information for a business contact is updated. Previously, the Webhook API supported notifications for only loan and transaction resources. With this release, Webhook API support has been expanded to other loan events such as Documents, Enhanced Conditions, Milestones, and External Orgs. Subscribing to any of these events will generate a Webhook notification when certain subevents occur.
The following table displays the newly supported loan event and the subevents that generate a notification:

Rate Lock API: Support for Additional Rate Lock Request Field Management

The lock request form includes the capability to mirror one or more loan-level standard or custom fields in addition to the base data set included in the lock request form itself. This data can be identified in Encompass > Settings. When a new lock request form is created, the loan data is mirrored to both the lock request fields and the additional lock request fields. This data can then be modified through Encompass Smart Client if there are variations added during the course of pricing scenarios for the loan file. When the lock is confirmed, this data is synchronized back to the corresponding loan-level fields and logged in the associated lock request snapshot. Previously, these fields could not be modified through Encompass APIs. With this release, custom fields that are set up under Settings > Secondary Setup > Lock Request Additional Fields are now supported as part of the followings V1 APIs:

• Create Loan
• Update Loan
• Get Loan
• Create Rate Lock Request
• Get Snapshot of Rate Lock Request

Usage Note

The Webhook eventTime attribute for Transaction resources now follows the ISO 8601 specification in UTC/Zulu time.

Introducing New Version 3 (V3) APIs

Early access to Encompass Developer Connect V3 APIs will be available in this release. The new and improved V3 APIs, which will be available under the "V3" section of the API Documentation can be used with the same oAuth token flow. The v3 APIs will simply have a new version in the API endpoints, and may have different data contracts from their v1 counterparts. V3 APIs ensure better performance, stability, ease of use and consistency for consuming the Developer Connect APIs. There will be a gradual roll-out plan for the v3 APIs.

Using V3 APIs to Manage Attachments and Documents
The V3 APIs utilize cloud storage for loan attachments. Cloud storage makes it possible to store and retrieve loan attachments faster, and requires less resources from the client workstation to process documents.

📘

Enabling V3 Could Storage APIs for Early Access

The V3 Cloud Storage APIs will be generally available in 2020. For early access on Encompass 19.4 R2T Smart Client test environments, contact your Ellie Mae Relationship Manager.

Viewing Attachments in Encompass
Developer Connect V3 APIs work seamlessly with Encompass. Whether accessing attachments from the media server or cloud storage, the flow is the same with V3 APIs. With cloud storage, Encompass users will notice improved performance. They may also notice subtle changes in appearance to the Encompass eFolder and document viewer for new loans.

Using Both V1 and V3 APIs
You can start the consumption of the V3 APIs on your R2T instances without turning on Cloud Storage as the V3 APIs are backward compatible. However, the V1 APIs used to manage attachments will no longer work once the Encompass instance is enabled for Cloud Storage/ Skydive, and loans will be using Cloud Storage. Encompass Developer Connect V1 and V3 APIs can be used simultaneously. API calls will be directed to the correct server depending on the API version. Attachments for Loans using media server can still be managed with the V1 APIs, and attachments for loans using cloud storage need to use the V3 APIs. Documents can be managed using V1 or V3 APIs, and the workflow will not break.

For this initial release, we are offering the following V3 APIs:
eFolder Documents
• Get List of Documents
• Get a Document
• Get Comments to a Document
• Manage Documents
• Manage Attachments Linked to a Document
• Add Comments to a Document

eFolder Attachments
• Get list of attachments
• Get Attachment
• Manage Attachment
• Upload an Attachment
• Download an Attachment

Accessing the V3 APIs

The V3 APIs will be available from the Developer Connect portal. A new menu at the top left of the Developer Connect Welcome page allows you to select the version you want to view. You can toggle between V1 and V3 using this menu.

For additional information about the V3 Cloud Storage APIs, check out the November blog post, Introducing Cloud Storage for Loan Attachments.

New V1 APIs

Export Attachments
• Create an export job with a list of attachments within a loan
• Get the status of the export job

Enhancements to V1 APIs

EPPS Loan Qualifier Contract Changes
The custom attribute in the EPPS Loan Qualifier contract is deprecated in this release. The custom attribute included the ratesCustomInput object and any custom rate details provided in the loan. This attribute will be replaced in a future release.

Support for Avantus Credit Partner
With this release, the Developer Connect Services API will support ordering and retrieving consumer credit reports from Avantus (CBCT).

New Webhook Notification for Moving a Loan
A new event type is being added to Webhooks notifications so that lenders can receive a notification when a loan is moved from one folder to another in Encompass. This enhancement is implemented by the new move event type. The move event type will be available for Create a Subscription, Update a Subscription, and Get Resource for Loan APIs.

Updates to Get Loan Metadata API
Two new attributes are being added to the Get Loan Metadata API so that lenders can query and view loans according to the user ID (createdBy) of the person who created the loan and the current version/ loan sequence number (loanFileSequenceNumber).

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.