ENHANCEMENTS
With this Service Pack release, support for the following services have been added to the Services API:
New APIs
The February Major Release introduces the following new APIs for Developer Connect:
- Loan Associates API for viewing and modifying the set of loan associates assigned to a given loan. A loan associate is a team member or group assigned to a role within a loan, for example, loan officer or loan processor. This API is currently supported on Encompass versions 18.1 and later.
- Milestones API for retrieving one or all milestones for a given loan and modifying a loan's milestone schedule, check for past-due work, and mark a milestone as being completed. This API is currently supported on Encompass versions 18.1 and later.
- Milestone Free Roles API for retrieving and updating the milestone free role logs for a given loan. This API is currently supported on Encompass versions 18.1 and later.
- Borrower: Get Canonical Names API and Business:Get Canonical Names API for retrieving canonical field names for borrower and business contacts. Canonical field names can be used to view, sort, and filter borrower and business contact information.
- Borrower: Get Contact List API and Business: Get Contact List API for retrieving all contacts. The POST borrowerContactSelector method includes start and limit parameters whose values you can use to control size and start point of the response page.
ENHANCEMENTS
API Client Secret Can Be Regenerated from the Developer Portal
An Encompass "super admin" can now regenerate the API client secret from the API Key Management page.
IMPORTANT: When a client secret is regenerated, the old client secret expires immediately and all client integrations will need to be updated with the new client secret.
What's New
New APIs
The following new APIs are now available for Developer Connect:
- Resource Lock API for locking and unlocking a resource. Use this API to lock, unlock, and manage locks to update a loan.
- Loan Templates API to view folders and files under Loan Template folders.
- Custom Data Objects API to create and manage Loan, User, and Global custom data objects (CDOs). CDOs allow administrators to store information and data elements that are unique to their organization at loan, user, and Global level. We do not recommend storing secure or any PII information within these Custom Data Objects. The Custom Data Objects API set provides the following:
- Loan Custom Data Object APIs to create and manage custom loan-level data. Custom loan-level data includes data that does not have a standard field or custom field in Encompass, file attachments not stored in the eFolder, custom templates, and so on.
- User Custom Data Object APIs to create and manage custom user-level data.
- Global Custom Data Object APIs to create and manage company settings. Global CDOs are also useful for storing mapping files for mapping data across two or more applications for a lender or organization.
.NET Language Bindings and Sample Applications
.NET language bindings and sample applications for APIs are now available on Encompass Developer Connect.
Enhancements
- The Loan API includes the following new operations:
- Create a loan in a folder
- Create a loan from a loan template
- Apply a loan template to an existing loan
- Move a loan from one folder to another
- Retrieve metadata information from a loan
- The eFolder: Attachments API includes operations to upload attachments to the eFolder, retrieve page of attachment and get thumbnail of page of attachment.
- The Ordering Services API introduces operations for Electronic 4506-T Income Verification (EV4506T) and Verification of Employment (EVVOE).
What's New
New APIs
The following new APIs are now available in Developer Connect:
- Services API for ordering and retrieving credit reports from partner service providers.
- Get Resource Events Webhook API for retrieving all available webhook resources and events available on the Lender Platform.
Enhancements
New Webhook Subscription
You can subscribe to a webhook notification that will notify you when a vendor service order is updated(Resource: "Transaction", "eventType";"update"). This will avoid frequently polling to check the status of the service order response.
Refine Subscription Results
A new filter has been added to the Get Subscriptions API. Subscriptions can now be filtered by loan, transactions and events.
What's New
New APIs
The following new APIs are now available in Developer Connect:
- Borrower Pair API for creating and managing borrower pairs.
- Borrower Contacts API for creating and managing borrower contacts and notes.
- Business Contacts API for creating and managing business contacts and notes.
Access to Forums and Blogs
Developer Connect forums and blogs are now accessible from the Developer Connect portal. To access the forums and blogs, click Community in the top right of your screen.
Enhancements
Support for Cursor-Based Pagination
To help improve the performance when handling large data sets, the Pipeline API now supports cursor-based pagination. Create cursors to separate results into pages. To learn how to create cursors, see the Create Cursor Type topic. To learn how to use cursors, see the View Pipeline (with Pagination) topic.
Filter Attributes
There are no longer restrictions on filter attributes.
Usage Notes
API Key Access Limited to Corresponding Client ID
For increased security, your API Key/Secret will be verified against the corresponding Ellie Mae client ID when you log in. Users with multiple Client IDs should obtain an API Key/Secret for each Ellie Mae Client ID. See the Get an API Key topic to learn how to obtain an API Key.
Known Issues
Borrower and Business Contacts APIs
When creating a borrower or business contact, the mandatory attributes are not enforced. The mandatory attributes are the contact's firstName OR lastName AND one of the following parameters: personalEmail/businessEmail, currentMailingAddress.street1, homePhone, mobilePhone, workPhone.
Fixed Issues
Response Payload Size Exceeded the Maximum Limit Error
As designed, the gateway server has a 6MB limit. When this limit is exceeded, a maximum payload error is returned. However, there was an issue where some users experienced the error and modified the request to lower the payload size, but continued to receive the error. Upon investigating this issue, we discovered the response payload size was being calculated incorrectly and some payloads less than 6MB were being calculated as greater than 6MB.
The error message:
{ "summary": "Response payload size exceeded the maximum limit - 6 MB.,", "details": "Please modify your request to lower the response payload size." }
This Service Pack reduces the frequency of this error. Payloads less than 6MB will not experience the maximum payload error. Please also note that we are working with our provider to increase the 6MB limit.
What’s New
Automatically Reset Locked Accounts from Failed Login Attempts
When a Developer Connect account is locked after five failed login attempts, the account now resets automatically after one hour. After fifteen failed attempts, however, the account does not reset automatically. In this case, the developer should call Ellie Mae Technical Support to reset the password.
Removed Password Length Limitation
Developer accounts no longer have a password length limitation. Previously, passwords were limited to 99 characters.
New Terms of Service Dialog Box
Users are now presented with a Terms of Services dialog box after clicking the Create Account button. Users can view and accept the Terms of Service agreement to continue creating the account.
What’s New
Documentation Updates
- Sample request bodies added to View Pipeline.
- Information about Working with Multiple Client IDs added to Get an API Key page.
What’s New
Developer Connect Account is Now Required
In order to access the Developer Connect portal, users must create a Developer Connect account.
New API Key Required for Authentication
A new API key consisting of an API Client ID and API Client Secret is required for authentication. An Encompass user with the super administrator persona can access the API key under My Account and distribute to team members. To learn more about the API key, see Get an API Key.
Enhancements
Increased Maximum Limit for the View Pipeline API
The maximum number of items returned for the View Pipeline API has been increased from 1k to 25k.
Fixed Issues
Query Parameter for Entities in the Get Loan Schema API is Case Sensitive
If the entities parameter passed in the Schema API was lower-case, an error was returned. This issue is now resolved. The query parameter for entities is no longer case-sensitive.
© ICE Mortgage Technology, Inc. All rights reserved.