Version3ReferenceModelGeneralI Guide (FINAL)
Version3ReferenceModelGeneralI Guide (FINAL)
TABLE OF CONTENTS
i
MISMO V3 General Information Guide Table of Contents
ii
MISMO V3 General Information Guide Table of Contents
iii
MISMO V3 General Information Guide Table of Contents
PARTY Element...........................................................................................................................................49
REFERENCE Element .............................................................................................................................50
INDIVIDUAL Element ............................................................................................................................51
LEGAL_ENTITY Element ......................................................................................................................52
ROLES / ROLE Elements ........................................................................................................................53
GOVERNMENT MONITORING Element (V3.3.1 & Earlier) ...........................................................55
GOVERNMENT MONITORING Element (V3.4 & Later) ................................................................56
LOAN Element.............................................................................................................................................58
LOAN ROLE Attribute ............................................................................................................................58
LOAN_STATE Element ..........................................................................................................................59
LOAN ROLE LOAN STATE Use Cases..............................................................................................60
Non-Modified Loans Delivered to Investor .........................................................................................60
Modified Loans Delivered to Investor..................................................................................................61
Converted Loans...................................................................................................................................62
Reset Balloon Loans .............................................................................................................................63
Second Lien Subject Loan with Related First Lien Loan .....................................................................64
Loans with Concurrent Secondary Financing ......................................................................................65
ADJUSTMENT Element..........................................................................................................................66
INDEX RULE ......................................................................................................................................66
LIFETIME ADJUSTMENT RULE Elements......................................................................................67
CONVERSION OPTION PERIOD ADJUSTMENT RULES.............................................................68
PER CHANGE ADJUSTMENT RULES ............................................................................................68
PERIODIC ADJUSTMENT RULES ...................................................................................................69
RATE OR PAYMENT CHANCE OCCURRENCES .........................................................................72
Chapter 5: Extending the MISMO Standard ....................................................................................................73
Goals of the MISMO Extension Model ....................................................................................................73
Guidelines for Using the EXTENSION Element .....................................................................................73
EXTENSION Element Version 3.2 and Later...................................................................................74
EXTENSION Element Versions 3.0 and 3.1 ....................................................................................75
Adding Data Point Elements ................................................................................................................75
Adding Container Elements..................................................................................................................76
iv
MISMO V3 General Information Guide Table of Contents
v
MISMO V3 General Information Guide Table of Contents
vi
MISMO V3 General Information Guide Getting Started
About MISMO
The Mortgage Bankers Association (MBA) created the Mortgage Industry Standard
Maintenance Organization, commonly known MISMO, in October, 1999. This section
provides the following information about MISMO:
MISMOs objective
Who Participates in MISMO?
Mortgage Industry Areas
The MISMO Reference Model
For detailed information about MISMOs structure and mission, see the
www.mismo.org/AboutMISMO web page.
1
MISMO V3 General Information Guide Getting Started
MISMOs Objective
MISMOs purpose is to develop and maintain the XML data formats businesses use to
exchange data electronically in mortgage transactions. This XML protocol is called the
MISMO Reference Model. To document the MISMO Reference Model, the MISMO
workgroups work together to produce the following:
A data dictionary (the LDD) to provide business definitions and corresponding
architecture data element tag names.
An XML architecture that encompasses all data contributed by the Industry
Workgroups.
The Core Data Structures Workgroup coordinates data common to multiple industry
areas, such as borrower and property elements.
2
MISMO V3 General Information Guide Getting Started
This image diagrams the relationships among categories and industry areas.
3
MISMO V3 General Information Guide Getting Started
XML Schema: The MISMO V3 XML Schema specifies how the data elements
are organized into a logical, well-defined structure that allows for both the
exchange of data and documents as well as its use within a system or enterprise.
Types of Workgroups
Three of the MISMO workgroups guide the overall structure of the XML Reference
Model or the MISMO organization itself. These workgroups include Architecture, Core
Data Structures, and the MISMO Council of Chairs.
The Architecture Workgroup provides overall technical direction and support for
development of the MISMO Reference Model. Representatives from the industry
workgroups make up the Architecture workgroup.
The Core Data Structures (CDS) workgroup makes sure that all workgroups use
the same data definitions and business concepts across the Reference Model.
CDS uses data modeling and relational concepts to do so. Business data experts
and technical experts from the industry workgroups make up the CDS
workgroup.
The MISMO Council of Chairs includes all industry work groups chairpersons.
It provides a forum for workgroups to share information with each other.
Industry workgroups focus on the interests of a particular area and include subject matter
experts for that industry area. Examples of industry workgroups include Credit,
Verification Services, eMortgage, Origination, Appraisal, and others.
Development workgroups are formed to produce a specific item. Rather than being an
ongoing workgroup, a development workgroup meets to produce its deliverable and then
disbands once the project is complete. An example of a development workgroup is the
MISMO General Implementation Guide (I-Guide) Workgroup, which has met over
several months to produce this Implementation Guide. Once the MISMO I-Guide
workgroup has published its implementation guide, it will disband, but it might form
again to develop another I-guide when the MISMO Reference Model is updated.
4
MISMO V3 General Information Guide Getting Started
Data Architecture
In addition to the MISMO Reference Model, the MISMO Engineering Guidelines
(MEGs) are another resource available to CIOs and Data Architects. The MEGs cover a
variety of useful topics including defining data classes, namespaces, data elements and
attributes, use of acronyms, data extensions, and version release processes. The MEGs
are developed primarily for usage by MISMO in the development of the Reference
Model; however they may also be useful to some companies for their own internal
policies. Established companies may already have architecture policies that are much
more comprehensive that those defined within the MEGs. Others may find them useful
for building or augmenting their own data architecture policies.
5
MISMO V3 General Information Guide Getting Started
6
MISMO V3 General Information Guide Reference Model Logical Data Dictionary
V3.x.x.x Tab
This worksheet tab identifies the version identifier of the LDD and Reference Model,
legal declarations, and statistical information about the MISMO data set data point
counts, container counts, etc.
Build = B298: internal MISMO identifier for each Reference Model / LDD
Build. The Build identifier is generated by the system that generates the MISMO
Reference Model. There could be several Builds created before the release of a
specific LDD Version or Model Version.
Date = 2014-02-04: date that the version of the build was created.
Model Version = 3.3.0: identifier for the Reference Model, the XML schema
that defines the MISMO data structure.
Version = 3.3.0.0: identifier for this release of the Logical Data Dictionary.
7
MISMO V3 General Information Guide Reference Model Logical Data Dictionary
Containers Tab
This worksheet tab of the LDD contains a list of each container element used in the
MISMO V3 Reference Model. Here are some of the features of the Containers Tab of
the worksheet:
8
MISMO V3 General Information Guide Reference Model Logical Data Dictionary
Attributes Tab
This worksheet tab contains an alphabetical list of the attributes defined in the V3.x
Reference Model. Attributes define additional qualities about either containers or data
points. Here are some of the features of the Containers Tab of the worksheet:
Lists attributes alphabetically by their term name.
Provides a definition for each attribute.
For attributes that only allow specific values, provides that list of values with a
value definition, if it is needed.
Lists all data points or containers that have the attribute, plus a total usage count.
This tab will list up to the first 30 usages. If the number of usages exceeds that
number, you must refer to the Usages Tab for a complete list.
Lists the data type associated with the attribute.
9
MISMO V3 General Information Guide Reference Model Logical Data Dictionary
10
MISMO V3 General Information Guide Reference Model Logical Data Dictionary
Below is a simplified XML sample that shows how the XLink attributes are used to
establish a relationship between a source and target data point or container element. In
this mortgage deal sample below, there are two assets, three liabilities and two
borrowers. Note that the third liability is a joint account associated with both borrowers.
XLink label attributes are added to each ASSET element, each LIABILITY element, and
each PARTY elements ROLE element. The MISMO RELATIONSHIP element identifies
which liability is associated with each borrower using the XLink arcrole, from and to
attributes.
DEAL
ASSETS
ASSET xlink:label = Asset1 (Auto - $21,200)
ASSET xlink:label = Asset2 (Stocks - $132,000)
LIABILITIES
LIABILITY xlink:label = Liability1 (GMAC - $23,700)
LIABILITY xlink:label = Liability2 (Sears - $400)
LIABILITY xlink:label = Liability3 (Visa - $6,700)
PARTIES
PARTY / ROLE xlink:label=Borrower1 (John Doe)
PARTY / ROLE xlink:label=Borrower2 (Jane Doe)
RELATIONSHIPS
RELATIONSHIP xlink:from=Asset1 xlink:to=Borrower2
xlink:arcrole=ASSET_IsAssociatedWith_ROLE
RELATIONSHIP xlink:from=Asset2 xlink:to=Borrower2
xlink:arcrole=ASSET_IsAssociatedWith_ROLE
RELATIONSHIP xlink:from=Liability1 xlink:to=Borrower1
xlink:arcrole=LIABILITY_IsAssociatedWith_ROLE
RELATIONSHIP xlink:from=Liability2 xlink:to=Borrower1
xlink:arcrole=LIABILITY_IsAssociatedWith_ROLE
RELATIONSHIP xlink:from=Liability3 xlink:to=Borrower1
xlink:arcrole=LIABILITY_IsAssociatedWith_ROLE
RELATIONSHIP xlink:from=Liability3 xlink:to=Borrower2
xlink:arcrole=LIABILITY_IsAssociatedWith_ROLE
There is a more detail discussion in the Rules for XLink Relationships section of the
Reference Model XML Schema chapter of this guide.
11
MISMO V3 General Information Guide Reference Model Logical Data Dictionary
Enumerations Tab
This worksheet tab shows the term name, definitions and valid values for all enumerated
data and attributes. An enumeration is a specific data value for data point. Here are some
of the features of the Enumerations Tab of the worksheet:
Lists alphabetically the enumerated term.
For ease of use, repeats the definition and usage count for the enumerated term
which may also be found on the Data Point / Attribute Tabs.
Lists alphabetically all enumerations and their definitions. This is the complete
list. When the number of enumerations exceeds 30, you will need to use this tab
to see the entire list.
Lists the Base term name for the data point that is used in the XML schema.
12
MISMO V3 General Information Guide Reference Model Logical Data Dictionary
Acronyms Tab
This worksheet tab of the LDD contains the MISMO approved list of acronyms that are
incorporated into some Data Point names and Attribute names. Acronyms are approved
by MISMO for use based on guidelines defined by the MISMO Architecture Work
Group.
NOTE: The MISMO Engineering Guidelines (MEG 0008 and 0008A) for Approved
Acronyms discusses this topic in more detail. It is available at the link below:
http://www.mismo.org/Guidelines/EngineeringGuidelines(MEGS).htm
Here are some of the features of the Acronyms Tab of the worksheet:
Lists acronyms alphabetically.
Provides a definition - the full name of the acronym.
Lists the number of times it is used in the Reference Model and the data point
names, acronym names and enumeration values where each acronym is used.
13
MISMO V3 General Information Guide Reference Model Logical Data Dictionary
Usages Tab
This worksheet tab shows the XPaths for every use of data points, containers and
attributes within the MISMO Reference Model. Here are some of the features of the
Usages Tab of the worksheet:
Lists alphabetically every data point, container and attribute.
For ease of use, repeats the definition and usages for the data point / container /
attribute which may also be found on the Data Point / Container / Attribute Tabs.
Lists all XPath usages. This is the complete list. When the number of
enumerations exceeds 30, you will need to use this tab to see the entire list.
14
MISMO V3 General Information Guide Reference Model Logical Data Dictionary
15
MISMO V3 General Information Guide Reference Model XML Schema
Data Elements
Data elements capture concrete pieces of information in the XML transactions. For
example, the LDD data point Loan Maturity Date is defined as the date when the loan
is scheduled to be paid in full as reflected in the Note. In an XML document, this would
be expressed as an XML data element LoanMaturityDate as shown below:
<LoanMaturityDate>2043-09-30</LoanMaturityDate>
16
MISMO V3 General Information Guide Reference Model XML Schema
<CreatedDatetime IgnoreTimeSegmentIndicator="true">
2015-12-02T00:00:00+00:00
</CreatedDatetime>
MISMO data element names ending in the class words: Amount, Date, DateTime,
Percent, Rate, and Type will not validate against the MISMO Reference Model schema
if they have blank values. In Version 3.4 and later an additional attribute, xsi:nil="true",
must be added to allow blank data values to be validated by the schema. The XML
sample below shows how this attribute is implemented for a Type element.
<HMDAEthnicityType DataNotSuppliedReasonType="NotCollected" xsi:nil="true"/>
17
MISMO V3 General Information Guide Reference Model XML Schema
Container Elements
Container elements are elements that can hold either related data elements or other
container elements, never both.
The root or main container element of the MISMO V3 Schema is MESSAGE. It is the
highest level in the MISMO architecture. The following image shows the MESSAGE
container element, which holds ABOUT_VERSIONS and DEAL_SETS container elements.
18
MISMO V3 General Information Guide Reference Model XML Schema
Container elements with plural names always have a child element with the singular
version of the name. For example:
DEAL_SETS / DEAL_SET
LOANS / LOAN
PARTIES / PARTY
INDEX_RULES / INDEX_RULE
In the example below the LOANS element has two LOAN elements. All repeating
container elements have a SequenceNumber attribute, which may be used to identify the
order of the two LOAN elements as shown in this XML example:
<DEAL>
<LOANS>
<LOAN SequenceNumber="1"/>
<LOAN SequenceNumber="2"/>
</LOANS>
</DEAL>
Every container element has an EXTENSION element that can be used to provide
additional data not otherwise defined in the MISMO standard. In the following
example, the MISMO BIRTH_INFORMATION element contains the mothers maiden
name, an existing MISMO data point, and is being extended to also include the
grandmothers maiden name, which is not a MISMO data point. The extended data is
added to the EXTENSION / OTHER element structure.
<BIRTH_INFORMATION>
<MothersMaidenName>Jennings</MothersMaidenName>
<EXTENSION xmlns:abc="http://abcmortgage.com">
<OTHER>
<abc:GrandmothersMaidenName>Kelly</abc:GrandmothersMaidenName>
</OTHER>
</EXTENSION>
</BIRTH_INFORMATION>
See the Extending the MISMO Standard chapter of this I-Guide for more information
on the use of the EXTENSION element.
Certain containers can appear in more than one location. These are sometimes referred
to as generic or reusable containers. The container and its contents have a specific
meaning that is further refined based on its location within the model. For example, the
ADDRESS container element captures the address data element, street name, city name,
state code, postal code, etc. When the ADDRESS container element appears in the
PROPERTY container element, it represents a property address. When the ADDRESS
19
MISMO V3 General Information Guide Reference Model XML Schema
Cardinality
The cardinality of an element defines the number possible occurrences of that element.
As discussed in the previous section, some data containers may be repeated multiple
times within a MISMO data file. The MISMO Reference Model Schema defines the
cardinality of each element. The attributes that specify cardinality are minOccurs
(minimum number of elements) and maxOccurs (maximum number of elements). If the
minOccurs value or maxOccurs value is not specified they have a default value of 1
(single occurrence).
The XML sample below is part of the MISMO Schema definition for the ADDRESSES
container element. The ADDRESS child element is defined with a cardinality of
minOccurs=0 and maxOccurs = unbounded, which indicates that ADDRESS is
optional but may occur an unlimited number of times within ADDRESSES. The
EXTENSION element has a cardinality of minOccurs=0, which indicates that it is
optional and may only appear once (since maxOccurs is assumed to be 1 if it is not
specified.
<xsd:complexType name="ADDRESSES">
<xsd:sequence>
<xsd:element name="ADDRESS" minOccurs="0" maxOccurs="unbounded"/>
<xsd:element name="EXTENSION" minOccurs="0"/>
</xsd:sequence>
</xsd:complexType>
Data Relationships
Providing a list of mortgage industry data elements and their definitions is an important
feature of the MISMO Reference Model. Equally important is how the Reference Model
Schema defines the relationships between those data elements. Source and target data
elements in a relationship are generally referred to as end points. The following types of
relationships are supported in the Reference Model.
One-to-One Relationship
A One-to-One Relationship is one in which any given instance of the source element
may only be associated with one instance of the target element, and no two instances of
the source element are associated with the same instance of the target element.
For example: Each instance of the source PARTY / INDIVIDUAL element may be
20
MISMO V3 General Information Guide Reference Model XML Schema
associated with one instance of the target NAME element, which is not associated with
any other instances of the PARTY / INDIVIDUAL element.
INDIVIDUAL 1 NAME 1
INDIVIDUAL 2 NAME 2
Most One-to-One Relationships are established in the MISMO Reference Model by
containment. Containment means that there is a direct parent/child relationship between
the elements. In the example above the INDIVIDUAL element contains a NAME element,
which itself contains the individuals name components First Name, Middle Name,
Last Name, and others. Other One-to-One Relationships may be needed which cannot
be made using containment. For example, relating two data elements that are in different
container elements. These types of relationships are sometimes referred to as pointing
relations and are defined using XLink Relationships, which are discussed later in this
chapter.
One-to-Many Relationship
A One-to-Many Relationship is one in which one instance of the source element may be
associated with one or more instances of the target element and no two instances of the
source element are associated with the same instance of the target element.
For example: Each instance of the source BORROWER element may have multiple
instances of the target EMPLOYER element, each of those is not associated with any other
instances of BORROWER. Even if both borrowers on a loan may have the same
employer, the values of some the employer data elements may be different, such as their
income amounts, start dates, and positions.
EMPLOYER 1
BORROWER 1
EMPLOYER 2
EMPLOYER 3
BORROWER 2
EMPLOYER 4
Most One-to-Many Relationships are also established in the MISMO Reference Model
by containment. Other One-to-Many Relationships may be defined using XLink
Relationships.
Many-to-Many Relationship
A Many-to-Many Relationship is one in which one instance of the source element may
be associated with multiple instances of the target element and multiple instances of the
source element may be associated with the same instance of the target element.
21
MISMO V3 General Information Guide Reference Model XML Schema
For example: Each BORROWER element may be associated with multiple ASSET
elements, and multiple BORROWER elements may be associated with the same ASSET
element.
BORROWER 1 ASSET 1
BORROWER 2 ASSET 2
Many-to-Many Relationships are defined using XLink Relationships.
Reflexive Relationship
A Reflexive Relationship is a one-to-one, one-to-many, or many-to-many relationship
between instances of the same element, i.e., the source and target elements are of the
same type.
For example: An instance of the INDIVIDUAL element may be associated with another
instance of the INDIVIDUAL element to represent a marriage relationship.
Reflexive Relationships are defined using XLink Relationships.
Irreflexive Relationship
An Irreflexive Relationship is the opposite of a Reflexive Relationship. It is a one-to-
one, one-to-many, or many-to-many relationship between instances of different
elements, i.e., the source and target elements are of different types.
For example: The One-to-One INDIVIDUAL to NAME relationship, One-to-Many
BORROWER to EMPLOYER relationship, and Many-to-Many BORROWER to ASSET
relationships discussed earlier are all examples of Irreflexive Relationships.
Overview
The previous section identified types of relationships and the methods MISMO uses to
define relationships either by containment or by pointing. Whenever we need to
identify relationships between elements that are not directly contained by another, we
use Xlink Relationships. MISMO has added the appropriately named RELATIONSHIPS
container structure as a means of specifying those relationships.
The RELATIONSHIPS container is a child of MESSAGE, DEAL_SETS, DEAL_SET, DEALS,
DEAL, and DOCUMENT. The location in the Reference Model of the RELATIONSHIPS
container is determined by the XML instance and its structure. The RELATIONSHIPS
container used MUST be at the lowest structural level that is a parent or sibling of the
elements being joined.
22
MISMO V3 General Information Guide Reference Model XML Schema
Examples include:
The RELATIONSHIPS container as a child of a DEAL_SETS container links
DEAL_SETS/PARTY data to DEAL_SETS/DEAL_SET/DEALS/DEAL/LOANS/LOAN
data.
The RELATIONSHIPS container as a child of a DOCUMENT container links all the
information about document signatures in the
DOCUMENT/SIGNATORIES/SIGNATORY container to the actual
DOCUMENT/DEAL_SETS/DEAL_SET/DEALS/DEAL/PARTY container representing
the person that signed the document.
The RELATIONSHIPS container as a child of a DEAL container links all the
information for a DEAL/LOANS/LOAN, such as asset and liability information, to
an individual borrowers under DEAL/PARTIES/PARTY container.
The MISMO Reference Model uses an XML specification called XLink to define data
relationships in a MISMO message that are not naturally expressed by the MISMO
container hierarchy. The full XLink standard is defined by the W3C at
http://www.w3.org/TR/xlink. At this time MISMO is only using a limited set of the
XLink attributes.
One of the XLink attributes, arcrole describes the type of relationship between source
data and target data. The XLink from attribute identifies the source data point or
container. The XLink to attribute identifies the target data point or container. The
XLink label attribute is an identifier that is attached to data point or container elements
that will be used to express an arcrole relationship. The MISMO RELATIONSHIP
container elements hold the XLink arcrole, from and to attributes that describe the data
relationships.
In the simplified example below, a CREDIT_RESPONSE has returned CREDIT_SCORE data
for BORROWER parties in a loan DEAL. XLink label attributes are added to each
CREDIT_SCORE element and each PARTY elements ROLE element. The MISMO
RELATIONSHIP element identifies which credit score is associated with each borrower.
23
MISMO V3 General Information Guide Reference Model XML Schema
DEAL
RELATIONSHIPS
RELATIONSHIP xlink:from=EquifaxCreditScore1 xlink:to=Borrower1
xlink:arcrole=CREDIT_SCORE_IsAssociatedWith_ROLE
RELATIONSHIP xlink:from=EquifaxCreditScore2 xlink:to=Borrower2
xlink:arcrole=CREDIT_SCORE_IsAssociatedWith_ROLE
RELATIONSHIP xlink:from=ExperianCreditScore1 xlink:to=Borrower1
xlink:arcrole=CREDIT_SCORE_IsAssociatedWith_ROLE
RELATIONSHIP xlink:from=ExperianCreditScore2 xlink:to=Borrower2
xlink:arcrole=CREDIT_SCORE_IsAssociatedWith_ROLE
RELATIONSHIP xlink:from=TransUnionCreditScore1 xlink:to=Borrower1
xlink:arcrole=CREDIT_SCORE_IsAssociatedWith_ROLE
RELATIONSHIP xlink:from=TransUnionCreditScore2 xlink:to=Borrower2
xlink:arcrole=CREDIT_SCORE_IsAssociatedWith_ROLE
SERVICES
SERVICE
CREDIT_RESPONSE
CREDIT_SCORES
CREDIT_SCORE xlink:label=EquifaxCreditScore1 (Score 690)
CREDIT_SCORE xlink:label=EquifaxCreditScore2 (Score 720)
CREDIT_SCORE xlink:label=ExperianCreditScore1 (Score 655)
CREDIT_SCORE xlink:label=ExperianCreditScore2 (Score 706)
CREDIT_SCORE xlink:label=TransUnionCreditScore1 (Score 681)
CREDIT_SCORE xlink:label=TransUnionCreditScore2 (Score 710)
PARTIES
PARTY/ROLES/ROLE xlink:label=Borrower1 (John Doe)
PARTY/ROLES/ROLE xlink:label=Borrower2 (Jane Doe)
For example, to represent the relationship where a party is a borrower on a loan, link the
elements LOAN and ROLE. That relationship meets the rules of sufficiency and
uniqueness.
24
MISMO V3 General Information Guide Reference Model XML Schema
LOAN is sufficient to represent an instance of a loan because all the elements under
LOAN work together to describe the same loan. If we go any higher in the model, we
would fail to identify a loan. We could not use the DEAL element, because it may contain
multiple loans and we would not know to which one of them the relationship is being
applied.
LOAN is unique because it represents one specific instance of the LOAN container. Any
other sibling instance would be a different loan. If we go any lower, the endpoint would
not be unique. For example, we could not use LOAN_IDENTIFIER because all sibling
occurrences of LOAN_IDENTIFIER refer to the same loan.
ROLE is sufficient to identify a party as a borrower (by setting the ROLE_DETAIL
elements PartyRoleType attribute value to Borrower). If we go any higher in the
model, we would fail to identify the role. For example, we could not use the PARTY
element, because it may contain multiple roles and we would not know to which of them
the relationship is being applied.
The ROLE element is unique. Any given party will only have one ROLE element of type
borrower. If we want to say that a party is a borrower on a loan, we need to use one
specific instance of the ROLE element. Pointing to any other sibling instance would mean
a different role. If we go any lower, the endpoint would not be unique. For example, we
could not use EMPLOYER because all sibling instances of EMPLOYER refer to the same
borrower.
25
MISMO V3 General Information Guide Reference Model XML Schema
26
MISMO V3 General Information Guide Major Elements of the Schema
MESSAGE Element
The MESSAGE element is the root, or primary, element of the MISMO message. 2
This image shows the top two levels of the MISMO MESSAGE data structure.
The second-level element DEAL_SETS holds sets of loan data, or deals. The
DOCUMENT_SETS element includes printable/viewable documents as well as the
related data that populates the documents.
1
Even though the DEAL element is listed in the Reference Model schema as one of the three root elements, MESSAGE
is always used as the root element when exchanging data between business partners. However DEAL or DOCUMENT can
be used as a root element of an XML instance document when using it internally for analysis, reporting or archiving.
2
The data captured in MESSAGE data set can be the message payload of any SOAP or REST transaction. In a SOAP
transaction, MESSAGE is the content of the SOAP body element. In a REST transaction, MESSAGE is the document that
is in the PUT, GET or DELETE HTTP protocol methods.
27
MISMO V3 General Information Guide Major Elements of the Schema
In general, the DEAL_SETS container, as the only child of MESSAGE, is used for data-
centric exchanges and the DOCUMENT_SETS container, as the only child of
MESSAGE, is used for document-centric exchanges. There are certain cases where
related documents are included in a data centric message. In these cases, there may be
both a DEAL_SETS element and a DOCUMENT_SETS element as children of a
MESSAGE container; in these cases RELATIONSHIP containers are used link the data
and associated documents. An example is a data-centric service request for underwriting
that would have attached the documents for the borrowers authorizations to obtain data
from the IRS.
The RELATIONSHIPS element holds the XLink attributes and the SYSTEM_SIGNATURES
element enables the use of W3C XML digital signatures for creating tamper-evident
electronic seals around the MESSAGE and the DOCUMENT elements.
MESSAGE Attributes
Every MISMO data element can have additional XML attributes that either provide
additional identifiers for the element, or that further describe an elements usage. The
first two attributes of MESSAGE identify the MISMO Reference Model version
(example: 3.3.0) and Logical Data Dictionary version (example 3.3.0.0) used in a
particular MISMO XML message instance.
28
MISMO V3 General Information Guide Major Elements of the Schema
The diagram above like others in this guide were generated from the MISMO XML
Schema using an XML-aware editor. Note that it includes the definitions for each data
element and attribute. These are the same as the definitions from MISMO Logical Data
Dictionary.
DEAL_SETS Element
DEAL_SETS contains information about one or more DEAL_SET elements. The DEAL_SETS
element may be a child of the MESSAGE or the DOCUMENT element. When the
DEAL_SETS is a direct child of MESSAGE, each DEAL_SET can be used for transmitting a
group of related loans such as set of loans being transferred to or from a loan servicer or
other entity, or a pool of loans that forms a mortgage-backed security (MBS).
29
MISMO V3 General Information Guide Major Elements of the Schema
When the DEAL_SETS container is a child of a DOCUMENT element, there are two uses.
A single DEAL_SET may be used to represent the data of the document. Alternatively,
multiple DEAL_SET containers may be used to represent a group of data on a single
document (such as a report on a pool of loans). The DEAL_SET_SERVICE elements
contain information about services related to deal sets, such as servicing transfers,
workout evaluations, loan registrations or securities rating services.
PARTY elements list information about the business entities or individuals providing or
receiving services related to deal sets. RELATIONSHIP elements identify how data points
in the DEAL_SETS structures are related to each other. VERIFICATION_DATA contains
information that may be used as a cross check to verify the full content of the DEAL_SET
is present, such as a Loan Total Count or to summarize the content such as Escrow
Balance Total Amount.
30
MISMO V3 General Information Guide Major Elements of the Schema
DOCUMENT_SETS Element
Individual related DOCUMENT elements are grouped together as a DOCUMENT_SET.
DOCUMENT_SETS can hold one or more DOCUMENT_SET elements. See the
DOCUMENT Element section of this chapter for more information on its use.
When common document data or image files are being provided for multiple documents
in a non-MISMO or foreign format, the FOREIGN_OBJECTS element is used to either
contain the shared content directly or identify the location of the document on a server or
web site.
31
MISMO V3 General Information Guide Major Elements of the Schema
DEAL Element
The DEAL element captures information for a single mortgage transaction. A deal may
involve a single loan or multiple loans, such a first lien refinance of a mortgage and a
second lien home equity line of credit.
Even though the DEAL element is listed in the Reference Model schema as one of the
three root elements, MESSAGE is always used as the root element when exchanging data
between business partners. However DEAL can be used as a root element of an XML
instance document when using it internally for analysis, reporting or archiving.
On the next page is a diagram of the DEAL data structure. The elements contained by
DEAL can hold information about the assets, collaterals, expenses, liabilities, loans,
parties (borrowers, brokers, closing agents, etc.), and services (appraisals, credit reports,
title, etc.) related to the mortgage deal.
DEAL Attributes
When the DEAL element is used as the root element of an XML instance, its first two
attributes are used to identify the MISMO Reference Model version (example: 3.3.0) and
Logical Data Dictionary version (example 3.3.0.0) that was used to define the data and
structures in a particular MISMO XML message instance.
32
MISMO V3 General Information Guide Major Elements of the Schema
33
MISMO V3 General Information Guide Major Elements of the Schema
REFERENCE Element
Normally DEAL data is included directly in its child elements, ASSETS, COLLATERALS,
LOANS, and so on. In some cases it may be necessary or preferred to refer to data related
to a deal by referencing a server location or web site address using a URL (Universal
Reference Locator). The data related to this option is stored in the REFERENCE element.
For an individual DEAL instance, either a REFERENCE can be used or the normal
ASSETS, COLLATERALS, LOANS, etc. set of elements can be used, not both. In the XML
Schema this is referred to as a choice group.
34
MISMO V3 General Information Guide Major Elements of the Schema
ASSETS Element
ASSETS captures data about a collection of assets that may be used to determine the
credit-worthiness of the borrowers. Each child ASSET element captures information
about a single asset, including its cash or market value, its description, the asset holder,
and verification documentation related to the asset. Assets can be associated with a
borrower using the RELATIONSHIP elements. Relating assets to a borrower is probably
the most common usage. However, the model supports the ability to relate an asset to
any other party specified by the Party Role Type.
For owned property assets, additional information may be collected such as lien
amounts, rental income, maintenance expenses, etc. In V3.0 and V3.1 the ASSETS
container could hold either ASSET elements or OWNED_PROPERTIES elements as shown
in the diagram above.
35
MISMO V3 General Information Guide Major Elements of the Schema
In V3.2 and later, ASSETS was restructured to only contain ASSET elements. If the asset
was an owned property, the additional property information would be contained in the
OWNED_PROPERTY child element of ASSET.
COLLATERALS Element
The COLLATERALS element captures data about a collection of assets that are designated
as collateral for the loans of this deal. For most mortgage loans the primary collateral
used to secure the loan is the subject property, but this structure has the flexibility to
support other collateral arrangements.
In all MISMO versions, the COLLATERALS element can contain one or more COLLATERAL
elements. The two diagrams below highlight significant structure change between the
V3.0 and V3.1 COLLATERAL structure and one used in V3.2 and later.
36
MISMO V3 General Information Guide Major Elements of the Schema
In V3.0 and V3.1 a single COLLATERAL element could contain data about the properties
that are the subject of the loan, plus multiple other assets or owned properties being
pledged as collateral for the deal. This structure is represented in the diagram shown
below.
37
MISMO V3 General Information Guide Major Elements of the Schema
In V3.2 and later, a single COLLATERAL element could contain either data about the
subject property or data about other pledged assets such as owned property or another
type of asset as depicted in the diagram below. In V3.2 each COLLATERAL record only
contains data about a single asset or property.
NOTE: The property and valuation data structures are being covered in more detail in
an Implementation Guide being prepared by the Property Information & Valuation
Services Workgroup. When it is completed it will be available on the Implementation
Guidelines page of the MISMO web site (www.mismo.org).
38
MISMO V3 General Information Guide Major Elements of the Schema
39
MISMO V3 General Information Guide Major Elements of the Schema
LOANS Element
This element holds a one or more LOAN elements that are part of a mortgage deal
between a mortgage lender and one or more borrowers. More detailed coverage of the
contents of the LOAN element appears later in this chapter.
The LOANS element also has a COMBINED_LTVS, which can contain one or more records
of the calculated combined loan to value (LTV) ratio percentages calculated at different
times during the life of the loan. For example: If there are 2 loans, a first and second, on
a single property. The individually calculated LTV (the ratio of the amount of the loan to
the property value) for each loan would be carried within an instance of the LOAN
container. The COMBINED_LTV container would carry the combined LTV (the ratio of
the sum of both loans to the property value). The COMBINED_LTV element can also
capture the Home Equity Combined LTV.
40
MISMO V3 General Information Guide Major Elements of the Schema
41
MISMO V3 General Information Guide Major Elements of the Schema
42
MISMO V3 General Information Guide Major Elements of the Schema
DOCUMENT Element
The DOCUMENT element contains an electronic file that reports one or more aspects of a
business transaction. It can contain the image of a document as well as information
about the document and the data represented on the document.
Document Concepts
A document in electronic-record form is an eye-readable file. It has several functions:
When a document is signed, it can show that the signer acknowledges its
contents.
When the document is a contract it can bind the signer to the terms of that
contract, and the document becomes evidence to other readers that the signer
agreed to those terms.
Because electronic documents can be easily altered, there are special processes to
prove that a document has not been altered after it was signed.
A set of documents together can provide evidence that the proper processes have
been carried out in a mortgage transaction, and that all parties agreed to the same
set of facts.
43
MISMO V3 General Information Guide Major Elements of the Schema
DOCUMENT Attributes
Similar to the MESSAGE and DEAL elements, the first two attributes of the DOCUMENT
element identify the MISMO Reference Model version (example: 3.3.0) and Logical
Data Dictionary version (example 3.3.0.0) that define the data and structures in a
particular MISMO XML MESSAGE element.
REFERENCE Element
Instead of containing a document and its data directly, a DOCUMENT element may just
identify the external location of the document. This is done using the REFERENCE /
LocationURL element which contains data points that refer to the documents location
by referencing a server location or web site address using a URL (Universal Reference
Locator), as shown in the XML sample below.
44
MISMO V3 General Information Guide Major Elements of the Schema
<REFERENCE>
<LocationURL> http://abcmortgage.com/somedocument.pdf </LocationURL>
</REFERENCE>
For an individual DOCUMENT instance, either a REFERENCE can be used or the normal
DEAL_SETS, MAP, VIEWS, etc. set of elements can be used, not both.
UNKNOWN_VERSION3_DOCUMENT Element
The UNKNOWN_VERSION3_DOCUMENT element captures document content that is not
part of the namespace or version of the MISMO Version 3 schema. This document is
either contained directly (using this structures EmbeddedContent XML element), or
indirectly (using this structures ObjectURL element).
AUDIT_TRAIL Element
The AUDIT_TRAIL element contains entries that show the documents history, including
corrections, additions, signings, validation, voiding, and editing of the document,
including who edited the document, date and time of the edit, and the system that it was
edited on.
Each entry should have a corresponding SYSTEM_SIGNATURE element to create a digital
tamper-evident seal over the audit entry as well as the affected portions of the document.
More information about its implementation is provided in implementation guides in the
eMortgage Specifications section of the MISMO web site (www.mismo.org).
DEAL_SETS Element
A DOCUMENT element can contain a DEAL_SETS element that captures data related to
the instance of DOCUMENT. If a DEAL_SETS element is present, it must contain the
documents data and must be a child of the DOCUMENT element. Only the data elements
contained in the document need to appear in the DEAL_SETS structure however additional
data that is not viewable on the document may be included. When tamper-sealed with a
digital signature, a document can provide both eye-readable and machine-readable
evidence of its history.
For example:
If the DOCUMENT element holds a closing document, then the child elements
DEAL and LOAN of DEAL_SETS element are populated.
If the document is a credit report, then the child elements of DEAL, SERVICE and
CREDIT_RESPONSE of the DEAL_SETS element are populated.
If the document involves a mortgage-backed security covering a pool of loans,
then the child elements of the DEAL_SET element are populated.
45
MISMO V3 General Information Guide Major Elements of the Schema
MAP Element
A MAP element contains or points to style sheets for generating or populating document
VIEWS, based on the contents of the DEAL_SETS data and/or the SIGNATORIES data. The
MAP data can verify that the data in the target VIEW element matches the data provided
in the DEAL_SETS and SIGNATORY elements.
More information about its implementation is provided in implementation guides in the
eMortgage Specifications section of the MISMO web site (www.mismo.org).
46
MISMO V3 General Information Guide Major Elements of the Schema
Depending on the type of document, the views can either be organized as VIEW_FILES or
VIEW_PAGES. There are additional data elements that describe areas of a view that
contain interactive fields, a notary signature, recording endorsement, stakeholder
signatures or witness signatures.
More information about its implementation is provided in implementation guides in the
eMortgage Specifications section of the MISMO web site (www.mismo.org).
DOCUMENT_CLASSIFICATION Element
Data elements in this section contain information about a specific instance of the
document that describes its type and also its use, as opposed to its contents. Because
documents can serve such critical functions, it is important to consistently identify and
classify each document in a set so that it can be easily found and used at any point in the
future. It is further subdivided as follows.
DOCUMENT_CLASSES - One or more specific document types that differentiate
this document from other document types. There are multiple occurrences
because a single readable document image may be classified in more than one
way, and it is useful to search for a single document by any of the listed types.
DOCUMENT_CLASSIFICATION_DETAIL Contains the non-repeatable data about
an instance of a document such as the publisher and version of the document.
DOCUMENT_USAGES - Apart from being classified, a document may be used in
multiple ways and multiple processes, as defined by trading partners who are
sending and receiving sets of documents. NOTE: DOCUMENT_USAGES is only
present in MISMO Versions 3.1 and later.
Document Profiles
Use of the DOCUMENT element is defined by profiles, which determine how and when
the containers described above are used. The profiles help to efficiently manage data
exchange between multiple internal and external computer systems while also
preserving the human need to read, understand and analyze the information being
47
MISMO V3 General Information Guide Major Elements of the Schema
exchanged.
The three MISMO v3 profiles are:
Basic: The document receiver only needs the view, information related to signatures (if
the document is signed) and the document type or name.
Retrievable: The receiver wants to access data from the document and there is not a
requirement to automatically verify that the data matches what is presented in the
viewable image. The data in the Retrievable profile may or may not include all of the
information contained in the view.
Verifiable: The document receiver wants to verify that the data matches the information
contained in the view. The data in the Verifiable profile must include all of the
information included in the view.
Each profile determines which sections of the MISMO v3 DOCUMENT model are
expected to be in the document. This allows computer systems to be programmed to
interpret and read the various potential sections of the document. The profiles become
more extensive, from Basic to Verifiable.
A summary of the sections used by each profile and MISMO V3 Reference Model
requirements for each profile are provided in the table below. Optional means the section
may or may not be present. Required sections must be present and prohibited sections
must not be present. Conditional sections may be present depending on the presence of
other sections. For instance, the Audit Trail Section in the Basic and Retrievable profiles
is required if a Computer System Signature is present.
About Versions: Identify the SMART document profile. Required Required Required
Audit Trail: Logs events that occur during the lifecycle of Conditional1 Conditional1 Required
the document.
Deal Sets: Provides the data for the document. Conditional2 Required Required
48
MISMO V3 General Information Guide Major Elements of the Schema
System Signature: Provides digital signatures over some or Optional Optional Required
the entire document to provide proof that no tampering
has occurred.
Templates or Mapping: Relates data from other sections Prohibited Prohibited Required
of the document to the viewable image.
View: Provides the visual representation of the document. Required Required Required
1
If a digital signature is provided in the SYSTEM_SIGNATURE element, then there MUST be at least one entry in AUDIT_TRAIL_ENTRIES.
Otherwise, the use of the AUDIT_TRAIL_ENTRIES container is OPTIONAL.
2
If information about signatures for stakeholders, notaries, and/or witnesses is provided in the SIGNATORIES container, then the
DEAL_SETS container MAY be used to convey the signers information in a corresponding PARTY element.
3
If the document has signatures for stakeholders, notaries, and witnesses, then the information about those signatures MUST be provided
in the SIGNATORIES container.
4
If the document has signatures or signature placeholders, then the RELATIONSHIPS container MUST be used to link the SIGNATORY
element and/or the VIEW_FIELD container to the corresponding PARTY container.
PARTY Element
The PARTY container element collects information about a single party that is involved in
the mortgage related transaction. There must be a separate PARTY container for each
party for whom information is required.
The MISMO Reference Model allows collections of PARTY elements to be documented
at several locations within the Reference Model to support different types of
transactions. For example, if data related to pools of loans are being transmitted then the
PARTIES associated with pool-level data can be included at either the DEAL_SETS or DEAL
SET level. If data and documents related to pools of loans are being transmitted then the
PARTIES associated with pool-level data and documents should be included at the
MESSAGE level to allow for linking between the pool level data and the individual
documents in the DOCUMENT_SETS container.
Parties involved with an individual mortgage deal would be listed in the PARTIES
container structure at the DEALS or DEAL level. Parties related to an individual document
would be listed in the PARTIES container structure within the DEALS or DEAL level as a
child of DOCUMENT.
Parties related to mortgage services are generally included in a PARTIES element within
those transaction structures (i.e. CREDIT_RESPONSE, FLOOD_RESPONSE,
MI_VALIDATION_RESPONSE, TITLE_RESPONSE, and VALUATION_RESPONSE). Parties
represented on a document are generally included in a PARTIES element within the DEAL
49
MISMO V3 General Information Guide Major Elements of the Schema
level under the DOCUMENT element. In general, the PARTY elements should be used at
the lowest level in the Reference Model at which the entities to which they are linked by
RELATIONSHIPS are all contained.
In the MISMO Reference Model, it is possible for each PARTY to play multiple roles. A
Party may be either an INDIVIDUAL or a LEGAL_ENTITY. Because many entities and
individuals play a role in the loan origination, servicing, and delivery processes, multiple
PARTY containers will likely be delivered for each DEAL - for example, Borrower,
Appraiser, Appraiser Supervisor, Loan Originator, and Loan Origination Company. If
there is a Primary Borrower and a Co-Borrower, a separate PARTY container would be
sent for each of them.
Whether a party is an INDIVIDUAL or a LEGAL_ENTITY, the PARTY element also provides
ADDRESS, ROLE and TAXPAYER_IDENTIFIER containers to hold this type of data.
REFERENCE Element
Normally the PARTY data is included directly in its child elements, INDIVIDUAL or a
LEGAL_ENTITY, and the ADDRESS, ROLE and TAXPAYER_IDENTIFIER elements. In some
cases it may be necessary or preferred to refer to party data in another part of the
message or at an external server location or web site address. The data related to this
option is stored in the REFERENCE element. For an individual PARTY instance, either a
REFERENCE can be used or the normal INDIVIDUAL or LEGAL_ENTITY, etc. set of
elements can be used, not both. In the XML Schema this is referred to as a choice
group.
When the PARTY data is being referenced in another location within the same XML
document, the LocationLabelValue element is used to identify the XPath and the label
value assigned to the PARTY element record that contains the full set of data.
50
MISMO V3 General Information Guide Major Elements of the Schema
The following XML PARTY element samples demonstrate the use the REFERENCE
element. This sample shows a PARTY element that is located within a DEAL element.
Note that the PARTY elements xlink:label attribute contains a label value.
<DEAL>
<PARTIES>
<PARTY xlink:label="Party-0001">
<LEGAL_ENTITY>
<LEGAL_ENTITY_DETAIL>
<FullName>ABC Mortgage</FullName>
</LEGAL_ENTITY_DETAIL>
</LEGAL_ENTITY>
</PARTY>
</PARTIES>
</DEAL>
In some use cases the same party data may need to be used within the MESSAGE /
DEAL_SETS element to identify the requesting party. Rather than repeating the party
data, the PARTY element within DEAL_SETS can contain a REFERENCE element that points
to the PARTY element above within the DEAL element.
<DEAL_SETS>
<PARTIES>
<PARTY>
<REFERENCE>
<LocationLabelValue>
/MESSAGE/DEALSETS/DEAL_SET/DEALS/DEAL/PARTIES/PARTY[@xlink:label =
Party-0001]
</LocationLabelValue>
</REFERENCE>
</PARTY>
</PARTIES>
</DEAL_SETS>
INDIVIDUAL Element
The INDIVIDUAL container element is used to provide the type of information that is
appropriate for a Party that is an individual as opposed to a legal entity. The persons
name and contact points (phone numbers, email addresses, etc.) as well as aliases
(previous names such as a maiden name). Under the IDENTIFICATION_VERIFICATION
element, the BIRTH_INFORMATION element is used to record the city, state, province or
country of the individuals birth. The IDENTITY_DOCUMENTATION element is available
to record information about documents that identify a person such as drivers license or a
passport.
51
MISMO V3 General Information Guide Major Elements of the Schema
LEGAL_ENTITY Element
This element holds information specific to a legal entity, such as the company name,
Doing Business As names, and contact information for individuals within a company.
If an individual within a company has a key mortgage transaction role, such as a loan
officer, broker, appraiser, etc., these individuals should also have their own PARTY
records with their INDIVIDUAL information and should use a relationship to link the
individual to the legal entity.
In general, it is not recommended to solely use the CONTACTS container to represent
individuals of a legal entity, as the purpose of the container is to describe methods of
communication and identify individuals that may be contacted for a legal entity. It is
recommended to create PARTY containers for each individual that is associated with the
legal entity, then connect the two parties using a RELATIONSHIP element using the
appropriate arcrole (see Data Relationships section).
52
MISMO V3 General Information Guide Major Elements of the Schema
<PARTY xlink:label="Appraiser-1">
<INDIVIDUAL>
<NAME>
<FirstName>Arnold</FirstName>
<LastName>Smith</LastName>
<MiddleName>P</MiddleName>
</NAME>
</INDIVIDUAL>
<ROLES>
<ROLE>
<APPRAISER>
<APPRAISER_DETAIL>
<AppraiserCompanyName>
Acme Appraisers Inc.
</AppraiserCompanyName>
</APPRAISER_DETAIL>
</APPRAISER>
<LICENSES>
<LICENSE>
<APPRAISER_LICENSE>
<AppraiserLicenseType>
LicensedResidentialAppraiser
</AppraiserLicenseType>
</APPRAISER_LICENSE>
<LICENSE_DETAIL>
<LicenseIdentifier IdentifierOwnerURI="www.grec.state.ga.us">
279249
</LicenseIdentifier>
<LicenseIssuingAuthorityName>
Georgia Real Estate Appraisers Board
</LicenseIssuingAuthorityName>
<LicenseIssuingAuthorityStateCode>
GA
</LicenseIssuingAuthorityStateCode>
</LICENSE_DETAIL>
</LICENSE>
53
MISMO V3 General Information Guide Major Elements of the Schema
</LICENSES>
<ROLE_DETAIL>
<PartyRoleType>Appraiser</PartyRoleType>
</ROLE_DETAIL>
</ROLE>
</ROLES>
</PARTY>
54
MISMO V3 General Information Guide Major Elements of the Schema
<RESIDENCE>
<ADDRESS>
<AddressLineText>10655 N BIRCH ST</AddressLineText>
<CityName>BURBANK</CityName>
<PostalCode>91502</PostalCode>
<StateCode>CA</StateCode>
</ADDRESS>
</RESIDENCE>
</RESIDENCES>
</BORROWER>
<ROLE_DETAIL>
<PartyRoleType>Borrower</PartyRoleType>
</ROLE_DETAIL>
</ROLE>
</ROLES>
<TAXPAYER_IDENTIFIERS>
<TAXPAYER_IDENTIFIER>
<TaxpayerIdentifierType>SocialSecurityNumber</TaxpayerIdentifierType>
<TaxpayerIdentifierValue>000223333</TaxpayerIdentifierValue>
</TAXPAYER_IDENTIFIER>
</TAXPAYER_IDENTIFIERS>
</PARTY>
55
MISMO V3 General Information Guide Major Elements of the Schema
56
MISMO V3 General Information Guide Major Elements of the Schema
The XML snippet below shows a sample of borrower demographics with the
HMDARaceType of Asian, and the HMDARaceDesignationType values of Korean.
<BORROWER>
<GOVERNMENT_MONITORING>
<GOVERNMENT_MONITORING_DETAIL>
<GenderType>Male</GenderType>
<HMDAEthnicityType>NotHispanicOrLatino</HMDAEthnicityType
</GOVERNMENT_MONITORING_DETAIL>
<HMDA_RACES>
<HMDA_RACE>
<HMDA_RACE_DESIGNATIONS>
<HMDA_RACE_DESIGNATION>
<HMDARaceDesignationType>Korean</HMDARaceDesignationType>
</HMDA_RACE_DESIGNATION>
</HMDA_RACE_DESIGNATIONS>
<HMDA_RACE_DETAIL>
<HMDARaceType>Asian</HMDARaceType>
</HMDA_RACE_DETAIL>
</HMDA_RACE>
</HMDA_RACES>
</GOVERNMENT_MONITORING>
</BORROWER>
57
MISMO V3 General Information Guide Major Elements of the Schema
LOAN Element
The LOAN element is one of the core elements of the mortgage-related data set. While
the child container elements and data points are defined in the MISMO LDD, there are a
few concepts that will be covered in more detail in this section of the chapter. A single
mortgage DEAL may need to contain data about one or more loans. For example, in
addition to the subject loan, data may also be needed about an existing loan that is
being refinanced. This section explains various use cases and how they are implemented
using multiple LOAN container elements.
58
MISMO V3 General Information Guide Major Elements of the Schema
LOAN_STATE Element
The MISMO Reference model also allows multiple LOAN elements that show the state of
the loan data at different points during the lifetime of the loan. For example it may be
useful to know what loan data was on file at the time of loan closing, compared with the
loan data at the time of a modification. The LOAN_STATE child element of LOAN has
several data points that identify the state of a loan at a particular date or a date and time:
LoanStateDate - Specifies the date for the "Loan State Type".
LoanStateDatetime - Specifies the date and time for the "Loan State Type".
(Version 3.3 and later)
LoanStateType - Identifies the state at a point in time for the data included in this
instance of the LOAN data. Here are the valid values:
o AtClosing - A snapshot of the loan data at the completion of the closing
process. This is sometimes referred to as "original".
o AtConversion - For loans with a conversion option, a snapshot of the loan
data at the time the conversion features become effective (e.g., biweekly to
monthly payments; adjustable to fixed rate amortization).
o AtEstimate - A snapshot of the loan data at the point in time when a loan
estimate is disclosed. (Version 3.3 and later)
o AtModification - For loans which undergo term modifications not
originally specified in the note, a snapshot of the loan data at the time the
new note terms become effective.
o AtRelief - For loans subject to payment relief, a snapshot of the loan data at
the time the relief is initiated. (Version 3.3 and later)
o AtReset - For balloon mortgages with a reset feature, a snapshot of the loan
data on the balloon maturity date at the time the borrower exercises the reset
option to modify and extend the balloon note.
o AtTransfer - A snapshot of the loan data as of the effective date of the
servicing transfer. (Version 3.3 and later)
o AtTrial - A snapshot of the loan data at the initiation of a trial period for a
workout modification. (Version 3.3 and later)
o AtUnderwriting - A snapshot of the loan data at the point at which the
underwriting recommendation is made. (Version 3.3 and later)
o Current - A snapshot of the loan data as of the "Loan State Date".
59
MISMO V3 General Information Guide Major Elements of the Schema
60
MISMO V3 General Information Guide Major Elements of the Schema
Subset of data about the Data about the modified Data valid as of time of
original loan: loan: loan delivery:
Product Derivation Underwriting Data Current Balances,
Note Terms Product Derivation Rates, Option Status,
Payment Status
Product Features
MI and Credit
Note Terms
Enhancements
Modification Information
Escrow Details
Transaction Details
Program Identifiers
MortgageModification
Indicator = true and
LoanStateDate = LoanStateDate = Date
LoanStateDate = LoanModificationEffective data retrieved from
NoteDate Date submitters system
61
MISMO V3 General Information Guide Major Elements of the Schema
Converted Loans
If the loan has been converted from either biweekly to monthly payments or from an
adjustable to a fixed note rate, it originally would have had a LOAN_DETAIL element with
a ConvertibleIndicator set to true. The original note information would be submitted
in a LOAN element with a LoanStateType value of AtClosing. This is the data that was
valid at the time the loan was closed, so the LoanStateDate value would be the same as
the NoteDate value.
A second LOAN element container, with a LoanStateType of AtConversion, holds
information that has changed as a result of the conversion, such as the loan terms. The
LoanStateDate would be the same as the LatestConversionEffectiveDate (located in the
RATE_OR_PAYMENT_ CHANGE_OCCURRENCE container element).
A third LOAN element would include the data in its current state such as current
balances, option status, payment status, escrow details, etc. and would have
LoanStateType of Current. The LoanStateDate set to the date that the data was
retrieved from the submitters system for delivery. Since the loan had been converted
before delivery, the RATE_OR_PAYMENT_CHANGE_ OCCURRENCE elements
ConvertibleStatusType should have a value of Exercised.
Original data about the Data about the converted Data valid as of time of
subject loan: loan: loan delivery:
Underwriting Data Product Derivation Current Balances,
Product Derivation Note Terms Rates, Option Status,
Payment Status
Product Features
MI and Credit
Conversion Rules
Enhancements
Note Terms
Escrow Details
Transaction Details
Program Identifiers
ConvertibleStatusType =
ConvertibleIndicator = Exercised and
true and LoanStateDate = LoanStateDate = Date
LoanStateDate = LatestConversionEffective data retrieved from
NoteDate Date submitters system
62
MISMO V3 General Information Guide Major Elements of the Schema
Original data about the Data about the reset loan: Current data valid as of
subject loan: Product Derivation time of loan delivery:
Underwriting Data Note Terms Current Balances,
Product Derivation Rates, Option Status,
Payment Status
Product Features
MI and Credit
Note Terms
Enhancements
Escrow Details
Transaction Details
Program Identifiers
BalloonResetIndicator =
BalloonIndicator = true true and
and LoanStateDate = Date
LoanStateDate = LoanStateDate = data retrieved from
NoteDate BalloonResetDate submitters system
63
MISMO V3 General Information Guide Major Elements of the Schema
Sample LOAN Containers Usage Data for Second Lien Subject Loan with Related First
Lien Loan Delivered to an Investor
LOAN Element 1 LOAN Element 2 LOAN Element 3
Subject Loan / At Related Loan / At Subject Loan / Current
Closing Closing
Original data about the Original subset of data Current subset of data
second lien subject loan: about the first lien related valid as of time of subject
Underwriting Data loan: loan delivery:
Product Derivation Product Derivation Current Balances,
Note Terms Rates, Option Status,
Product Features
Payment Status
Note Terms
MI and Credit
Enhancements
Escrow Details
Transaction Details
Program Identifiers
LienPriorityType = LienPriorityType =
SecondLien and FirstLien and LoanStateDate = Date
LoanStateDate = LoanStateDate = data retrieved from
NoteDate of second lien BalloonResetDate submitters system
64
MISMO V3 General Information Guide Major Elements of the Schema
Sample Loan Containers Usage Data for Concurrently Closing Secondary Financing
when a First Lien is being Delivered
LOAN Element 1 LOAN Element 2 LOAN Element 3
Original data about the Current subset of data Current subset of data
first lien subject loan: valid as of time of subject valid as of time of related
Underwriting Data loan delivery: loan delivery:
Product Derivation Current Balances, Type of concurrent
Rates, Option Status, secondary financing
Product Features
Payment Status Balance of concurrent
Note Terms
MI and Credit secondary financing
Enhancements
Escrow Details
Transaction Details
Program Identifiers
LienPriorityType =
LoanStateDate = Date
FirstLien and LoanStateDate = Date
data retrieved from
LoanStateDate = data retrieved from
submitters system
NoteDate of first lien submitters system
65
MISMO V3 General Information Guide Major Elements of the Schema
ADJUSTMENT Element
The ADJUSTMENT element within LOAN, holds child elements that describe how the rate
and payment structure of a loan can change. It contains data that specifies the rules for
adjustments and conversions to the interest rate and principal and interest payment for
the life of the loan as specified in the Note. It also includes provisions to capture the
modifications to interest rate and principal and interest payment for each adjustment
period. It can also specify the rules for selecting the appropriate index upon which the
adjustments may be based.
Each of the ADJUSTMENT child elements has a similar structure; one to specify index
rules, one to articulate the rules in effect for the life of the conversion option or loan, one
to identify the rules applicable to the First and Subsequent change periods and one
to communicate associated rules that are also in effect for specified time periods. The
RATE_OR_PAYMENT_CHANGE_OCCURRENCE container holds data points that
communicate values resulting from execution of each of the applicable rules.
INDEX RULE
The INDEX_RULE element contains data points specifying the index used to govern
changes in the interest rate or principal and interest payment. The data points it contains
include the index source, lookback period, rounding rules, calculation methods, and
index averaging rules. While multiple Index Rules can be identified for each potential
adjustment to a loan (conversion, adjustable rate, or adjustable payments), typically there
is only one.
66
MISMO V3 General Information Guide Major Elements of the Schema
67
MISMO V3 General Information Guide Major Elements of the Schema
68
MISMO V3 General Information Guide Major Elements of the Schema
Adjustment Rule consists of instructions governing the interest rate changes that follow
the First rate or payment change. Typically, the Subsequent adjustment rules
remain in place once they become effective.
INTEREST_RATE_PER_CHANGE_ADJUSTMENT_RULE: If the ARM has an initial
fixed period (AdjustmentRuleType value of First), the data in this element
governs the rate change that commences at the end of the fixed rate period. It
specifies for this initial rate change, rate change maximums and minimums,
calculation method, and rule duration. When this element has a
AdjustmentRuleType value of Subsequent, it provides data parameters for all
following rate changes.
PRINCIPAL_AND_INTEREST_PAYMENT_PER_CHANGE_ADJUSTMENT_RULE:
When the AdjustmentRuleType is First, this element governs the initial
payment change period. It specifies payment percentage and dollar increase and
decrease maximums and minimums, calculation method, and rule duration
(among other things). When this element has a AdjustmentRuleType value of
Subsequent, it provides data parameters for all following rate changes.
69
MISMO V3 General Information Guide Major Elements of the Schema
70
MISMO V3 General Information Guide Major Elements of the Schema
The following is an XML representation of the ADJUSTMENT structure for the ARM
example used in earlier tables.
<ADJUSTMENT>
<INTEREST_RATE_ADJUSTMENT>
<INDEX_RULES>
<INDEX_RULE>
<IndexSourceType>LIBOROneMonthWSJDaily</IndexSourceType>
<InterestAdjustmentIndexLeadDaysCount>25</InterestAdjustmentIndexLeadDaysCount>
</INDEX_RULE>
</INDEX_RULES>
<INTEREST_RATE_LIFETIME_ADJUSTMENT_RULE>
<CeilingRatePercent>11.5</CeilingRatePercent>
<FirstRateChangePaymentEffectiveDate>2015-03-01</FirstRateChangePaymentEffectiveDate>
<InterestRateRoundingPercent>0.125</InterestRateRoundingPercent>
<InterestRateRoundingType>Nearest</InterestRateRoundingType>
<MarginRatePercent>2.60</MarginRatePercent>
</INTEREST_RATE_LIFETIME_ADJUSTMENT_RULE>
<INTEREST_RATE_PER_CHANGE_ADJUSTMENT_RULES>
<INTEREST_RATE_PER_CHANGE_ADJUSTMENT_RULE>
<AdjustmentRuleType>First</AdjustmentRuleType>
<PerChangeMaximumDecreaseRatePercent>5.0</PerChangeMaximumDecreaseRatePercent>
<PerChangeMaximumIncreaseRatePercent>5.0</PerChangeMaximumIncreaseRatePercent>
<PerChangeRateAdjustmentEffectiveDate>2015-02-01</PerChangeRateAdjustmentEffectiveDate>
<PerChangeRateAdjustmentFrequencyMonthsCount>
12
</PerChangeRateAdjustmentFrequencyMonthsCount>
</INTEREST_RATE_PER_CHANGE_ADJUSTMENT_RULE>
<INTEREST_RATE_PER_CHANGE_ADJUSTMENT_RULE>
<AdjustmentRuleType>Subsequent</AdjustmentRuleType>
<PerChangeMaximumDecreaseRatePercent>2.0</PerChangeMaximumDecreaseRatePercent>
<PerChangeMaximumIncreaseRatePercent>2.0</PerChangeMaximumIncreaseRatePercent>
<PerChangeRateAdjustmentEffectiveDate>2016-02-01</PerChangeRateAdjustmentEffectiveDate>
<PerChangeRateAdjustmentFrequencyMonthsCount>
12
</PerChangeRateAdjustmentFrequencyMonthsCount>
</INTEREST_RATE_PER_CHANGE_ADJUSTMENT_RULE>
</INTEREST_RATE_PER_CHANGE_ADJUSTMENT_RULES>
</INTEREST_RATE_ADJUSTMENT>
</ADJUSTMENT>
71
MISMO V3 General Information Guide Major Elements of the Schema
72
MISMO V3 General Information Guide Extending the MISMO Standard
73
MISMO V3 General Information Guide Extending the MISMO Standard
EXTENSION element.
Differences between EXTENSION element use in V3.2 and later and earlier MISMO
versions are discussed below, along with rules for adding data point elements and
container elements and XML examples of extended data elements.
MISMO this child element of EXTENSION allows data points or containers from
a later MISMO version to be added to a version that is currently in use. For
example, if a lenders system is currently using MISMO Version 3.2, but they
need to use a few data points that were added to Version 3.3. They could add
these data points to the EXTENSION / MISMO element to give them the use of
these Version 3.3 data points while still using Version 3.2. Any data points or
containers added to the EXTENSION / MISMO element would remain under the
MISMO namespace.
OTHER this child element is used for any other non-MISMO data points or
containers and would use the namespace declaration of the entity that added the
data.
74
MISMO V3 General Information Guide Extending the MISMO Standard
75
MISMO V3 General Information Guide Extending the MISMO Standard
In the V3.2 XML snippet below, two extended data points were added. The first one,
PropertyOwnedSinceDate, is a MISMO data point that was added to the MISMO
Reference Model in a fictional, future V3.9 version that a business partner would like to
use in their current V3.2 messages. By adding this data point to the EXTENSION /
MISMO element, the current V3.2 message will still validate against the V3.2 Reference
Model Schema.
A second data point, OtherPropertiesOwnedCount, is a non-MISMO data point used by
a fictional ACME Mortgage that they would like to include in their V3.2 messages.
Since this is an ACME data point, they must assign it to the acme namespace using the
xmlns:acme namespace declaration as shown in the EXTENSION element below. This
namespace declaration could also be placed in the MISMO root MESSAGE element.
Note that the extended data point, acme:OtherPropertiesOwnedCount, is marked with
the acme: namespace prefix when it is placed in the OTHER element.
<PROPERTY_OWNER>
<OwnershipPercent>100</OwnershipPercent>
<RelationshipVestingType>JointTenants</RelationshipVestingType>
<EXTENSION xmlns:acme="www.acmeMortgage.com">
<MISMO>
<PropertyOwnedSinceDate>2013-02-15</PropertyOwnedSinceDate>
</MISMO>
<OTHER>
<acme:OtherPropertiesOwnedCount>5</acme:OtherPropertiesOwnedCount>
</OTHER>
</EXTENSION>
</PROPERTY_OWNER>
76
MISMO V3 General Information Guide Extending the MISMO Standard
In the V3.2 XML snippet below, a new container was added to the MISMO
SERVICE_PRODUCT container. SERVICE_COMPLIANCE_RATING is a non-MISMO
container element a fictional Ajax Compliance Ratings that they would like to include
in their V3.2 messages. Since this is an Ajax container, they must assign it to the ajax
namespace using the xmlns:ajax namespace declaration as shown in the EXTENSION
element below. This namespace declaration could also be placed in the MISMO root
MESSAGE element. Note that the Ajax data container and its data points are marked with
the ajax: namespace prefix when they are placed in the OTHER element.
<SERVICE_PRODUCT>
<EXTENSION xmlns:ajax="www.AjaxComplianceRatings.org">
<OTHER>
<ajax:COMPLIANCE_RATING>
<ajax:ComplianceRatingCode>A3</:ajax:ComplianceRatingCode>
<ajax:ComplianceDate>2012-02-13</ajax:ComplianceDate>
</ajax:COMPLIANCE_RATING>
</OTHER>
</EXTENSION>
</SERVICE_PRODUCT>
77
MISMO V3 General Information Guide Extending the MISMO Standard
EXTENSION / OTHER element. Then a copy of the MISMO root schema is created and
modified to import the extended content schemas files and declare their namespaces.
But instead of using the xs:redefine element to redefine the EXTENSION content, the
actual MISMO Extension schema block is modified.
This approach will support schema validation in most platforms, but requires changes to
the published MISMO schemas to support validation of the extended content.
78
MISMO V3 General Information Guide Implementing MISMO: Programming Guidance
79
MISMO V3 General Information Guide Implementing MISMO: Programming Guidance
Performance Considerations
While the ideal programming best practice would be to use an XML Object Model to
load a MISMO XML message and then validate it against the MISMO XML schema,
performance and computational power must be taken into account, especially for larger
files.
Validating XML against a schema can be a resource-intensive step. In cases where the
MISMO XML files being consumed are coming from a source that you trust to provide
well-formed messages, developers might consider skipping the schema validation step in
order to improve performance.
In cases where files are so large as to adversely affect memory usage or processing
speed, programming techniques that do not load the entire XML file at one time are
another option. The XMLReader object in .NET and SAX parser in Java are two tools that
developers can use to read XML files using a forward-only read-only mechanism. Under
this model, applications can only process XML files in one direction from beginning to
end. This method is more difficult and less flexible for programmers, but has the
potential to greatly reduce processing time and memory usage.
80
MISMO V3 General Information Guide Implementing MISMO: Programming Guidance
such as string concatenation. Although easy, these techniques provide no assurance that
the XML generated is a valid MISMO message, or even well-formed XML.
MISMO messages should usually be generated using the same XML Object Model tools
discussed previously. This technique allows developers to generate the entire document
or message in memory using programming methods that make it easy to assemble an
XML document in the correct structure. XML Object Models also ensure that the end
result is well-formed XML.
Additionally, most XML Object Model tools also include the option to validate against
an XML schema, such as the MISMO Reference Model. When feasible to use, this
option provides assurance that the XML files produced are valid MISMO messages.
81
MISMO V3 General Information Guide Implementing MISMO: Programming Guidance
Although a full discussion of XSLT is beyond the scope of this document, many good
resources are available on the internet for learning this technique.
Conclusion
Although custom applications and services vary widely in their usage scenarios, a
careful examination of functional and performance requirements, weighed against the
various options for handling MISMO data in code, should allow for creating solutions
that meet needs and perform well.
82
MISMO V3 General Information Guide Version 3 SMART Doc
Overview
The SMART Doc specification is defined by MISMO to provide a consistent, standard
electronic document format for the mortgage industry. SMART is an acronym for
Securable, Manageable, Archiveable, Retrievable, and Transferable, the key attributes
that the eMortgage Workgroup determined were necessary for efficient eMortgage
process flow.
SMART Doc Version 1.02 was based on XML DTD, and is the currently-accepted
standard format for eNote delivery to Fannie Mae and Freddie Mac. Approximately
300,000 eNotes have been registered on the MERS eRegistry as of June 2013, and
virtually all of them are in the SMART Doc V1.02 Category One format, which
requires an XHTML View section and an XML Data section, and linking statements that
link each piece of data in the View (what the Borrower sees and signs) to a
corresponding piece of data in the Data section (for lights-out back-end processing).
In the MISMO Version 3 Reference Model structure, a separate SMART Doc
specification is no longer necessary. The SMART Doc structure is inherently contained
within the Reference Model XML schema, via the DOCUMENT structure. However, for
broad industry understanding, we call this new structure SMART Doc Version 3
(SDV3). SDV3 addresses many of the challenges that were inherent in the Ver. 1.02
specification, and supports any View format (for example, Adobe PDF, Microsoft Word,
image files, RTF, etc.) A single SDV3 document can contain multiple Views, such as
pre- and post-signing, pre-and post-recording, and other useful process flow points.
General information about Version 3 SMART Docs and Frequently Asked Questions
(FAQs) are available on the MISMO website. 3
3
http://www.mismo.org/files/BrochuresandPresentations/FAQUsingMISMOVersion3withDocuments.pdf
83
MISMO V3 General Information Guide Version 3 SMART Doc
84
MISMO V3 General Information Guide Version 3 SMART Doc
eMortgage Guide
The MISMO eMortgage guide is intended to educate the mortgage industry community
about the business and (high-level) technical aspects of eMortgage implementations and
their potential benefits. It provides guidance on how to get started with your own
eMortgage system implementation, and describes general industry-acceptable guidelines
for eMortgages that mortgage industry participants may elect to apply across related
mortgage processes. This guide provides general information about the legal framework
surrounding eMortgage implementation. It is educational in nature and is not intended as
legal advice. Professional advice should be sought in connection with any specific
efforts to implement eMortgages. This guide applies to all MISMO versions of SMART
Doc implementations.
85
MISMO V3 General Information Guide Version 3 SMART Doc
86
MISMO V3 General Information Guide Version 3 SMART Doc
87
MISMO V3 General Information Guide Appendix A: Evolution of the MISMO Standards
88
MISMO V3 General Information Guide Appendix A: Evolution of the MISMO Standards
In MISMO Version 1, each mortgage process area only used the MORTGAGEDATA sub-
categories that included the data that was needed. For example:
Loan Application - the initial loan application might use data from the
APPLICATION, BORROWER, EXPENSE, INCOME, LOAN and PROPERTY elements.
Credit Reporting - a credit reporting bureau might use data from the
BORROWER, CREDITREQUEST, CREDITREPORT and CREDITSCORE elements.
Underwriting - the underwriting process could also use
ARMPAYMENTADUSTMENT and ARMRATEADJUSTMENT elements plus the data
from the loan application process.
After the loan was processed, the data from all the processes could be combined into a
single loan package.
As the MISMO Version1 data structure was being built, each data point was assigned a
name and a definition. These were organized into a Logical Data Dictionary (LDD).
The MISMO Version 1 LDD contained 790 data points. Todays Version 3 LDD has
most of those and has expanded to around 4,000 data points.
Credit bureaus and mortgage insurers were some of the early adopters of the MISMO
Version 1 standards, but MISMO participants were also expressing a need for
transaction standards that would support the request and response of mortgage services,
such as credit reporting, flood certification, property appraisal, title services, and
automated underwriting. This led to the development of MISMO Version 2.
89
MISMO V3 General Information Guide Appendix A: Evolution of the MISMO Standards
The following three examples show the structural differences of each MISMO Version 2
transaction.
MISMO V2 Automated Underwriting Request Transaction
90
MISMO V3 General Information Guide Appendix A: Evolution of the MISMO Standards
When each of the MISMO work groups developed their transactions, they made the
content of each data container match their processing needs. For example, the type of
PROPERTY information needed for an automated underwriting transaction can differ
greatly from that needed for a property appraisal transaction or a flood certification.
There were 14 variations of the PROPERTY data container content. This meant that a
loan originator who generated transactions for a variety of services needed to be aware
of the differences in the MISMO PROPERTY data container for each transaction type.
Many lenders and mortgage service companies adopted MISMO Version 2. As this
acceptance grew, MISMO decided to expand the usability of the MISMO standards by
making the data content more uniform across all process areas. This led to the
development of MISMO Version 3.
91
MISMO V3 General Information Guide Appendix A: Evolution of the MISMO Standards
92
MISMO V3 General Information Guide Appendix A: Evolution of the MISMO Standards
The following diagram shows the basic structure of a MISMO Version 3 MESSAGE. The
main chapters of this guide describe this structure in more detail.
93
MISMO V3 General Information Guide Appendix A: Evolution of the MISMO Standards
94
MISMO V3 General Information Guide Appendix B: Security Principles
Authentication
Authentication is the process of establishing confidence in user identities. 4
Trading partners must perform authentication to establish a degree of confidence in the
identity with who they are in communication. This can be driven by legislative,
regulatory, intellectual propriety, financial and general privacy protection requirements.
Regardless, trading partners must deploy a reliable mechanism to assert their identity as
well as validate their partners identity.
Within this chapter, the representation of identity is referred to as a token. Tokens can
take many forms: login string, passwords, account numbers or digital certificates. Some
forms for tokens are more secure than others. Account numbers or passwords are
usually clear-text strings and contain no embedded protection to provide privacy (see
additional comments throughout this Guide related to clear text logins and passwords);
hence, confidentiality must be applied when they are used. These recommendations
attempt to address protection requirements for non-secure tokens.
Confidentiality
Confidentiality is reserving authorized restrictions on information access and disclosure,
including means for protecting personal privacy and proprietary information. [44 U.S.C.,
SEC. 3542] 5
Confidentiality and privacy are often used synonymously. There are several methods to
achieve privacy for information from strong access controls to encryption. Robust
authentication can be used to implement identity based access controls. However, for
MISMO transactions (data-in-motion) between trading partners, encryption is the
preferred solution. As a general rule, private or sensitive data-in-motion should be
protected, regardless of internal (enterprise) or external transports. Restated, any
sensitive data that is transferred over public networks (e.g., internal eMail/IM) or stored
4
NIST SP 800-63
5
NIST SP 800-199
95
MISMO V3 General Information Guide Appendix B: Security Principles
in portable storage media (e.g., laptops, flash/USB drives) should be encrypted to protect
it from unauthorized access or disclosure.
Integrity
Integrity involves guarding against improper information modification or destruction,
and includes ensuring information non-repudiation and authenticity. [44 U.S.C., SEC.
3542] 6
Integrity comprises timely, accurate, complete, and consistent data. The information
must not be manipulated in any way, either through electronic errors or human intention.
The use of hashing functions and digital signatures are very common in many system
applications to provide data integrity services. A strong hashing function ensures that
data modification does not go undetected. And by then digitally signing the hash value,
one can ensure that the hash can be trusted.
Non-repudiation
Non-repudiation can provide various levels of assurance that the sender of information is
provided with proof of delivery and the recipient is provided with proof of the senders
identity, so neither can later deny having processed the information. 7
Historically, repudiate is a legal term for the ability to deny or reject validity or
authority. In the world of eCommerce, the goal of non-repudiation is to prevent
repudiation of valid transactions, which is critical to the success of eCommerce. The
ability to prevent an entity from denying a particular act must be supported to ensure
intent. There are several examples from a simple transaction between parties to an
electronic signature (eSignature).
Appropriate policies and procedures, along with the security principles of authentication
and integrity are combined into a single principle. This helps to ensure the identity of
the entity and integrity of the associated transaction, which provides evidence against
modification. A commonly used method for non-repudiation is XML digital signature
(DigSig).
6
NIST SP 800-199
7
NIST SP 800-53, Revision 1
96
MISMO V3 General Information Guide Appendix B: Security Principles
97
MISMO V3 General Information Guide Appendix B: Security Principles
(eMail) and Instant Messaging (IM). Both technologies offer convenience and
productivity to users. In addition, both technologies offer users the ability to transmit
sensitive data outside the controls of an application environment. For example, many
organizations deploy a server outside the internal network in a DMZ (demilitarized zone)
with a secure tunnel to the remote client/system and some form of authentication. These
automated processes are intended to ensure access controls, confidentiality, and
protection to the internal network. Tools such as email and IM circumvent that
infrastructure. There is no guaranty of privacy for the text or attachment(s), and
authentication is based on the senders email or IM address. There are however,
solutions that can be implemented such as S/MIME (Secure/Multipurpose Internet Mail
Extensions), PGP, or other commercially available data encryption technologies to
provide for a more secure message exchange. Businesses should establish policies
around the use of eMail and IM, and if required deploy secure messaging technology
and policies that incorporate the general security principles discussed.
98
MISMO V3 General Information Guide Appendix B: Security Principles
(i.e., encrypted and/or digitally signed) between two parties, including if the
content is being transported through an intermediary entity or entities (e.g., portal
server).
Each use case scenario ontains a description, business use case, security requirements,
and possible security recommendations. The possible security recommendations
address each security requirement with one or more potential solutions. The list is not
an inclusive list of all potential solutions; rather it is a list that is most applicable to the
electronic mortgage environment.
Assumptions:
All transactions are performed using a secure tunnel.
Trading partners have pre-negotiated legal terms and conditions, and
authentication tokens or privilege rights have been exchanged.
Examples selected will embed the MISMO Envelope as a header for the process
area transaction. For example, both the MISMO Credit Request and Response
DTDs utilize the MISMO Envelope Request/Response Group DTDs as the
header for their business process area.
The simple diagrams are not intended to represent a complex network
environment. The diagram associated with the Client appears to represent a
Desktop PC. In reality it could be a server or some other device. Both Client
and Service Provider environments could contain several domains with the
application service in one domain and a communication server in a DMZ.
99
MISMO V3 General Information Guide Appendix B: Security Principles
Request
Network
`
Response
Client Service
Provider
Security Requirements
1. Client authenticates Service Provider (SP). SP presents token to Client, and Client
validates token. Client authentication of the Service Provider (server) will reduce
pharming scams and is useful for synchronous transactions.
2. SP authenticates Client. Client presents token to SP, and SP validates token.
3. Protect any sensitive data (e.g., PI) transmitted between Client and SP. Many MISMO
transactions (DTDs) contain personal information (PI). These sensitive elements should
be identified to ensure appropriate protection is being applied. At a minimum, a secure
tunnel is to be used to pass both the request and response transactions.
4. Ensure integrity of data being transmitted between Client and SP. A secure and
mutually authenticated tunnel will provide some implicit level of integrity.
100
MISMO V3 General Information Guide Appendix B: Security Principles
Confidentiality Solutions
SSL/TLS using minimum 1024 bit RSA public keys and 128 bit 3DES or AES.
SSL/TLS provides for an encrypted tunnel to transport plaintext data.
VPN using SSL/TLS or IPSec. VPN provides for an encrypted tunnel to
transport plaintext data.
Encrypted email using S/MIME or PGP and minimum 1024 bit RSA public keys
and 128 bit 3DES or AES.
XML encryption to provide additional confidentiality on specific data elements
within an XML document being transported through a secure tunnel.
Integrity Solutions
SSL/TLS Implicit integrity is achieved through establishment of a mutually
authenticated SSL/TLS connection.
VPN using SSL or IPSec Implicit integrity is achieved through establishment
of a mutually authenticated VPN connection.
S/MIME email A digitally signed email also provides data integrity services.
XML signature Additional data integrity can be provided on specific XML data
elements within an XML document being transported through a secure tunnel.
101
MISMO V3 General Information Guide Appendix B: Security Principles
Request
Portal
Network
`
Response
Client Request
Network
Response
Service
Provider
Request
Portal
Network
`
Response
Request
Client Request
Network
Network
Response Response
Service
Provider
102
MISMO V3 General Information Guide Appendix B: Security Principles
Confidentiality Solutions
SSL/TLS using minimum 1024 bit RSA public keys and 128 bit 3DES or AES.
SSL/TLS provides for an encrypted tunnel to transport plaintext data.
103
MISMO V3 General Information Guide Appendix B: Security Principles
Integrity Solutions
SSL/TLS Implicit integrity is achieved through establishment of a mutually
authenticated SSL/TLS connection.
XML signature Additional data integrity can be provided on specific XML data
elements within an XML document being transported through a secure tunnel.
Multi-Services Scenario
In this scenario, the client interacts with a multi-services provider (MSP) to receive the
requested information. The client submits a single request to the MSP. The MSP then
submits various requests to different SPs. In many cases the MSP uses the same
document in each of its requests to the SPs to minimize the number of different requests
that have to be created by the MSP. The SPs individually respond back to the MSP,
which then creates and sends a single response back to the client.
Req.
Service
Provider A
Request Resp.
Network
Req.
Service
Network Provider B
` Resp.
Response
Req.
Multi-Services
Client
Provider Service
Resp. Provider C
Multi-Services - Scenario 1
Security Requirements
1. Client authenticates MSP. MSP presents token to Client, and Client validates token.
2. MSP authenticates Client. Client presents token to MSP, and MSP validates token.
3. MSP authenticates SP1. SP1 presents token to MSP, and MSP validates token.
4. SP1 authenticates MSP. MSP presents token to SP1, and SP1 validates token.
5. MSP authenticates SPn. SPn presents token to MSP, and MSP validates token.
6. SPn authenticates MSP. MSP presents token to SPn, and SPn validates token.
104
MISMO V3 General Information Guide Appendix B: Security Principles
7. Protect any sensitive data (e.g., PI) transmitted between Client, MSP and SPs. Many
MISMO transactions (DTDs) contain personal information (PI). These sensitive
elements should be identified to ensure appropriate protection is being applied. At a
minimum, a secure tunnel is to be used to pass both the request and response
transactions.
8. Ensure non-disclosure of sensitive data to unauthorized entities. For example, a
particular SP may not be authorized to view certain information in the request/response
sequence, especially if the MSP is using a single XML document for all SP
request/response sequences.
9. Ensure integrity of data being transmitted between Client, MSP and SPs. A secure and
mutually authenticated tunnel will provide some implicit level of integrity.
Confidentiality Solutions
SSL/TLS using minimum 1024 bit RSA public keys and 128 bit 3DES or AES.
SSL/TLS provides for an encrypted tunnel to transport plaintext data.
VPN using SSL/TLS or IPSec. VPN provides for an encrypted tunnel to
transport plaintext data.
105
MISMO V3 General Information Guide Appendix B: Security Principles
Encrypted email using S/MIME or PGP and minimum 1024 bit RSA public keys
and 128 bit 3DES or AES.
XML encryption to provide additional confidentiality on specific data elements
within an XML document being transported through a secure tunnel.
Integrity Solutions
SSL/TLS Implicit integrity is achieved through establishment of a mutually
authenticated SSL/TLS connection.
VPN using SSL or IPSec Implicit integrity is achieved through establishment
of a mutually authenticated VPN connection.
S/MIME email A digitally signed email also provides data integrity services.
XML signature Additional data integrity can be provided on specific XML data
elements within an XML document being transported through a secure tunnel.
Security Definitions
Asymmetric encryption In deploying asymmetric data encryption, the use of public and
private key pairs to encrypt and subsequently de-crypt the data is
required. Use of these pairs of keys can provide for both
confidentiality and authentication.
106
MISMO V3 General Information Guide Appendix B: Security Principles
Typically, the DMZ contains devices accessible to Internet traffic, such as Web
(HTTP) servers, FTP servers, SMTP (e-mail) servers and DNS servers. The term
comes from military use, meaning a buffer area between two enemies.
Encryption The translation of data into a secret code. Encryption is the most
effective way to achieve data security. To read an encrypted file,
you must have access to a secret key or password that enables
you to decrypt it. Unencrypted data is called plain text; encrypted
data is referred to as cipher text.
There are two main types of encryption: asymmetric encryption (also called public-
key encryption) and symmetric encryption
Hash/digest Producing hash values for accessing data or for security. A hash
value (or simply hash), also called a message digest, is a number
generated from a string of text. The hash is generated by a
formula in such a way that it is extremely unlikely that some
other text will produce the same hash value.
Hashes play a role in security systems where they're used to ensure that transmitted
messages have not been tampered with. The sender generates a hash of the message,
encrypts it, and sends it with the message itself. The recipient then decrypts both the
message and the hash, produces another hash from the received message, and
compares the two hashes. If they're the same, there is a very high probability that the
message was transmitted intact.
107
MISMO V3 General Information Guide Appendix B: Security Principles
IPsec supports two encryption modes: Transport and Tunnel. Transport mode
encrypts only the data portion (payload) of each packet, but leaves the header
untouched. The more secure Tunnel mode encrypts both the header and the payload.
On the receiving side, an IPSec-compliant device decrypts each packet.
PKI digital certificate Short for public key infrastructure, a system of digital
certificates, Certificate Authorities, and other registration
authorities that verify and authenticate the validity of each party
involved in an Internet transaction. PKIs are currently evolving
and there is no single PKI nor even a single agreed-upon
standard for setting up a PKI.
108
MISMO V3 General Information Guide Appendix B: Security Principles
There are many predefined MIME types, such as GIF graphics files and
PostScript files. It is also possible to define your own MIME types.
MIME was defined in 1992 by the Internet Engineering Task Force (IETF). A
new version, called S/MIME, supports encrypted messages.
Security domain The subset of data required by a party to fulfill their respective
portion of the request.
Symmetric encryption In deploying data encryption, the use of a key to de-crypt the
data is required. When utilizing a symmetric algorithm, both the
sender and receiver of the data share a common key.
109
MISMO V3 General Information Guide Appendix B: Security Principles
XML encryption An encryption method for XML data that offers the ability to
selectively encrypt certain data elements, while leaving the
remainder in clear text.
110