Download Postman Collection
API Reference

Get Programs and Rates

post
https://api.elliemae.com/epps/v2/loanQualifier

Returns a complete list of loan programs for the given loan criteria. Rates are also returned when the loan is eligible for a program. If a loan ID is not provided with the loan criteria (loanQualifier Attributes), a new loan will be created in ICE PPE.

Body Params

Post the necessary fields for the API to create a new user.

integer

This is optional but required for relock requests.
Possible values are:

  • 1 = QuoteRequest
  • 2 = ValidateRelock
  • 3 = CheckEligibilityAndPricing
  • 4 = BuyRequest ['1', '2', '3', '4']
integer

This is optional but required for relock requests. Possible values are:

  • 0 = NoStatus
  • 1 = NotLocked
  • 2 = ActiveLock
  • 3 = Expired
  • 4 = Cancelled ['0', '1', '2', '3', '4']
integer

Information to be used to retrieve rate information from ICE PPE.

string

The source application name.

string

The source application form name.

string

The ICE PPE user name/id is required to validate whether the user is mapped to an Encompass user.

string

User ID that should be considered as the caller of the API. If the user ID of the currently logged user is not passed, then facadeUserID will be used.

string

Represents the userID used for pricing. This is also known as the compUserID.

lockDays
array of integers

Number of days for which to lock the rate.
For example, [30,60]

lockDays
string

Type of loan.
Possibles values are:

  • Heloc
  • NonHeloc
integer

Specifies the rate lock delivery type.
Possible values are:

  • 1 = IndividualMandatory
  • 2 = IndividualBestEfforts
  • 3 = Bulk
  • 4 = AOT
  • 5 = LiveTrade
integer

Specifies the BuydownContributor. It is a required field if BuydownType has a non-zero value.
Possible values are:

  • 0 = None,
  • 1 = Lender,
  • 2 = Seller,
  • 3 = Builder,
  • 4 = Borrower,
  • 5 = Unassigned,
  • 6 = Parent,
  • 7 = Non_ParentRelative,
  • 8 = UnrelatedFriend,
  • 9 = Employer ['0', '1', '2', '3', '4', '5', '6', '7', '8', '9']
integer

Specifies the BuydownType. Possible values are:

  • 0 = None,
  • 1 = Three_Two_One,
  • 2 = Two_One,
  • 3 = One_Zero,
  • 4 = OnePointFive_PointSeventyFive,
  • 5 = One_PointFive ['0', '1', '2', '3', '4', '5']
integer

The previously obtained FNMA / FHLMC approval level.

string

The previously obtained FNMA / FHLMC approval level.

productType
array of integers

Required. Specifies one or more desired Loan Product Types. You may provide multiple instances of this field in your form submission. Not all product types are available for every scenario.

productType
productOptions
array of integers

Specifies one or more desired product options. You may provide multiple instances of this field in your form submission. Not all options are available for every scenario.

Tip: Use the Get Product Options API to get a list of products available for the user.

productOptions
specialProducts
array of integers

Specifies zero or more desired Special Loan Products. Special Product selections are independent of IncConventional, IncFHA and IncVA selections.

Tip: Use the Get Special Products API to get a list of special products available for the user.

specialProducts
standardProducts
array of integers

Include various supported Products.

Tip: Use the Get Standard Products API to get a list of standard products available for the user.

standardProducts
integer

Required. This value represents the documentation level or documentation type. Possible values are:

  • 1 = FullDoc
  • 2 = SIVA
  • 3 = SISA
  • 4 = NIVA
  • 6 = NINA
  • 7 = NoDoc
  • 9 = LimitedDoc
  • 10 = LiteDoc ['1', '2', '3', '4', '6', '7', '9', '10']
compensation
object

Loan officer compensation details.

loanInformation
object
borrowers
object

Borrower personal information.

borrowerFinancialHistory
object

Financial information.

property
object

Subject Property and Other Real Estate Owned details.

relockRequest
object
lockUpdateRequest
object
lockRequestAdditionalFields
array

Lock Request AdditionalFields.

lockRequestAdditionalFields
string

Based on the action it should be CustomId or LoanId.

string
Headers
string
required

Bearer token.

Responses

400

Updated 4 months ago

Language
URL
Response 
 Choose an example:
application/json
Updated 4 months ago 



































© ICE Mortgage Technology, Inc. All rights reserved. Terms of Use