Note: You are viewing the development version of Schema.org. See how we work for more details.

MortgageLoan

A Schema.org Type

This term is in the "new" area - implementation feedback and adoption from applications and websites can help improve our definitions.
A loan in which property or real estate is used as collateral. (A loan securitized against some real estate.)
PropertyExpected TypeDescription
Properties from MortgageLoan
domiciledMortgage Boolean Whether borrower is a resident of the jurisdiction where the property is located.
loanMortgageMandateAmount MonetaryAmount Amount of mortgage mandate that can be converted into a proper mortgage at a later stage.
Properties from LoanOrCredit
amount MonetaryAmount  or
Number
The amount of money.
currency Text The currency in which the monetary amount is expressed.

Use standard formats: ISO 4217 currency format, e.g. "USD"; Ticker symbol for cryptocurrencies, e.g. "BTC"; well known names for Local Exchange Trading Systems (LETS) and other currency types, e.g. "Ithaca HOUR".
gracePeriod Duration The period of time after any due date that the borrower has to fulfil its obligations before a default (failure to pay) is deemed to have occurred.
loanRepaymentForm RepaymentSpecification A form of paying back money previously borrowed from a lender. Repayment usually takes the form of periodic payments that normally include part principal plus interest in each payment.
loanTerm QuantitativeValue The duration of the loan or credit agreement.
loanType Text  or
URL
The type of a loan or credit.
recourseLoan Boolean The only way you get the money back in the event of default is the security. Recourse is where you still have the opportunity to go back to the borrower for the rest of the money.
renegotiableLoan Boolean Whether the terms for payment of interest can be renegotiated during the life of the loan.
requiredCollateral Text  or
Thing
Assets required to secure loan or credit repayments. It may take form of third party pledge, goods, financial instruments (cash, securities, etc.)
Properties from FinancialProduct
annualPercentageRate Number  or
QuantitativeValue
The annual rate that is charged for borrowing (or made by investing), expressed as a single percentage number that represents the actual yearly cost of funds over the term of a loan. This includes any fees or additional costs associated with the transaction.
feesAndCommissionsSpecification Text  or
URL
Description of fees, commissions, and other terms applied either to a class of financial product, or by a financial service organization.
interestRate Number  or
QuantitativeValue
The interest rate, charged or paid, applicable to the financial product. Note: This is different from the calculated annualPercentageRate.
Properties from Service
aggregateRating AggregateRating The overall rating, based on a collection of reviews or ratings, of the item.
areaServed AdministrativeArea  or
GeoShape  or
Place  or
Text
The geographic area where a service or offered item is provided. Supersedes serviceArea.
audience Audience An intended audience, i.e. a group for whom something was created. Supersedes serviceAudience.
availableChannel ServiceChannel A means of accessing the service (e.g. a phone bank, a web site, a location, etc.).
award Text An award won by or for this item. Supersedes awards.
brand Brand  or
Organization
The brand(s) associated with a product or service, or the brand(s) maintained by an organization or business person.
broker Organization  or
Person
An entity that arranges for an exchange between a buyer and a seller. In most cases a broker never acquires or releases ownership of a product or service involved in an exchange. If it is not clear whether an entity is a broker, seller, or buyer, the latter two terms are preferred. Supersedes bookingAgent.
category CategoryCode  or
PhysicalActivityCategory  or
Text  or
Thing  or
URL
A category for the item. Greater signs or slashes can be used to informally indicate a category hierarchy.
hasCertification Certification Certification information about a product, organization, service, place, or person.
hasOfferCatalog OfferCatalog Indicates an OfferCatalog listing for this Organization, Person, or Service.
hoursAvailable OpeningHoursSpecification The hours during which this service or contact is available.
isRelatedTo Product  or
Service
A pointer to another, somehow related product (or multiple products).
isSimilarTo Product  or
Service
A pointer to another, functionally similar product (or multiple products).
logo ImageObject  or
URL
An associated logo.
offers Demand  or
Offer
An offer to provide this item—for example, an offer to sell a product, rent the DVD of a movie, perform a service, or give away tickets to an event. Use businessFunction to indicate the kind of transaction offered, i.e. sell, lease, etc. This property can also be used to describe a Demand. While this property is listed as expected on a number of common types, it can be used in others. In that case, using a second type, such as Product or a subtype of Product, can clarify the nature of the offer.
Inverse property: itemOffered
provider Organization  or
Person
The service provider, service operator, or service performer; the goods producer. Another party (a seller) may offer those services or goods on behalf of the provider. A provider may also serve as the seller. Supersedes carrier.
providerMobility Text Indicates the mobility of a provided service (e.g. 'static', 'dynamic').
review Review A review of the item. Supersedes reviews.
serviceOutput Thing The tangible thing generated by the service, e.g. a passport, permit, etc. Supersedes produces.
serviceType GovernmentBenefitsType  or
Text
The type of service being offered, e.g. veterans' benefits, emergency relief, etc.
slogan Text A slogan or motto associated with the item.
termsOfService Text  or
URL
Human-readable terms of service documentation.
Properties from Thing
additionalType Text  or
URL
An additional type for the item, typically used for adding more specific types from external vocabularies in microdata syntax. This is a relationship between something and a class that the thing is in. Typically the value is a URI-identified RDF class, and in this case corresponds to the use of rdf:type in RDF. Text values can be used sparingly, for cases where useful information can be added without their being an appropriate schema to reference. In the case of text values, the class label should follow the schema.org style guide.
alternateName Text An alias for the item.
description Text  or
TextObject
A description of the item.
disambiguatingDescription Text A sub property of description. A short description of the item used to disambiguate from other, similar items. Information from other properties (in particular, name) may be necessary for the description to be useful for disambiguation.
identifier PropertyValue  or
Text  or
URL
The identifier property represents any kind of identifier for any kind of Thing, such as ISBNs, GTIN codes, UUIDs etc. Schema.org provides dedicated properties for representing many of these, either as textual strings or as URL (URI) links. See background notes for more details.
image ImageObject  or
URL
An image of the item. This can be a URL or a fully described ImageObject.
mainEntityOfPage CreativeWork  or
URL
Indicates a page (or other CreativeWork) for which this thing is the main entity being described. See background notes for details.
Inverse property: mainEntity
name Text The name of the item.
potentialAction Action Indicates a potential Action, which describes an idealized action in which this thing would play an 'object' role.
sameAs URL URL of a reference Web page that unambiguously indicates the item's identity. E.g. the URL of the item's Wikipedia page, Wikidata entry, or official website.
subjectOf CreativeWork  or
Event
A CreativeWork or Event about this Thing.
Inverse property: about
url URL URL of the item.

Acknowledgements

Financial Industry Business Ontology project
This element is based on the work of the Financial Industry Business Ontology project (see http://www.fibo.org/schema for details), in support of the W3C Financial Industry Business Ontology Community Group (http://www.fibo.org/community). Many class and property definitions are inspired by or based on http://www.fibo.org.

Source

https://github.com/schemaorg/schemaorg/issues/1253


Examples

Example 1
Copied
Example notes or example HTML without markup.
<div>
  <h1>Agency 30 Year Fixed</h1>
  <p>Experience easier budgeting with predictable monthly payments. Relax knowing you’ll never have to worry about rising interest rates for the life of your loan.</p>
</div>
<table>
  <caption>Rates are based on a loan amount of $200,000 and 20% down payment.</caption>
  <tr>
    <td>Interest rate</td>
    <td>3.625%</td>
  </tr>
  <tr>
    <td>APR</td>
    <td>3.8047%</td>
  </tr>
  <tr>
    <td>Estimated payment</td>
    <td>$912.11</td>
  </tr>
  <tr>
    <td>Months</td>
    <td>360</td>
  </tr>
</table>
Example encoded as Microdata embedded in HTML.
<div itemscope itemtype="https://schema.org/MortgageLoan">
  <h1 itemprop="name">Agency 30 Year Fixed</h1>
  <div itemprop="loanTerm" itemscope itemtype="https://schema.org/QuantitativeValue">
    <meta itemprop="value" content="30"/>
    <meta itemprop="unitCode" content="ANN"/>
  </div>
  <p itemprop="description">Experience easier budgeting with predictable monthly payments. Relax knowing you’ll never have to worry about rising interest rates for the life of your loan.</p>
  <div itemprop="loanRepaymentForm" itemscope itemtype="https://schema.org/RepaymentSpecification" itemref="estPay payNum">
    <meta itemprop="downPayment" content="20"/>
    <meta itemprop="loanPaymentFrequency" content="1"/>
      <span>Estimated payment</span>
    <div id="estPay" itemprop="loanPaymentAmount" itemscope itemtype="https://schema.org/MonetaryAmount">
    <span itemprop="currency" content="USD">$</span><span itemprop="value">912.11</span></div>
    <span>Months</span>
    <div id="payNum" itemprop="numberOfLoanPayments">360</div>
  </div>

<table>
	<caption id="amount" itemprop="amount" itemscope itemtype="https://schema.org/MonetaryAmount">Rates are based on a loan amount of <span itemprop="currency" content="USD">$</span><span itemprop="value" content="200000">200,000</span> and 20% down payment.</caption>
  <tr>
    <td>Interest rate</td>
    <td><span id="intRate" itemprop="interestRate">3.625</span>%</td>
  </tr>
  <tr>
    <td>APR</td>
    <td><span id="apr" itemprop="annualPercentageRate">3.8047</span>%</td>
  </tr>
</table>

</div>
Example encoded as RDFa embedded in HTML.
<div vocab="https://schema.org/" typeof="MortgageLoan">
  <h1 property="name">Agency 30 Year Fixed</h1>
  <div property="loanTerm" typeof="QuantitativeValue">
    <meta property="value" content="30"/>
    <meta property="unitCode" content="ANN"/>
  </div>
  <p property="description">Experience easier budgeting with predictable monthly payments. Relax knowing you’ll never have to worry about rising interest rates for the life of your loan.</p>
  <div property="loanRepaymentForm" typeof="RepaymentSpecification" itemref="estPay payNum">
    <meta property="downPayment" content="20"/>
    <meta property="loanPaymentFrequency" content="1"/>
      <span>Estimated payment</span>
    <div id="estPay" property="loanPaymentAmount" typeof="MonetaryAmount">
    <span property="currency" content="USD">$</span><span property="value">912.11</span></div>
    <span>Months</span>
    <div id="payNum" property="numberOfLoanPayments">360</div>
  </div>

<table>
	<caption id="amount" property="amount" typeof="MonetaryAmount">Rates are based on a loan amount of <span property="currency" content="USD">$</span><span property="value" content="200000">200,000</span> and 20% down payment.</caption>
  <tr>
    <td>Interest rate</td>
    <td><span id="intRate" property="interestRate">3.625</span>%</td>
  </tr>
  <tr>
    <td>APR</td>
    <td><span id="apr" property="annualPercentageRate">3.8047</span>%</td>
  </tr>
</table>

</div>
Example encoded as JSON-LD in a HTML script tag.
<script type="application/ld+json">
{
  "@context": "https://schema.org",
  "@type": "MortgageLoan",
  "name": "Agency 30 Year Fixed",
  "description": "Experience easier budgeting with predictable monthly payments. Relax knowing you’ll never have to worry about rising interest rates for the life of your loan.",
  "amount": {
    "@type": "MonetaryAmount",
    "value": "200000",
    "currency": "USD"
  },
  "loanTerm": {
    "@type": "QuantitativeValue",
    "value": "30",
    "unitCode": "ANN"
  },
  "interestRate": "3.625",
  "annualPercentageRate": "3.8047",
  "loanRepaymentForm": {
    "@type": "RepaymentSpecification",
    "loanPaymentAmount": {
      "@type": "MonetaryAmount",
      "value": "909.3",
      "currency": "USD"
    },
    "downPayment": "20",
    "numberOfLoanPayments": "360",
    "loanPaymentFrequency": "1"
  }
}
</script>
Structured representation of the JSON-LD example.