| Name | Description | Data Type |
|---|
| affinityCodes | An affinity code is an extra search criteria associated with products that can apply an additional adjustment . A common scenario use for is an employee code that will offer better pricing.
affinityCodes is a field that accepts an array of affinity codes and returns results for which any of the affinity codes are applicable.
Example:
"affinityCode": "ABC"
In this case, the 30 Year Conventional product has an adjustment when the affinity code is "ABC" that applies a -0.1 adjustment, or better pricing.
An HLA/Loan Officer who knows the code can enter it in the search UI or API and receive a -0.1 adjustment applied to the pricing.
| Array[string] |
| affordableHousingType | | Array[string] |
| affordableHousingTypes | | Array[string] |
| alternateCreditScore | | integer |
| ami | | number |
| applicationTakenDate | | string |
| appraisalConditionAsIs | | boolean |
| appraisedValue | For conventional programs, this value needs to be higher than $0.
For purchase, the lower between appraisedValue and purchasePrice is used (LTV logic).
This field is required. | number |
| assumption | | boolean |
| assumptionRate | | number |
| averageMedianCreditScore | | integer |
| balloon | | boolean |
| borrowerCompPlanAmount | Specifies a numeric compensation plan (comp plan) value for the borrower. | number |
| borrowerCompPlanPercent | Specifies a compensation plan (comp plan) value for the borrower as a percentage. | number |
| buyDown | | string |
| caseAssignementDate | | string |
| cashoutAmount | | number |
| cemaIndicator | CEMA indicator. CEMA loans are an option open to New Yorkers to reduce the cost to refinance a mortgage. True if the borrower qualifies for a CEMA loan.
Default is False.
| boolean |
| citizenshipType | | string |
| clientDti | | number |
| closedEnd | | boolean |
| closingDate | | string |
| cltv | See cltv reference material. | number |
| communitySecond | | boolean |
| compensationType | This field determines the type of compensation a borrower receives. | string |
| computeApr | If set to True, the APR will be calculated. | boolean |
| constructionDrawAmount | | number |
| creditQualify | If the borrower's credit qualifies them for the loan, creditQualify is True. | boolean |
| docType | | string |
| downPaymentAmount | Sets the down payment amount.
If not set, the value will be 0. | number |
| downRate | Sets the down rate amount.
If left empty, the value is 0. | number |
| drawAmount | drawAmount is the draw amount if the client would like to price HELOC or Second Lien. | number |
| dscr | | number |
| dti | Debt-to-Income ratio. Set as a percentage.
Example:
"dti": 33
| number |
| dutyToServe | | boolean |
| employeeLoan | Contains the employee loan, if applicable. | string |
| escrowWaiver | This field corresponds to impound or not impound. Set to True if the client qualifies for an escrow waiver.
Default is False. | boolean |
| existingFirstLien | | boolean |
| ext | | boolean |
| fhaCaseNumber | If the borrower qualifies for an FHA loan, fhaCaseNumber is the ten digit number assigned to the loan, stored as a string value. | string |
| fhaEndorsementDate | | string |
| fhaLoanTypes | | Array[string] |
| fico | | integer |
| firstLienPaymentAmount | | number |
| firstTimeHomeBuyer | | boolean |
| fundingFeeFinanced | This field is required only if pricing a VA loan. It does not have a default value. If no value is passed, no pricing is returned. This design is intentional. | string |
| guranteeFeeFinanced | This field is required only if pricing a USDA Rural loan and does not have a default value. If no value is passed, no pricing is returned. This design is intentional. | string |
| hcltvDrawAmount | The hcltv draw amount. | number |
| hcltvLineAmount | The hcltv line amount. | number |
| helocCriteria | | HelocCriteria |
| highBalanceCounty | True if the property is in a high balance county. | boolean |
| inclusive | Set to True to include only the listed mortgage option.
Default is False. | boolean |
| incomeAmiRatio | | number |
| interestOnly | | boolean |
| isFirstLienSame | This field is simply a boolean that will activate a credit adjustment, which needs to be configured in the following fields:
Example:
This field is used if the client is doing a refinance and Lender Price was the original holder of the loan.
Default is null.
| string |
| lenderFeeWaiver | Set to True to waive the admin fee.
Default value is False. | boolean |
| lienPriorityType | This field specifies the lien priority type.
Values:
Default value is “FirstLien” if no value is entered. | string |
| lineAmount | | number |
| lmiData | | LmiData |
| loanAmount | The loan amount. A dollar value.
Default if left blank is 0. | number |
| loanDownPayment | The down payment on the loan. A dollar value.
Default if left blank is 0. | number |
| loanPurpose | The purpose of the loan.
Values:
- "Purchase"
- "Refinance"
- "StreamLineRefinance"
- "CashoutRefinance"
Note:
This field is required only if doing a single search. | string |
| loanType | Specifies the type of loan.
Values:
Default value is "Fixed".
Note:
This field is required only if doing a single search.
| string |
| loanYear | The loan term, in years.
Default value is 30.
This field is required only if doing a single search. | integer |
| ltv | The ltv value. | number |
| monthlyDebt | This value is required to calculate Debt-to-Income, stored in the dti field. | number |
| monthlyIncome | This value is required to calculate Debt-to-Income, stored in the dti field. | number |
| monthlyReserve | The monthly reserve. | number |
| mortgageTypes | The types of mortgages to search for. Use this value is performing a multisearch.
Values:
- "UsdaRural"
- "VA"
- "Conventional"
- "BP"
- "NonPrime"
- "HELOC"
- "NonAgency"
Default value: "mortgageTypes": ["Conventional"] | Array[string] |
| nonOccCoBorrower | | boolean |
| nonWarrantableProject | | boolean |
| normalHelocBehavior | | boolean |
| numberOfBorrower | | integer |
| numberOfCoBorrower | | integer |
| occupancyRate | | number |
| otherExpenses | | number |
| ownProperties | Number of borrower owned properties. | integer |
| paymentInterestType | Sets the payment interest type.
Values:
- "FullPITI"
- "InterestOnly"
- "InterestPlusFixedPrinciple"
| string |
| payoffStatusIndicatorFirstLien | | boolean |
| payoffStatusIndicatorSecondLien | | boolean |
| percentageFeeCriteria | | PercentageFeeCriteria |
| pmiType | Values:
| string |
| priorSalesDate | | string |
| propertyUse | Identifies the use for the property.
Values:
- "PrimaryResidence"
- "SecondaryVacation"
- "Investment"
Default value is "PrimaryResidence". | string |
| propertyValuationType | Determines the type of property valuation.
Values:
- "HVE"
- "PIW"
- "ACE"
- "FMP"
- "Full_Appraisal"
- "Streamline"
| string |
| purchasePrice | Specifies the purchase price of the property.
Default is 500000. | number |
| rehabBudget | Used to set the rehabilitation budget for the property.
Default is 0. | number |
| renovationCost | | number |
| renovationLoan | | boolean |
| rent | | number |
| rentalPropertyCashFlowAmount | | number |
| rural | | boolean |
| selfEmployed | | boolean |
| specialMortgageOptions | Filters the result by the listed special mortgage options in the array of SpecialMortgageOption objects.
If there are no special mortgage options, set inclusive to False. Otherwise, set inclusive to True.
Examples:
- "specialMortgageOptions":[],
"inclusive": false
- "specialMortgageOptions":[{"id":null,"name":"CDCore","description":"CDCore","enabled":true,"category":"AFR"}],
"inclusive":true
- "specialMortgageOptions":[{"id":null,"name":"SSLI","description":"SSLI","enabled":true,"category":"AFR"},{"id":null,"name":"CDCore","description":"CDCore","enabled":true,"category":"AFR"}],
"inclusive":true
| Array[SpecialMortgageOption] |
| studentLoanIndicator | | boolean |
| subordinateLoanAmount | Specifies the subordinate loan amount.
Default is 0. | number |
| subordinateSubType | | string |
| ufmipFinanced |
This field is mandatory only if pricing an FHA loan. There is no default value, meaning if no value is passed, no pricing is returned. This design is intentional. | string |
| useCustomerTotalLoanAmount | | boolean |
| useSmoBackFilter | | boolean |
| vaLoanTypes | | Array[string] |
| vaUsageType | Values:
- "First_Use"
- "Subsequent_Use"
| string |
| valueOfCollateral | Sets the value of the collateral.
Default is null. | number |
| varaiableLoanTypes | This field is required for Variable loan types. If the array is empty, Lender Price will search all possible types.
Values:
- "_1_1"
- "_2_1"
- "_3_1"
- "_5_1"
- "_5_2"
- "_5_5"
- "_7_1"
- "_7_2"
- "_10_1"
Default is empty. | Array[string] |
| veteranType | Determines the veteran status of the borrower. Leaving null indicates the borrower is not a veteran.
Values:
- "Active_Or_Veteran"
- "Reserves_Or_National_Guard"
Default is null. | string |
| mortgageLimit | Lender Price calculates this value automatically.
Values:
- "Conforming"
- "HighBalance"
- "Jumbo"
| string |
| totalLoanAmountByMortgage | The total amount by mortgage. | double |
