Select Rate

post

https://api.elliemae.com/epps/v2/loans/{loanId}/rateSelector

Select a rate for a given loan. Returns the rates, adjustments and other calculations for the specified loan.

Path Params

loanId

string

required

Unique identifier of the EPPS loan.

Body Params

sourceApplicationName

string

required

Required. Name of the source application.

sourceApplicationFormName

string

required

Required. Name of the source application form.

requestAction

integer

This attribute is required for relock requests only. For all other requests, this parameter is optional.
Possible values are:
1 = QuoteRequest
2 = ValidateRelock,
3 = CheckEligibilityAndPricing
4 = BuyRequest
['1', '2', '3', '4']

The default value is QuoteRequest, which represents the current pricing.

requestLockStatus

integer

This is Optional Parameter but required for relock requests.
Possible values are:
0 = NoStatus
1 = NotLocked
2 = ActiveLock
3 = Expired
4 = Cancelled
['0', '1', '2', '3', '4']

eppsUserName

string

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

facadeUserID

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.

programID

integer

required

Required. The unique identifier of the program.

rateDataID

integer

required

Required. The unique identifier of the Rate.

lienPosition

integer

required

Required. The borrower's lien position.

effectiveDate

string

required

Required. The date from the previous snapshot. This field is optional. effectiveDate should be less than Data Retention Days configured in database (current configuration is 1 year).

Headers

Authorization

string

required

Bearer token

Responses

400

Bad Request

200OK