April 20.1 Major Release
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:
Resource | Event | Subevent |
---|---|---|
Loan | Documents (via API only) | Create (createDocuments) Update (updateDocuments) Assign Attachment (assignAttachmentsToDocument) |
Milestone (via API only) | Update (updateMilestones) Complete (finishMilestones) | |
ExternalOrganizations | Create (via SmartClient only) | |
Update (via SmartClient only) | ||
ExternalUser | Create (via SmartClient only) | |
Update (via SmartClient only) |
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