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