Mortgage Input
Represents the input for mortgage POST or PATCH method.
| Name | Type | Description | Required or Optional | Available Version |
|---|---|---|---|---|
accountId | String | Account associated with the application. | Required if opportunityId isn’t provided | 48.0 |
amortizationTerm | Integer | Duration of the amortization in months. | Optional | 48.0 |
amortizationType | String | Amortization type for loan. | Optional | 48.0 |
assets | Asset Input[] | Represents details about the borrower’s and co-borrower’s current personal and real property. | Optional | 48.0 |
balloonTermMonths | Integer | Number of months during which the cumulative loan must be repaid. | Optional | 48.0 |
borrowers | Borrower Input[] | List of borrowers for a loan application. | Optional | 48.0 |
estateHoldType | String | Lender’s lien is on both land and structure (fee simple) or just structure (leasehold). | Optional | 48.0 |
extendedFields | Extended Fields Input[] | Represents custom fields related to a loan application. | Optional | 48.0 |
externalId | String | Identifier assigned to imported data by external data source (if applicable). | Optional | 48.0 |
financials | Financial Input[] | Represents transaction details for a loan application. | Optional | 48.0 |
hasOtherLoanFeature | Boolean | Indicates whether loan has other amortization feature. | Optional | 48.0 |
hasPrepaymentPenalty | Boolean | Indicates whether penalty is incurred if borrower pays off loan balance before the loan term expires. | Optional | 48.0 |
improvementCost | Double | Construction costs for a construction loan or home improvement costs for a renovation loan. | Optional | 48.0 |
initialBuydownRate | Double | Initial lesser interest rate for the loan. | Optional | 48.0 |
interestOnlyMonthCount | Integer | Number of months that loan payments are interest only. | Optional | 48.0 |
interestRate | Double | Interest rate for loan. | Optional | 48.0 |
isBalloon | Boolean | Indicates whether borrower is applying for a balloon payment mortgage. | Optional | 48.0 |
isBorrowerInCommunityPropState | Boolean | Indicates whether borrower lives in community property state. | Optional | 48.0 |
isConstructionToPermanent | Boolean | Indicates whether at least one borrower lives in a community property state. | Optional | 48.0 |
isContractForDeed | Boolean | Indicates whether loan proceeds are to pay off balance due on a contract for deed or land contract. | Optional | 48.0 |
isEnergyRelatedImprovement | Boolean | Indicates whether loan is to finance energy-related improvements. | Optional | 48.0 |
isInterestOnly | Boolean | Indicates whether borrower is applying for an interest-only mortgage. | Optional | 48.0 |
isNegativeAmortization | Boolean | Indicates whether loan allows for negative amortization where shortfalls in interest payments are added to the outstanding loan balance. | Optional | 48.0 |
isPropInCommunityPropState | Boolean | Indicates whether property is located in a community property state. | Optional | 48.0 |
isRenovation | Boolean | Indicates whether loan proceeds to finance cost of renovations to the property, and renovation value is included in the property’s appraised value. | Optional | 48.0 |
isSingleClosing | Boolean | Indicates whether construction and permanent loans have a single combined closing. Once construction is complete, loan converts to a traditional mortgage. | Optional | 48.0 |
isSubjectToPriorityLien | Boolean | Indicates whether property is currently subject to an energy-related lien that could take priority over the first mortgage lien. | Optional | 48.0 |
isTempIntRateBuydown | Boolean | Indicates whether borrower is applying for loan with an initially reduced interest payment in exchange for an up-front cash deposit. | Optional | 48.0 |
leaseHoldExpirationDate | String | Date when leasehold expires if land is leased. | Optional | 48.0 |
liabilities | Liability Input[] | Represents details about the borrower and co-borrower current liabilities. | Optional | 48.0 |
loanPurpose | String | Purpose of the loan. | Optional | 48.0 |
lotAcquiredDate | String | Month and year property or land was purchased. | Optional | 48.0 |
lotOriginalCost | Double | Original property cost (refinance) or original land cost (construction). | Optional | 48.0 |
monthsBeforeFirstAdj | Integer | Initial period prior to first adjustment in months. | Optional | 48.0 |
monthsBetweenAdjustments | Integer | Number of months before the first rate adjustment for an adjustable rate loan. | Optional | 48.0 |
mortgageLienType | String | Type of mortgage lien associated with this loan application. | Optional | 48.0 |
mortgageProgramType | String | Type of mortgage program applied for. | Optional | 48.0 |
name | String | Name of the residential loan application. | Required | 48.0 |
nativeLandTenure | String | Property is located on an area reserved by or for an Indian land, village, or tribe to live on and use. | Optional | 48.0 |
opportunityId | String | Opportunity associated with the application. | Required if accountId isn’t provided | 48.0 |
otherAmortizationType | String | Description of other amortization type for government loans. | Optional | 48.0 |
otherLoanFeature | String | Description of other loan amortization feature. | Optional | 48.0 |
otherLoanPurpose | String | What the borrower will use the loan for if other was specified. | Optional | 48.0 |
otherMortgageProgramType | String | Description of the other mortgage type. | Optional | 48.0 |
otherRefinanceProgType | String | Refinance program name if other was specified. | Optional | 48.0 |
prepayPenaltyTermMonth | Integer | Number of months during which borrower incurs a penalty for early payoff of the loan balance. | Optional | 48.0 |
projectType | String | Specifies the type of project that the property belongs to. | Optional | 48.0 |
properties | Property Input[] | Represents details of the property the loan application finances. | Optional | 48.0 |
refinanceProgramType | String | The applicable refinance program type based on the investor, guarantor, or lender guidelines. | Optional | 48.0 |
refinanceType | String | Refinance loan type. | Optional | 48.0 |
status | String | Indicates the current status of the loan application. | Optional | 48.0 |
titleHolders | Title Holder Input[] | Represents details of borrowers who are applying to hold title to the property the loan application finances. | Optional | 48.0 |
titleType | String | Way the borrower or borrowers take title for the loan. | Optional | 48.0 |
trustTitleType | String | Title to be held in a living trust or a land trust. | Optional | 48.0 |