Mortgage Input

Represents the input for mortgage POST or PATCH method.

NameTypeDescriptionRequired or OptionalAvailable Version
accountIdStringAccount associated with the application.Required if opportunityId isn’t provided48.0
amortizationTermIntegerDuration of the amortization in months.Optional48.0
amortizationTypeStringAmortization type for loan.Optional48.0
assetsAsset Input[]Represents details about the borrower’s and co-borrower’s current personal and real property.Optional48.0
balloonTermMonthsIntegerNumber of months during which the cumulative loan must be repaid.Optional48.0
borrowersBorrower Input[]List of borrowers for a loan application.Optional48.0
estateHoldTypeStringLender’s lien is on both land and structure (fee simple) or just structure (leasehold).Optional48.0
extendedFieldsExtended Fields Input[]Represents custom fields related to a loan application.Optional48.0
externalIdStringIdentifier assigned to imported data by external data source (if applicable).Optional48.0
financialsFinancial Input[]Represents transaction details for a loan application.Optional48.0
hasOtherLoanFeatureBooleanIndicates whether loan has other amortization feature.Optional48.0
hasPrepaymentPenaltyBooleanIndicates whether penalty is incurred if borrower pays off loan balance before the loan term expires.Optional48.0
improvementCostDoubleConstruction costs for a construction loan or home improvement costs for a renovation loan.Optional48.0
initialBuydownRateDoubleInitial lesser interest rate for the loan.Optional48.0
interestOnlyMonthCountIntegerNumber of months that loan payments are interest only.Optional48.0
interestRateDoubleInterest rate for loan.Optional48.0
isBalloonBooleanIndicates whether borrower is applying for a balloon payment mortgage.Optional48.0
isBorrowerInCommunityPropStateBooleanIndicates whether borrower lives in community property state.Optional48.0
isConstructionToPermanentBooleanIndicates whether at least one borrower lives in a community property state.Optional48.0
isContractForDeedBooleanIndicates whether loan proceeds are to pay off balance due on a contract for deed or land contract.Optional48.0
isEnergyRelatedImprovementBooleanIndicates whether loan is to finance energy-related improvements.Optional48.0
isInterestOnlyBooleanIndicates whether borrower is applying for an interest-only mortgage.Optional48.0
isNegativeAmortizationBooleanIndicates whether loan allows for negative amortization where shortfalls in interest payments are added to the outstanding loan balance.Optional48.0
isPropInCommunityPropStateBooleanIndicates whether property is located in a community property state.Optional48.0
isRenovationBooleanIndicates whether loan proceeds to finance cost of renovations to the property, and renovation value is included in the property’s appraised value.Optional48.0
isSingleClosingBooleanIndicates whether construction and permanent loans have a single combined closing. Once construction is complete, loan converts to a traditional mortgage.Optional48.0
isSubjectToPriorityLienBooleanIndicates whether property is currently subject to an energy-related lien that could take priority over the first mortgage lien.Optional48.0
isTempIntRateBuydownBooleanIndicates whether borrower is applying for loan with an initially reduced interest payment in exchange for an up-front cash deposit.Optional48.0
leaseHoldExpirationDateStringDate when leasehold expires if land is leased.Optional48.0
liabilitiesLiability Input[]Represents details about the borrower and co-borrower current liabilities.Optional48.0
loanPurposeStringPurpose of the loan.Optional48.0
lotAcquiredDateStringMonth and year property or land was purchased.Optional48.0
lotOriginalCostDoubleOriginal property cost (refinance) or original land cost (construction).Optional48.0
monthsBeforeFirstAdjIntegerInitial period prior to first adjustment in months.Optional48.0
monthsBetweenAdjustmentsIntegerNumber of months before the first rate adjustment for an adjustable rate loan.Optional48.0
mortgageLienTypeStringType of mortgage lien associated with this loan application.Optional48.0
mortgageProgramTypeStringType of mortgage program applied for.Optional48.0
nameStringName of the residential loan application.Required48.0
nativeLandTenureStringProperty is located on an area reserved by or for an Indian land, village, or tribe to live on and use.Optional48.0
opportunityIdStringOpportunity associated with the application.Required if accountId isn’t provided48.0
otherAmortizationTypeStringDescription of other amortization type for government loans.Optional48.0
otherLoanFeatureStringDescription of other loan amortization feature.Optional48.0
otherLoanPurposeStringWhat the borrower will use the loan for if other was specified.Optional48.0
otherMortgageProgramTypeStringDescription of the other mortgage type.Optional48.0
otherRefinanceProgTypeStringRefinance program name if other was specified.Optional48.0
prepayPenaltyTermMonthIntegerNumber of months during which borrower incurs a penalty for early payoff of the loan balance.Optional48.0
projectTypeStringSpecifies the type of project that the property belongs to.Optional48.0
propertiesProperty Input[]Represents details of the property the loan application finances.Optional48.0
refinanceProgramTypeStringThe applicable refinance program type based on the investor, guarantor, or lender guidelines.Optional48.0
refinanceTypeStringRefinance loan type.Optional48.0
statusStringIndicates the current status of the loan application.Optional48.0
titleHoldersTitle Holder Input[]Represents details of borrowers who are applying to hold title to the property the loan application finances.Optional48.0
titleTypeStringWay the borrower or borrowers take title for the loan.Optional48.0
trustTitleTypeStringTitle to be held in a living trust or a land trust.Optional48.0