Lookups

Use the Lookups APIs to search for and return certain types of loan information across the Product and Pricing system. For example, the Standard Product lookup returns all the standard products available for a given user/client.

Response Contracts and Attributes

The following Lookups return data in the format of key-value pairs.

Agency Approvals
Bankruptcy
Citizenship
Counties
Delivery Types
Encompass Elements
Foreclosure
Investors
Lien Position
Loan Terms
Loan Usage
Prepay Penalty Terms
Product Options
Property Types
Property Use
Special Products
Standard Products

Buydown Type Response

ATTRIBUTE	DESCRIPTION
buydownTypeId integer	BuydownTypeId from the BuydownType table.
descriptionText string	BuydownType.
displayOrder integer	DisplayOrder from BuydownType table.

Buydown Contributor Type Response

ATTRIBUTE	DESCRIPTION
buydownContributorTypeId integer	BuydownContributor ID.
descriptionText string	BuydownContributor.
displayOrder integer	DisplayOrder from BuydownContributor table.

Client Settings Response

ATTRIBUTE	DESCRIPTION
options object	Options as configured on the EPPS Admin tab > Settings > Options. The Options section is used to manage features on the EPPS Qualify and Summary tabs.
options.skipIncome boolean	Indicates whether income checking rules are not considered for qualified programs and rates on the Qualify tab.
options.skipAssets boolean	Indicates whether asset checking rules are not considered for qualified programs and rates on the Qualify tab.
options.allowLock boolean	Indicates whether the Lock Request button displays at the bottom of the Summary tab. Authorized users may click this button to submit a rate lock request to the lock desk via EPPS.
options.roundCorr boolean	Indicates whether prices are rounded down by an eighth for loans in the Correspondent channel.
options.roundBroker boolean	Indicates whether prices are rounded down by an eighth for loans in the Broker channel.
options.noClosingCost boolean	Indicates whether a No Closing Cost option is displayed on the General tab and EPPS will return the appropriate profit margin or loan level price adjustment (LLPA).
options.flagged boolean	Indicates whether the Flagged check box on the Qualify tab is selected and flagged programs are included in Qualification results.
options.isMIQuotesEnabled boolean	Indicates whether MI quotes are enabled.

encompassSettings object	Encompass Settings as configured in EPPS Admin tab > Settings >Encompass Settings.
encompassSettings.changeEffective DateOnReLock boolean	Indicates whether changes to the Effective Date are allowed on re-lock and lock update.
encompassSettings.changeProgram OnReLock boolean	Indicates whether loan program changes are allowed on re-Lock and lock update.
encompassSettings.changeAdditional LoanProg boolean	Indicates whether selection of additional loan programs are allowed only when current loan program is no longer eligible on re-lock and lock update.

productTypes	The product types included in product and pricing results (on the Qualify tab).

Commitment Types Response

ATTRIBUTE	DESCRIPTION
commitmentTypeID integer	Commitment type ID.
description string	Description of the commitment type. For example, Best Efforts.

Custom Fields Response

ATTRIBUTE	DESCRIPTION
newFieldId integer	Unique identifier of the custom field.
originalFieldId integer	Unique identifier of the original field.
description string	Description of the custom field.
type string	Data type. For example, DROPDOWNLIST.
editable boolean	Indicates whether the custom field is editable.
hidden boolean	Indicates whether the custom field is hidden.
masterList array of strings	Master list of custom fields.

Documentation Types Response

ATTRIBUTE	DESCRIPTION
documentationId integer	Document ID.
documentation string	Documentation Type. For example, Full, LimitedDocumentation, NoDocumenation, and so on.
income number	Borrower income.
incomeLevel string	Indicates the income level. For example, Full Income, Alternative Income, Lite Income, Stated Income, No Income, and so on.
assets number
assetsLevel string	Indicates the asset level.
employment number
employmentLevel string	Indicates the borrower's level of employment. For example, Employed or Retired, and so on.
displayOrder	Order in which a documentation type is displayed in the drop-down.

Loan Limits Response

ATTRIBUTE	DESCRIPTION
limitText string
limit1 integer
limit2 integer
limit3 integer
limit4 integer
effectiveDate string
iOrder integer

LoanLimitsOutput {

Locations Response

ATTRIBUTE	DESCRIPTION
city string	Name of the city within the given zip code.
countyID integer	County ID.
county string	County name.
stateID integer	Number of the state. For example, Alaska = 1, Alabama = 2, Arkansas = 3, and so on.
state string	Name of the state for given zip code.
abbrev string	State abbreviation.

Lock Days Response

ATTRIBUTE	DESCRIPTION
lockDays integer	Number of lock days.
virtualLock integer	Number of virtual lock days.

NOD Types Response

ATTRIBUTE	DESCRIPTION
nodTypeID integer	Notice of Default (NOD) Type ID.
description string	NOD Type description. For example, Short Sale ,Foreclosure/Default, Deed in Lieu, and so on.
displayOrder integer	Order in which the NOD Type is displayed in the drop-down.

Non QM Doc Level Response

ATTRIBUTE	DESCRIPTION
nonQMDocLevelTypeId integer	DocLevelId from the NonQMDocLevelOutput table.
descriptionText string	Non-QM documentation description. For example, 24 Months W-2/Tax Returns 12 Months W-2/Tax Returns 24 Months Personal Bank Statements 12 Months Personal Bank Statements 24 Months Business Bank Statements 12 Months Business Bank Statements
displayOrder integer	Order in which the Non-QM documentation is displayed in the drop-down.

States Response

ATTRIBUTE	DESCRIPTION
stateID integer	Number of the state. For example, Alaska = 1, Alabama = 2, Arkansas = 3, and so on.
state string	Name of state available for the user/client.
abbreviation string	State abbreviation.