Get Eligible Rates

post

https://api.elliemae.com/epps/v2/loans/programs/{programId}/eligibility

Returns eligible rates for a specified program. If the loan ID is not specified, a new ICE PPE Loan is created. If the loan criteria does not qualify for the specified program, the ineligibility reason is returned as part of the API response.

Path Params

programId

string

required

Unique identifier of the program for which to get eligible rates.

Body Params

requestAction

integer

Required only for relock requests. The default value is QuoteRequest when nothing is supplied. This will represent the current pricing.

eppsUserName

string

The ICE PPE user ID is required to validate if the Encompass User is mapped to an ICE PPE User.

facadeUserID

integer

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.

userTierId

integer

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

lockDays

integer

Number of days to lock the rate for.

loanType

string

Indicates whether the loan is a Heloc or NonHeloc loan.

deliveryType

integer

Specifies the rate lock delivery type.

buydownContributor

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']

buydownType

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']

eligibilityRequest

object

Request for determining eligibility.

loanInformation

object

EligibleRatesLoanInformationInput object.

compensation

object

Compensation details.

agencyApprovals

integer

The previously obtained FNMA / FHLMC approval level.

productType

array of integers

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 products available for the user.

specialProducts

documentationLevel

integer

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']

borrowers

array of objects

The eligibleRatesBorrowerInput object and other
personal information from the borrower.

borrowers

borrowerFinancialHistory

object

Includes the EligibleRatesBorrowerFinancialHistoryInput object and borrower's financial history.

property

object

Subject Property and Other Real Estate Owned details.

lockRequestAdditionalFields

object

Lock Request Additional Fields.

Headers

Authorization

string

required

Bearer token

Responses

400

Bad Request

Language

URL

Response

Choose an example:

application/json

200OK