MC Client Integration API Guide

Welcome to the Mortgage Connect Client Integration API Guide.

The Mortgage Connect Client Integration API Guide provides specifications and details for building direct Title & Closing integrations with clients, service providers, and other parties that intend to leverage Mortgage Connect's API platform.

The benefits of becoming an integrated partner are:

Reliable message transfer and data integrity
A common façade that provides a single and consistent access interface
Data rich API responses
Integration monitoring and real-time notifications
Reporting capabilities
Fast response times to address service-level agreements (SLA)
Etc.

The Integration API is implemented using a REST API (a.k.a. RESTful API) that supports both JSON and XML payloads. With the definitions, features, and requirements outlined in this API Guide, clients will be empowered to submit Title & Closing orders and get information and statuses regarding the different stages of order fulfillment. This guide includes, but is not limited to the following information:

Authentication requirements
Identifying message types
Example payloads in JSON and XML
Message workflow orchestration
Required vs optional fields
Field data types and constraints
Field enumeration requirements
Environment and endpoint addresses
Terms and definitions
Onboarding checklist
Etc.

Introduction

To get the most benefit from the Integration API Guide it is best to first familiarize yourself with the general layout, navigation, and features of the site. The following sections will highlight the general layout and navigation features in addition to any general nomenclatures and terms used throughout the API Guide.

The following sections define the layout and navigation features of this API guide.

Browser Support

This site has only been tested using Google Chrome. The use of any other browser may result in unexpected rendering issues and/or functional limitations.

Under the Mortgage Connect logo in the far upper left side of the document is where you will find the menu and navigation features supported by this API Guide.

The menu is an intuitive collapsable collection of items that once clicked, navigate the user to the associated section of the API Guide.

The menu also supports a search feature at the very top of the navigation section. Entering a value in the search bar will filter the menu items to only show those whose content contains the entered search value.

Content

The middle section of the API Guide is where you will find specific details regarding the menu item that was selected. Also note that you do not have to use the menu to navigate to specific content of interest because you can continuously scroll down the page and the navigation menu will track where you are located.

Examples

The far right side of the API Guide is where you will find more technical details including actual payload examples in JSON and XML. Where technical examples are not applicable, the right side pane will be empty in relationship to the current section the user is on.

In future iterations of this API Guide the "csharp" and "javascript" tabs at the top of the right pane will enable you toggle between referencing actual code examples that invoke the referenced API method.

Action Buttons

The site also supports actionable buttons that provide additional functionality. When you see the following action buttons the corresponding action will be taken when the button is clicked.

Button	Action
	When you see the button, this means that when it is clicked the site will scroll to the corresponding transaction in the `Title API Workflow Orchestration` page.
	When you see the button, this means that when it is clicked it will navigate the user to either the `Transaction Header` or `Transaction Extensions` property definitions section on the `Title API Message Structure` page.
	When you see the button, this means that when it is clicked it will toggle the collaping and expanding of the corresponding JSON or XML example.
	When you see the button, this means that when it is clicked it will copy the corresponding JSON or XML to the clipboard. This is applicable to JSON and XML HTTP `Requests`, `Acknowledgments`, and `Schemas`.
	When you see the button, this means that when it is clicked it will navigate you to the corresponding sections to view the `JSON` or `XML` example.

Schemas

While still a work in progress, some schema validation files can be found throughout this documentation. Schema files are typically very large in comparison to the actual JSON or XML payload they are validating. In addition, they are much more technical in nature and thus are not easily read. It is for this reason you will notice that schema file examples will have scrollable regions, so as to cut down on the vertical scrolling required to navigate the site. Actual payload examples, will not have scrollable regions.

Nomenclatures & Legends

The following sections define specific nomenclatures used throughout the API Guide along with any specific legends or codes for referrence.

Directional Indicator Definitions

Throughout the API Guide you will see images of arrows. These are used to quickly and visually determine the direction of an API message. Direction in this context refers to who is initating the method and who is receiving it.

Directional Indicator	Description
→	Indicates that the API message is an inbound message. Which is to say it is sent by the Client to Mortgage Connect.
←	Indicates that the API message is an outbound message. Which is to say it is sent by Mortgage Connect to the Client.
⇄	Indicates that the API message is an inbound and outbound message (i.e. bidirectional). Which is to say it can be sent by either the Client or Mortgage Connect.

Property Definitions

Throughout the API Guide you will find Property Definition tables that define the requirements per property in reference to the JSON or XML supporting a sepcific API Method. One column of interest is the "Requirement" column whose state is represented by the following values.

Code	Term	Description
R	Required	Indicates that the property is mandatory and is required to be present in the JSON or XML at all times.
O	Optional	Indicates that the property is optional and may or may not be present in the JSON or XML.
C	Conditional	Indicates that the property is conditionally required, which is typically dependent on which Product is selected.

If space permits the Term will will always be used, however where screen real estate is at a premium, the Code will be used.

In addition, the property definition tables contained throughout this document will have property names that are highlighed in blue. This is nothing more than a visual cue to distinguish objects and arrays from general properties in the JSON and XML payloads, with the hope that it makes it quicker to find these sections in the documentation.

NULL Values

An optional collection or property by definition implies that there values may be null. By convention it is standard for null collections or properties to not exist in the physical payload when they are null and the client should code accordingly for this scenario. Note that in some circumstances you may see null properties returned as empty strings instead of nulls and if the field is optional the client should subsequently treat it as null or an empty string at their discretion.

Authentication

The following sections provide implementation details regarding the default authentication mechanisms supported by the Integration API.

Basic Access Authentication

Authentication by default is handled via Basic Access Authentication also known as Basic Auth.

Basic Access Authentication is a means by which a HTTP user agent is able to provide a username and password when making a request. The user agent in this context is the client who is invoking the Integration API. Basic Access Authentication is one of the simplest techniques for enforcing access controls to web resources because it does not require cookies, session identifiers, or a login page. Rather, Basic Access Authentication uses standard fields in the HTTP header, thus removing the need for handshakes.

Note however, Basic Access Authentication provides no confidentiality protection for the transmitted credentials. The credentials are merely Base64 encoded in transit and are not encrypted or hashed in any way. It is for these reasons that HTTPS must be used in conjunction with Basic Access Authentication. See: wikipedia for more information.

Basic Access Authentication is used because of its low entry point, which is to say that virtually all integrations through a client Loan Origination System (LOS) can typically support this functionality out of the box.

Basic Auth Specification Details

When leveraging the default Basic Auth specification, the client request must incorporate an HTTP Authorization header field which must be set accordingly based on the Basic Access Authentication specification. See: wikipedia for more details.

The Authorization Header field must be constructed as follows:

The username and password that are assigned to the client are to be concatenated with a single colon : between them. This implies that the username and password cannot contain a colon :.

For example, assume the client was assigned the user name “AcmeInc” and the password “Yj1394nNk”. At this juncture of the construction of the Authorization Header it would look like “AcmeInc:Yj1394nNk”. Notice the colon between the user name and password.
The resulting string must then be encoded using Base64.

For example, at this juncture we have so far constructed the following string “AcmeInc:Yj1394nNk”. If we then Base64 encode the string it will then take on the form of “QWNtZUluYzpZajEzOTRuTms=”.

For more information regarding Base64 encoding, please reference: Base 64
Next the authorization method (i.e., Basic) and a space is then prepended to the Base64 encoded string.

For example, at this juncture we have so far constructed the following string “QWNtZUluYzpZajEzOTRuTms=”. If we now prepend the string with “Basic “, then our new string takes on the form of “Basic QWNtZUluYzpZajEzOTRuTms=”.
Finally, you need to add the constructed string as the value of the Authorization header when making the HTTP request to the Integration API.

For example, Authorization: Basic QWNtZUluYzpZajEzOTRuTms=.

Title API

The following sections detail the Title API methods that are specific to Mortgage Connect's Title workflow pipeline.

Title - API Event Matrix

The following matrix details the API event matrix supported by the Integration Title API. The EventId is an internal Mortgage Connect code that the individual methods are often referenced by.

Client & Mortgage Connect Acknowledgments

The Integration Title workflow orchestration currently supports the following acknowledgment events. While technically speaking an Acknowledgment response is not an event, it is being loosely grouped in this category for documentation purposes.

EventId	Event Code	HTTP	Description
MC010 ⇄	Acknowledgment	POST	The `Acknowledgment` response is the mechanism in which the Client and Mortgage Connect can communicate that a message was processed succesfully or failed. In addition, exception information can be returned as well if applicable. These are essentially the response payloads returned in response to a request and are virtually the same for each request with a couple deviations that are outlined in the `MC010 - Acknowledgment` section. All events whether initiated by the Client or Mortgage Connect should return a `MC010 Acknowledgment` message. View Details

Client Initiated Events

The Integration Title workflow orchestration currently supports the following events that are to be initiated by the Client LOS and sent to the Mortgage Connect Integration API.

flowchart LR Client(Client LOS) -- POST --> API(MC Integration API)

EventId	Event Code	HTTP	Description
MC100 →	New-Order	POST	The `New Order` API method is the mechanism in which a Client can submit a request to Mortgage Connect to create a new Title order. View Details
MC117 →	Cancel-Order	POST	The `Cancel Order` API method is the mechanism in which a Client can submit a request to Mortgage Connect to cancel a Title order. View Details
MC120 →	Update-Order	POST	The `Update Order` API method is the mechanism in which a Client can submit a request to Mortgage Connect to update a Title order. View Details
MC130 ⇄	Add-Note	POST	The `Add Note` API method is the mechanism in which a Client can submit a request to Mortgage Connect to annotated a Title order with notes. View Details
MC140 ⇄	Add-Note-Action	POST	The `Add Note Action` API method is the mechanism in which a Client can submit a request to Mortgage Connect to annotate a Title order with notes, with the expectation that Mortgage Connect needs to perform an urgent `Action` such as contacting the borrower. View Details
MC150 ⇄	Add-Attachment	POST	The `Add Attachment` API method is the mechanism in which a Client can submit a request to Mortgage Connect to add documents to a Title order. View Details

Mortgage Connect Initiated Events

The Integration Title workflow orchestration currently supports the following events that are to be initiated by the Mortgage Connect Integration API and sent to the Client LOS.

flowchart RL API(MC Integration API) -- POST --> Client(Client LOS)

EventId	Event Code	HTTP	Description
MC110 ←	Order-Confirmation	POST	The `Order Confirmation` API method is the mechanism in which Mortgage Connect notifies the Client that a Title order has been created. This applies to new orders where `transactionIsAsynchronous` is true. View Details
MC115 ←	Instant-Title	POST	The `Instant Title` API method is the mechanism in which Mortgage Connect can submit a request to the Client to deliver the `Instant Title Report` and supporting metadata. View Details
MC130 ⇄	Add-Note	POST	The `Add Note` API method is the mechanism in which Mortgage Connect can submit a request to the Client to annotate a Title order with notes. View Details
MC140 ⇄	Add-Note-Action	POST	The `Add Note Action` API method is the mechanism in which Mortgage Connect can submit a request to the Client to annotate a Title order with notes, with the expectation that the Client needs to Perform an urgent `Action` such as contacting the borrower. View Details
MC150 ⇄	Add-Attachment	POST	The `Add Attachment` API method is the mechanism in which Mortgage Connect can submit a request to the Client to add documents to a Title order. View Details
MC160 ←	Product-Delivery	POST	The `Product Delivery` API method is the mechanism in which Mortgage Connect can submit a request to the Client to deliver the `Final Title Document` and supporting metadata. View Details
MC165 ←	Fee-Sheet	POST	The `Fee Sheet` API method is the mechanism in which Mortgage Connect can submit a request to the Client to deliver the `Fees` and supporting metadata. View Details
MC170 ←	Clear-Title	POST	The `Clear Title` API method is the mechanism in which Mortgage Connect can submit a request to the Client to deliver the `Title Clearance Status` and supporting metadata. View Details
MC172 ←	Settlement-Agent	POST	The `Settlement Agent` API method is the mechanism in which Mortgage Connect can submit a request to the Client to deliver the `Settlement Agent` and supporting metadata. View Details
MC180 ←	Order-Complete	POST	The `Order Complete` API method is the mechanism in which Mortgage Connect can submit a request to the Client to indicate that the Title order is complete. View Details
MC190 ←	Title-Policy	POST	The `Title Policy` API method is the mechanism in which Mortgage Connect can submit a request to the Client to deliver the `Final Title Policy` and supporting metadata. View Details

Title - API Message Structure

✅ The following is an example 'Message Envelope'.

/* Copyright © 2023 Mortgage Connect LP */
{
    "transactionHeader": {
        "transactionIdempotentId": "90039F81-73C1-4788-98BC-90553888D301",
        "transactionDate": "2022-07-11T02:03:40",
        "clientCode": "1799",
        "clientName": "AcmeInc",
        "vendorCode": "MC",
        "vendorName": "Mortgage Connect"
    },
    "transactionBody": {
        /* Message Type Specific Metadata Goes Here */
    },
    "transactionExtensions": {
        "transactionExtension": [
            {
                "key": "Client Specific Key 1",
                "value": "Client Specific Value 1"
            },
            {
                "key": "Client Specific Key 2",
                "value": "Client Specific Value 2"
            }
        ]
    }
}
/* Copyright © 2023 Mortgage Connect LP */

<!-- Copyright © 2023 Mortgage Connect LP -->
<root>
    <transactionHeader>
        <transactionIdempotentId>90039F81-73C1-4788-98BC-90553888D301</transactionIdempotentId>
        <transactionDate>022-07-11T02:03:40</transactionDate>
        <clientCode>1799</clientCode>
        <clientName>AcmeInc</clientName>
        <vendorCode>MC</vendorCode>
        <vendorName>Mortgage Connect</vendorName>
    </transactionHeader>
    <transactionBody>
        <!-- Message Type Specific Metadata Goes Here -->
    </transactionBody>
    <transactionExtensions>
        <transactionExtension>
            <key>Client Specific Key 1</key>
            <value>Client Specific Value 1</value>
        </transactionExtension>
        <transactionExtension>
            <key>Client Specific Key 2</key>
            <value>Client Specific Value 1</value>
        </transactionExtension>
    </transactionExtensions>
</root>
<!-- Copyright © 2023 Mortgage Connect LP -->

All of the messages are wrapped in a parent object which serves as the Message Envelope that encompasses all of the message's metadata.

Within the Message Envelope you will find three (3) root level objects.

Transaction Header (transactionHeader)
Transaction Body (transactionBody)
Transaction Extensions (transactionExtensions)

The Transaction Header and Transaction Extensions are identifical for every message and thus will be documented here to eliminate redundancy.
References to this section will be found in the corresponding sections of each supported message type.

The Transaction Body on the other hand is message type specific and will be documentated separately in a section dedicated to each supported message type.

Property Definitions - Transaction Header

Defines the properties represented in the Transaction Header object (JSON) or node (XML). Note that this message artifact is identical for each and every message type.

Property	Requirement	Data Type	Min / Max	Description
transactionHeader	Required			A parent object (JSON) or node (XML) that contains the transaction header metadata.
transactionIdempotentId	Conditional	GUID		A new globally unique identifier to be generated per every single response. This value is used to ensure transactions are processed idempotently. Idempotent message identification is `NOT` currently implemented. However when a need for this feature bubbles up to the top and it is added to the development pipeline it will work as follows. The API supports idempotency for safely retrying requests without accidentally performing the same operation twice. This is useful when an API call is disrupted in transit and you do not receive a response. For example, if a request to create a new order does not respond due to a network connection error, you can retry the request with the same idempotency Id to guarantee that no more than one order is created. Idempotency works by saving the resulting status code and body of the first request made for any given idempotency Id, regardless of whether it succeeded or failed. Subsequent requests with the same idempotency Id will return the same result, including 500 errors. An idempotency key is a unique value generated by the client which the server uses to recognize subsequent retries of the same request. Idempotent Ids should be GUIDs to ensure uniqueness. Under consideration is also the ability to expire previously processed idempotent Ids, for example ignoring those that are 24 hours old or more. Thus enabling the same transaction to be sent again. Results are only saved if an API endpoint started executing. If incoming parameters failed validation, or the request conflicted with another that was executing concurrently, no idempotent result is saved because no API endpoint began execution. It is safe to retry these requests. All POST requests will accept idempotency keys. Sending idempotent Id in GET and DELETE requests has no effect, as these requests are idempotent by definition. `TransactionIdempotentId` will be required for all `POST` messages once this feature is implemented.
transactionDate	Required	DateTime		The date and time that is associated with the message request.
clientCode	Required	String		This represents Mortgage Connect's client code which uniquely identifies a client. Internally Mortgage Connect often refers to this property as the `ClientId`. A given integration can be associated with one or more `ClientCode`(s). As part of the onboarding process, the Client will need to map their client codes to Mortgage Connects `ClientCode`(s).
clientName	Required	String	1 / 100	This represents the name associated with the client. It is not uncommon for multiple clients, i.e. `ClientCode`(s) to be grouped under the same parent client and thus this field often reflects the parent name instead of individual branch names. This field is not technically of importance from a mapping perspective and is only included to aid in identifying the client when viewing the raw payload, versus memorizing or looking up the `ClientCode`.
vendorCode	Required	String	1 / 100	A code supplied by Mortgage Connect that uniquely identifes the `Integration Platform Instance` or `Tenant` being used to service the integration. Note that typically this value is static per integration.
vendorName	Required	String	1 / 100	A name supplied by Mortgage Connect that uniquely identifes the `Integration Platform Instance` or `Tenant` being used to service the integration. While this value is essentially synonymous to the `VendorCode` it is included for readability, much like the `ClientName` property.

Property Definitions - Transaction Body

Defines the properties represented in the Transaction Body object (JSON) or node (XML).

Property Definitions - Transaction Extensions

Defines the properties represented in the TransactionExtensions object (JSON) or node (XML). Note that this message artifact is identical for each and every message type.

Property	Requirement	Data Type	Min / Max	Description
transactionExtensions	Optional			A parent object (JSON) or node (XML) that contains a list of transaction extensions. `(0 to Many)`.
transactionExtension	Required			A parent object (JSON) or node (XML) that contains the metadata associated with a transaction extension.
key	Required	String	1 / 200	The key (i.e. name) that uniquely identifies the transaction extension.
value	Required	String	1 / MAX	The value that is associated with the transaction extension.

Title - API Workflow Orchestration

The following sections provide a graphical overview of the typical Title API worflow, from an API sequencing and orchestration perspective.

Title - MC010 - Acknowledgment

✅ The following is an 'Accepted' example payload to be returned in the HTTP response.

/* Copyright © 2023 Mortgage Connect LP */
{
    "transactionHeader": {
        "transactionIdempotentId": "90039F81-73C1-4788-98BC-90553888D301",
        "transactionDate": "2022-07-11T02:03:40",
        "clientCode": "1799",
        "clientName": "AcmeInc",
        "vendorCode": "MC",
        "vendorName": "Mortgage Connect"
    },
    "transactionBody": {
        "transactionCode": "Acknowledgment",
        "transactionId": "7832143",
        "productTransactionId": "",
        "orderNumber": 2429888,
        "ackStatus": true,
        "ackMessage": "Accepted",
        "ackException": ""
    },
    "transactionExtensions": {
        "transactionExtension": [
            {
                "key": "Client Specific Key 1",
                "value": "Client Specific Value 1"
            },
            {
                "key": "Client Specific Key 2",
                "value": "Client Specific Value 2"
            }
        ]
    }
}
/* Copyright © 2023 Mortgage Connect LP */

<!-- Copyright © 2023 Mortgage Connect LP -->
<root>
    <transactionHeader>
        <transactionIdempotentId>90039F81-73C1-4788-98BC-90553888D301</transactionIdempotentId>
        <transactionDate>022-07-11T02:03:40</transactionDate>
        <clientCode>1799</clientCode>
        <clientName>AcmeInc</clientName>
        <vendorCode>MC</vendorCode>
        <vendorName>Mortgage Connect</vendorName>
    </transactionHeader>
    <transactionBody>
        <transactionCode>Acknowledgment</transactionCode>
        <transactionId>7832143</transactionId>
        <productTransactionId></productTransactionId>
        <orderNumber>2429888</orderNumber>
        <ackStatus>true</ackStatus>
        <ackMessage>Accepted</ackMessage>
        <ackException></ackException>
    </transactionBody>
    <transactionExtensions>
        <transactionExtension>
            <key>Client Specific Key 1</key>
            <value>Client Specific Value 1</value>
        </transactionExtension>
        <transactionExtension>
            <key>Client Specific Key 2</key>
            <value>Client Specific Value 1</value>
        </transactionExtension>
    </transactionExtensions>
</root>
<!-- Copyright © 2023 Mortgage Connect LP -->

⛔ The following is a 'Rejected' example payload to be returned in the HTTP response.

/* Copyright © 2023 Mortgage Connect LP */
{
    "transactionHeader": {
        "transactionIdempotentId": "90039F81-73C1-4788-98BC-90553888D301",
        "transactionDate": "2022-07-11T02:03:40",
        "clientCode": "1799",
        "clientName": "AcmeInc",
        "vendorCode": "MC",
        "vendorName": "Mortgage Connect"
    },
    "transactionBody": {
        "transactionCode": "Acknowledgment",
        "transactionId": "7832143",
        "orderNumber": 0,
        "ackStatus": false,
        "ackMessage": "Rejected",
        "ackException": "Invalid Credentials"
    },
    "transactionExtensions": {
        "transactionExtension": [
            {
                "key": "Client Specific Key 1",
                "value": "Client Specific Value 1"
            },
            {
                "key": "Client Specific Key 2",
                "value": "Client Specific Value 2"
            }
        ]
    }
}
/* Copyright © 2023 Mortgage Connect LP */

<!-- Copyright © 2023 Mortgage Connect LP -->
<root>
    <transactionHeader>
        <transactionIdempotentId>90039F81-73C1-4788-98BC-90553888D301</transactionIdempotentId>
        <transactionDate>022-07-11T02:03:40</transactionDate>
        <clientCode>1799</clientCode>
        <clientName>AcmeInc</clientName>
        <vendorCode>MC</vendorCode>
        <vendorName>Mortgage Connect</vendorName>
    </transactionHeader>
    <transactionBody>
        <transactionCode>Acknowledgment</transactionCode>
        <transactionId>7832143</transactionId>
        <orderNumber>0</orderNumber>
        <ackStatus>false</ackStatus>
        <ackMessage>Rejected</ackMessage>
        <ackException>Invalid Credentials</ackException>
    </transactionBody>
    <transactionExtensions>
        <transactionExtension>
            <key>Client Specific Key 1</key>
            <value>Client Specific Value 1</value>
        </transactionExtension>
        <transactionExtension>
            <key>Client Specific Key 2</key>
            <value>Client Specific Value 1</value>
        </transactionExtension>
    </transactionExtensions>
</root>
<!-- Copyright © 2023 Mortgage Connect LP -->

👍 The response payload can be verified using the following validation schema.

/* Copyright © 2023 Mortgage Connect LP */
{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "$id": "root",
  "description": "Copyright @ 2022 Mortgage Connect LP - Title & Tax Schema.",
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "legalHeader": {
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "version": {
          "examples": [
            "1.0.8.0"
          ],
          "type": "string",
          "minLength": 1,
          "maxLength": 20
        },
        "disclosingParty": {
          "examples": [
            "Copyright @ 2022 Mortgage Connect LP"
          ],
          "type": "string",
          "minLength": 1,
          "maxLength": 100
        },
        "proprietaryInformationAndConfidential": {
          "examples": [
            "Ownership of Proprietary Information. The Recipient agrees that it shall not receive any right, title or interest, or any license or right to use, the Disclosing Partys Proprietary Information, including, but not limited to, technology, ideas, concepts, drawings, documentation, designs, prototypes, processes, trade secrets, trademarks or other intellectual property rights therein, by implication or otherwise."
          ],
          "type": "string",
          "minLength": 1,
          "maxLength": 2000
        }
      },
      "required": [
        "version",
        "disclosingParty",
        "proprietaryInformationAndConfidential"
      ],
      "minProperties": 3,
      "maxProperties": 3
    },
    "transactionHeader": {
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "transactionIdempotentId": {
          "examples": [
            "3B34A671-BB17-400D-90BF-7CBF9C96E8ED"
          ],
          "type": "string",
          "minLength": 36,
          "maxLength": 36,
          "pattern": "^[\\da-fA-F]{8}-[\\da-fA-F]{4}-[\\da-fA-F]{4}-[\\da-fA-F]{4}-[\\da-fA-F]{12}$"
        },
        "transactionDate": {
          "examples": [
            "2022-07-11T02:03:40"
          ],
          "type": "string",
          "format": "date-time"
        },
        "clientCode": {
          "examples": [
            "1799"
          ],
          "type": "string",
          "minLength": 1,
          "maxLength": 100,
          "format": "integer"
        },
        "clientName": {
          "examples": [
            "AcmeInc"
          ],
          "type": "string",
          "minLength": 1,
          "maxLength": 100
        },
        "vendorCode": {
          "examples": [
            "MC"
          ],
          "type": "string",
          "minLength": 1,
          "maxLength": 100
        },
        "vendorName": {
          "examples": [
            "Mortgage Connect"
          ],
          "type": "string",
          "minLength": 1,
          "maxLength": 100
        }
      },
      "required": [
        "transactionIdempotentId",
        "transactionDate",
        "clientCode",
        "clientName",
        "vendorCode",
        "vendorName"
      ],
      "minProperties": 6,
      "maxProperties": 6
    },
    "transactionBody": {
      "if": {
        "properties": {
          "ackStatus": {
            "const": false
          }
        }
      },
      "then": {
        "required": [
          "transactionCode",
          "ackStatus",
          "ackMessage",
          "ackException"
        ]
      },
      "else": {
        "required": [
          "transactionCode",
          "ackStatus",
          "ackMessage"
        ]
      },
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "transactionCode": {
          "examples": [
            "Acknowledgment"
          ],
          "type": "string",
          "const": "Acknowledgment"
        },
        "transactionId": {
          "examples": [
            "7832143"
          ],
          "type": "string",
          "minLength": 1,
          "maxLength": 50
        },
        "productTransactionId": {
          "examples": [
            "7832143"
          ],
          "type": "string",
          "minLength": 0,
          "maxLength": 50
        },
        "orderNumber": {
          "examples": [
            "2429888"
          ],
          "type": "integer"
        },
        "ackStatus": {
          "examples": [
            true,
            false
          ],
          "type": "boolean"
        },
        "ackMessage": {
          "type": "string"
        },
        "ackException": {
          "type": "string"
        },
        "responseType": {
            "type": "string"
        },
        "response": {
            "type": "object"
        }
      }
    },
    "transactionExtensions": {
      "type": "object",
      "properties": {
        "transactionExtension": {
          "type": "array",
          "items": {
            "type": "object",
            "additionalProperties": false,
            "properties": {
              "key": {
                "examples": [
                  "Client Specific Key"
                ],
                "type": "string",
                "minLength": 1,
                "maxLength": 200
              },
              "value": {
                "examples": [
                  "Client Specific Value"
                ],
                "type": "string",
                "minLength": 1
              }
            },
            "required": [
              "key",
              "value"
            ],
            "minProperties": 2,
            "maxProperties": 2
          },
          "minItems": 0
        }
      }
    }
  },
  "required": [
    "transactionHeader",
    "transactionBody"
  ],
  "minProperties": 2,
  "maxProperties": 4
}
/* Copyright © 2023 Mortgage Connect LP */

The response payload XML schema validation is under construction. 🚧

The Acknowledgment event is essentially the payload that is to be returned by all HTTP requests whether it was initialized by the Client or Mortgage Connect.

Simply put, it is the response payload that is to be returned after every request and is used to indicate whether the operation was a success or failure, along with exception information if applicable.

Property Definitions - Transaction Header

Defines the properties represented in the Transaction Header object (JSON) or node (XML). Note that this message artifact is identical for each and every message type.

View Transaction Header Details

Property Definitions - Transaction Body

Defines the properties represented in the Transaction Body object (JSON) or node (XML).

Property	Requirement	Data Type	Min / Max	Description
transactionBody	Required			A parent object (JSON) or node (XML) that contains the transaction metadata.
transactionCode	Required	String	14 / 14	A static value of `Acknowledgment`. The transaction code is meant to identify the message type and the context or action that should be taken. An `Acknowledgment` transaction code is unique from all other transaction codes in that the context is actually derived from the value of the `AckStatus` property. Possible Values: Acknowledgment
transactionId	Required	String	1 / 50	Represents the Client's unique order number.
productTransactionId	Optional	String	0 / 50	Represents the Client's unique product order number. Note that the `productTransactionId` field is not used in most circumstances. However, when there is a need to further differentiate order numbers at a product level, that share the same `transactionId`, (i.e. the primary order level id), then the `productTransactionId` can be used to ensure uniqueness across the integration transactions. This makes it possible for multiple orders of the same product type to be placed using the same `transactionId`. The use of the `productTransactionId` field and any specific workflow deviations will be vetted during the onboarding process.
orderNumber	Conditional	Integer		Represents Mortgage Connects unique order number. Note this property `Must` be populated in response to a `MC100 - New Order` message that is successfully processed `Synchronously`. For all other messages types, if the `OrderNumber` can be ascertained then it should be included, otherwise it should be set to zero (0) by default.
ackStatus	Required	Boolean		A boolean code indicating whether the request message was successfully processed. This is the property you should interrogate to determine if the message was successful or a failure. Possible Values: true false
ackMessage	Required	String	1 / MAX	A message indicating whether the request message was successfully processed. This property is typically just populated with `Success` or `Failure`. However, it can optionally be populated with additional metadata that provides additional context as to why it was a successful or failed message. It is for this reason you should key off of the `ackStatus` field to determine whether it was a successful or failed message. `Typical` Values: Accepted Rejected
ackException	Conditional	String	0 / MAX	A message that provides additional exception details in the event the message was not sucessfully processed. This property is only ever populated if the message failed to be processed and there are applicable exception details that are appropriate to share, such as `Invalid Credentials` when trying to authenticate the request.
responseType	Conditional	String	0 / MAX	The requested action has returned a response object of the type specified by this property's value. The response type is defined in the `Response Definition` section of the event providing the reponse. Currently applicable to the following events: N/A
response	Conditional	String	0 / MAX	A string containing the JSON or XML representation of the response object. The response object is defined in the `Response Definition` section of the event providing the reponse.

Property Definitions - Transaction Extensions

Defines the properties represented in the TransactionExtensions object (JSON) or node (XML). Note that this message artifact is identical for each and every message type.

View Transaction Extension Details

Title - MC100 - New Order

🌐 The following is an example payload to be posted in the body of the HTTP request.

/* Copyright © 2023 Mortgage Connect LP */
{
    "transactionHeader": {
        "transactionIdempotentId": "3B34A671-BB17-400D-90BF-7CBF9C96E8ED",
        "transactionDate": "2022-07-11T02:03:40",
        "clientCode": "1799",
        "clientName": "AcmeInc",
        "vendorCode": "MC",
        "vendorName": "Mortgage Connect"
    },
    "transactionBody": {
        "transactionCode": "New-Order",
        "transactionId": "7832143",
        "productTransactionId": "",
        "transactionIsAsynchronous": false,
        "productCode": "TTL",
        "loanNumber": "73201-3433",
        "loanAmount": "200000",
        "originalLoanAmount": "59900",
        "unpaidPrincipalAmount": "158698",
        "salePrice": "210000",
        "loanType": "Refinance",
        "propertyType": "SingleFamily",
        "amortizationType": "Fixed",
        "expectedClosingDate": "2022-10-19T14:00:00",
        "cema": "CEMA loan option requested",
        "occupancyType": "Primary",
        "propertyAddress": {
            "address1": "1234 Main St",
            "address2": "Apt 1",
            "city": "Shawnee",
            "state": "CA",
            "zipCode": "93950",
            "county": "Monterey"
        },
        "borrowers": {
            "borrower": [
                {
                    "firstName": "Johnny",
                    "middleName": "J",
                    "lastName": "Doe",
                    "suffix": "Sr.",
                    "type": "Borrower",
                    "email": "johnnydoe@gmail.com",
                    "cellPhone": "724-323-4234",
                    "ssn": "111-11-1111",
                    "maritalStatus": "Married",
                    "language": "English",
                    "dateOfBirth": "1965-07-04",
                    "borrowerAddress": {
                        "address1": "1234 Main St",
                        "address2": "Apt1",
                        "city": "Shawnee",
                        "state": "CA",
                        "zipCode": "93950",
                        "county": "Monterey"
                    }
                },
                {
                    "firstName": "Janie",
                    "middleName": "J",
                    "lastName": "Doe",
                    "type": "Borrower",
                    "email": "janiedoe@gmail.com",
                    "cellPhone": "724-123-4545",
                    "ssn": "222-22-2222",
                    "maritalStatus": "Married",
                    "language": "English",
                    "dateOfBirth": "1967-09-22"
                }
            ]
        },
        "parties": {
            "party" : [
                {
                    "firstName": "John",
                    "lastName": "Doe",
                    "phone": "724-420-3341",
                    "email": "johndoe@acmeinc.com",
                    "role": "Processor"
                },
                {
                    "firstName": "Jane",
                    "lastName": "Doe",
                    "phone": "724-420-1833",
                    "email": "janedoe@acmeinc.com",
                    "role": "LoanOfficer"
                }
            ]
        },
        "lender": {
            "name": "Direct",
            "address": "26642 Towne Centre Dr",
            "city": "Lake Forest",
            "state": "CA",
            "zipCode": "92630"
        },
        "specialInstruction": "Conveyance of easement."
    },
    "transactionExtensions": {
        "transactionExtension": [
            {
                "key": "Client Specific Key 1",
                "value": "Client Specific Value 1"
            },
            {
                "key": "Client Specific Key 2",
                "value": "Client Specific Value 2"
            }
        ]
    }
}
/* Copyright © 2023 Mortgage Connect LP */

<!-- Copyright © 2023 Mortgage Connect LP -->
<root>
    <transactionHeader>
        <transactionIdempotentId>3B34A671-BB17-400D-90BF-7CBF9C96E8ED</transactionIdempotentId>
        <transactionDate>022-07-11T02:03:40</transactionDate>
        <clientCode>1799</clientCode>
        <clientName>AcmeInc</clientName>
        <vendorCode>MC</vendorCode>
        <vendorName>Mortgage Connect</vendorName>
    </transactionHeader>
    <transactionBody>
        <transactionCode>New-Order</transactionCode>
        <transactionId>7832143</transactionId>
        <productTransactionId></productTransactionId>
        <transactionIsAsynchronous>false</transactionIsAsynchronous>
        <productCode>TTL</productCode>
        <loanNumber>73201-3433</loanNumber>
        <loanAmount>200000</loanAmount>
        <originalLoanAmount>59900</originalLoanAmount>
        <unpaidPrincipalAmount>158698</unpaidPrincipalAmount>
        <salePrice>210000</salePrice>
        <loanType>Refinance</loanType>
        <propertyType>SingleFamily</propertyType>
        <amortizationType>Fixed</amortizationType>
        <expectedClosingDate>2022-10-19T14:00:00</expectedClosingDate>
        <cema>CEMA loan option requested</cema>
        <occupancyType>Primary</occupancyType>
        <propertyAddress>
            <address1>1234 Main St</address1>
            <address2>Apt 1</address2>
            <city>Shawnee</city>
            <state>CA</state>
            <zipCode>93950</zipCode>
            <county>Monterey</county>
        </propertyAddress>
        <borrowers>
            <borrower>
                <firstName>Johnny</firstName>
                <middleName>J</middleName>
                <lastName>Doe</lastName>
                <suffix>Sr.</suffix>
                <type>Borrower</type>
                <email>johnnydoe@gmail.com</email>
                <cellPhone>724-323-4234</cellPhone>
                <ssn>111-11-1111</ssn>
                <maritalStatus>Married</maritalStatus>
                <language>English</language>
                <dateOfBirth>1965-07-04</dateOfBirth>
                <borrowerAddress>
                    <address1>100 Willow St</address1>
                    <address2>Suite 2</address2>
                    <city>Shawnee</city>
                    <state>CA</state>
                    <zipCode>93950</zipCode>
                    <county>Monterey</county>
                </borrowerAddress>
            </borrower>
            <borrower>
                <firstName>Janie</firstName>
                <middleName>J</middleName>
                <lastName>Doe</lastName>
                <type>Borrower</type>
                <email>janiedoe@gmail.com</email>
                <cellPhone>724-123-4545</cellPhone>
                <ssn>222-22-2222</ssn>
                <maritalStatus>Married</maritalStatus>
                <language>English</language>
                <dateOfBirth>1967-09-22</dateOfBirth>
            </borrower>
        </borrowers>
        <parties>
            <party>
                <firstName>John</firstName>
                <lastName>Doe</lastName>
                <phone>724-420-3341</phone>
                <email>johndoe@acmeinc.com</email>
                <role>Processor</role>
            </party>
            <party>
                <firstName>Jane</firstName>
                <lastName>Doe</lastName>
                <phone>724-420-1833</phone>
                <email>janedoe@acmeinc.com</email>
                <role>LoanOfficer</role>
            </party>
        </parties>
        <lender>
            <name>Direct</name>
            <address>26642 Towne Centre Dr</address>
            <city>Lake Forest</city>
            <state>CA</state>
            <zipCode>92630</zipCode>
        </lender>
        <specialInstruction>Conveyance of easement.</specialInstruction>
    </transactionBody>
    <transactionExtensions>
        <transactionExtension>
            <key>Client Specific Key 1</key>
            <value>Client Specific Value 1</value>
        </transactionExtension>
        <transactionExtension>
            <key>Client Specific Key 2</key>
            <value>Client Specific Value 1</value>
        </transactionExtension>
    </transactionExtensions>
</root>
<!-- Copyright © 2023 Mortgage Connect LP -->

👍 The request payload can be verified using the following validation schema.

/* Copyright © 2023 Mortgage Connect LP */
{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "$id": "root",
  "description": "Copyright @ 2022 Mortgage Connect LP - Title & Tax Schema.",
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "legalHeader": {
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "version": {
          "examples": [
            "1.0.8.0"
          ],
          "type": "string",
          "minLength": 1,
          "maxLength": 20
        },
        "disclosingParty": {
          "examples": [
            "Copyright @ 2022 Mortgage Connect LP"
          ],
          "type": "string",
          "minLength": 1,
          "maxLength": 100
        },
        "proprietaryInformationAndConfidential": {
          "examples": [
            "Ownership of Proprietary Information. The Recipient agrees that it shall not receive any right, title or interest, or any license or right to use, the Disclosing Partys Proprietary Information, including, but not limited to, technology, ideas, concepts, drawings, documentation, designs, prototypes, processes, trade secrets, trademarks or other intellectual property rights therein, by implication or otherwise."
          ],
          "type": "string",
          "minLength": 1,
          "maxLength": 2000
        }
      },
      "required": [
        "version",
        "disclosingParty",
        "proprietaryInformationAndConfidential"
      ],
      "minProperties": 3,
      "maxProperties": 3
    },
    "transactionHeader": {
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "transactionIdempotentId": {
          "examples": [
            "3B34A671-BB17-400D-90BF-7CBF9C96E8ED"
          ],
          "type": "string",
          "minLength": 36,
          "maxLength": 36,
          "pattern": "^[\\da-fA-F]{8}-[\\da-fA-F]{4}-[\\da-fA-F]{4}-[\\da-fA-F]{4}-[\\da-fA-F]{12}$"
        },
        "transactionDate": {
          "examples": [
            "2022-07-11T02:03:40"
          ],
          "type": "string",
          "format": "date-time"
        },
        "clientCode": {
          "examples": [
            "1799"
          ],
          "type": "string",
          "minLength": 1,
          "maxLength": 100,
          "format": "integer"
        },
        "clientName": {
          "examples": [
            "AcmeInc"
          ],
          "type": "string",
          "minLength": 1,
          "maxLength": 100
        },
        "vendorCode": {
          "examples": [
            "MC"
          ],
          "type": "string",
          "minLength": 1,
          "maxLength": 100
        },
        "vendorName": {
          "examples": [
            "Mortgage Connect"
          ],
          "type": "string",
          "minLength": 1,
          "maxLength": 100
        }
      },
      "required": [
        "transactionIdempotentId",
        "transactionDate",
        "clientCode",
        "clientName",
        "vendorCode",
        "vendorName"
      ],
      "minProperties": 6,
      "maxProperties": 6
    },
    "transactionBody": {
      "title": "TransactionBody",
      "if": {
        "properties": {
          "propertyType": {
            "enum": [
              "Purchase"
            ]
          }
        }
      },
      "then": {
        "required": [
          "salePrice"
        ]
      },
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "transactionCode": {
          "examples": [
            "New-Order"
          ],
          "type": "string",
          "const": "New-Order"
        },
        "transactionId": {
          "examples": [
            "7832143"
          ],
          "type": "string",
          "minLength": 1,
          "maxLength": 50
        },
        "productTransactionId": {
          "examples": [
            "7832143"
          ],
          "type": "string",
          "minLength": 0,
          "maxLength": 50
        },
        "transactionIsAsynchronous": {
          "examples": [
            true,
            false
          ],
          "type": "boolean"
        },
        "productCode": {
          "type": "string",
          "minLength": 3,
          "maxLength": 4,
          "enum": [
            "LVR",
            "PRT",
            "PUR",
            "TTL"
          ]
        },
        "loanNumber": {
          "examples": [
            "7313993"
          ],
          "type": "string",
          "minLength": 1,
          "maxLength": 64
        },
        "loanAmount": {
          "examples": [
            "0.00"
          ],
          "type": "string",
          "format": "money"
        },
        "originalLoanAmount": {
          "$ref": "root#/properties/transactionBody/properties/loanAmount"
        },
        "unpaidPrincipalAmount": {
          "$ref": "root#/properties/transactionBody/properties/loanAmount"
        },
        "salePrice": {
          "$ref": "root#/properties/transactionBody/properties/loanAmount"
        },
        "loanType": {
          "type": "string",
          "minLength": 1,
          "maxLength": 24,
          "enum": [
            "Equity",
            "Other",
            "Purchase",
            "Refinance",
            "Reverse"
          ]
        },
        "propertyType": {
          "type": "string",
          "minLength": 1,
          "maxLength": 64,
          "enum": [
            "Condominium",
            "Cooperative",
            "Manufactured",
            "Multi-Family",
            "Other",
            "Residential",
            "SingleFamily"
          ]
        },
        "amortizationType": {
          "type": "string",
          "maxLength": 64,
          "enum": [
            "ARM",
            "Fixed",
            "Interest Only",
            "Reverse",
            ""
          ]
        },
        "expectedClosingDate": {
          "type": "string",
          "format": "date-time"
        },
        "cema": {
          "type": "string",
          "maxLength": 100
        },
        "occupancyType": {
          "type": "string",
          "minLength": 1,
          "maxLength": 64,
          "enum": [
            "Primary",
            "Secondary",
            "Investment"
          ]
        },
        "propertyAddress": {
          "type": "object",
          "additionalProperties": false,
          "properties": {
            "address1": {
              "examples": [
                "1204 New York Drive"
              ],
              "type": "string",
              "maxLength": 32
            },
            "address2": {
              "examples": [
                "1204 New York Drive"
              ],
              "type": "string",
              "maxLength": 32
            },
            "city": {
              "examples": [
                "Mckees Rocks"
              ],
              "type": "string",
              "maxLength": 32
            },
            "state": {
              "examples": [
                "PA"
              ],
              "type": "string",
              "enum": [
                "AK",
                "AL",
                "AR",
                "AS",
                "AZ",
                "CA",
                "CO",
                "CT",
                "DC",
                "DE",
                "FL",
                "FM",
                "GA",
                "GU",
                "HI",
                "IA",
                "ID",
                "IL",
                "IN",
                "KS",
                "KY",
                "LA",
                "MA",
                "MD",
                "ME",
                "MH",
                "MI",
                "MN",
                "MO",
                "MP",
                "MS",
                "MT",
                "NC",
                "ND",
                "NE",
                "NH",
                "NJ",
                "NM",
                "NV",
                "NY",
                "OH",
                "OK",
                "OR",
                "PA",
                "PR",
                "PW",
                "RI",
                "SC",
                "SD",
                "TN",
                "TX",
                "UT",
                "VA",
                "VI",
                "VT",
                "WA",
                "WI",
                "WV",
                "WY"
              ]
            },
            "zipCode": {
              "examples": [
                "15136"
              ],
              "type": "string",
              "minLength": 5,
              "maxLength": 5,
              "pattern": "^[0-9]{5}$"
            },
            "county": {
              "examples": [
                "Allegheny"
              ],
              "type": "string",
              "maxLength": 32
            }
          },
          "required": [
            "address1",
            "city",
            "state",
            "zipCode"
          ],
          "minProperties": 4,
          "maxProperties": 6
        },
        "borrowers": {
          "type": "object",
          "properties": {
            "borrower": {
              "type": "array",
              "items": {
                "title": "Borrower",
                "type": "object",
                "additionalProperties": false,
                "properties": {
                  "firstName": {
                    "examples": [
                      "John"
                    ],
                    "type": "string",
                    "minLength": 1,
                    "maxLength": 150
                  },
                  "middleName": {
                    "examples": [
                      "M"
                    ],
                    "type": "string",
                    "minLength": 0,
                    "maxLength": 150
                  },
                  "lastName": {
                    "examples": [
                      "Smith"
                    ],
                    "type": "string",
                    "minLength": 1,
                    "maxLength": 255
                  },
                  "suffix": {
                    "examples": [
                      "Sr."
                    ],
                    "type": "string",
                    "minLength": 0,
                    "maxLength": 4,
                    "enum": [
                      "II",
                      "III",
                      "Esq.",
                      "Jr.",
                      "M.D.",
                      "P.A.",
                      "Sr.",
                      ""
                    ]
                  },
                  "type": {
                    "type": "string",
                    "enum": [
                      "Asset Management Company",
                      "Asset Manager",
                      "Assignee",
                      "Assignor",
                      "Attorney",
                      "Bank Attorney",
                      "Borrower",
                      "Borrower/Buyer",
                      "Builder",
                      "Buyer",
                      "Buyer Agent",
                      "Buyer Attorney",
                      "Buyer Title Company",
                      "Buyers Broker",
                      "Condo Association",
                      "Custodian",
                      "Foreclosed Party",
                      "Investor",
                      "LENDER",
                      "Lender Loan Officer",
                      "Listing Agent",
                      "MC MC Auction Company",
                      "Mortgage Connect Closer",
                      "Non-HUD Borrower",
                      "Non-Vested Signer",
                      "Other",
                      "Processor",
                      "Property Access",
                      "Real Estate Agent",
                      "Real Estate Agent - Seller",
                      "Seller",
                      "Seller Attorney",
                      "Sellers Broker",
                      "Selling Agent",
                      "Servicer",
                      "Settlement Agent",
                      "Title Company",
                      "Underwriter",
                      "Vested Signer - Non-Borrower"
                    ]
                  },
                  "email": {
                    "type": "string",
                    "maxLength": 255,
                    "format": "email"
                  },
                  "cellPhone": {
                    "type": "string",
                    "maxLength": 24
                  },
                  "ssn": {
                    "type": "string",
                    "maxLength": 128
                  },
                  "maritalStatus": {
                    "type": "string",
                    "enum": [
                      "Divorced",
                      "Married",
                      "Separated",
                      "Single",
                      "Widowed",
                      ""
                    ]
                  },
                  "language": {
                    "type": "string",
                    "enum": [
                      "English",
                      "Spanish"
                    ]
                  },
                  "dateOfBirth": {
                    "type": "string",
                    "format": "date"
                  },
                  "borrowerAddress": {
                    "$ref": "root#/properties/transactionBody/properties/propertyAddress"
                  }
                },
                "required": [
                  "firstName",
                  "lastName",
                  "type"
                ]
              },
              "minItems": 1
            }
          }
        },
        "parties": {
          "type": "object",
          "properties": {
            "party": {
              "type": "array",
              "items": {
                "title": "Party",
                "type": "object",
                "additionalProperties": false,
                "properties": {
                  "sequenceNo": {
                    "type": "integer"
                  },
                  "firstName": {
                    "type": "string",
                    "maxLength": 150
                  },
                  "lastName": {
                    "type": "string",
                    "maxLength": 150
                  },
                  "phone": {
                    "type": "string",
                    "maxLength": 24
                  },
                  "email": {
                    "type": "string",
                    "maxLength": 255,
                    "format": "email"
                  },
                  "role": {
                    "type": "string",
                    "enum": [
                      "Closer",
                      "LoanOfficer",
                      "LoanOfficerAssistant",
                      "Other",
                      "Processor",
                      "ProcessorAssistant",
                      "Underwriter",
                      "User"
                    ]
                  }
                },
                "required": [
                  "firstName",
                  "lastName",
                  "role"
                ]
              }
            }
          }
        },
        "lender": {
          "title": "Lender",
          "type": "object",
          "additionalProperties": false,
          "properties": {
            "name": {
              "type": "string",
              "maxLength": 255
            },
            "address": {
              "examples": [
                "1204 New York Drive"
              ],
              "type": "string",
              "maxLength": 255
            },
            "city": {
              "$ref": "root#/properties/transactionBody/properties/propertyAddress/properties/city"
            },
            "state": {
              "$ref": "root#/properties/transactionBody/properties/propertyAddress/properties/state"
            },
            "zipCode": {
              "$ref": "root#/properties/transactionBody/properties/propertyAddress/properties/zipCode"
            }
          },
          "required": [
            "address",
            "city",
            "state",
            "zipCode"
          ]
        },
        "specialInstruction": {
          "type": "string"
        }
      },
      "required": [
        "transactionCode",
        "transactionId",
        "transactionIsAsynchronous",
        "productCode",
        "loanNumber",
        "loanType",
        "propertyType",
        "occupancyType",
        "propertyAddress",
        "borrowers"
      ]
    },
    "transactionExtensions": {
      "type": "object",
      "properties": {
        "transactionExtension": {
          "type": "array",
          "items": {
            "type": "object",
            "additionalProperties": false,
            "properties": {
              "key": {
                "examples": [
                  "Client Specific Key"
                ],
                "type": "string",
                "minLength": 1,
                "maxLength": 200
              },
              "value": {
                "examples": [
                  "Client Specific Value"
                ],
                "type": "string",
                "minLength": 1
              }
            },
            "required": [
              "key",
              "value"
            ],
            "minProperties": 2,
            "maxProperties": 2
          },
          "minItems": 0
        }
      }
    }
  },
  "required": [
    "transactionHeader",
    "transactionBody"
  ],
  "minProperties": 2,
  "maxProperties": 4
}
/* Copyright © 2023 Mortgage Connect LP */

The request payload XML schema validation is under construction. 🚧

✅ The following is an 'Accepted' example payload to be returned in the HTTP response.

Accepted Acknowledgment payloads are typically message type agnostic.

Accepted Acknowledgment payloads are typically message type agnostic.

⛔ The following is a 'Rejected' example payload to be returned in the HTTP response.

Rejected Acknowledgment payloads are typically message type agnostic.

Rejected Acknowledgment payloads are typically message type agnostic.

The New Order API method is the mechanism in which a Client can submit a message to Mortgage Connect to create a new Title Order.

View Workflow Orchestration

Mortgage Connect URL

POST 🔒 https://{BaseUrl}/Api/V1.0/{ClientCode}/SubmitMessage

Mortgage Connect URL Properties

Defines the dynamic properties in the URL (i.e. those enclosed in curly brakets {}) that are used to uniquely identify the targeted endpoint and client. The actual property values will be determined during the onboarding process, however you can reference the Environments section to acquaint yourself with the standard BaseUrls exposed by Mortgage Connect.

Property	Requirement	Description
BaseUrl	Required	A unique base Url that represents a specific Mortgage Connect endpoint and targeted environment.
ClientCode	Required	A unique code assigned to all clients that is used for identification, authentication, and customization purposes.

Property Definitions - Transaction Header

Defines the properties represented in the Transaction Header object (JSON) or node (XML). Note that this message artifact is identical for each and every message type.

View Transaction Header Details

Property Definitions - Transaction Body

Defines the properties represented in the Transaction Body object (JSON) or node (XML).

Property	Requirement	Data Type	Min / Max	Description
transactionBody	Required			A parent object (JSON) or node (XML) that contains the transaction metadata.
transactionCode	Required	String	9 / 9	A static value of `New-Order`. The transaction code is meant to identify the message type and the context or action that should be taken. In this context it implies that a new Title Order should be placed. Possible Values: New-Order
transactionId	Required	String	1 / 50	Represents the Client's unique order number.
productTransactionId	Optional	String	0 / 50	Represents the Client's unique product order number. Note that the `productTransactionId` field is not used in most circumstances. However, when there is a need to further differentiate order numbers at a product level, that share the same `transactionId`, (i.e. the primary order level id), then the `productTransactionId` can be used to ensure uniqueness across the integration transactions. This makes it possible for multiple orders of the same product type to be placed using the same `transactionId`. The use of the `productTransactionId` field and any specific workflow deviations will be vetted during the onboarding process.
transactionIsAsynchronous	Required	Boolean		Indicates whether the transaction is processed asynchronously (i.e. `true`) or synchronously (i.e. `false`). The `New-Order` transaction is unique in that it is the only transaction that supports this feature. Synchronous (i.e `false`) processing might be perferred by some clients who's system architecture are dependent on receiving an actual `Order Number` at the time of order submission. If the transaction is processed asynchronous then an `Order-Confirmation` message will be sent to the client once the `New-Order` transaction is actually processed, which will contain the actual `Order Number`. Possible Values: true false
productCode	Required	String	3 / 4	Represents Mortgage Connect's product codes. Note that these are just an example subset of the many products Mortgage Connect supports. Possible Values: LVR `LEGAL & VEString REPORT` PRT `PROPERTY REPORT` PUR `PURCHASE` TTL `TITLE INSURANCE` etc. Traditionally, clients use Mortgage Connects `Product Code` names and thus there is a one to one mapping relationship that is maintained by the client. However, Mortgage Connect is aware that our naming conventions may not resonate and that there are many inconsistencies in product code naming conventions and nomenclatures. It is for this reason that Mortgage Connect is able to map the client's product code to Mortgage Connect's product code to ease the transition. Any required product code mapping exercises will be addressed during the onboarding process. The supported `productCode`(s) are specific per integration and will be determined during the onboarding process. Note that the minimum/maximum length requirement of 3/4 is only applicable if using Mortgage Connect's internal product codes, otherwise when mapping to the client's product codes, the minimum/maximum is 1/50. Note that from an ordering perspective, there often is a correlation and synchronization process that occurs between Title and Closing orders. Specifically, due to the typical workflow requirements of Mortgage Connect's Title Platform, if a Closing order is placed before a Title order, a temporary placeholder Title order is automatically created at the same time the Closing order request is received. In this scenario, it is assumed that the Title order request will be received shortly afterwards. At which time, the temporary placeholder Title order will be updated with the actual Title product type requested by the client. For example, assume a client sends a New Order request for a CWO (Closing Without Insurance - Loan Amount < 250K) or CWI (Closing With Insurance - Loan Amount > 250K) product prior to sending a New Order Title request. In this scenario, a TPLC (Title Place Holder) order will be placed as a temporary Title order and the requested Closing will also be placed. Later, if the client sends a New Order request for a PRT (Property Report) or TTL (Title Insurance) product, then the original TPLC (Title Place Holder) order will be updated with the actual Title product requested by the client. Lastly, it is important to recognize that this an example of one of many workflows (Originations, Default, Loss Mitigation, Originations) supported by Mortgage Connect and will not be applicable to all clients. Subsequently, these specific scenarios will vetted during the onboarding process and can be configured per client integration partner.
loanNumber	Required	String	1 / 64	The clients loan number `alpha-numeric`.
loanAmount	Optional	Money		The loan amount
originalLoanAmount	Optional	Money		The original Loan amount.
unpaidPrincipalAmount	Optional	Money		The unpaid principle amount `if any` in dollars.
salePrice	Conditional	Money		The property sale price. The `salePrice` is optional but is `Required` if the `loanType` is `Purchase`.
loanType	Required	String	1 / 24	The loan type. Possible Values: Equity Purchase Refinance Reverse
propertyType	Required	String	1 / 64	The property usage type. Possible Values: Condominium Cooperative Manufactured Multi-Family Other PUD SingleFamily
amortizationType	Optional	String	0 / 64	The amortization type, i.e. how the loan will be paid. Possible Values: ARM Fixed Interest Only Reverse
expectedClosingDate	Optional	DateTime		The expected closing data `if known`. Format: `mm/dd/yyyy`
cema	Optional	String	0 / 100	Information regarding a CEMA (Consolidation, Extension and Modification Agreement) mortgage loan.
occupancyType	Required	String	1 / 64	The occupancy type, i.e. how the property will be used Possible Values: Primary Secondary Investment
propertyAddress	Required			A parent object (JSON) or node (XML) that contains metadata associated with a property address.
address1	Required	String	1 / 255	The property street address.
address2	Optional	String	0 / 255	The property street address 2.
city	Required	String	1 / 32	The property city name.
state	Required	String	2 / 2	The property state abbreviation. Possible Values: AK, AL, AR, AS, AZ, CA, CO, CT, DC, DE, FL, FM, GA, GU, HI, IA, ID, IL, IN, KS, KY, LA, MA, MD, ME, MH, MI, MN, MO, MP, MS, MT, NC, ND, NE, NH, NJ, NM, NV, NY, OH, OK, OR, PA, PR, PW, RI, SC, SD, TN, TX, UT, VA, VI, VT, WA, WI, WV, WY.
zipCode	Required	String	5 / 5	The property zip code.
county	Optional	String	0 / 32	The property county.
borrowers	Required			A parent object (JSON) or node (XML) that contains a list of borrowers. `(1 to Many)` Note that the first borrower is assumed to `always` be the `Primary` borrower.
borrower	Required			A parent object (JSON) or node (XML) that contains the metadata associated with a single borrower.
firstName	Required	String	1 / 150	The borrower’s first name.
middleName	Optional	String	0 / 150	The borrower’s middle name.
lastName	Required	String	1 / 255	The borrower’s last name.
suffix	Optional	String	0 / 4	The borrower's suffix. Possible Values: II III Esq. Jr. Sr.
type	Required	String	1 / 32	The borrower's type. Note that typically this value will be set to `Borrower`. Possible Values: Asset Management Company Asset Manager Assignee Assignor Attorney Bank Attorney Borrower Borrower/Buyer Builder Buyer Buyer Agent Buyer Attorney Buyer Title Company Buyers Broker Condo Association Custodian Foreclosed Party Investor LENDER Lender Loan Officer Listing Agent MC MC Auction Company Mortgage Connect Closer Non-HUD Borrower Non-Vested Signer Other Processor Property Access Real Estate Agent Real Estate Agent - Seller Seller Seller Attorney Sellers Broker Selling Agent Servicer Settlement Agent Title Company Underwriter Vested Signer - Non-Borrower
email	Optional	String	0 / 255	The borrower’s email address.
cellPhone	Optional	String	0 / 24	The borrower's cell phone number.
ssn	Optional	String	0 / 128	The borrower's social security number.
maritalStatus	Optional	String	0 / 128	The borrower’s marital status. Possible Values: Divorced Married Separated Single Widowed
language	Optional	String	0 / 100	The borrower’s natural language. Possible Values: English Spanish
dateOfBirth	Optional	DateTime		The borrower’s date of birth. Format: `mm/dd/yyyy`
borrowerAddress	Optional			A parent object (JSON) or node (XML) that contains metadata associated with a borrower address.
address1	Required	String	1 / 255	The borrower street address.
address2	Optional	String	0 / 255	The borrower street address 2.
city	Required	String	1 / 32	The borrower city name.
state	Required	String	2 / 2	The borrower state abbreviation. Possible Values: AK, AL, AR, AS, AZ, CA, CO, CT, DC, DE, FL, FM, GA, GU, HI, IA, ID, IL, IN, KS, KY, LA, MA, MD, ME, MH, MI, MN, MO, MP, MS, MT, NC, ND, NE, NH, NJ, NM, NV, NY, OH, OK, OR, PA, PR, PW, RI, SC, SD, TN, TX, UT, VA, VI, VT, WA, WI, WV, WY.
zipCode	Required	String	5 / 5	The borrower zip code.
county	Optional	String	0 / 32	The borrower county.
parties	Optional			A parent object (JSON) or node (XML) that contains a list of parties (i.e. those working on the loan). `(0 to Many)`
party	Optional			A parent object (JSON) or node (XML) that contains the metadata associated with a single borrower.
firstName	Required	String	1 / 150	The party first name.
lastName	Required	String	1 / 255	The party last name.
phone	Optional	String	0 / 24	The party's phone number.
email	Optional	String	0 / 255	The party's email address.
role	Required	String	1 / 32	The party's role. Possible Values: Closer LoanOfficer Processor
lender	Optional			A parent object (JSON) or node (XML) that contains the metadata associated with a single lender.
name	Optional	String	0 / 255	The lender's name.
address	Required	String	1 / 255	The lender's address.
city	Required	String	1 / 32	The lender's city.
state	Required	String	2 / 2	The lender's state.
zipCode	Required	String	5 / 5	The lender's zip code.
specialInstruction	Optional	String	0 / MAX	The special instruction associated with the Title. `(if applcable)`

Property Definitions - Transaction Extensions

Defines the properties represented in the TransactionExtensions object (JSON) or node (XML). Note that this message artifact is identical for each and every message type.

View Transaction Extension Details

Title - MC110 - Order Confirmation

🌐 The following is an example payload to be posted in the body of the HTTP request.

/* Copyright © 2023 Mortgage Connect LP */
{
    "transactionHeader": {
        "transactionIdempotentId": "3B34A671-BB17-400D-90BF-7CBF9C96E8ED",
        "transactionDate": "2022-07-11T02:03:40",
        "clientCode": "1799",
        "clientName": "AcmeInc",
        "vendorCode": "MC",
        "vendorName": "Mortgage Connect"
    },
    "transactionBody": {
        "transactionCode": "Order-Confirmation",
        "transactionId": "7832143",
        "productTransactionId": "",
        "orderNumber": 2429888,
        "itemNumber": 1,
        "productCode": "TTL",
        "loanNumber": "7313993"
    },
    "transactionExtensions": {
        "transactionExtension": [
            {
                "key": "Client Specific Key 1",
                "value": "Client Specific Value 1"
            },
            {
                "key": "Client Specific Key 2",
                "value": "Client Specific Value 2"
            }
        ]
    }
}
/* Copyright © 2023 Mortgage Connect LP */

<!-- Copyright © 2023 Mortgage Connect LP -->
<root>
    <transactionHeader>
        <transactionIdempotentId>3B34A671-Bb17-400D-90Bf-7Cbf9C96E8Ed</transactionIdempotentId>
        <transactionDate>2022-07-11T02:03:40</transactionDate>
        <clientCode>1799</clientCode>
        <clientName>Acmeinc</clientName>
        <vendorCode>MC</vendorCode>
        <vendorName>Mortgage Connect</vendorName>
    </transactionHeader>
    <transactionBody>
        <transactionCode>Order-Confirmation</transactionCode>
        <transactionId>7832143</transactionId>
        <productTransactionId></productTransactionId>
        <orderNumber>2429888</orderNumber>
        <itemNumber>1</itemNumber>
        <productCode>TTL</productCode>
        <loanNumber>7313993</loanNumber>
    </transactionBody>
    <transactionExtensions>
        <transactionExtension>
            <key>Client Specific Key 1</key>
            <value>Client Specific Value 1</value>
        </transactionExtension>
        <transactionExtension>
            <key>Client Specific Key 2</key>
            <value>Client Specific Value 1</value>
        </transactionExtension>
    </transactionExtensions>
</root>
<!-- Copyright © 2023 Mortgage Connect LP -->

👍 The request payload can be verified using the following validation schema.

/* Copyright © 2023 Mortgage Connect LP */
{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "$id": "root",
  "description": "Copyright @ 2022 Mortgage Connect LP - Title & Tax Schema.",
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "legalHeader": {
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "version": {
          "examples": [
            "1.0.8.0"
          ],
          "type": "string",
          "minLength": 1,
          "maxLength": 20
        },
        "disclosingParty": {
          "examples": [
            "Copyright @ 2022 Mortgage Connect LP"
          ],
          "type": "string",
          "minLength": 1,
          "maxLength": 100
        },
        "proprietaryInformationAndConfidential": {
          "examples": [
            "Ownership of Proprietary Information. The Recipient agrees that it shall not receive any right, title or interest, or any license or right to use, the Disclosing Partys Proprietary Information, including, but not limited to, technology, ideas, concepts, drawings, documentation, designs, prototypes, processes, trade secrets, trademarks or other intellectual property rights therein, by implication or otherwise."
          ],
          "type": "string",
          "minLength": 1,
          "maxLength": 2000
        }
      },
      "required": [
        "version",
        "disclosingParty",
        "proprietaryInformationAndConfidential"
      ],
      "minProperties": 3,
      "maxProperties": 3
    },
    "transactionHeader": {
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "transactionIdempotentId": {
          "examples": [
            "3B34A671-BB17-400D-90BF-7CBF9C96E8ED"
          ],
          "type": "string",
          "minLength": 36,
          "maxLength": 36,
          "pattern": "^[\\da-fA-F]{8}-[\\da-fA-F]{4}-[\\da-fA-F]{4}-[\\da-fA-F]{4}-[\\da-fA-F]{12}$"
        },
        "transactionDate": {
          "examples": [
            "2022-07-11T02:03:40"
          ],
          "type": "string",
          "format": "date-time"
        },
        "clientCode": {
          "examples": [
            "1799"
          ],
          "type": "string",
          "minLength": 1,
          "maxLength": 100,
          "format": "integer"
        },
        "clientName": {
          "examples": [
            "AcmeInc"
          ],
          "type": "string",
          "minLength": 1,
          "maxLength": 100
        },
        "vendorCode": {
          "examples": [
            "MC"
          ],
          "type": "string",
          "minLength": 1,
          "maxLength": 100
        },
        "vendorName": {
          "examples": [
            "Mortgage Connect"
          ],
          "type": "string",
          "minLength": 1,
          "maxLength": 100
        }
      },
      "required": [
        "transactionIdempotentId",
        "transactionDate",
        "clientCode",
        "clientName",
        "vendorCode",
        "vendorName"
      ],
      "minProperties": 6,
      "maxProperties": 6
    },
    "transactionBody": {
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "transactionCode": {
          "examples": [
            "Order-Confirmation"
          ],
          "type": "string",
          "const": "Order-Confirmation"
        },
        "transactionId": {
          "examples": [
            "7832143"
          ],
          "type": "string",
          "minLength": 1,
          "maxLength": 50
        },
        "productTransactionId": {
          "examples": [
            "7832143"
          ],
          "type": "string",
          "minLength": 0,
          "maxLength": 50
        },
        "orderNumber": {
          "examples": [
            "2429888"
          ],
          "type": "integer"
        },
        "itemNumber": {
          "examples": [
            "1"
          ],
          "type": "integer",
          "minimum": 1.0,
          "maximum": 40.0
        },
        "productCode": {
          "type": "string",
          "minLength": 3,
          "maxLength": 4,
          "enum": [
            "LVR",
            "PRT",
            "PUR",
            "TTL"
          ]
        },
        "loanNumber": {
          "examples": [
            "7313993"
          ],
          "type": "string",
          "minLength": 1,
          "maxLength": 64
        }
      },
      "required": [
        "transactionCode",
        "transactionId",
        "orderNumber",
        "itemNumber",
        "productCode",
        "loanNumber"
      ]
    },
    "transactionExtensions": {
      "type": "object",
      "properties": {
        "transactionExtension": {
          "type": "array",
          "items": {
            "type": "object",
            "additionalProperties": false,
            "properties": {
              "key": {
                "examples": [
                  "Client Specific Key"
                ],
                "type": "string",
                "minLength": 1,
                "maxLength": 200
              },
              "value": {
                "examples": [
                  "Client Specific Value"
                ],
                "type": "string",
                "minLength": 1
              }
            },
            "required": [
              "key",
              "value"
            ],
            "minProperties": 2,
            "maxProperties": 2
          },
          "minItems": 0
        }
      }
    }
  },
  "required": [
    "transactionHeader",
    "transactionBody"
  ],
  "minProperties": 2,
  "maxProperties": 4
}
/* Copyright © 2023 Mortgage Connect LP */

The request payload XML schema validation is under construction. 🚧

✅ The following is an 'Accepted' example payload to be returned in the HTTP response.

Accepted Acknowledgment payloads are typically message type agnostic.

Accepted Acknowledgment payloads are typically message type agnostic.

⛔ The following is a 'Rejected' example payload to be returned in the HTTP response.

Rejected Acknowledgment payloads are typically message type agnostic.

Rejected Acknowledgment payloads are typically message type agnostic.

The Order-Confirmation event is the payload that is sent to the client after a New-Order message is processed asynchronously and contains the Mortgage Connect order number that was assigned to the order.

View Workflow Orchestration

Client URL

POST 🔒 To be determined during onboarding process.

Property Definitions - Transaction Header

Defines the properties represented in the Transaction Header object (JSON) or node (XML). Note that this message artifact is identical for each and every message type.

View Transaction Header Details

Property Definitions - Transaction Body

Defines the properties represented in the Transaction Body object (JSON) or node (XML).

Property	Requirement	Data Type	Min / Max	Description
transactionBody	Required			A parent object (JSON) or node (XML) that contains the transaction metadata.
transactionCode	Required	String	14 / 14	A static value of `Order-Confirmation`. The transaction code is meant to identify the message type and the context or action that should be taken. An `Order-Confirmation` transaction code indicates that the previously submitted `New-Order` transaction was successfully processed. As part of the payload, Mortgage Connect's Order and Item Number will be returned. Possible Values: Order-Confirmation
transactionId	Required	String	1 / 50	Represents the Client's unique order number.
productTransactionId	Optional	String	0 / 50	Represents the Client's unique product order number. Note that the `productTransactionId` field is not used in most circumstances. However, when there is a need to further differentiate order numbers at a product level, that share the same `transactionId`, (i.e. the primary order level id), then the `productTransactionId` can be used to ensure uniqueness across the integration transactions. This makes it possible for multiple orders of the same product type to be placed using the same `transactionId`. The use of the `productTransactionId` field and any specific workflow deviations will be vetted during the onboarding process.
orderNumber	Required	Integer		Represents Mortgage Connects unique order number.
itemNumber	Required	Integer	Integer	Represents Mortgage Connects product sequencing number (i.e `1 through 40`) that is associated with each product ordered.
productCode	Required	String	3 / 4	Represents Mortgage Connect's product code. Possible Values: LVR `LEGAL & VESTING REPORT` PRT `PROPERTY REPORT` PUR `PURCHASE` TTL `TITLE INSURANCE` etc. Traditionally, clients use Mortgage Connects `Product Code` names and thus there is a one to one mapping relationship that is maintained by the client. However, Mortgage Connect is aware that our naming conventions may not resonate and that there are many inconsistencies in product code naming conventions and nomenclatures. It is for this reason that Mortgage Connect is able to map the client's product code to Mortgage Connect's product code to ease the transition. Any required product code mapping exercises will be addressed during the onboarding process. The supported `productCode`(s) are specific per integration and will be determined during the onboarding process. Note that the minimum/maximum length requirement of 3/4 is only applicable if using Mortgage Connect's internal product codes, otherwise when mapping to the client's product codes, the minimum/maximum is 1/50.
loanNumber	Required	String	1 / 64	The client's loan number that is associated with the order.

Property Definitions - Transaction Extensions

Defines the properties represented in the TransactionExtensions object (JSON) or node (XML). Note that this message artifact is identical for each and every message type.

View Transaction Extension Details

Title - MC115 - Instant Title

🌐 The following is an example payload to be posted in the body of the HTTP request.

/* Copyright © 2025 Mortgage Connect LP */
{
    "transactionHeader": {
        "transactionIdempotentId": "3B34A671-BB17-400D-90BF-7CBF9C96E8ED",
        "transactionDate": "2025-04-23T04:11:43",
        "clientCode": "1799",
        "clientName": "AcmeInc",
        "vendorCode": "MC",
        "vendorName": "Mortgage Connect"
    },
    "transactionBody": {
        "transactionCode": "Instant-Title",
        "transactionId": "13092023-1-NK",
        "productTransactionId": "",
        "orderNumber": "3478151",
        "loanNumber": "13092023-1",
        "comment": "Processed",
        "completedDate": "2025-04-22T03:25:56",
        "decisions": {
            "lenderWorkflowDecision": "Expedited"
        },
        "borrowers": {
            "borrower": [
                {
                    "borrowerType": "Individual",
                    "firstName": "John",
                    "middleName": "",
                    "lastName": "Smith",
                    "streetAddress": "123 Main Street",
                    "city": "Springfield",
                    "state": "IL",
                    "zip": "62704"
                },
                {
                    "borrowerType": "Individual",
                    "firstName": "Jane",
                    "middleName": "",
                    "lastName": "Smith",
                    "streetAddress": "123 Main Street",
                    "city": "Springfield",
                    "state": "IL",
                    "zip": "62704"
                }
            ]
        },
        "property": {
            "propertyStreetAddress": "123 Main Street",
            "propertyCity": "Springfield",
            "propertyState": "IL",
            "propertyZip": "62704",
            "propertyType": "Single Family",
            "yearBuilt": 2005,
            "landUseCode": "SFR",
            "sqft": 2500,
            "lotSqft": 10000,
            "bedrooms": 4,
            "bathrooms": 2.5,
            "estimatedValue": 450000,
            "currentlyListed": false,
            "deedRecorded24Months": "No",
            "ownerOccupied": "Yes",
            "propertyAddress": "123 Main Street, Springfield IL, 62704",
            "mailingAddress": "123 Main Street, Springfield IL, 62704",
            "siteCounty": "Sangamon",
            "lotSize": "0.23 acres",
            "aPN": "123-456-789",
            "vestingInfo": "John Smith and Jane Smith, husband and wife, as joint tenants",
            "briefLegalDescription": "Lot 45, Block 12, Springfield Heights",
            "fullLegalDescription": "Lot 45, Block 12, Springfield Heights, according to the plat recorded in Book 35 of Plats, Page 12, records of Sangamon County, Illinois.",
            "mLSActive": "No",
            "fips": 17167
        },
        "lender": {
            "lenderName": "ABC Mortgage",
            "lenderID": "LEN12345",
            "loanID": "LOAN678901",
            "loanAmount": 320000,
            "cashOutAmount": 50000
        },
        "consumerReports": {
            "consumerReport": [
                {
                    "consumer": "John Smith",
                    "individualResult": "Clear",
                    "submittedWithOrder": true,
                    "vestedOwner": "Yes",
                    "bankruptcy": "None",
                    "deceasedIndicator": "None",
                    "liensandJudgments": "None",
                    "spousalAndChildSupport": "None"
                },
                {
                    "consumer": "Jane Smith",
                    "individualResult": "Clear",
                    "submittedWithOrder": true,
                    "vestedOwner": "Yes",
                    "bankruptcy": "None",
                    "deceasedIndicator": "None",
                    "liensandJudgments": "None",
                    "spousalAndChildSupport": "None"
                }
            ]
        },
        "mortgages": {
            "mortgage": [
                {
                    "recordedDate": "06-10-2020",
                    "book": "10105",
                    "page": "1127",
                    "amount": 112000,
                    "granteeOrLender": "XYZ Bank",
                    "grantorOrBorrower": "John Smith and Jane Smith"
                }
            ]
        },
        "liens": {
            "lien": [
                {
                    "documentType": "Notice of Commencement",
                    "recordedDate": "06-10-2020",
                    "book": "10296",
                    "page": "2303",
                    "amount": 0,
                    "granteeOrLender": "Sun Coast Roofing Services, Inc.",
                    "grantorOrBorrower": "John Smith and Jane Smith"
                }
            ]
        },
        "ownerships": {
            "ownership": [
                {
                    "documentType": "Warranty Deed",
                    "recordedDate": "05-15-2015",
                    "amount": 380000,
                    "granteeOrLender": "John Smith and Jane Smith",
                    "grantorOrBorrower": "Robert Johnson"
                }
            ]
        },
        "loansAndEncumbrances": {
            "loanAndOtherEncumbrance": [
                {
                    "documentType": "Mortgage",
                    "recordedDate": "05-15-2015",
                    "amount": "304000",
                    "granteeOrLender": "XYZ Bank",
                    "grantorOrBorrower": "John Smith and Jane Smith",
                    "isPI": true
                }
            ]
        },
        "otherRecordings": {
            "otherRecording": [
                {
                    "documentType": "Easement",
                    "recordedDate": "03-11-2022",
                    "amount": 0,
                    "granteeOrLender": "City of Springfield",
                    "grantorOrBorrower": "John Smith and Jane Smith"
                }
            ]
        },
        "taxes": {
            "totalAssessedValue": 425000,
            "landValue": 125000,
            "totalImprovementValue": 300000,
            "totalTaxableValue": 425000,
            "propertyTaxAmount": 6875.5,
            "assessmentYear": 2024,
            "taxYearDeliquency": 0,
            "apn": "123-456-789",
            "taxAuthorities": {
                "taxAuthority": [
                    {
                        "taxAuthorityType": "County",
                        "collectionEntryName": "Sangamon County Treasurer",
                        "collectionEntryStreetAddress": "200 County Plaza",
                        "collectionEntryStreetCityState": "Springfield IL 62701",
                        "collectionEntryPhone": "(217) 555-1234",
                        "payments": {
                            "payment": [
                                {
                                    "paymentType": "Regular",
                                    "startYear": 2024,
                                    "endYear": 2024,
                                    "installmentCount": 2,
                                    "paymentStatuses": {
                                        "paymentStatus": [
                                            {
                                                "paymentStatus": "PAID",
                                                "seqIdentifier": "A",
                                                "baseAmount": 3437.75,
                                                "taxAmount": 3437.75
                                            }
                                        ]
                                    }
                                }
                            ]
                        }
                    },
                    {
                        "taxAuthorityType": "School",
                        "collectionEntryName": "Springfield School District",
                        "collectionEntryStreetAddress": "100 Education Way",
                        "collectionEntryStreetCityState": "Springfield IL 62704",
                        "collectionEntryPhone": "(217) 555-5678",
                        "payments": {
                            "payment": [
                                {
                                    "paymentType": "Regular",
                                    "startYear": 2024,
                                    "endYear": 2024,
                                    "installmentCount": 1,
                                    "paymentStatuses": {
                                        "paymentStatus": [
                                            {
                                                "paymentStatus": "PAID",
                                                "seqIdentifier": "A",
                                                "baseAmount": 3437.75,
                                                "taxAmount": 3437.75
                                            }
                                        ]
                                    }
                                }
                            ]
                        }
                    }
                ]
            },
            "exemptions": {
                "exemption": [
                    {
                        "key": "Exemption Senior",
                        "value": "SENIOR"
                    },
                    {
                        "key": "Exemption Homestead",
                        "value": "HOMESTEAD"
                    }
                ]
            }
        },
        "otherOwnerProperties": {
            "otherOwnerProperty": [
                {
                    "property": "None"
                }
            ],
            "mortgage": "None"
        }
    },
    "transactionExtensions": {
        "transactionExtension": [
            {
                "key": "Client Specific Key 1",
                "value": "Client Specific Value 1"
            },
            {
                "key": "Client Specific Key 2",
                "value": "Client Specific Value 2"
            }
        ]
    }
}
/* Copyright © 2025 Mortgage Connect LP */

<!-- Copyright © 2025 Mortgage Connect LP -->
<?xml version="1.0" encoding="UTF-8"?>
<transaction>
    <transactionHeader>
        <transactionIdempotentId>3B34A671-BB17-400D-90BF-7CBF9C96E8ED</transactionIdempotentId>
        <transactionDate>2025-04-23T04:11:43</transactionDate>
        <clientCode>1799</clientCode>
        <clientName>AcmeInc</clientName>
        <vendorCode>MC</vendorCode>
        <vendorName>Mortgage Connect</vendorName>
    </transactionHeader>
    <transactionBody>
        <transactionCode>Instant-Title</transactionCode>
        <transactionId>13092023-1-NK</transactionId>
        <productTransactionId></productTransactionId>
        <orderNumber>3478151</orderNumber>
        <loanNumber>13092023-1</loanNumber>
        <comment>Processed</comment>
        <completedDate>2025-04-22T03:25:56</completedDate>
        <decisions>
            <lenderWorkflowDecision>Expedited</lenderWorkflowDecision>
        </decisions>
        <borrowers>
            <borrower>
                <borrowerType>Individual</borrowerType>
                <firstName>John</firstName>
                <middleName></middleName>
                <lastName>Smith</lastName>
                <streetAddress>123 Main Street</streetAddress>
                <city>Springfield</city>
                <state>IL</state>
                <zip>62704</zip>
            </borrower>
            <borrower>
                <borrowerType>Individual</borrowerType>
                <firstName>Jane</firstName>
                <middleName></middleName>
                <lastName>Smith</lastName>
                <streetAddress>123 Main Street</streetAddress>
                <city>Springfield</city>
                <state>IL</state>
                <zip>62704</zip>
            </borrower>
        </borrowers>
        <property>
            <propertyStreetAddress>123 Main Street</propertyStreetAddress>
            <propertyCity>Springfield</propertyCity>
            <propertyState>IL</propertyState>
            <propertyZip>62704</propertyZip>
            <propertyType>Single Family</propertyType>
            <yearBuilt>2005</yearBuilt>
            <landUseCode>SFR</landUseCode>
            <sqft>2500</sqft>
            <lotSqft>10000</lotSqft>
            <bedrooms>4</bedrooms>
            <bathrooms>2.5</bathrooms>
            <estimatedValue>450000</estimatedValue>
            <currentlyListed>false</currentlyListed>
            <deedRecorded24Months>No</deedRecorded24Months>
            <ownerOccupied>Yes</ownerOccupied>
            <propertyAddress>123 Main Street, Springfield IL, 62704</propertyAddress>
            <mailingAddress>123 Main Street, Springfield IL, 62704</mailingAddress>
            <siteCounty>Sangamon</siteCounty>
            <lotSize>0.23 acres</lotSize>
            <aPN>123-456-789</aPN>
            <vestingInfo>John Smith and Jane Smith, husband and wife, as joint tenants</vestingInfo>
            <briefLegalDescription>Lot 45, Block 12, Springfield Heights</briefLegalDescription>
            <fullLegalDescription>Lot 45, Block 12, Springfield Heights, according to the plat recorded in Book 35 of Plats, Page 12, records of Sangamon County, Illinois.</fullLegalDescription>
            <mLSActive>No</mLSActive>
            <fips>17167</fips>
        </property>
        <lender>
            <lenderName>ABC Mortgage</lenderName>
            <lenderID>LEN12345</lenderID>
            <loanID>LOAN678901</loanID>
            <loanAmount>320000</loanAmount>
            <cashOutAmount>50000</cashOutAmount>
        </lender>
        <consumerReports>
            <consumerReport>
                <consumer>John Smith</consumer>
                <individualResult>Clear</individualResult>
                <submittedWithOrder>true</submittedWithOrder>
                <vestedOwner>Yes</vestedOwner>
                <bankruptcy>None</bankruptcy>
                <deceasedIndicator>None</deceasedIndicator>
                <liensandJudgments>None</liensandJudgments>
                <spousalAndChildSupport>None</spousalAndChildSupport>
            </consumerReport>
            <consumerReport>
                <consumer>Jane Smith</consumer>
                <individualResult>Clear</individualResult>
                <submittedWithOrder>true</submittedWithOrder>
                <vestedOwner>Yes</vestedOwner>
                <bankruptcy>None</bankruptcy>
                <deceasedIndicator>None</deceasedIndicator>
                <liensandJudgments>None</liensandJudgments>
                <spousalAndChildSupport>None</spousalAndChildSupport>
            </consumerReport>
        </consumerReports>
        <mortgages>
            <mortgage>
                <recordedDate>06-10-2020</recordedDate>
                <book>10105</book>
                <page>1127</page>
                <amount>112000</amount>
                <granteeOrLender>XYZ Bank</granteeOrLender>
                <grantorOrBorrower>John Smith and Jane Smith</grantorOrBorrower>
            </mortgage>
        </mortgages>
        <liens>
            <lien>
                <documentType>Notice of Commencement</documentType>
                <recordedDate>06-10-2020</recordedDate>
                <book>10296</book>
                <page>2303</page>
                <amount>0</amount>
                <granteeOrLender>Sun Coast Roofing Services, Inc.</granteeOrLender>
                <grantorOrBorrower>John Smith and Jane Smith</grantorOrBorrower>
            </lien>
        </liens>
        <ownerships>
            <ownership>
                <documentType>Warranty Deed</documentType>
                <recordedDate>05-15-2015</recordedDate>
                <amount>380000</amount>
                <granteeOrLender>John Smith and Jane Smith</granteeOrLender>
                <grantorOrBorrower>Robert Johnson</grantorOrBorrower>
            </ownership>
        </ownerships>
        <loansAndEncumbrances>
            <loanAndOtherEncumbrance>
                <documentType>Mortgage</documentType>
                <recordedDate>05-15-2015</recordedDate>
                <amount>304000</amount>
                <granteeOrLender>XYZ Bank</granteeOrLender>
                <grantorOrBorrower>John Smith and Jane Smith</grantorOrBorrower>
                <isPI>true</isPI>
            </loanAndOtherEncumbrance>
        </loansAndEncumbrances>
        <otherRecordings>
            <otherRecording>
                <documentType>Easement</documentType>
                <recordedDate>03-11-2022</recordedDate>
                <amount>0</amount>
                <granteeOrLender>City of Springfield</granteeOrLender>
                <grantorOrBorrower>John Smith and Jane Smith</grantorOrBorrower>
            </otherRecording>
        </otherRecordings>
        <taxes>
            <totalAssessedValue>425000</totalAssessedValue>
            <landValue>125000</landValue>
            <totalImprovementValue>300000</totalImprovementValue>
            <totalTaxableValue>425000</totalTaxableValue>
            <propertyTaxAmount>6875.5</propertyTaxAmount>
            <assessmentYear>2024</assessmentYear>
            <taxYearDeliquency>0</taxYearDeliquency>
            <apn>123-456-789</apn>
            <taxAuthorities>
                <taxAuthority>
                    <taxAuthorityType>County</taxAuthorityType>
                    <collectionEntryName>Sangamon County Treasurer</collectionEntryName>
                    <collectionEntryStreetAddress>200 County Plaza</collectionEntryStreetAddress>
                    <collectionEntryStreetCityState>Springfield IL 62701</collectionEntryStreetCityState>
                    <collectionEntryPhone>(217) 555-1234</collectionEntryPhone>
                    <payments>
                        <payment>
                            <paymentType>Regular</paymentType>
                            <startYear>2024</startYear>
                            <endYear>2024</endYear>
                            <installmentCount>2</installmentCount>
                            <paymentStatuses>
                                <paymentStatus>
                                    <paymentStatus>PAID</paymentStatus>
                                    <seqIdentifier>A</seqIdentifier>
                                    <baseAmount>3437.75</baseAmount>
                                    <taxAmount>3437.75</taxAmount>
                                </paymentStatus>
                            </paymentStatuses>
                        </payment>
                    </payments>
                </taxAuthority>
                <taxAuthority>
                    <taxAuthorityType>School</taxAuthorityType>
                    <collectionEntryName>Springfield School District</collectionEntryName>
                    <collectionEntryStreetAddress>100 Education Way</collectionEntryStreetAddress>
                    <collectionEntryStreetCityState>Springfield IL 62704</collectionEntryStreetCityState>
                    <collectionEntryPhone>(217) 555-5678</collectionEntryPhone>
                    <payments>
                        <payment>
                            <paymentType>Regular</paymentType>
                            <startYear>2024</startYear>
                            <endYear>2024</endYear>
                            <installmentCount>1</installmentCount>
                            <paymentStatuses>
                                <paymentStatus>
                                    <paymentStatus>PAID</paymentStatus>
                                    <seqIdentifier>A</seqIdentifier>
                                    <baseAmount>3437.75</baseAmount>
                                    <taxAmount>3437.75</taxAmount>
                                </paymentStatus>
                            </paymentStatuses>
                        </payment>
                    </payments>
                </taxAuthority>
            </taxAuthorities>
            <exemptions>
                <exemption>
                    <key>Exemption Senior</key>
                    <value>SENIOR</value>
                </exemption>
                <exemption>
                    <key>Exemption Homestead</key>
                    <value>HOMESTEAD</value>
                </exemption>
            </exemptions>
        </taxes>
        <otherOwnerProperties>
            <otherOwnerProperty>
                <property>None</property>
            </otherOwnerProperty>
            <mortgage>None</mortgage>
        </otherOwnerProperties>
    </transactionBody>
    <transactionExtensions>
        <transactionExtension>
            <key>Client Specific Key 1</key>
            <value>Client Specific Value 1</value>
        </transactionExtension>
        <transactionExtension>
            <key>Client Specific Key 2</key>
            <value>Client Specific Value 2</value>
        </transactionExtension>
    </transactionExtensions>
</transaction>
<!-- Copyright © 2025 Mortgage Connect LP -->

👍 The request payload can be verified using the following validation schema.

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "$id": "root",
  "description": "Copyright @ 2025 Mortgage Connect LP - Instant Title Schema.",
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "legalHeader": {
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "version": {
          "examples": [
            "1.0.8.0"
          ],
          "type": "string",
          "minLength": 1,
          "maxLength": 20
        },
        "disclosingParty": {
          "examples": [
            "Copyright @ 2025 Mortgage Connect LP"
          ],
          "type": "string",
          "minLength": 1,
          "maxLength": 100
        },
        "proprietaryInformationAndConfidential": {
          "examples": [
            "Ownership of Proprietary Information. The Recipient agrees that it shall not receive any right, title or interest, or any license or right to use, the Disclosing Partys Proprietary Information, including, but not limited to, technology, ideas, concepts, drawings, documentation, designs, prototypes, processes, trade secrets, trademarks or other intellectual property rights therein, by implication or otherwise."
          ],
          "type": "string",
          "minLength": 1,
          "maxLength": 2000
        }
      },
      "required": [
        "version",
        "disclosingParty",
        "proprietaryInformationAndConfidential"
      ],
      "minProperties": 3,
      "maxProperties": 3
    },
    "transactionHeader": {
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "transactionIdempotentId": {
          "examples": [
            "3B34A671-BB17-400D-90BF-7CBF9C96E8ED"
          ],
          "type": "string",
          "minLength": 36,
          "maxLength": 36,
          "pattern": "^[\\da-fA-F]{8}-[\\da-fA-F]{4}-[\\da-fA-F]{4}-[\\da-fA-F]{4}-[\\da-fA-F]{12}$"
        },
        "transactionDate": {
          "examples": [
            "2025-04-23T04:11:43"
          ],
          "type": "string",
          "format": "date-time"
        },
        "clientCode": {
          "examples": [
            "1799"
          ],
          "type": "string",
          "minLength": 1,
          "maxLength": 100,
          "format": "integer"
        },
        "clientName": {
          "examples": [
            "AcmeInc"
          ],
          "type": "string",
          "minLength": 1,
          "maxLength": 100
        },
        "vendorCode": {
          "examples": [
            "MC"
          ],
          "type": "string",
          "minLength": 1,
          "maxLength": 100
        },
        "vendorName": {
          "examples": [
            "Mortgage Connect"
          ],
          "type": "string",
          "minLength": 1,
          "maxLength": 100
        }
      },
      "required": [
        "transactionIdempotentId",
        "transactionDate",
        "clientCode",
        "clientName",
        "vendorCode",
        "vendorName"
      ],
      "minProperties": 6,
      "maxProperties": 6
    },
    "transactionBody": {
      "title": "TransactionBody",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "transactionCode": {
          "examples": [
            "Instant-Title"
          ],
          "type": "string",
          "const": "Instant-Title",
          "minLength": 13,
          "maxLength": 13
        },
        "transactionId": {
          "examples": [
            "13092023-1-NK"
          ],
          "type": "string",
          "minLength": 1,
          "maxLength": 50
        },
        "productTransactionId": {
          "examples": [
            ""
          ],
          "type": "string",
          "minLength": 0,
          "maxLength": 50
        },
        "orderNumber": {
          "examples": [
            "3478151"
          ],
          "type": "integer"
        },
        "loanNumber": {
          "examples": [
            "13092023-1"
          ],
          "type": "string",
          "minLength": 1,
          "maxLength": 64
        },
        "comment": {
          "examples": [
            "Processed"
          ],
          "type": "string"
        },
        "completedDate": {
          "examples": [
            "2025-04-22T03:25:56"
          ],
          "type": "string",
          "format": "date-time"
        },
        "decisions": {
          "type": "object",
          "additionalProperties": false,
          "properties": {
            "lenderWorkflowDecision": {
              "type": "string",
              "enum": [
                "Expedited",
                "Traditional",
                null
              ],
              "minLength": 9,
              "maxLength": 11
            }
          },
          "required": [
            "lenderWorkflowDecision"
          ]
        },
        "borrowers": {
          "type": "object",
          "properties": {
            "borrower": {
              "type": "array",
              "items": {
                "type": "object",
                "additionalProperties": false,
                "properties": {
                  "borrowerType": {
                    "type": "string"
                  },
                  "firstName": {
                    "type": "string"
                  },
                  "middleName": {
                    "type": "string"
                  },
                  "lastName": {
                    "type": "string"
                  },
                  "streetAddress": {
                    "type": "string"
                  },
                  "city": {
                    "type": "string"
                  },
                  "state": {
                    "type": "string"
                  },
                  "zip": {
                    "type": "string"
                  }
                }
              }
            }
          }
        },
        "property": {
          "type": "object",
          "additionalProperties": false,
          "properties": {
            "propertyStreetAddress": {
              "type": "string"
            },
            "propertyCity": {
              "type": "string"
            },
            "propertyState": {
              "type": "string"
            },
            "propertyZip": {
              "type": "string"
            },
            "propertyType": {
              "type": "string"
            },
            "yearBuilt": {
              "type": "integer"
            },
            "landUseCode": {
              "type": "string"
            },
            "sqft": {
              "type": "integer"
            },
            "lotSqft": {
              "type": "integer"
            },
            "bedrooms": {
              "type": "integer"
            },
            "bathrooms": {
              "type": "number"
            },
            "estimatedValue": {
              "type": "number"
            },
            "currentlyListed": {
              "type": "boolean"
            },
            "deedRecorded24Months": {
              "type": "string"
            },
            "ownerOccupied": {
              "type": "string"
            },
            "propertyAddress": {
              "type": "string"
            },
            "mailingAddress": {
              "type": "string"
            },
            "siteCounty": {
              "type": "string"
            },
            "lotSize": {
              "type": "string"
            },
            "aPN": {
              "type": "string"
            },
            "vestingInfo": {
              "type": "string"
            },
            "briefLegalDescription": {
              "type": "string"
            },
            "fullLegalDescription": {
              "type": "string"
            },
            "mLSActive": {
              "type": "string"
            },
            "fips": {
              "type": "integer"
            }
          }
        },
        "lender": {
          "type": "object",
          "additionalProperties": false,
          "properties": {
            "lenderName": {
              "type": "string"
            },
            "lenderID": {
              "type": "string"
            },
            "loanID": {
              "type": "string"
            },
            "loanAmount": {
              "type": "number"
            },
            "cashOutAmount": {
              "type": "number"
            }
          }
        },
        "consumerReports": {
          "type": "object",
          "properties": {
            "consumerReport": {
              "type": "array",
              "items": {
                "type": "object",
                "additionalProperties": false,
                "properties": {
                  "consumer": {
                    "type": "string"
                  },
                  "individualResult": {
                    "type": "string"
                  },
                  "submittedWithOrder": {
                    "type": "boolean"
                  },
                  "vestedOwner": {
                    "type": "string"
                  },
                  "bankruptcy": {
                    "type": "string"
                  },
                  "deceasedIndicator": {
                    "type": "string"
                  },
                  "liensandJudgments": {
                    "type": "string"
                  },
                  "spousalAndChildSupport": {
                    "type": "string"
                  }
                }
              }
            }
          }
        },
        "mortgages": {
          "type": "object",
          "properties": {
            "mortgage": {
              "type": "array",
              "items": {
                "type": "object",
                "additionalProperties": false,
                "properties": {
                  "recordedDate": {
                    "type": "string",
                    "format": "date-time"
                  },
                  "book": {
                    "type": "string"
                  },
                  "page": {
                    "type": "string"
                  },
                  "amount": {
                    "type": "number"
                  },
                  "granteeOrLender": {
                    "type": "string"
                  },
                  "grantorOrBorrower": {
                    "type": "string"
                  }
                }
              }
            }
          }
        },
        "liens": {
          "type": "object",
          "properties": {
            "lien": {
              "type": "array",
              "items": {
                "type": "object",
                "additionalProperties": false,
                "properties": {
                  "documentType": {
                    "type": "string"
                  },
                  "recordedDate": {
                    "type": "string",
                    "format": "date-time"
                  },
                  "book": {
                    "type": "string"
                  },
                  "page": {
                    "type": "string"
                  },
                  "amount": {
                    "type": "number"
                  },
                  "granteeOrLender": {
                    "type": "string"
                  },
                  "grantorOrBorrower": {
                    "type": "string"
                  }
                }
              }
            }
          }
        },
        "ownerships": {
          "type": "object",
          "properties": {
            "ownership": {
              "type": "array",
              "items": {
                "type": "object",
                "additionalProperties": false,
                "properties": {
                  "documentType": {
                    "type": "string"
                  },
                  "recordedDate": {
                    "type": "string",
                    "format": "date-time"
                  },
                  "amount": {
                    "type": "number"
                  },
                  "granteeOrLender": {
                    "type": "string"
                  },
                  "grantorOrBorrower": {
                    "type": "string"
                  }
                }
              }
            }
          }
        },
        "loansAndEncumbrances": {
          "type": "object",
          "properties": {
            "loanAndOtherEncumbrance": {
              "type": "array",
              "items": {
                "type": "object",
                "additionalProperties": false,
                "properties": {
                  "documentType": {
                    "type": "string"
                  },
                  "recordedDate": {
                    "type": "string",
                    "format": "date-time"
                  },
                  "amount": {
                    "type": "number"
                  },
                  "granteeOrLender": {
                    "type": "string"
                  },
                  "grantorOrBorrower": {
                    "type": "string"
                  },
                  "isPI": {
                    "type": "boolean"
                  }
                }
              }
            }
          }
        },
        "otherRecordings": {
          "type": "object",
          "properties": {
            "otherRecording": {
              "type": "array",
              "items": {
                "type": "object",
                "additionalProperties": false,
                "properties": {
                  "documentType": {
                    "type": "string"
                  },
                  "recordedDate": {
                    "type": "string",
                    "format": "date-time"
                  },
                  "amount": {
                    "type": "number"
                  },
                  "granteeOrLender": {
                    "type": "string"
                  },
                  "grantorOrBorrower": {
                    "type": "string"
                  }
                }
              }
            }
          }
        },
        "taxes": {
          "type": "object",
          "additionalProperties": false,
          "properties": {
            "totalAssessedValue": {
              "type": "number"
            },
            "landValue": {
              "type": "number"
            },
            "totalImprovementValue": {
              "type": "number"
            },
            "totalTaxableValue": {
              "type": "number"
            },
            "propertyTaxAmount": {
              "type": "number"
            },
            "assessmentYear": {
              "type": "integer"
            },
            "taxYearDeliquency": {
              "type": "integer"
            },
            "apn": {
              "type": "string"
            },
            "taxAuthorities": {
              "type": "object",
              "properties": {
                "taxAuthority": {
                  "type": "array",
                  "items": {
                    "type": "object",
                    "additionalProperties": false,
                    "properties": {
                      "taxAuthorityType": {
                        "type": "string"
                      },
                      "collectionEntryName": {
                        "type": "string"
                      },
                      "collectionEntryStreetAddress": {
                        "type": "string"
                      },
                      "collectionEntryStreetCityState": {
                        "type": "string"
                      },
                      "collectionEntryPhone": {
                        "type": "string"
                      },
                      "payments": {
                        "type": "object",
                        "properties": {
                          "payment": {
                            "type": "array",
                            "items": {
                              "type": "object",
                              "additionalProperties": false,
                              "properties": {
                                "paymentType": {
                                  "type": "string"
                                },
                                "startYear": {
                                  "type": "integer"
                                },
                                "endYear": {
                                  "type": "integer"
                                },
                                "installmentCount": {
                                  "type": "integer"
                                },
                                "paymentStatuses": {
                                  "type": "object",
                                  "properties": {
                                    "paymentStatus": {
                                      "type": "array",
                                      "items": {
                                        "type": "object",
                                        "additionalProperties": false,
                                        "properties": {
                                          "paymentStatus": {
                                            "type": "string"
                                          },
                                          "seqIdentifier": {
                                            "type": "string"
                                          },
                                          "baseAmount": {
                                            "type": "number"
                                          },
                                          "taxAmount": {
                                            "type": "number"
                                          }
                                        }
                                      }
                                    }
                                  }
                                }
                              }
                            }
                          }
                        }
                      }
                    }
                  }
                }
              }
            },
            "exemptions": {
              "type": "object",
              "properties": {
                "exemption": {
                  "type": "array",
                  "items": {
                    "type": "object",
                    "additionalProperties": false,
                    "properties": {
                      "key": {
                        "type": "string"
                      },
                      "value": {
                        "type": "string"
                      }
                    }
                  }
                }
              }
            }
          }
        },
        "otherOwnerProperties": {
          "type": "object",
          "properties": {
            "otherOwnerProperty": {
              "type": "array",
              "items": {
                "type": "object",
                "additionalProperties": false,
                "properties": {
                  "property": {
                    "type": "string"
                  }
                }
              }
            },
            "otherMortgage": {
              "type": "string"
            }
          }
        }
      },
      "required": [
        "transactionCode",
        "transactionId",
        "orderNumber",
        "loanNumber",
        "comment",
        "completedDate",
        "decisions"
      ]
    },
    "transactionExtensions": {
      "type": "object",
      "properties": {
        "transactionExtension": {
          "type": "array",
          "items": {
            "type": "object",
            "additionalProperties": false,
            "properties": {
              "key": {
                "examples": [
                  "Client Specific Key 1"
                ],
                "type": "string",
                "minLength": 1,
                "maxLength": 200
              },
              "value": {
                "examples": [
                  "Client Specific Value 1"
                ],
                "type": "string",
                "minLength": 1
              }
            },
            "required": [
              "key",
              "value"
            ],
            "minProperties": 2,
            "maxProperties": 2
          },
          "minItems": 0
        }
      }
    }
  },
  "required": [
    "transactionHeader",
    "transactionBody"
  ],
  "minProperties": 2,
  "maxProperties": 4
}

The request payload XML schema validation is under construction. 🚧

✅ The following is an 'Accepted' example payload to be returned in the HTTP response.

Accepted Acknowledgment payloads are typically message type agnostic.

Accepted Acknowledgment payloads are typically message type agnostic.

⛔ The following is a 'Rejected' example payload to be returned in the HTTP response.

Rejected Acknowledgment payloads are typically message type agnostic.

Rejected Acknowledgment payloads are typically message type agnostic.

The Instant Title API method is the mechanism in which Mortgage Connect sends a message to the Client containing an Instant Title Report and supporting metadata to be applied to the Title Order.

Supported Instant Title Decisions:

Expedited
Traditional
null (i.e. no hit)

View Workflow Orchestration

Client URL

POST 🔒 To be determined during onboarding process.

Property Definitions - Transaction Header

Defines the properties represented in the Transaction Header object (JSON) or node (XML). Note that this message artifact is identical for each and every message type.

View Transaction Header Details

Property Definitions - Transaction Body

Defines the properties represented in the Transaction Body object (JSON) or node (XML).

Property	Requirement	Data Type	Min / Max	Description
transactionBody	Required			A parent object (JSON) or node (XML) that contains the transaction metadata.
transactionCode	Required	String	13 / 13	A static value of `Instant-Title`. The transaction code is meant to identify the message type and the context or action that should be taken. In this context it implies that an Instant Title Report should be added to the Title Order. Possible Values: Instant-Title
transactionId	Required	String	1 / 50	Represents the Client's unique order number.
productTransactionId	Optional	String	0 / 50	Represents the Client's unique product order number. Note that the `productTransactionId` field is not used in most circumstances. However, when there is a need to further differentiate order numbers at a product level, that share the same `transactionId`, (i.e. the primary order level id), then the `productTransactionId` can be used to ensure uniqueness across the integration transactions. This makes it possible for multiple orders of the same product type to be placed using the same `transactionId`. The use of the `productTransactionId` field and any specific workflow deviations will be vetted during the onboarding process.
orderNumber	Required	Integer		Represents Mortgage Connects unique order number.
loanNumber	Required	String	1 / 64	The client's loan number that is associated with the order.
comment	Required	String	0 / MAX	A general comment to provide additional context regarding the status of the Instant Title request. For example, when the `decision` is `null` the comment will provide additional details as to why there was no decison or specific details regarding an encounted error condition.
completedDate	Required	DateTime		The date and time when the Instant Title was completed.

Property Definitions - Decisions Details

Property	Requirement	Data Type	Min / Max	Description
decisions	Required			A parent object (JSON) or node (XML) that contains metadata associated with the instant title decisions.
lenderWorkflowDecision	Required	String	9 / 11	The instant title lender workflow decision. Possible Values: Expedited Traditional null (i.e. no hit) Note that a value of `null` or the exclusion of the field in the payload indicates that the Title Provider was not able to provide a decision or an unexpected exception was encountered.

Property Definitions - Borrower Details

Property	Requirement	Data Type	Min / Max	Description
borrowers	Optional			A parent object (JSON) or node (XML) that contains a list of borrowers. `(0 to Many)` Note that the first borrower is assumed to `always` be the `Primary` borrower.
borrower	Optional			A parent object (JSON) or node (XML) that contains the metadata associated with a borrower.
borrowerType	Optional	String	10 / 10	The borrower type. Possible Values: Individual
firstName	Optional	String	N/A	The borrower first name.
middleName	Optional	String	N/A	The borrower middle name.
lastName	Optional	String	N/A	The borrower last name.
streetAddress	Optional	String	N/A	The borrower street address.
city	Optional	String	N/A	The borrower city.
state	Optional	String	N/A	The borrower state.
zip	Optional	String	N/A	The borrower zip code.

Property Definitions - Property Details

Property	Requirement	Data Type	Min / Max	Description
property	Optional			A parent object (JSON) or node (XML) that contains a metadata associated with the property.
propertyStreetAddress	Optional	String	N/A	The property street address.
propertyCity	Optional	String	N/A	The property city.
propertyState	Optional	String	N/A	The property state.
propertyZip	Optional	String	N/A	The property zip code.
propertyType	Optional	String	N/A	The property type.
yearBuilt	Optional	Integer		The year the property was built.
landUseCode	Optional	String	N/A	The land use code.
sqft	Optional	Integer		The square footage of the property.
lotSqft	Optional	Integer		The square footage of the property lot.
bedrooms	Optional	Integer		The number of bedrooms.
bathrooms	Optional	Decimal		The number of bathrooms.
estimatedValue	Optional	Money		The estimated value of the property.
currentlyListed	Optional	Boolean		Indicates whether the property is currently listed for sale.
deedRecorded24Months	Optional	String	N/A	Indicates whether the deed was recorded within the last 24 months.
ownerOccupied	Optional	String	N/A	Indicates whether the property is owner occupied.
propertyAddress	Optional	String	N/A	The property full address.
mailingAddress	Optional	String	N/A	The property mailing address.
siteCounty	Optional	String	N/A	The property county.
lotSize	Optional	String	N/A	The property lot size.
aPN	Optional	String	N/A	The parcels unique Assessor's Parcel Number.
vestingInfo	Optional	String	N/A	The vesting information.
briefLegalDecription	Optional	String	N/A	The property brief legal decription.
fullLegalDescription	Optional	String	N/A	The property full legal description.
mLSActive	Optional	String	N/A	Indicates whether the property is associated with a Multiple Listing Service.
fips	Optional	Integer		The county FIPS code.

Property Definitions - Lender Details

Property	Requirement	Data Type	Min / Max	Description
lender	Optional			A parent object (JSON) or node (XML) that contains metadata associated with the lender.
lenderName	Optional	String	N/A	The lender name.
lenderID	Optional	String	N/A	The lender Id.
loanID	Optional	String	N/A	The loan Id.
loanAmount	Optional	Money		The loan amount.
cashOutAmount	Optional	Money		The cash out amount.

Property Definitions - Consumer Report Details

Property	Requirement	Data Type	Min / Max	Description
consumerReports	Optional			A parent object (JSON) or node (XML) that contains a list of consumer reports.
consumerReport	Optional			A parent object (JSON) or node (XML) that contains the metadata associated with a consumer report.
consumer	Optional	String	N/A	The consumer.
individualResult	Optional	String	5 / 8	An individual result of the consumer report, which indicates what is needed from a research perspective. Possible Values: Clear Optional Required Review
submittedWithOrder	Optional	Boolean		Indicates whether it was submitted with the order.
vestedOwner	Optional	String	N/A	Is the consumer a vested owner.
bankruptcy	Optional	String	4 / 10	Is the consumer in bankruptcy. Possible Values: Found None None Found (synonomous with None)
deceasedIndicator	Optional	String	4 / 10	Is the consumer deceased. Possible Values: Found None None Found (synonomous with None)
liensandJudgments	Optional	String	4 / 10	Are there any liens and judgements against the consumer. Possible Values: Found None None Found (synonomous with None)
spousalAndChildSupport	Optional	String	4 / 10	Does the consumer have any spousal or child support obligations. Possible Values: Found None None Found (synonomous with None)

Property Definitions - Mortgage Details

Property	Requirement	Data Type	Min / Max	Description
mortgages	Options			A parent object (JSON) or node (XML) that contains a list of mortgages.
mortgage	Options			A parent object (JSON) or node (XML) that contains metadata associated with a mortgage.
recordedDate	Optional	DateTime		The date the mortgage was recorded. Format: `mm-dd-yyyy`
book	Optional	String	N/A	The book that the mortgage was recorded in.
page	Optional	String	N/A	The page that the mortgage was recorded on.
amount	Optional	Money		The amount of the mortgage.
granteeOrLender	Optional	String	N/A	The mortgage grantee or lender.
grantorOrBorrower	Optional	String	N/A	The mortgage grantor or borrower.

Property Definitions - Lien Details

Property	Requirement	Data Type	Min / Max	Description
liens	Options			A parent object (JSON) or node (XML) that contains a list of liens.
lien	Options			A parent object (JSON) or node (XML) that contains metadata associated with a lien.
documentType	Optional	String	N/A	The lien document type. Defining an exhaustive and complete list of document types is not feasible. Document types are dynamic in nature as they are categorized and named differently across different states, counties, and jurisdictions. If a document type mapping is required by the client, Mortgage Connect recommends looking for key words to generalize the document type. For example: `General Warranty Deed` and `Quitclaim Deed` could be categorized as Deeds if keying off the keyword `Deed`.
recordedDate	Optional	DateTime		The date the lien was recorded. Format: `mm-dd-yyyy`
book	Optional	String	N/A	The book that the lien was recorded in.
page	Optional	String	N/A	The page that the lien was recorded on.
amount	Optional	Money		The amount of the lien.
granteeOrLender	Optional	String		The lien grantee or lender.
grantorOrBorrower	Optional	String	N/A	The lien grantor or borrower.

Property Definitions - Ownership Details

Property	Requirement	Data Type	Min / Max	Description
ownerships	Optional			A parent object (JSON) or node (XML) that contains a list of ownership.
ownership	Optional			A parent object (JSON) or node (XML) that contains the metadata associated with a ownership.
documentType	Optional	String	N/A	The ownership document type. Defining an exhaustive and complete list of document types is not feasible. Document types are dynamic in nature as they are categorized and named differently across different states, counties, and jurisdictions. If a document type mapping is required by the client, Mortgage Connect recommends looking for key words to generalize the document type. For example: `General Warranty Deed` and `Quitclaim Deed` could be categorized as Deeds if keying off the keyword `Deed`.
recordedDate	Optional	DateTime		The data of the recording. Format: `mm-dd-yyyy`
amount	Optional	Money		The amount.
granteeOrLender	Optional	String	N/A	The grantee or lender.
grantorOrBorrower	Optional	String	N/A	The grantor or borrower.

Property Definitions - Loan And Encumbrace Details

Property	Requirement	Data Type	Min / Max	Description
loansAndEncumbrances	Options			A parent object (JSON) or node (XML) that contains a list of loans and encumbrances.
loanAndEncumbrance	Options			A parent object (JSON) or node (XML) that contains the metadata associated with a loan and encumbrance.
documentType	Optional	String	N/A	The loan and encumbrance document type. Defining an exhaustive and complete list of document types is not feasible. Document types are dynamic in nature as they are categorized and named differently across different states, counties, and jurisdictions. If a document type mapping is required by the client, Mortgage Connect recommends looking for key words to generalize the document type. For example: `General Warranty Deed` and `Quitclaim Deed` could be categorized as Deeds if keying off the keyword `Deed`.
recordedDate	Optional	DateTime		The date of the recording. Format: `mm-dd-yyyy`
amount	Optional	Money		The amount.
granteeOrLender	Optional	String	N/A	The grantee or lender.
grantorOrBorrower	Optional	String	N/A	The grantor or borrower.
isPI	Optional	Boolean		Indicates whether the property indexed.

Property Definitions - Other Recording Details

Property	Requirement	Data Type	Min / Max	Description
otherRecordings	Options			A parent object (JSON) or node (XML) that contains a list of other recordings.
otherRecording	Options			A parent object (JSON) or node (XML) that contains the metadata associated with another recording.
documentType	Optional	String	N/A	The recording document type. Defining an exhaustive and complete list of document types is not feasible. Document types are dynamic in nature as they are categorized and named differently across different states, counties, and jurisdictions. If a document type mapping is required by the client, Mortgage Connect recommends looking for key words to generalize the document type. For example: `General Warranty Deed` and `Quitclaim Deed` could be categorized as Deeds if keying off the keyword `Deed`.
recordedDate	Optional	DateTime		The date of the recording. Format: `mm-dd-yyyy`
amount	Optional	Money		The amount.
granteeOrLender	Optional	String	N/A	The grantee or lender.
grantorOrBorrower	Optional	String	N/A	The grantor or borrower.

Property Definitions - Tax Details

Property	Requirement	Data Type	Min / Max	Description
taxes	Options			A parent object (JSON) or node (XML) that contains metadata associated with taxes.
totalAssessedValue	Optional	Money		The total assessed value.
landValue	Optional	Money		The the land value.
totalImprovementValue	Optional	Money		The total improvement value.
totalTaxableValue	Optional	Money		The the total taxable value.
propertyTaxAmount	Optional	Money		The property tax amount.
assessmentYear	Optional	Integer		The assessment year.
taxYearDeliquency	Optional	Integer		The tax deliquency.
apn	Optional	String	N/A	The parcels unique Assessor's Parcel Number.
taxAuthorities	Options			A parent object (JSON) or node (XML) that contains a list of tax authorities.
taxAuthority	Options			A parent object (JSON) or node (XML) that contains metadata associated with a tax authority.
taxAuthorityType	Optional	String	4 / 11	The tax authority type. Possible Values: City County Local Other School Sewage Township Water/Sewer
collectionEntryName	Optional	String	N/A	The tax authority name.
collectionEntryStreetAddress	Optional	String	N/A	The tax authority address.
collectionEntryStreetCityState	Optional	String	N/A	The tax authority city, state, and zip code
collectionEntryPhone	Optional	String	N/A	The tax authority phone number.
payments	Options			A parent object (JSON) or node (XML) that contains a list of payments.
payment	Options			A parent object (JSON) or node (XML) that contains metadata associated with a payment.
paymentType	Optional	String	7 / 7	The payment type. Possible Values: Regular
startYear	Optional	Integer		The billing starting year.
endYear	Optional	Integer		The billing ending year.
installmentCount	Optional	Integer		The installment count.
paymentStatuses	Options			A parent object (JSON) or node (XML) that contains a list of payment statuses.
paymentStatus	Options			A parent object (JSON) or node (XML) that contains metadata associated with a payment status.
paymentStatus	Optional	String	4 / 10	The payment status. Possible Values: Delinquent Open Paid Unknown
seqIdentifier	Optional	String	1 / 1	The sequence identifier. Possible Values: A B C D
baseAmount	Optional	Money		The base amount.
taxAmount	Optional	Money		The tax amount.
exemptions	Options			A parent object (JSON) or node (XML) that contains list of exemptions.
exemption	Options			A parent object (JSON) or node (XML) that contains metadata associated with an exemption.
key	Optional	String	N/A	The exemption key or name.
value	Optional	String	N/A	The exemption value or description.

Property Definitions - Other Owner Property Details

Property	Requirement	Data Type	Min / Max	Description
otherOwnerProperties	Options			A parent object (JSON) or node (XML) that contains a list of other owner properties.
otherOwnerProperty	Options			A parent object (JSON) or node (XML) that contains metadata associated with another owner property.
property	Optional	String	N/A	Are there other properties. Possible Values: Found None None Found (synonomous with None)
otherMortgage	Optional	String	N/A	Are there other mortgage. Possible Values: Found None None Found (synonomous with None)

Property Definitions - Transaction Extensions

Defines the properties represented in the TransactionExtensions object (JSON) or node (XML). Note that this message artifact is identical for each and every message type.

View Transaction Extension Details

Title - MC117 - Cancel Order

🌐 The following is an example payload to be posted in the body of the HTTP request.

/* Copyright © 2023 Mortgage Connect LP */
{
    "transactionHeader": {
        "transactionIdempotentId": "3B34A671-BB17-400D-90BF-7CBF9C96E8ED",
        "transactionDate": "2022-07-11T02:03:40",
        "clientCode": "1799",
        "clientName": "AcmeInc",
        "vendorCode": "MC",
        "vendorName": "Mortgage Connect"
    },
    "transactionBody": {
        "transactionCode": "Cancel-Order",
        "transactionId": "7832143",
        "productTransactionId": "",
        "orderNumber": 2429888,
        "productCode": "TTL"
    },
    "transactionExtensions": {
        "transactionExtension": [
            {
                "key": "Client Specific Key 1",
                "value": "Client Specific Value 1"
            },
            {
                "key": "Client Specific Key 2",
                "value": "Client Specific Value 2"
            }
        ]
    }
}
/* Copyright © 2023 Mortgage Connect LP */

<!-- Copyright © 2023 Mortgage Connect LP -->
<root>
    <transactionHeader>
        <transactionIdempotentId>3B34A671-Bb17-400D-90Bf-7Cbf9C96E8Ed</transactionIdempotentId>
        <transactionDate>2022-07-11T02:03:40</transactionDate>
        <clientCode>1799</clientCode>
        <clientName>Acmeinc</clientName>
        <vendorCode>MC</vendorCode>
        <vendorName>Mortgage Connect</vendorName>
    </transactionHeader>
    <transactionBody>
        <transactionCode>Cancel-Order</transactionCode>
        <transactionId>7832143</transactionId>
        <productTransactionId></productTransactionId>
        <orderNumber>2429888</orderNumber>
        <productCode>TTL</productCode>
  </transactionBody>
    <transactionExtensions>
        <transactionExtension>
            <key>Client Specific Key 1</key>
            <value>Client Specific Value 1</value>
        </transactionExtension>
        <transactionExtension>
            <key>Client Specific Key 2</key>
            <value>Client Specific Value 1</value>
        </transactionExtension>
    </transactionExtensions>
</root>
<!-- Copyright © 2023 Mortgage Connect LP -->

👍 The request payload can be verified using the following validation schema.

/* Copyright © 2023 Mortgage Connect LP */
{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "$id": "root",
  "description": "Copyright @ 2022 Mortgage Connect LP - Title & Tax Schema.",
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "legalHeader": {
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "version": {
          "examples": [
            "1.0.8.0"
          ],
          "type": "string",
          "minLength": 1,
          "maxLength": 20
        },
        "disclosingParty": {
          "examples": [
            "Copyright @ 2022 Mortgage Connect LP"
          ],
          "type": "string",
          "minLength": 1,
          "maxLength": 100
        },
        "proprietaryInformationAndConfidential": {
          "examples": [
            "Ownership of Proprietary Information. The Recipient agrees that it shall not receive any right, title or interest, or any license or right to use, the Disclosing Partys Proprietary Information, including, but not limited to, technology, ideas, concepts, drawings, documentation, designs, prototypes, processes, trade secrets, trademarks or other intellectual property rights therein, by implication or otherwise."
          ],
          "type": "string",
          "minLength": 1,
          "maxLength": 2000
        }
      },
      "required": [
        "version",
        "disclosingParty",
        "proprietaryInformationAndConfidential"
      ],
      "minProperties": 3,
      "maxProperties": 3
    },
    "transactionHeader": {
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "transactionIdempotentId": {
          "examples": [
            "3B34A671-BB17-400D-90BF-7CBF9C96E8ED"
          ],
          "type": "string",
          "minLength": 36,
          "maxLength": 36,
          "pattern": "^[\\da-fA-F]{8}-[\\da-fA-F]{4}-[\\da-fA-F]{4}-[\\da-fA-F]{4}-[\\da-fA-F]{12}$"
        },
        "transactionDate": {
          "examples": [
            "2022-07-11T02:03:40"
          ],
          "type": "string",
          "format": "date-time"
        },
        "clientCode": {
          "examples": [
            "1799"
          ],
          "type": "string",
          "minLength": 1,
          "maxLength": 100,
          "format": "integer"
        },
        "clientName": {
          "examples": [
            "AcmeInc"
          ],
          "type": "string",
          "minLength": 1,
          "maxLength": 100
        },
        "vendorCode": {
          "examples": [
            "MC"
          ],
          "type": "string",
          "minLength": 1,
          "maxLength": 100
        },
        "vendorName": {
          "examples": [
            "Mortgage Connect"
          ],
          "type": "string",
          "minLength": 1,
          "maxLength": 100
        }
      },
      "required": [
        "transactionIdempotentId",
        "transactionDate",
        "clientCode",
        "clientName",
        "vendorCode",
        "vendorName"
      ],
      "minProperties": 6,
      "maxProperties": 6
    },
    "transactionBody": {
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "transactionCode": {
          "examples": [
            "Cancel-Order"
          ],
          "type": "string",
          "const": "Cancel-Order"
        },
        "transactionId": {
          "examples": [
            "7832143"
          ],
          "type": "string",
          "minLength": 1,
          "maxLength": 50
        },
        "productTransactionId": {
          "examples": [
            "7832143"
          ],
          "type": "string",
          "minLength": 0,
          "maxLength": 50
        },
        "orderNumber": {
          "examples": [
            "2429888"
          ],
          "type": "integer"
        },
        "productCode": {
          "type": "string",
          "minLength": 3,
          "maxLength": 4,
          "enum": [
            "LVR",
            "PRT",
            "PUR",
            "TTL"
          ]
        }
      },
      "required": [
        "transactionCode",
        "transactionId",
        "orderNumber",
        "productCode",
      ]
    },
    "transactionExtensions": {
      "type": "object",
      "properties": {
        "transactionExtension": {
          "type": "array",
          "items": {
            "type": "object",
            "additionalProperties": false,
            "properties": {
              "key": {
                "examples": [
                  "Client Specific Key"
                ],
                "type": "string",
                "minLength": 1,
                "maxLength": 200
              },
              "value": {
                "examples": [
                  "Client Specific Value"
                ],
                "type": "string",
                "minLength": 1
              }
            },
            "required": [
              "key",
              "value"
            ],
            "minProperties": 2,
            "maxProperties": 2
          },
          "minItems": 0
        }
      }
    }
  },
  "required": [
    "transactionHeader",
    "transactionBody"
  ],
  "minProperties": 2,
  "maxProperties": 4
}
/* Copyright © 2023 Mortgage Connect LP */

The request payload XML schema validation is under construction. 🚧

✅ The following is an 'Accepted' example payload to be returned in the HTTP response.

Accepted Acknowledgment payloads are typically message type agnostic.

Accepted Acknowledgment payloads are typically message type agnostic.

⛔ The following is a 'Rejected' example payload to be returned in the HTTP response.

Rejected Acknowledgment payloads are typically message type agnostic.

Rejected Acknowledgment payloads are typically message type agnostic.

The Cancel-Order API method is the mechanism in which a Client can submit a message to Mortgage Connect to cancel a Title Order.

The order to cancel is identified by the combination of the OrderNumber and ProductCode.

View Workflow Orchestration

Mortgage Connect URL

POST 🔒 https://{BaseUrl}/Api/V1.0/{ClientCode}/SubmitMessage

Mortgage Connect URL Properties

Property	Requirement	Description
BaseUrl	Required	A unique base Url that represents a specific Mortgage Connect endpoint and targeted environment.
ClientCode	Required	A unique code assigned to all clients that is used for identification, authentication, and customization purposes.

Property Definitions - Transaction Header

Defines the properties represented in the Transaction Header object (JSON) or node (XML). Note that this message artifact is identical for each and every message type.

View Transaction Header Details

Property Definitions - Transaction Body

Defines the properties represented in the Transaction Body object (JSON) or node (XML).

Property	Requirement	Data Type	Min / Max	Description
transactionBody	Required			A parent object (JSON) or node (XML) that contains the transaction metadata.
transactionCode	Required	String	12 / 12	A static value of `Cancel-Order`. The transaction code is meant to identify the message type and the context or action that should be taken. A `Cancel-Order` transaction code indicates that a Title Order should be canceled. Possible Values: Cancel-Order
transactionId	Required	String	1 / 50	Represents the Client's unique order number.
productTransactionId	Optional	String	0 / 50	Represents the Client's unique product order number. Note that the `productTransactionId` field is not used in most circumstances. However, when there is a need to further differentiate order numbers at a product level, that share the same `transactionId`, (i.e. the primary order level id), then the `productTransactionId` can be used to ensure uniqueness across the integration transactions. This makes it possible for multiple orders of the same product type to be placed using the same `transactionId`. The use of the `productTransactionId` field and any specific workflow deviations will be vetted during the onboarding process.
orderNumber	Required	Integer		Represents Mortgage Connects unique order number.
productCode	Required	String	3 / 4	Represents Mortgage Connect's product code. Possible Values: LVR `LEGAL & VESTING REPORT` PRT `PROPERTY REPORT` PUR `PURCHASE` TTL `TITLE INSURANCE` etc. Traditionally, clients use Mortgage Connects `Product Code` names and thus there is a one to one mapping relationship that is maintained by the client. However, Mortgage Connect is aware that our naming conventions may not resonate and that there are many inconsistencies in product code naming conventions and nomenclatures. It is for this reason that Mortgage Connect is able to map the client's product code to Mortgage Connect's product code to ease the transition. Any required product code mapping exercises will be addressed during the onboarding process. The supported `productCode`(s) are specific per integration and will be determined during the onboarding process. Note that the minimum/maximum length requirement of 3/4 is only applicable if using Mortgage Connect's internal product codes, otherwise when mapping to the client's product codes, the minimum/maximum is 1/50.

Property Definitions - Transaction Extensions

Defines the properties represented in the TransactionExtensions object (JSON) or node (XML). Note that this message artifact is identical for each and every message type.

View Transaction Extension Details

Title - MC120 - Update Order

🌐 The following is an example payload to be posted in the body of the HTTP request.

/* Copyright © 2023 Mortgage Connect LP */
{
    "transactionHeader": {
        "transactionIdempotentId": "3B34A671-BB17-400D-90BF-7CBF9C96E8ED",
        "transactionDate": "2022-07-11T02:03:40",
        "clientCode": "1799",
        "clientName": "AcmeInc",
        "vendorCode": "MC",
        "vendorName": "Mortgage Connect"
    },
    "transactionBody": {
        "transactionCode": "Update-Order",
        "transactionId": "7832143",
        "productTransactionId": "",
        "orderNumber": 2429888,
        "productCode": "TTL",
        "loanNumber": "73201-3433",
        "loanAmount": "200000",
        "originalLoanAmount": "59900",
        "unpaidPrincipalAmount": "158698",
        "salePrice": "210000",
        "loanType": "Refinance",
        "propertyType": "SingleFamily",
        "amortizationType": "Fixed",
        "expectedClosingDate": "2022-08-31T14:00:00",
        "cema": "CEMA loan option requested",
        "occupancyType": "Primary",
        "propertyAddress": {
            "address1": "1234 Main St",
            "address2": "Apt 1",
            "city": "Shawnee",
            "state": "CA",
            "zipCode": "93950",
            "county": "Monterey"
        },
        "borrowers": {
            "borrower": [
                {
                    "firstName": "Johnny",
                    "middleName": "J",
                    "lastName": "Doe",
                    "suffix": "Sr.",
                    "type": "Borrower",
                    "email": "johnnydoe@gmail.com",
                    "cellPhone": "724-323-4234",
                    "ssn": "111-11-1111",
                    "maritalStatus": "Married",
                    "dateOfBirth": "1965-07-04",
                    "borrowerAddress": {
                        "address1": "1234 Main St",
                        "address2": "",
                        "city": "Shawnee",
                        "state": "CA",
                        "zipCode": "93950",
                        "county": "Monterey"
                    }
                },
                {
                    "firstName": "Janie",
                    "middleName": "J",
                    "lastName": "Doe",
                    "type": "Borrower",
                    "email": "janiedoe@gmail.com",
                    "cellPhone": "724-123-4545",
                    "ssn": "222-22-2222",
                    "maritalStatus": "Married",
                    "dateOfBirth": "1967-09-22"
                }
            ]
        },
        "parties": {
            "party" : [
                {
                    "firstName": "John",
                    "lastName": "Doe",
                    "phone": "724-420-3341",
                    "email": "johndoe@acmeinc.com",
                    "role": "Processor"
                },
                {
                    "firstName": "Jane",
                    "lastName": "Doe",
                    "phone": "724-420-1833",
                    "email": "janedoe@acmeinc.com",
                    "role": "LoanOfficer"
                }
            ]
        },
        "lender": {
            "name": "Direct",
            "address": "26642 Towne Centre Dr",
            "city": "Lake Forest",
            "state": "CA",
            "zipCode": "92630"
        },
        "specialInstruction": "Conveyance of easement."
    },
    "transactionExtensions": {
        "transactionExtension": [
            {
                "key": "Client Specific Key 1",
                "value": "Client Specific Value 1"
            },
            {
                "key": "Client Specific Key 2",
                "value": "Client Specific Value 2"
            }
        ]
    }
}
/* Copyright © 2023 Mortgage Connect LP */

<!-- Copyright © 2023 Mortgage Connect LP -->
<root>
    <transactionHeader>
        <transactionIdempotentId>3B34A671-BB17-400D-90BF-7CBF9C96E8ED</transactionIdempotentId>
        <transactionDate>022-07-11T02:03:40</transactionDate>
        <clientCode>1799</clientCode>
        <clientName>AcmeInc</clientName>
        <vendorCode>MC</vendorCode>
        <vendorName>Mortgage Connect</vendorName>
    </transactionHeader>
    <transactionBody>
        <transactionCode>Update-Order</transactionCode>
        <transactionId>7832143</transactionId>
        <productTransactionId></productTransactionId>
        <orderNumber>2429888</orderNumber>
        <productCode>TTL</productCode>
        <loanNumber>73201-3433</loanNumber>
        <loanAmount>200000</loanAmount>
        <originalLoanAmount>59900</originalLoanAmount>
        <unpaidPrincipalAmount>158698</unpaidPrincipalAmount>
        <salePrice>210000</salePrice>
        <loanType>Refinance</loanType>
        <propertyType>SingleFamily</propertyType>
        <amortizationType>Fixed</amortizationType>
        <expectedClosingDate>2022-08-31T14:00:00</expectedClosingDate>
        <cema>CEMA loan option requested</cema>
        <occupancyType>Primary</occupancyType>
        <propertyAddress>
            <address1>1234 Main St</address1>
            <address2>Suite 2</address2>
            <city>Shawnee</city>
            <state>CA</state>
            <zipCode>93950</zipCode>
            <county>Monterey</county>
        </propertyAddress>
        <borrowers>
            <borrower>
                <firstName>Johnny</firstName>
                <middleName>J</middleName>
                <lastName>Doe</lastName>
                <suffix>Sr.</suffix>
                <type>Borrower</type>
                <email>johnnydoe@gmail.com</email>
                <cellPhone>724-323-4234</cellPhone>
                <ssn>111-11-1111</ssn>
                <maritalStatus>Married</maritalStatus>
                <dateOfBirth>1965-07-04</dateOfBirth>
                <borrowerAddress>
                    <address1>100 Willow St</address1>
                    <address2>Suite 2</address2>
                    <city>Shawnee</city>
                    <state>CA</state>
                    <zipCode>93950</zipCode>
                    <county>Monterey</county>
                </borrowerAddress>
            </borrower>
            <borrower>
                <firstName>Janie</firstName>
                <middleName>J</middleName>
                <lastName>Doe</lastName>
                <type>Borrower</type>
                <email>janiedoe@gmail.com</email>
                <cellPhone>724-123-4545</cellPhone>
                <ssn>222-22-2222</ssn>
                <maritalStatus>Married</maritalStatus>
                <dateOfBirth>1967-09-22</dateOfBirth>
            </borrower>
        </borrowers>
        <parties>
            <party>
                <firstName>John</firstName>
                <lastName>Doe</lastName>
                <phone>724-420-3341</phone>
                <email>johndoe@acmeinc.com</email>
                <role>Processor</role>
            </party>
            <party>
                <firstName>Jane</firstName>
                <lastName>Doe</lastName>
                <phone>724-420-1833</phone>
                <email>janedoe@acmeinc.com</email>
                <role>LoanOfficer</role>
            </party>
        </parties>
        <lender>
            <name>Direct</name>
            <address>26642 Towne Centre Dr</address>
            <city>Lake Forest</city>
            <state>CA</state>
            <zipCode>92630</zipCode>
        </lender>
        <specialInstruction>Conveyance of easement.</specialInstruction>
    </transactionBody>
    <transactionExtensions>
        <transactionExtension>
            <key>Client Specific Key 1</key>
            <value>Client Specific Value 1</value>
        </transactionExtension>
        <transactionExtension>
            <key>Client Specific Key 2</key>
            <value>Client Specific Value 1</value>
        </transactionExtension>
    </transactionExtensions>
</root>
<!-- Copyright © 2023 Mortgage Connect LP -->

👍 The request payload can be verified using the following validation schema.

/* Copyright © 2023 Mortgage Connect LP */
{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "$id": "root",
  "description": "Copyright @ 2022 Mortgage Connect LP - Title & Tax Schema.",
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "legalHeader": {
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "version": {
          "examples": [
            "1.0.8.0"
          ],
          "type": "string",
          "minLength": 1,
          "maxLength": 20
        },
        "disclosingParty": {
          "examples": [
            "Copyright @ 2022 Mortgage Connect LP"
          ],
          "type": "string",
          "minLength": 1,
          "maxLength": 100
        },
        "proprietaryInformationAndConfidential": {
          "examples": [
            "Ownership of Proprietary Information. The Recipient agrees that it shall not receive any right, title or interest, or any license or right to use, the Disclosing Partys Proprietary Information, including, but not limited to, technology, ideas, concepts, drawings, documentation, designs, prototypes, processes, trade secrets, trademarks or other intellectual property rights therein, by implication or otherwise."
          ],
          "type": "string",
          "minLength": 1,
          "maxLength": 2000
        }
      },
      "required": [
        "version",
        "disclosingParty",
        "proprietaryInformationAndConfidential"
      ],
      "minProperties": 3,
      "maxProperties": 3
    },
    "transactionHeader": {
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "transactionIdempotentId": {
          "examples": [
            "3B34A671-BB17-400D-90BF-7CBF9C96E8ED"
          ],
          "type": "string",
          "minLength": 36,
          "maxLength": 36,
          "pattern": "^[\\da-fA-F]{8}-[\\da-fA-F]{4}-[\\da-fA-F]{4}-[\\da-fA-F]{4}-[\\da-fA-F]{12}$"
        },
        "transactionDate": {
          "examples": [
            "2022-07-11T02:03:40"
          ],
          "type": "string",
          "format": "date-time"
        },
        "clientCode": {
          "examples": [
            "1799"
          ],
          "type": "string",
          "minLength": 1,
          "maxLength": 100,
          "format": "integer"
        },
        "clientName": {
          "examples": [
            "AcmeInc"
          ],
          "type": "string",
          "minLength": 1,
          "maxLength": 100
        },
        "vendorCode": {
          "examples": [
            "MC"
          ],
          "type": "string",
          "minLength": 1,
          "maxLength": 100
        },
        "vendorName": {
          "examples": [
            "Mortgage Connect"
          ],
          "type": "string",
          "minLength": 1,
          "maxLength": 100
        }
      },
      "required": [
        "transactionIdempotentId",
        "transactionDate",
        "clientCode",
        "clientName",
        "vendorCode",
        "vendorName"
      ],
      "minProperties": 6,
      "maxProperties": 6
    },
    "transactionBody": {
      "title": "TransactionBody",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "transactionCode": {
          "examples": [
            "Update-Order"
          ],
          "type": "string",
          "const": "Update-Order"
        },
        "transactionId": {
          "examples": [
            "7832143"
          ],
          "type": "string",
          "minLength": 1,
          "maxLength": 50
        },
        "productTransactionId": {
          "examples": [
            "7832143"
          ],
          "type": "string",
          "minLength": 0,
          "maxLength": 50
        },
        "orderNumber": {
          "examples": [
            "2429888"
          ],
          "type": "integer"
        },
        "productCode": {
          "type": "string",
          "minLength": 3,
          "maxLength": 4,
          "enum": [
            "LVR",
            "PRT",
            "PUR",
            "TTL"
          ]
        },
        "loanNumber": {
          "examples": [
            "7313993"
          ],
          "type": "string",
          "minLength": 1,
          "maxLength": 64
        },
        "loanAmount": {
          "examples": [
            "0.00"
          ],
          "type": "string",
          "format": "money"
        },
        "originalLoanAmount": {
          "$ref": "root#/properties/transactionBody/properties/loanAmount"
        },
        "unpaidPrincipalAmount": {
          "$ref": "root#/properties/transactionBody/properties/loanAmount"
        },
        "salePrice": {
          "$ref": "root#/properties/transactionBody/properties/loanAmount"
        },
        "loanType": {
          "type": "string",
          "minLength": 1,
          "maxLength": 24,
          "enum": [
            "Equity",
            "Other",
            "Purchase",
            "Refinance",
            "Reverse"
          ]
        },
        "propertyType": {
          "type": "string",
          "minLength": 1,
          "maxLength": 64,
          "enum": [
            "Condominium",
            "Cooperative",
            "Manufactured",
            "Multi-Family",
            "Other",
            "Residential",
            "SingleFamily"
          ]
        },
        "amortizationType": {
          "type": "string",
          "maxLength": 64,
          "enum": [
            "ARM",
            "Fixed",
            "Interest Only",
            "Reverse",
            ""
          ]
        },
        "expectedClosingDate": {
          "type": "string",
          "format": "date-time"
        },
        "cema": {
          "type": "string"
        },
        "occupancyType": {
          "type": "string",
          "minLength": 1,
          "maxLength": 64,
          "enum": [
            "Primary",
            "Secondary",
            "Investment"
          ]
        },
        "propertyAddress": {
          "type": "object",
          "additionalProperties": false,
          "properties": {
            "address1": {
              "examples": [
                "1204 New York Drive"
              ],
              "type": "string",
              "maxLength": 32
            },
            "address2": {
              "examples": [
                "1204 New York Drive"
              ],
              "type": "string",
              "maxLength": 32
            },
            "city": {
              "examples": [
                "Mckees Rocks"
              ],
              "type": "string",
              "maxLength": 32
            },
            "state": {
              "examples": [
                "PA"
              ],
              "type": "string",
              "enum": [
                "AK",
                "AL",
                "AR",
                "AS",
                "AZ",
                "CA",
                "CO",
                "CT",
                "DC",
                "DE",
                "FL",
                "FM",
                "GA",
                "GU",
                "HI",
                "IA",
                "ID",
                "IL",
                "IN",
                "KS",
                "KY",
                "LA",
                "MA",
                "MD",
                "ME",
                "MH",
                "MI",
                "MN",
                "MO",
                "MP",
                "MS",
                "MT",
                "NC",
                "ND",
                "NE",
                "NH",
                "NJ",
                "NM",
                "NV",
                "NY",
                "OH",
                "OK",
                "OR",
                "PA",
                "PR",
                "PW",
                "RI",
                "SC",
                "SD",
                "TN",
                "TX",
                "UT",
                "VA",
                "VI",
                "VT",
                "WA",
                "WI",
                "WV",
                "WY"
              ]
            },
            "zipCode": {
              "examples": [
                "15136"
              ],
              "type": "string",
              "minLength": 5,
              "maxLength": 5,
              "pattern": "^[0-9]{5}$"
            },
            "county": {
              "examples": [
                "Allegheny"
              ],
              "type": "string",
              "maxLength": 32
            }
          },
          "required": [
            "address1",
            "city",
            "state",
            "zipCode"
          ],
          "minProperties": 4,
          "maxProperties": 6
        },
        "borrowers": {
          "type": "object",
          "properties": {
            "borrower": {
              "type": "array",
              "items": {
                "title": "Borrower",
                "type": "object",
                "additionalProperties": false,
                "properties": {
                  "firstName": {
                    "examples": [
                      "John"
                    ],
                    "type": "string",
                    "minLength": 1,
                    "maxLength": 150
                  },
                  "middleName": {
                    "examples": [
                      "M"
                    ],
                    "type": "string",
                    "minLength": 0,
                    "maxLength": 150
                  },
                  "lastName": {
                    "examples": [
                      "Smith"
                    ],
                    "type": "string",
                    "minLength": 1,
                    "maxLength": 255
                  },
                  "suffix": {
                    "examples": [
                      "Sr."
                    ],
                    "type": "string",
                    "minLength": 0,
                    "maxLength": 4,
                    "enum": [
                      "II",
                      "III",
                      "Esq.",
                      "Jr.",
                      "M.D.",
                      "P.A.",
                      "Sr.",
                      ""
                    ]
                  },
                  "type": {
                    "type": "string",
                    "enum": [
                      "Asset Management Company",
                      "Asset Manager",
                      "Assignee",
                      "Assignor",
                      "Attorney",
                      "Bank Attorney",
                      "Borrower",
                      "Borrower/Buyer",
                      "Builder",
                      "Buyer",
                      "Buyer Agent",
                      "Buyer Attorney",
                      "Buyer Title Company",
                      "Buyers Broker",
                      "Condo Association",
                      "Custodian",
                      "Foreclosed Party",
                      "Investor",
                      "LENDER",
                      "Lender Loan Officer",
                      "Listing Agent",
                      "MC MC Auction Company",
                      "Mortgage Connect Closer",
                      "Non-HUD Borrower",
                      "Non-Vested Signer",
                      "Other",
                      "Processor",
                      "Property Access",
                      "Real Estate Agent",
                      "Real Estate Agent - Seller",
                      "Seller",
                      "Seller Attorney",
                      "Sellers Broker",
                      "Selling Agent",
                      "Servicer",
                      "Settlement Agent",
                      "Title Company",
                      "Underwriter",
                      "Vested Signer - Non-Borrower"
                    ]
                  },
                  "email": {
                    "type": "string",
                    "maxLength": 255,
                    "format": "email"
                  },
                  "cellPhone": {
                    "type": "string",
                    "maxLength": 24
                  },
                  "ssn": {
                    "type": "string",
                    "maxLength": 128
                  },
                  "maritalStatus": {
                    "type": "string",
                    "enum": [
                      "Divorced",
                      "Married",
                      "Separated",
                      "Single",
                      "Widowed",
                      ""
                    ]
                  },
                  "language": {
                    "type": "string",
                    "enum": [
                      "English",
                      "Spanish"
                    ]
                  },
                  "dateOfBirth": {
                    "type": "string",
                    "format": "date"
                  },
                  "borrowerAddress": {
                    "$ref": "root#/properties/transactionBody/properties/propertyAddress"
                  }
                },
                "required": [
                  "firstName",
                  "lastName",
                  "type"
                ]
              },
              "minItems": 1
            }
          }
        },
        "parties": {
          "type": "object",
          "properties": {
            "party": {
              "type": "array",
              "items": {
                "title": "Party",
                "type": "object",
                "additionalProperties": false,
                "properties": {
                  "sequenceNo": {
                    "type": "integer"
                  },
                  "firstName": {
                    "type": "string",
                    "maxLength": 150
                  },
                  "lastName": {
                    "type": "string",
                    "maxLength": 150
                  },
                  "phone": {
                    "type": "string",
                    "maxLength": 24
                  },
                  "email": {
                    "type": "string",
                    "maxLength": 255,
                    "format": "email"
                  },
                  "role": {
                    "type": "string",
                    "enum": [
                      "Closer",
                      "LoanOfficer",
                      "LoanOfficerAssistant",
                      "Other",
                      "Processor",
                      "ProcessorAssistant",
                      "Underwriter",
                      "User"
                    ]
                  }
                },
                "required": [
                  "firstName",
                  "lastName",
                  "role"
                ]
              }
            }
          }
        },
        "lender": {
          "title": "Lender",
          "type": "object",
          "additionalProperties": false,
          "properties": {
            "name": {
              "type": "string",
              "maxLength": 255
            },
            "address": {
              "examples": [
                "1204 New York Drive"
              ],
              "type": "string",
              "maxLength": 255
            },
            "city": {
              "$ref": "root#/properties/transactionBody/properties/propertyAddress/properties/city"
            },
            "state": {
              "$ref": "root#/properties/transactionBody/properties/propertyAddress/properties/state"
            },
            "zipCode": {
              "$ref": "root#/properties/transactionBody/properties/propertyAddress/properties/zipCode"
            }
          },
          "required": [
            "address",
            "city",
            "state",
            "zipCode"
          ]
        },
        "specialInstruction": {
          "type": "string"
        }
      },
      "allOf": [
        {
          "required": [
            "transactionCode",
            "transactionId",
            "orderNumber",
            "productCode",
            "loanNumber",
            "loanType",
            "propertyType",
            "occupancyType",
            "propertyAddress",
            "borrowers"
          ]
        },
        {
          "if": {
            "properties": {
              "propertyType": {
                "enum": [
                  "Purchase"
                ]
              }
            }
          },
          "then": {
            "required": [
              "salePrice"
            ]
          }
        }
      ]
    },
    "transactionExtensions": {
      "type": "object",
      "properties": {
        "transactionExtension": {
          "type": "array",
          "items": {
            "type": "object",
            "additionalProperties": false,
            "properties": {
              "key": {
                "examples": [
                  "Client Specific Key"
                ],
                "type": "string",
                "minLength": 1,
                "maxLength": 200
              },
              "value": {
                "examples": [
                  "Client Specific Value"
                ],
                "type": "string",
                "minLength": 1
              }
            },
            "required": [
              "key",
              "value"
            ],
            "minProperties": 2,
            "maxProperties": 2
          },
          "minItems": 0
        }
      }
    }
  },
  "required": [
    "transactionHeader",
    "transactionBody"
  ],
  "minProperties": 2,
  "maxProperties": 4
}
/* Copyright © 2023 Mortgage Connect LP */

The request payload XML schema validation is under construction. 🚧

✅ The following is an 'Accepted' example payload to be returned in the HTTP response.

Accepted Acknowledgment payloads are typically message type agnostic.

Accepted Acknowledgment payloads are typically message type agnostic.

⛔ The following is a 'Rejected' example payload to be returned in the HTTP response.

Rejected Acknowledgment payloads are typically message type agnostic.

Rejected Acknowledgment payloads are typically message type agnostic.

The Update Order API method is the mechanism in which a Client can submit a message to Mortgage Connect to update a Title Order.

The order to update is identified by the combination of the OrderNumber and ProductCode.

View Workflow Orchestration

Mortgage Connect URL

POST 🔒 https://{BaseUrl}/Api/V1.0/{ClientCode}/SubmitMessage

Mortgage Connect URL Properties

Property	Requirement	Description
BaseUrl	Required	A unique base Url that represents a specific Mortgage Connect endpoint and targeted environment.
ClientCode	Required	A unique code assigned to all clients that is used for identification, authentication, and customization purposes.

Property Definitions - Transaction Header

Defines the properties represented in the Transaction Header object (JSON) or node (XML). Note that this message artifact is identical for each and every message type.

View Transaction Header Details

Property Definitions - Transaction Body

Defines the properties represented in the Transaction Body object (JSON) or node (XML).

Property	Requirement	Data Type	Min / Max	Description
transactionBody	Required			A parent object (JSON) or node (XML) that contains the transaction metadata.
transactionCode	Required	String	12 / 12	A static value of `Update-Order`. The transaction code is meant to identify the message type and the context or action that should be taken. In this context it implies that a new Title Order should be updated with additional or changed data. Possible Values: Update-Order
transactionId	Required	String	1 / 50	Represents the Client's unique order number.
productTransactionId	Optional	String	0 / 50	Represents the Client's unique product order number. Note that the `productTransactionId` field is not used in most circumstances. However, when there is a need to further differentiate order numbers at a product level, that share the same `transactionId`, (i.e. the primary order level id), then the `productTransactionId` can be used to ensure uniqueness across the integration transactions. This makes it possible for multiple orders of the same product type to be placed using the same `transactionId`. The use of the `productTransactionId` field and any specific workflow deviations will be vetted during the onboarding process.
orderNumber	Required	Integer		Represents Mortgage Connects unique order number.
productCode	Required	String	3 / 4	Represents Mortgage Connect's product code. Possible Values: LVR `LEGAL & VEString REPORT` PRT `PROPERTY REPORT` PUR `PURCHASE` TTL `TITLE INSURANCE` etc. Traditionally, clients use Mortgage Connects `Product Code` names and thus there is a one to one mapping relationship that is maintained by the client. However, Mortgage Connect is aware that our naming conventions may not resonate and that there are many inconsistencies in product code naming conventions and nomenclatures. It is for this reason that Mortgage Connect is able to map the client's product code to Mortgage Connect's product code to ease the transition. Any required product code mapping exercises will be addressed during the onboarding process. The supported `productCode`(s) are specific per integration and will be determined during the onboarding process. Note that the minimum/maximum length requirement of 3/4 is only applicable if using Mortgage Connect's internal product codes, otherwise when mapping to the client's product codes, the minimum/maximum is 1/50.
loanNumber	Required	String	1 / 64	The clients loan number `alpha-numeric`.
loanAmount	Optional	Money		The loan amount
originalLoanAmount	Optional	Money		The original Loan amount.
unpaidPrinipalAmount	Optional	Money		The unpaid principle amount `if any` in dollars.
salePrice	Conditional	Money		The property sale price. The `salePrice` is optional but is `Required` if the `loanType` is `Purchase`.
loanType	Required	String	1 / 24	The loan type. Possible Values: Equity Purchase Refinance Reverse
propertyType	Required	String	1 / 64	The property usage type. Possible Values: Condominium Cooperative Manufactured Multi-Family Other PUD SingleFamily
amortizationType	Optional	String	0 / 64	The amortization type, i.e. how the loan will be paid. Possible Values: ARM Fixed Interest Only Reverse
expectedClosingDate	Optional	DateTime		The expected closing data `if known`. Format: `mm/dd/yyyy`
cema	Optional	String	0 / 100	Information regarding a CEMA (Consolidation, Extension and Modification Agreement) mortgage loan.
occupancyType	Required	String	1 / 64	The occupancy type, i.e. how the property will be used Possible Values: Primary Secondary Investment
propertyAddress	Required			A parent object (JSON) or node (XML) that contains metadata associated with a property address.
address1	Required	String	1 / 255	The property street address.
address2	Optional	String	0 / 255	The property street address 2.
city	Required	String	1 / 32	The property city name.
state	Required	String	2 / 2	The property state abbreviation. Possible Values: AK, AL, AR, AS, AZ, CA, CO, CT, DC, DE, FL, FM, GA, GU, HI, IA, ID, IL, IN, KS, KY, LA, MA, MD, ME, MH, MI, MN, MO, MP, MS, MT, NC, ND, NE, NH, NJ, NM, NV, NY, OH, OK, OR, PA, PR, PW, RI, SC, SD, TN, TX, UT, VA, VI, VT, WA, WI, WV, WY.
zipCode	Required	String	5 / 5	The property zip code.
county	Optional	String	0 / 32	The property county.
borrowers	Required			A parent object (JSON) or node (XML) that contains a list of borrowers. `(1 to Many)` Note that the first borrower is assumed to `always` be the `Primary` borrower.
borrower	Required			A parent object (JSON) or node (XML) that contains the metadata associated with a single borrower.
firstName	Required	String	1 / 150	The borrower’s first name.
middleName	Required	String	1 / 150	The borrower’s middle name.
lastName	Required	String	1 / 255	The borrower’s last name.
suffix	Optional	String	0 / 4	The borrower's suffix. Possible Values: II III Esq. Jr. Sr.
type	Required	String	1 / 32	The borrower's type. Note that typically this value will be set to `Borrower`. Possible Values: Asset Management Company Asset Manager Assignee Assignor Attorney Bank Attorney Borrower Borrower/Buyer Builder Buyer Buyer Agent Buyer Attorney Buyer Title Company Buyers Broker Condo Association Custodian Foreclosed Party Investor LENDER Lender Loan Officer Listing Agent MC MC Auction Company Mortgage Connect Closer Non-HUD Borrower Non-Vested Signer Other Processor Property Access Real Estate Agent Real Estate Agent - Seller Seller Seller Attorney Sellers Broker Selling Agent Servicer Settlement Agent Title Company Underwriter Vested Signer - Non-Borrower
email	Optional	String	0 / 255	The borrower’s email address.
cellPhone	Optional	String	0 / 24	The borrower's cell phone number.
ssn	Optional	String	0 / 128	The borrower's social security number.
maritalStatus	Optional	String	0 / 128	The borrower’s marital status. Possible Values: Divorced Married Separated Single Widowed
dateOfBirth	Optional	DateTime		The borrower’s date of birth. Format: `mm/dd/yyyy`
borrowerAddress	Optional			A parent object (JSON) or node (XML) that contains metadata associated with a borrower address.
address1	Required	String	1 / 255	The borrower street address.
address2	Optional	String	0 / 255	The borrower street address 2.
city	Required	String	1 / 32	The borrower city name.
state	Required	String	2 / 2	The borrower state abbreviation. Possible Values: AK, AL, AR, AS, AZ, CA, CO, CT, DC, DE, FL, FM, GA, GU, HI, IA, ID, IL, IN, KS, KY, LA, MA, MD, ME, MH, MI, MN, MO, MP, MS, MT, NC, ND, NE, NH, NJ, NM, NV, NY, OH, OK, OR, PA, PR, PW, RI, SC, SD, TN, TX, UT, VA, VI, VT, WA, WI, WV, WY.
zipCode	Required	String	5 / 5	The borrower zip code.
county	Optional	String	0 / 32	The borrower county.
parties	Optional			A parent object (JSON) or node (XML) that contains a list of parties (i.e. those working on the loan). `(0 to Many)`
party	Optional			A parent object (JSON) or node (XML) that contains the metadata associated with a single borrower.
firstName	Required	String	1 / 150	The party first name.
lastName	Required	String	1 / 255	The party last name.
phone	Optional	String	0 / 24	The party's phone number.
email	Optional	String	0 / 255	The party's email address.
role	Required	String	1 / 32	The party's role. Possible Values: Closer LoanOfficer Processor
lender	Optional			A parent object (JSON) or node (XML) that contains the metadata associated with a single lender.
name	Optional	String	0 / 255	The lender's name.
address	Required	String	1 / 255	The lender's address.
city	Required	String	1 / 32	The lender's city.
state	Required	String	5 / 2	The lender's state.
zipCode	Required	String	5 / 5	The lender's zip code.
legalDescription	Optional	String	0 / MAX	The legal description associated with the Title. `(if applicable)`

Property Definitions - Transaction Extensions

Defines the properties represented in the TransactionExtensions object (JSON) or node (XML). Note that this message artifact is identical for each and every message type.

View Transaction Extension Details

Title - MC130 - Add Note

🌐 The following is an example payload to be posted in the body of the HTTP request.

/* Copyright © 2023 Mortgage Connect LP */
{
    "transactionHeader": {
        "transactionIdempotentId": "3B34A671-BB17-400D-90BF-7CBF9C96E8ED",
        "transactionDate": "2022-07-11T02:03:40",
        "clientCode": "1799",
        "clientName": "AcmeInc",
        "vendorCode": "MC",
        "vendorName": "Mortgage Connect"
    },
    "transactionBody": {
        "transactionCode": "Add-Note",
        "transactionId": "7832143",
        "productTransactionId": "",
        "orderNumber": 2429888,
        "productCode": "TTL",
        "note": "We have scheduled a trustees sale of the property.",
        "noteDate": "2022-10-19T14:00:00"
    },
    "transactionExtensions": {
        "transactionExtension": [
            {
                "key": "Client Specific Key 1",
                "value": "Client Specific Value 1"
            },
            {
                "key": "Client Specific Key 2",
                "value": "Client Specific Value 2"
            }
        ]
    }
}
/* Copyright © 2023 Mortgage Connect LP */

<!-- Copyright © 2023 Mortgage Connect LP -->
<root>
    <transactionHeader>
        <transactionIdempotentId>3B34A671-BB17-400D-90BF-7CBF9C96E8ED</transactionIdempotentId>
        <transactionDate>022-07-11T02:03:40</transactionDate>
        <clientCode>1799</clientCode>
        <clientName>AcmeInc</clientName>
        <vendorCode>MC</vendorCode>
        <vendorName>Mortgage Connect</vendorName>
    </transactionHeader>
    <transactionBody>
        <transactionCode>Add-Note</transactionCode>
        <transactionId>7832143</transactionId>
        <productTransactionId></productTransactionId>
        <orderNumber>2429888</orderNumber>
        <productCode>TTL</productCode>
        <note>We have scheduled a trustees sale of the property.</note>
        <noteDate>2022-10-19T14:00:00</noteDate>
    </transactionBody>
    <transactionExtensions>
        <transactionExtension>
            <key>Client Specific Key 1</key>
            <value>Client Specific Value 1</value>
        </transactionExtension>
        <transactionExtension>
            <key>Client Specific Key 2</key>
            <value>Client Specific Value 1</value>
        </transactionExtension>
    </transactionExtensions>
</root>
<!-- Copyright © 2023 Mortgage Connect LP -->

👍 The request payload can be verified using the following validation schema.

/* Copyright © 2023 Mortgage Connect LP */
{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "$id": "root",
  "description": "Copyright @ 2022 Mortgage Connect LP - Title & Tax Schema.",
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "legalHeader": {
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "version": {
          "examples": [
            "1.0.8.0"
          ],
          "type": "string",
          "minLength": 1,
          "maxLength": 20
        },
        "disclosingParty": {
          "examples": [
            "Copyright @ 2022 Mortgage Connect LP"
          ],
          "type": "string",
          "minLength": 1,
          "maxLength": 100
        },
        "proprietaryInformationAndConfidential": {
          "examples": [
            "Ownership of Proprietary Information. The Recipient agrees that it shall not receive any right, title or interest, or any license or right to use, the Disclosing Partys Proprietary Information, including, but not limited to, technology, ideas, concepts, drawings, documentation, designs, prototypes, processes, trade secrets, trademarks or other intellectual property rights therein, by implication or otherwise."
          ],
          "type": "string",
          "minLength": 1,
          "maxLength": 2000
        }
      },
      "required": [
        "version",
        "disclosingParty",
        "proprietaryInformationAndConfidential"
      ],
      "minProperties": 3,
      "maxProperties": 3
    },
    "transactionHeader": {
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "transactionIdempotentId": {
          "examples": [
            "3B34A671-BB17-400D-90BF-7CBF9C96E8ED"
          ],
          "type": "string",
          "minLength": 36,
          "maxLength": 36,
          "pattern": "^[\\da-fA-F]{8}-[\\da-fA-F]{4}-[\\da-fA-F]{4}-[\\da-fA-F]{4}-[\\da-fA-F]{12}$"
        },
        "transactionDate": {
          "examples": [
            "2022-07-11T02:03:40"
          ],
          "type": "string",
          "format": "date-time"
        },
        "clientCode": {
          "examples": [
            "1799"
          ],
          "type": "string",
          "minLength": 1,
          "maxLength": 100,
          "format": "integer"
        },
        "clientName": {
          "examples": [
            "AcmeInc"
          ],
          "type": "string",
          "minLength": 1,
          "maxLength": 100
        },
        "vendorCode": {
          "examples": [
            "MC"
          ],
          "type": "string",
          "minLength": 1,
          "maxLength": 100
        },
        "vendorName": {
          "examples": [
            "Mortgage Connect"
          ],
          "type": "string",
          "minLength": 1,
          "maxLength": 100
        }
      },
      "required": [
        "transactionIdempotentId",
        "transactionDate",
        "clientCode",
        "clientName",
        "vendorCode",
        "vendorName"
      ],
      "minProperties": 6,
      "maxProperties": 6
    },
    "transactionBody": {
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "transactionCode": {
          "examples": [
            "Add-Note"
          ],
          "type": "string",
          "const": "Add-Note"
        },
        "transactionId": {
          "examples": [
            "7832143"
          ],
          "type": "string",
          "minLength": 1,
          "maxLength": 50
        },
        "productTransactionId": {
          "examples": [
            "7832143"
          ],
          "type": "string",
          "minLength": 0,
          "maxLength": 50
        },
        "orderNumber": {
          "examples": [
            "2429888"
          ],
          "type": "integer"
        },
        "productCode": {
          "type": "string",
          "minLength": 3,
          "maxLength": 4,
          "enum": [
            "LVR",
            "PRT",
            "PUR",
            "TTL"
          ]
        },
        "note": {
          "example": [
            "We have scheduled a trustees sale of the property."
          ],
          "type": "string"
        },
        "noteDate": {
          "example": [
            "07-11-2022T14:00:00-4:00"
          ],
          "type": "string",
          "format": "date-time"
        }
      },
      "required": [
        "transactionCode",
        "transactionId",
        "orderNumber",
        "productCode",
        "note",
        "noteDate"
      ]
    },
    "transactionExtensions": {
      "type": "object",
      "properties": {
        "transactionExtension": {
          "type": "array",
          "items": {
            "type": "object",
            "additionalProperties": false,
            "properties": {
              "key": {
                "examples": [
                  "Client Specific Key"
                ],
                "type": "string",
                "minLength": 1,
                "maxLength": 200
              },
              "value": {
                "examples": [
                  "Client Specific Value"
                ],
                "type": "string",
                "minLength": 1
              }
            },
            "required": [
              "key",
              "value"
            ],
            "minProperties": 2,
            "maxProperties": 2
          },
          "minItems": 0
        }
      }
    }
  },
  "required": [
    "transactionHeader",
    "transactionBody"
  ],
  "minProperties": 2,
  "maxProperties": 4
}
/* Copyright © 2023 Mortgage Connect LP */

The request payload XML schema validation is under construction. 🚧

✅ The following is an 'Accepted' example payload to be returned in the HTTP response.

Accepted Acknowledgment payloads are typically message type agnostic.

Accepted Acknowledgment payloads are typically message type agnostic.

⛔ The following is a 'Rejected' example payload to be returned in the HTTP response.

Rejected Acknowledgment payloads are typically message type agnostic.

Rejected Acknowledgment payloads are typically message type agnostic.

The Add Note API method is the mechanism in which a Client or Mortgage Connect can submit a message to add a note to the Title Order.

View Workflow Orchestration

Client URL

POST 🔒 To be determined during onboarding process.

Mortgage Connect URL

POST 🔒 https://{BaseUrl}/Api/V1.0/{ClientCode}/SubmitMessage

Mortgage Connect URL Properties

Property	Requirement	Description
BaseUrl	Required	A unique base Url that represents a specific Mortgage Connect endpoint and targeted environment.
ClientCode	Required	A unique code assigned to all clients that is used for identification, authentication, and customization purposes.

Property Definitions - Transaction Header

Defines the properties represented in the Transaction Header object (JSON) or node (XML). Note that this message artifact is identical for each and every message type.

View Transaction Header Details

Property Definitions - Transaction Body

Defines the properties represented in the Transaction Body object (JSON) or node (XML).

Property	Requirement	Data Type	Min / Max	Description
transactionBody	Required			A parent object (JSON) or node (XML) that contains the transaction metadata.
**transactionCode	Required	String	8 / 8	A static value of `Add-Note`. The transaction code is meant to identify the message type and the context or action that should be taken. In this context it implies that a note should be added to the Title Order. Possible Values: Add-Note
transactionId	Required	String	1 / 50	Represents the Client's unique order number.
productTransactionId	Optional	String	0 / 50	Represents the Client's unique product order number. Note that the `productTransactionId` field is not used in most circumstances. However, when there is a need to further differentiate order numbers at a product level, that share the same `transactionId`, (i.e. the primary order level id), then the `productTransactionId` can be used to ensure uniqueness across the integration transactions. This makes it possible for multiple orders of the same product type to be placed using the same `transactionId`. The use of the `productTransactionId` field and any specific workflow deviations will be vetted during the onboarding process.
orderNumber	Required	Integer		Represents Mortgage Connects unique order number.
productCode	Required	String	3 / 4	Represents Mortgage Connect's product code. Possible Values: LVR `LEGAL & VEString REPORT` PRT `PROPERTY REPORT` PUR `PURCHASE` TTL `TITLE INSURANCE` etc. Traditionally, clients use Mortgage Connects `Product Code` names and thus there is a one to one mapping relationship that is maintained by the client. However, Mortgage Connect is aware that our naming conventions may not resonate and that there are many inconsistencies in product code naming conventions and nomenclatures. It is for this reason that Mortgage Connect is able to map the client's product code to Mortgage Connect's product code to ease the transition. Any required product code mapping exercises will be addressed during the onboarding process. The supported `productCode`(s) are specific per integration and will be determined during the onboarding process. Note that the minimum/maximum length requirement of 3/4 is only applicable if using Mortgage Connect's internal product codes, otherwise when mapping to the client's product codes, the minimum/maximum is 1/50.
note	Required	String	1 / MAX	The actual note text to be associated with the Order/Product.
noteDate	Required	DateTime		The date when the note was entered.

Property Definitions - Transaction Extensions

Defines the properties represented in the TransactionExtensions object (JSON) or node (XML). Note that this message artifact is identical for each and every message type.

View Transaction Extension Details

Title - MC140 - Add Note Action

🌐 The following is an example payload to be posted in the body of the HTTP request.

/* Copyright © 2023 Mortgage Connect LP */
{
    "transactionHeader": {
        "transactionIdempotentId": "3B34A671-BB17-400D-90BF-7CBF9C96E8ED",
        "transactionDate": "2022-07-11T02:03:40",
        "clientCode": "1799",
        "clientName": "AcmeInc",
        "vendorCode": "MC",
        "vendorName": "Mortgage Connect"
    },
    "transactionBody": {
        "transactionCode": "Add-Note-Action",
        "transactionId": "7832143",
        "productTransactionId": "",
        "orderNumber": 2429888,
        "productCode": "TTL",
        "note": "Please call borrower immediately to confirm martial status.",
        "noteDate": "2022-10-19T14:00:00"
    },
    "transactionExtensions": {
        "transactionExtension": [
            {
                "key": "Client Specific Key 1",
                "value": "Client Specific Value 1"
            },
            {
                "key": "Client Specific Key 2",
                "value": "Client Specific Value 2"
            }
        ]
    }
}
/* Copyright © 2023 Mortgage Connect LP */

<!-- Copyright © 2023 Mortgage Connect LP -->
<root>
    <transactionHeader>
        <transactionIdempotentId>3B34A671-BB17-400D-90BF-7CBF9C96E8ED</transactionIdempotentId>
        <transactionDate>022-07-11T02:03:40</transactionDate>
        <clientCode>1799</clientCode>
        <clientName>AcmeInc</clientName>
        <vendorCode>MC</vendorCode>
        <vendorName>Mortgage Connect</vendorName>
    </transactionHeader>
    <transactionBody>
        <transactionCode>Add-Note-Action</transactionCode>
        <transactionId>7832143</transactionId>
        <productTransactionId></productTransactionId>
        <orderNumber>2429888</orderNumber>
        <productCode>TTL</productCode>
        <note>Please call borrower immediately to confirm martial status.</note>
        <noteDate>2022-10-19T14:00:00</noteDate>
    </transactionBody>
    <transactionExtensions>
        <transactionExtension>
            <key>Client Specific Key 1</key>
            <value>Client Specific Value 1</value>
        </transactionExtension>
        <transactionExtension>
            <key>Client Specific Key 2</key>
            <value>Client Specific Value 1</value>
        </transactionExtension>
    </transactionExtensions>
</root>
<!-- Copyright © 2023 Mortgage Connect LP -->

👍 The request payload can be verified using the following validation schema.

/* Copyright © 2023 Mortgage Connect LP */
{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "$id": "root",
  "description": "Copyright @ 2022 Mortgage Connect LP - Title & Tax Schema.",
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "legalHeader": {
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "version": {
          "examples": [
            "1.0.8.0"
          ],
          "type": "string",
          "minLength": 1,
          "maxLength": 20
        },
        "disclosingParty": {
          "examples": [
            "Copyright @ 2022 Mortgage Connect LP"
          ],
          "type": "string",
          "minLength": 1,
          "maxLength": 100
        },
        "proprietaryInformationAndConfidential": {
          "examples": [
            "Ownership of Proprietary Information. The Recipient agrees that it shall not receive any right, title or interest, or any license or right to use, the Disclosing Partys Proprietary Information, including, but not limited to, technology, ideas, concepts, drawings, documentation, designs, prototypes, processes, trade secrets, trademarks or other intellectual property rights therein, by implication or otherwise."
          ],
          "type": "string",
          "minLength": 1,
          "maxLength": 2000
        }
      },
      "required": [
        "version",
        "disclosingParty",
        "proprietaryInformationAndConfidential"
      ],
      "minProperties": 3,
      "maxProperties": 3
    },
    "transactionHeader": {
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "transactionIdempotentId": {
          "examples": [
            "3B34A671-BB17-400D-90BF-7CBF9C96E8ED"
          ],
          "type": "string",
          "minLength": 36,
          "maxLength": 36,
          "pattern": "^[\\da-fA-F]{8}-[\\da-fA-F]{4}-[\\da-fA-F]{4}-[\\da-fA-F]{4}-[\\da-fA-F]{12}$"
        },
        "transactionDate": {
          "examples": [
            "2022-07-11T02:03:40"
          ],
          "type": "string",
          "format": "date-time"
        },
        "clientCode": {
          "examples": [
            "1799"
          ],
          "type": "string",
          "minLength": 1,
          "maxLength": 100,
          "format": "integer"
        },
        "clientName": {
          "examples": [
            "AcmeInc"
          ],
          "type": "string",
          "minLength": 1,
          "maxLength": 100
        },
        "vendorCode": {
          "examples": [
            "MC"
          ],
          "type": "string",
          "minLength": 1,
          "maxLength": 100
        },
        "vendorName": {
          "examples": [
            "Mortgage Connect"
          ],
          "type": "string",
          "minLength": 1,
          "maxLength": 100
        }
      },
      "required": [
        "transactionIdempotentId",
        "transactionDate",
        "clientCode",
        "clientName",
        "vendorCode",
        "vendorName"
      ],
      "minProperties": 6,
      "maxProperties": 6
    },
    "transactionBody": {
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "transactionCode": {
          "examples": [
            "Add-Note-Action"
          ],
          "type": "string",
          "const": "Add-Note-Action"
        },
        "transactionId": {
          "examples": [
            "7832143"
          ],
          "type": "string",
          "minLength": 1,
          "maxLength": 50
        },
        "productTransactionId": {
          "examples": [
            "7832143"
          ],
          "type": "string",
          "minLength": 0,
          "maxLength": 50
        },
        "orderNumber": {
          "examples": [
            "2429888"
          ],
          "type": "integer"
        },
        "productCode": {
          "type": "string",
          "minLength": 3,
          "maxLength": 4,
          "enum": [
            "LVR",
            "PRT",
            "PUR",
            "TTL"
          ]
        },
        "note": {
          "example": [
            "We have scheduled a trustees sale of the property."
          ],
          "type": "string"
        },
        "noteDate": {
          "example": [
            "07-11-2022T14:00:00-4:00"
          ],
          "type": "string",
          "format": "date-time"
        }
      },
      "required": [
        "transactionCode",
        "transactionId",
        "orderNumber",
        "productCode",
        "note",
        "noteDate"
      ]
    },
    "transactionExtensions": {
      "type": "object",
      "properties": {
        "transactionExtension": {
          "type": "array",
          "items": {
            "type": "object",
            "additionalProperties": false,
            "properties": {
              "key": {
                "examples": [
                  "Client Specific Key"
                ],
                "type": "string",
                "minLength": 1,
                "maxLength": 200
              },
              "value": {
                "examples": [
                  "Client Specific Value"
                ],
                "type": "string",
                "minLength": 1
              }
            },
            "required": [
              "key",
              "value"
            ],
            "minProperties": 2,
            "maxProperties": 2
          },
          "minItems": 0
        }
      }
    }
  },
  "required": [
    "transactionHeader",
    "transactionBody"
  ],
  "minProperties": 2,
  "maxProperties": 4
}
/* Copyright © 2023 Mortgage Connect LP */

The request payload XML schema validation is under construction. 🚧

✅ The following is an 'Accepted' example payload to be returned in the HTTP response.

Accepted Acknowledgment payloads are typically message type agnostic.

Accepted Acknowledgment payloads are typically message type agnostic.

⛔ The following is a 'Rejected' example payload to be returned in the HTTP response.

Rejected Acknowledgment payloads are typically message type agnostic.

Rejected Acknowledgment payloads are typically message type agnostic.

The Add Note Action API method is the mechanism in which a Client or Mortgage Connect can submit a message to add a note to the Title Order with escalation.

View Workflow Orchestration

Client URL

POST 🔒 To be determined during onboarding process.

Mortgage Connect URL

POST 🔒 https://{BaseUrl}/Api/V1.0/{ClientCode}/SubmitMessage

Mortgage Connect URL Properties

Property	Requirement	Description
BaseUrl	Required	A unique base Url that represents a specific Mortgage Connect endpoint and targeted environment.
ClientCode	Required	A unique code assigned to all clients that is used for identification, authentication, and customization purposes.

Property Definitions - Transaction Header

Defines the properties represented in the Transaction Header object (JSON) or node (XML). Note that this message artifact is identical for each and every message type.

View Transaction Header Details

Property Definitions - Transaction Body

Defines the properties represented in the Transaction Body object (JSON) or node (XML).

Property	Requirement	Data Type	Min / Max	Description
transactionBody	Required			A parent object (JSON) or node (XML) that contains the transaction metadata.
transactionCode	Required	String	15 / 15	A static value of `Add-Note-Action`. The transaction code is meant to identify the message type and the context or action that should be taken. In this context it implies that a note should be added to the Title Order and it should be escalated to the proper personnel. Possible Values: Add-Note-Action
transactionId	Required	String	1 / 50	Represents the Client's unique order number.
productTransactionId	Optional	String	0 / 50	Represents the Client's unique product order number. Note that the `productTransactionId` field is not used in most circumstances. However, when there is a need to further differentiate order numbers at a product level, that share the same `transactionId`, (i.e. the primary order level id), then the `productTransactionId` can be used to ensure uniqueness across the integration transactions. This makes it possible for multiple orders of the same product type to be placed using the same `transactionId`. The use of the `productTransactionId` field and any specific workflow deviations will be vetted during the onboarding process.
orderNumber	Required	Integer		Represents Mortgage Connects unique order number.
productCode	Required	String	3 / 4	Represents Mortgage Connect's product code. Possible Values: LVR `LEGAL & VEString REPORT` PRT `PROPERTY REPORT` PUR `PURCHASE` TTL `TITLE INSURANCE` etc. Traditionally, clients use Mortgage Connects `Product Code` names and thus there is a one to one mapping relationship that is maintained by the client. However, Mortgage Connect is aware that our naming conventions may not resonate and that there are many inconsistencies in product code naming conventions and nomenclatures. It is for this reason that Mortgage Connect is able to map the client's product code to Mortgage Connect's product code to ease the transition. Any required product code mapping exercises will be addressed during the onboarding process. The supported `productCode`(s) are specific per integration and will be determined during the onboarding process. Note that the minimum/maximum length requirement of 3/4 is only applicable if using Mortgage Connect's internal product codes, otherwise when mapping to the client's product codes, the minimum/maximum is 1/50.
note	Required	String	1 / MAX	The actual text to be associated with the Order/Product.
noteDate	Required	DateTime		The date when the note was entered.

Property Definitions - Transaction Extensions

Defines the properties represented in the TransactionExtensions object (JSON) or node (XML). Note that this message artifact is identical for each and every message type.

View Transaction Extension Details

Title - MC150 - Add Attachment

🌐 The following is an example payload to be posted in the body of the HTTP request.

/* Copyright © 2023 Mortgage Connect LP */
{
    "transactionHeader": {
        "transactionIdempotentId": "3B34A671-BB17-400D-90BF-7CBF9C96E8ED",
        "transactionDate": "2022-07-11T02:03:40",
        "clientCode": "1799",
        "clientName": "AcmeInc",
        "vendorCode": "MC",
        "vendorName": "Mortgage Connect"
    },
    "transactionBody": {
        "transactionCode": "Add-Attachment",
        "transactionId": "7832143",
        "productTransactionId": "",
        "orderNumber": 2429888,
        "productCode": "TTL",
        "documents": {
            "document": [
                {
                    "documentId": "1243992",
                    "type": "Patriot Search",
                    "name": "Patriot-Search.pdf",
                    "fileType": "PDF",
                    "contentMediaType": "application/pdf",
                    "contentUnicodeTextEncodingType": "UTF8",
                    "contentBinaryEncodingType": "Base64",
                    "content": "Base64 String",
                    "description": "Brief overview of the document"
                }
            ]
        }
    },
    "transactionExtensions": {
        "transactionExtension": [
            {
                "key": "Client Specific Key 1",
                "value": "Client Specific Value 1"
            },
            {
                "key": "Client Specific Key 2",
                "value": "Client Specific Value 2"
            }
        ]
    }
}
/* Copyright © 2023 Mortgage Connect LP */

<!-- Copyright © 2023 Mortgage Connect LP -->
<root>
    <transactionHeader>
        <transactionIdempotentId>3B34A671-BB17-400D-90BF-7CBF9C96E8ED</transactionIdempotentId>
        <transactionDate>2022-07-11T02:03:40</transactionDate>
        <clientCode>1799</clientCode>
        <clientName>AcmeInc</clientName>
        <vendorCode>MC</vendorCode>
        <vendorName>Mortgage Connect</vendorName>
    </transactionHeader>
    <transactionBody>
        <transactionCode>Add-Attachment</transactionCode>
        <transactionId>7832143</transactionId>
        <productTransactionId></productTransactionId>
        <orderNumber>2429888</orderNumber>
        <productCode>TTL</productCode>
        <documents>
            <document>
                <documentId>1243992</documentId>
                <type>Patriot Search</type>
                <name>Patriot-Search.pdf</name>
                <fileType>PDF</fileType>
                <contentMediaType>application/pdf</contentMediaType>
                <contentUnicodeTextEncodingType>UTF8</contentUnicodeTextEncodingType>
                <contentBinaryEncodingType>Base64</contentBinaryEncodingType>
                <content>Base64 String</content>
                <description>Brief overview of the document</description>
            </document>
        </documents>
    </transactionBody>
    <transactionExtensions>
        <transactionExtension>
            <key>Client Specific Key 1</key>
            <value>Client Specific Value 1</value>
        </transactionExtension>
        <transactionExtension>
            <key>Client Specific Key 2</key>
            <value>Client Specific Value 1</value>
        </transactionExtension>
    </transactionExtensions>
</root>
<!-- Copyright © 2023 Mortgage Connect LP -->

👍 The request payload can be verified using the following validation schema.

/* Copyright © 2023 Mortgage Connect LP */
{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "$id": "root",
  "description": "Copyright @ 2022 Mortgage Connect LP - Title & Tax Schema.",
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "legalHeader": {
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "version": {
          "examples": [
            "1.0.8.0"
          ],
          "type": "string",
          "minLength": 1,
          "maxLength": 20
        },
        "disclosingParty": {
          "examples": [
            "Copyright @ 2022 Mortgage Connect LP"
          ],
          "type": "string",
          "minLength": 1,
          "maxLength": 100
        },
        "proprietaryInformationAndConfidential": {
          "examples": [
            "Ownership of Proprietary Information. The Recipient agrees that it shall not receive any right, title or interest, or any license or right to use, the Disclosing Partys Proprietary Information, including, but not limited to, technology, ideas, concepts, drawings, documentation, designs, prototypes, processes, trade secrets, trademarks or other intellectual property rights therein, by implication or otherwise."
          ],
          "type": "string",
          "minLength": 1,
          "maxLength": 2000
        }
      },
      "required": [
        "version",
        "disclosingParty",
        "proprietaryInformationAndConfidential"
      ],
      "minProperties": 3,
      "maxProperties": 3
    },
    "transactionHeader": {
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "transactionIdempotentId": {
          "examples": [
            "3B34A671-BB17-400D-90BF-7CBF9C96E8ED"
          ],
          "type": "string",
          "minLength": 36,
          "maxLength": 36,
          "pattern": "^[\\da-fA-F]{8}-[\\da-fA-F]{4}-[\\da-fA-F]{4}-[\\da-fA-F]{4}-[\\da-fA-F]{12}$"
        },
        "transactionDate": {
          "examples": [
            "2022-07-11T02:03:40"
          ],
          "type": "string",
          "format": "date-time"
        },
        "clientCode": {
          "examples": [
            "1799"
          ],
          "type": "string",
          "minLength": 1,
          "maxLength": 100,
          "format": "integer"
        },
        "clientName": {
          "examples": [
            "AcmeInc"
          ],
          "type": "string",
          "minLength": 1,
          "maxLength": 100
        },
        "vendorCode": {
          "examples": [
            "MC"
          ],
          "type": "string",
          "minLength": 1,
          "maxLength": 100
        },
        "vendorName": {
          "examples": [
            "Mortgage Connect"
          ],
          "type": "string",
          "minLength": 1,
          "maxLength": 100
        }
      },
      "required": [
        "transactionIdempotentId",
        "transactionDate",
        "clientCode",
        "clientName",
        "vendorCode",
        "vendorName"
      ],
      "minProperties": 6,
      "maxProperties": 6
    },
    "transactionBody": {
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "transactionCode": {
          "examples": [
            "Add-Attachment"
          ],
          "type": "string",
          "const": "Add-Attachment"
        },
        "transactionId": {
          "examples": [
            "7832143"
          ],
          "type": "string",
          "minLength": 1,
          "maxLength": 50
        },
        "productTransactionId": {
          "examples": [
            "7832143"
          ],
          "type": "string",
          "minLength": 0,
          "maxLength": 50
        },
        "orderNumber": {
          "examples": [
            "2429888"
          ],
          "type": "integer"
        },
        "productCode": {
          "type": "string",
          "minLength": 3,
          "maxLength": 4,
          "enum": [
            "LVR",
            "PRT",
            "PUR",
            "TTL"
          ]
        },
        "documents": {
          "type": "object",
          "properties": {
            "document": {
              "type": "array",
              "items": {
                "type": "object",
                "properties": {
                  "documentId": {
                    "examples": [
                      "1243992"
                    ],
                    "type": "string"
                  },
                  "type": {
                    "type": "string",
                    "minLength": 0,
                    "maxLength": 0,
                    "enum": [
                      "Other"
                    ]
                  },
                  "name": {
                    "examples": [
                      "patriot-search.pdf"
                    ],
                    "type": "string",
                    "maxLength": 100
                  },
                  "fileType": {
                    "type": "string",
                    "enum": [
                      "DOC",
                      "DOCX",
                      "PDF",
                      "doc",
                      "docx",
                      "pdf"
                    ]
                  },
                  "contentMediaType": {
                    "type": "string",
                    "enum": [
                      "application/msword",
                      "application/vnd.openxmlformats-officedocument.wordprocessingml.document",
                      "application/pdf"
                    ]
                  },
                  "contentUnicodeTextEncodingType": {
                    "type": "string",
                    "enum": [
                      "UTF8"
                    ]
                  },
                  "contentBinaryEncodingType": {
                    "type": "string",
                    "enum": [
                      "Base64"
                    ]
                  },
                  "content": {
                    "contentEncoding": "base64",
                    "type": "string"
                  },
                  "description": {
                    "type": "string",
                    "maxLength": 255
                  }
                },
                "allOf": [
                  {
                    "if": {
                      "properties": { "fileType": { "enum": [ "DOC", "doc" ] } }
                    },
                    "then": {
                      "properties": { "contentMediaType": { "enum": [ "application/msword" ] } }
                    }
                  },
                  {
                    "if": {
                      "properties": { "fileType": { "enum": [ "DOCX", "docx" ] } }
                    },
                    "then": {
                      "properties": { "contentMediaType": { "enum": [ "application/vnd.openxmlformats-officedocument.wordprocessingml.document" ] } }
                    }
                  },
                  {
                    "if": {
                      "properties": { "fileType": { "enum": [ "PDF", "pdf" ] } }
                    },
                    "then": {
                      "properties": { "contentMediaType": { "enum": [ "application/pdf" ] } }
                    }
                  }
                ],
                "required": [
                  "documentId",
                  "type",
                  "name",
                  "fileType",
                  "contentMediaType",
                  "contentUnicodeTextEncodingType",
                  "contentBinaryEncodingType",
                  "content"
                ]
              },
              "minItems": 1
            }
          }
        }
      },
      "required": [
        "transactionCode",
        "transactionId",
        "orderNumber",
        "productCode",
        "documents"
      ]
    },
    "transactionExtensions": {
      "type": "object",
      "properties": {
        "transactionExtension": {
          "type": "array",
          "items": {
            "type": "object",
            "additionalProperties": false,
            "properties": {
              "key": {
                "examples": [
                  "Client Specific Key"
                ],
                "type": "string",
                "minLength": 1,
                "maxLength": 200
              },
              "value": {
                "examples": [
                  "Client Specific Value"
                ],
                "type": "string",
                "minLength": 1
              }
            },
            "required": [
              "key",
              "value"
            ],
            "minProperties": 2,
            "maxProperties": 2
          },
          "minItems": 0
        }
      }
    }
  },
  "required": [
    "transactionHeader",
    "transactionBody"
  ],
  "minProperties": 2,
  "maxProperties": 4
}
/* Copyright © 2023 Mortgage Connect LP */

The request payload XML schema validation is under construction. 🚧

✅ The following is an 'Accepted' example payload to be returned in the HTTP response.

Accepted Acknowledgment payloads are typically message type agnostic.

Accepted Acknowledgment payloads are typically message type agnostic.

⛔ The following is a 'Rejected' example payload to be returned in the HTTP response.

Rejected Acknowledgment payloads are typically message type agnostic.

Rejected Acknowledgment payloads are typically message type agnostic.

The Add Attachment API method is the mechanism in which a Client or Mortgage Connect can submit a message to add a document to a Title Order.

View Workflow Orchestration

Client URL

POST 🔒 To be determined during onboarding process.

Mortgage Connect URL

POST 🔒 https://{BaseUrl}/Api/V1.0/{ClientCode}/SubmitMessage

Mortgage Connect URL Properties

Property	Requirement	Description
BaseUrl	Required	A unique base Url that represents a specific Mortgage Connect endpoint and targeted environment.
ClientCode	Required	A unique code assigned to all clients that is used for identification, authentication, and customization purposes.

Property Definitions - Transaction Header

Defines the properties represented in the Transaction Header object (JSON) or node (XML). Note that this message artifact is identical for each and every message type.

View Transaction Header Details

Property Definitions - Transaction Body

Defines the properties represented in the Transaction Body object (JSON) or node (XML).

Property	Requirement	Data Type	Min / Max	Description
transactionBody	Required			A parent object (JSON) or node (XML) that contains the transaction metadata.
transactionCode	Required	String	14 / 14	A static value of `Add-Attachment`. The transaction code is meant to identify the message type and the context or action that should be taken. In this context it implies that an attachment should be added to the Title Order. Possible Values: Add-Attachment
transactionId	Required	String	1 / 50	Represents the Client's unique order number.
productTransactionId	Optional	String	0 / 50	Represents the Client's unique product order number. Note that the `productTransactionId` field is not used in most circumstances. However, when there is a need to further differentiate order numbers at a product level, that share the same `transactionId`, (i.e. the primary order level id), then the `productTransactionId` can be used to ensure uniqueness across the integration transactions. This makes it possible for multiple orders of the same product type to be placed using the same `transactionId`. The use of the `productTransactionId` field and any specific workflow deviations will be vetted during the onboarding process.
orderNumber	Required	Integer		Represents Mortgage Connects unique order number.
productCode	Required	String	3 / 4	Represents Mortgage Connect's product code. Possible Values: LVR `LEGAL & VEString REPORT` PRT `PROPERTY REPORT` PUR `PURCHASE` TTL `TITLE INSURANCE` etc. Traditionally, clients use Mortgage Connects `Product Code` names and thus there is a one to one mapping relationship that is maintained by the client. However, Mortgage Connect is aware that our naming conventions may not resonate and that there are many inconsistencies in product code naming conventions and nomenclatures. It is for this reason that Mortgage Connect is able to map the client's product code to Mortgage Connect's product code to ease the transition. Any required product code mapping exercises will be addressed during the onboarding process. The supported `productCode`(s) are specific per integration and will be determined during the onboarding process. Note that the minimum/maximum length requirement of 3/4 is only applicable if using Mortgage Connect's internal product codes, otherwise when mapping to the client's product codes, the minimum/maximum is 1/50.
documents	Require			A parent object (JSON) or node (XML) that contains a list of document metadata. `(1 to Many)`
document	Required			A parent object (JSON) or node (XML) that contains the metadata associated with a single document.
documentId	Required	String	1/36	A number or string that uniquely identifies the document within the host system. When an outbound Add-Attachment event is sent by Mortgage Connect to the Client, the documentId will be a string in the form of an integer. The integer value represents the Identity Field and Primary Key associated with the corresponding document record. Likewise, when the Client sends Mortgage Connect an Add-Attachment event, the documentId could also represent an Integer, however, there is no reason why the value could not be a unique string like a GUID. No matter what value is passed, the value needs to represent a unique value that uniquely identifies the attached document. There is no hard requirement to capture this information. However, both parties are encouraged to do so, in order that conversations or any triaging of exceptions around these values can be correlated across systems.
type	Required	String	1 / 255	A name that uniquely identifies the document type. Traditionally, clients use Mortgage Connects `Document Type` names and thus there is a one to one mapping relationship that is maintained by the client. However, Mortgage Connect is aware that our naming conventions may not resonate and that there are many inconsistencies in document type naming conventions and nomenclatures. It is for this reason that Mortgage Connect is able to map the client's document type to Mortgage Connect's document type to ease the transition. Any required document mapping exercises will be addressed during the onboarding process. The supported `types`(s) are specific per integration and will be determined during the onboarding process.
name	Required	String	1 / 100	This is the user friendly name that is associated with the document.
fileType	Required	String	3 / 4	This indicates what type of document it is. This in the context of what the file extension represents. Possible Values: DOC DOCX PDF Future Values: CSV HTML JSON TXT XLS XLSX XML `DOC`, `DOCX`, and `PDF` are currently supported with the vast majority of the documents being delivered as `PDF` documents. The other types are included to support additional documents in the future.
contentMediaType	Required	String	1 / 100	This represents the content media type, i.e. `MIME Type`. Possible Values: application/msword (DOC) application/vnd.openxmlformats-officedocument.wordprocessingml.document (DOCX) application/pdf (PDF) Future Values: text/csv (CSV) text/html (HTML) application/json (JSON) text/plain (TXT) application/vnd.ms-excel (XLS) application/vnd.openxmlformats-officedocument.spreadsheetml.sheet (XLSX) application/xml (XML) At this time `application/msword (DOC)`, `application/vnd.openxmlformats-officedocument.wordprocessingml.document (DOCX)`, and `application/pdf (PDF)` are supported with `application/pdf (PDF)` being used 90+% of the time. The other types are added to support future media types.
contentUnicode TextEncodingType	Required	String	4 / 4	This indicates what unicode text encoding type was used to generate the document. Possible Values: UTF8
contentBinary EncodingType	Required	String	6 / 6	This indicates what binary encoding type was used to generate the document content. Possible Values: Base64
content	Required	String	1 / MAX	This represents the digital representation of the document after it has been encoded using Base64. See: https://en.wikipedia.org/wiki/Base64 for more information regarding Base64 formatting.
description	Optional	String	0 / 255	Provides a brief overview of the document contents.

Property Definitions - Transaction Extensions

Defines the properties represented in the TransactionExtensions object (JSON) or node (XML). Note that this message artifact is identical for each and every message type.

View Transaction Extension Details

Title - MC160 - Product Delivery

🌐 The following is an example payload to be posted in the body of the HTTP request.

/* Copyright © 2023 Mortgage Connect LP */
{
    "transactionHeader": {
        "transactionIdempotentId": "3B34A671-BB17-400D-90BF-7CBF9C96E8ED",
        "transactionDate": "2022-07-11T02:03:40",
        "clientCode": "1799",
        "clientName": "AcmeInc",
        "vendorCode": "MC",
        "vendorName": "Mortgage Connect"
    },
    "transactionBody": {
        "transactionCode": "Product-Delivery",
        "transactionId": "7832143",
        "productTransactionId": "",
        "orderNumber": 2429888,
        "itemNumber": 1,
        "productCode": "TTL",
        "loanNumber": "7313993",
        "propertyType": "Single Family",
        "estateOwnership": "Fee Simple",
        "openDate": "05/10/2022",
        "legalDescription": "Being the same property as conveyed from Katie to John as set forth in Deed Instrument #18 dated 06/02/2022, recorded 06/02/2022, Allegheny County, PENNSYLVANIA.",
        "shortLegalDescription": "Deed Instrument #18 dated 06/02/2022, recorded 06/02/2022, Allegheny County",
        "landRecordsType": "Torrens",
        "transferCertTitleNumber": "53867",
        "lot": "127",
        "block": "1100",
        "censusTract": "6032.02",
        "isTrust": true,
        "projectName": "Fernbrook III Condominiums",
        "acreage": "1.52",
        "titleEffectiveDate": "06/01/2022",
        "liabilityAmount": "250000",
        "comments":"tax comment",
        "etaTaxDate":"TBD",       
        "propertyInfo": {
            "address1": "1204 New York Drive",
            "city": "Mckees Rocks",
            "state": "PA",
            "zipCode": "15136",
            "county": "Allegheny"
        },
        "title": {
            "deeds": {
                "deed": [
                    {
                        "grantee": "Jim",
                        "grantor": "Laker",
                        "deedDate": "05/10/2022",
                        "book": "11",
                        "page": "12",
                        "instrument": "234",
                        "recordedDate": "05/10/2022",
                        "considerationAmount": 0,
                        "currentDeed": false,
                        "deedType": "Warranty",
                        "comments": "Deed created on 05/10/2022"
                    },
                    {
                        "grantee": "John",
                        "grantor": "Katie",
                        "deedDate": "06/02/2022",
                        "book": "15",
                        "page": "16",
                        "instrument": "18",
                        "recordedDate": "06/02/2022",
                        "considerationAmount": 25000,
                        "currentDeed": true,
                        "deedType": "Grant Deed",
                        "comments": "Deed created on 06/02/2022"
                    }
                ]
            },
            "judgmentsAndLiens": {
                "judgmentsAndLien": [
                    {
                        "plaintiff": "Shart",
                        "defendant": "Sura",
                        "datedDate": "06/01/2022",
                        "book": "11",
                        "page": "12",
                        "instrument": "14",
                        "recordedDate": "06/01/2022",
                        "amount": 50000,
                        "docketNumber": "DN12345",
                        "lienType": "Judgment"
                    },
                    {
                        "plaintiff": "Jefferson",
                        "defendant": "Donald",
                        "datedDate": "06/01/2022",
                        "book": "31",
                        "page": "32",
                        "instrument": "34",
                        "recordedDate": "06/01/2022",
                        "amount": 25000,
                        "docketNumber": "2016-U-409",
                        "lienType": "Judgment"
                    }
                ]
            },
            "mortgages": {
                "mortgage": [
                    {
                        "mortgagee": "Baro",
                        "mortgagor": "Lopez",
                        "datedDate": "05/10/2022",
                        "book": "56",
                        "page": "57",
                        "instrument": "23432432",
                        "recordedDate": "05/10/2022",
                        "taxPaid": 423423,
                        "amount": 333330,
                        "mersIndicator": true,
                        "mers": "Redacted",
                        "openEnded": true,
                        "trustee": {
                            "name": "John",
                            "trusteeAddress": {
                                "address1": "1204 New York Drive",
                                "address2": "",
                                "city": "Mckees Rocks",
                                "state": "PA",
                                "zipCode": "15136",
                                "county": ""
                            }
                        },
                        "comments": "Gracia and Lopez",
                        "texas50A6": true,
                        "subjectMortgage": false,
                        "isConsolidated": false,
                        "position": "1",
                        "mortgagorDetails": {
                            "mortgagorDetail": [
                                {
                                    "entityType": "Corporation",
                                    "firstName": "Garcia",
                                    "middleName": "M",
                                    "lastName": "TEST"
                                },
                                {
                                    "entityType": "Individual/Entity",
                                    "firstName": "Oscar",
                                    "middleName": "Oscar M",
                                    "lastName": "TEST"
                                }
                            ]
                        },
                        "mortgageAssignments": {
                            "mortgageAssignment": [
                                {
                                    "assignor": "Michell",
                                    "assignee": "TEST",
                                    "datedDate": "06/01/2022",
                                    "book": "61",
                                    "page": "62",
                                    "instrument": "64",
                                    "recordedDate": "06/01/2022",
                                    "type": "MORTGAGE"
                                },
                                {
                                    "assignor": "Arnold",
                                    "assignee": "TEST",
                                    "datedDate": "05/30/2022",
                                    "book": "71",
                                    "page": "72",
                                    "instrument": "74",
                                    "recordedDate": "05/31/2022",
                                    "type": "Name Affidavit"
                                }
                            ]
                        },
                        "mortgageModifications": {
                            "mortgageModification": [
                                {
                                    "modFrom": "Gracia",
                                    "modTo": "Lopez",
                                    "datedDate": "06/01/2022",
                                    "book": "31",
                                    "page": "32",
                                    "instrument": "34",
                                    "recordedDate": "06/01/2022",
                                    "amount": 17500
                                },
                                {
                                    "modFrom": "Lopez",
                                    "modTo": "Gracia",
                                    "datedDate": "06/01/2022",
                                    "book": "51",
                                    "page": "52",
                                    "instrument": "55",
                                    "recordedDate": "06/01/2022",
                                    "amount": 25000
                                }
                            ]
                        },
                        "mortgageSubordinates": {
                            "mortgageSubordinate": [
                                {
                                    "mortgage": "(2022) John",
                                    "subordinatedTo": "(2022) Garcia",
                                    "datedDate": "06/02/2022",
                                    "book": "11",
                                    "page": "12",
                                    "instrument": "14",
                                    "recordedDate": "06/02/2022"
                                },
                                {
                                    "mortgage": "(2022) John",
                                    "subordinatedTo": "(2022) TEST MORTGAGE CORPORATION",
                                    "datedDate": "06/03/2022",
                                    "book": "51",
                                    "page": "52",
                                    "instrument": "54",
                                    "recordedDate": "06/03/2022"
                                }
                            ]
                        }
                    },
                    {
                        "mortgagee": "John",
                        "mortgagor": "Donell",
                        "datedDate": "05/31/2022",
                        "book": "41",
                        "page": "42",
                        "instrument": "25",
                        "recordedDate": "05/31/2022",
                        "taxPaid": 30000,
                        "amount": 500000,
                        "mersIndicator": true,
                        "mers": "Redacted",
                        "openEnded": false,
                        "trustee": {
                            "name": "Mitchell",
                            "trusteeAddress": {
                                "address1": "1204 New York Drive",
                                "address2": "",
                                "city": "Mckees Rocks",
                                "state": "PA",
                                "zipCode": "15136",
                                "county": ""
                            }
                        },
                        "comments": "John and Donell",
                        "texas50A6": true,
                        "subjectMortgage": false,
                        "isConsolidated": false,
                        "position": "1",
                        "mortgagorDetails": {
                            "mortgagorDetail": [
                                {
                                    "entityType": "Individual/Entity",
                                    "firstName": "John",
                                    "middleName": "M",
                                    "lastName": "Donell"
                                }
                            ]
                        }
                    },
                    {
                        "mortgagee": "TEST MORTGAGE CORPORATION",
                        "mortgagor": "Clarke",
                        "datedDate": "06/01/2022",
                        "book": "41",
                        "page": "42",
                        "instrument": "44",
                        "recordedDate": "06/01/2022",
                        "taxPaid": 0,
                        "amount": 55000,
                        "mersIndicator": true,
                        "mers": "Redacted",
                        "openEnded": false,
                        "trustee": {
                            "name": "",
                            "trusteeAddress": {
                                "address1": "",
                                "address2": "",
                                "city": "",
                                "state": "",
                                "zipCode": "",
                                "county": ""
                            }
                        },
                        "comments": "",
                        "texas50A6": true,
                        "subjectMortgage": false,
                        "isConsolidated": "",
                        "position": "1",
                        "mortgageAssignments": {
                            "mortgageAssignment": [
                                {
                                    "assignor": "Arnold",
                                    "assignee": "ORurke",
                                    "datedDate": "06/01/2022",
                                    "book": "81",
                                    "page": "82",
                                    "instrument": "84",
                                    "recordedDate": "06/01/2022",
                                    "type": "INVOICE"
                                }
                            ]
                        },
                        "mortgageModifications": {
                            "mortgageModification": [
                                {
                                    "modFrom": "Aditya Sain",
                                    "modTo": "TEST Mortgage Corporation",
                                    "datedDate": "06/01/2022",
                                    "book": "11",
                                    "page": "569",
                                    "instrument": "14",
                                    "recordedDate": "06/01/2022",
                                    "amount": 15000
                                }
                            ]
                        },
                        "mortgageSubordinates": {
                            "mortgageSubordinate": [
                                {
                                    "mortgage": "(2022) TEST MORTGAGE CORPORATION",
                                    "subordinatedTo": "(2022) Garcia",
                                    "datedDate": "06/03/2022",
                                    "book": "61",
                                    "page": "62",
                                    "instrument": "64",
                                    "recordedDate": "06/03/2022"
                                }
                            ]
                        }
                    }
                ]
            },
            "mortgageRecordings": {
                "mortgageRecording": [
                    {
                        "mortgagor": "Manish Gupta and spouse if any",
                        "mortgagee": "TEST MORTGAGE CORPORATION",
                        "datedDate": "04/23/2021",
                        "book": "748",
                        "page": "68",
                        "instrument": "2175315477",
                        "recordedDate": "05/10/2022",
                        "entryType": "Modification Agreement",
                        "amount": 1200
                    },
                    {
                        "mortgagor": "Manish Gupta and spouse if any",
                        "mortgagee": "TEST MORTGAGE CORPORATION",
                        "datedDate": "04/23/2021",
                        "book": "21",
                        "page": "22",
                        "instrument": "24",
                        "recordedDate": "",
                        "entryType": "Modification Agreement",
                        "amount": 1200
                    },
                    {
                        "mortgagor": "Manish Gupta and spouse if any",
                        "mortgagee": "TEST MORTGAGE CORPORATION",
                        "datedDate": "04/23/2021",
                        "book": "91",
                        "page": "92",
                        "instrument": "94",
                        "recordedDate": "",
                        "entryType": "Modification Agreement",
                        "amount": 1200
                    }
                ]
            },
            "requirements": {
                "requirement": [
                    {
                        "description": "Daniel's Law",
                        "text": "You must tell us in writing the name of anyone referred to in this Commitment who is or may be an individual protected by the provisions of any Address Confidentiality Program that applies to recorded documents.. We may then make additional requirements or exceptions."
                    },
                    {
                        "description": "Additional Party Being Added (Standard)",
                        "text": "The company must be notified of all parties being added to title, prior to the loan closing.  A judgment search must be completed for any parties being added to title.  The company reserves the right to add additional requirements and/or exceptions as may be deemed necessary, upon review of the judgment search."
                    }
                ]
            },
            "exceptions": {
                "exception": [
                    {
                        "description": "Rights or Claims Omission(standard)",
                        "text": "Rights or claims of parties in possession not shown by the public records."
                    },
                    {
                        "description": "Spousal",
                        "text": "Rights of dower, homestead or other marital right of the spouse, if any, of any individual insured."
                    }
                ]
            },
            "borrowers": {
                "borrower": [
                    {
                        "firstName": "Johnny",
                        "middleName": "J",
                        "lastName": "Doe",
                        "suffix": "Sr.",
                        "type": "Borrower",
                        "email": "johnnydoe@gmail.com",
                        "cellPhone": "724-323-4234",
                        "ssn": "111-11-1111",
                        "maritalStatus": "Married",
                        "dateOfBirth": "7/4/1965",
                        "borrowerAddress": {
                            "address1": "100 Willow St",
                            "address2": "",
                            "city": "Shawnee",
                            "state": "CA",
                            "zipCode": "93950",
                            "county": "Monterey"
                        }
                    },
                    {
                        "firstName": "Janie",
                        "middleName": "J",
                        "lastName": "Doe",
                        "type": "Borrower",
                        "email": "janiedoe@gmail.com",
                        "cellPhone": "724-123-4545",
                        "ssn": "222-22-2222",
                        "maritalStatus": "Married",
                        "dateOfBirth": "9/22/1967",
                        "borrowerAddress": {
                            "address1": "100 Willow St",
                            "address2": "",
                            "city": "Shawnee",
                            "state": "CA",
                            "zipCode": "93950",
                            "county": "Monterey"
                        }
                    }
                ]
            },
            "parties": {
                "party": [
                    {
                        "sequenceNo": 1,
                        "firstName": "John",
                        "lastName": "Doe",
                        "phone": "724-420-3341",
                        "email": "johndoe@acmeinc.com",
                        "role": "Processor"
                    },
                    {
                        "sequenceNo": 2,
                        "firstName": "Jane",
                        "lastName": "Doe",
                        "phone": "724-420-1833",
                        "email": "janedoe@acmeinc.com",
                        "role": "LoanOfficer"
                    }
                ]
            },
            "documents": {
                "document": [
                    {
                        "documentId": "1734433",
                        "type": "Property Report",
                        "name": "property-report.pdf",
                        "fileType": "PDF",
                        "contentMediaType": "application/pdf",
                        "contentUnicodeTextEncodingType": "UTF8",
                        "contentBinaryEncodingType": "Base64",
                        "content": "Base64 String",
                        "description": "Brief overview of the document"
                    }
                ]
            }
        },
        "tax": {
            "taxParsedAddress": {
                "address1": "1204 New York Drive",
                "city": "Mckees Rocks",
                "state": "PA",
                "county": "Allegheny",
                "zipCode": "15136",
                "countyFips": "42003",
                "stateFips": "42"
            },
            "taxAssessment": {
                "assessmentArea": "McKeesport",
                "address1": "1204",
                "address2": "NEW YORK DRIVE",
                "city": "MCKEES ROCKS",
                "state": "PA",
                "zipCode": "15136"
            },
            "taxDetails": {
                "taxDetail": [
                    {
                        "receivedDate": "",
                        "taxAPN": "12345",
                        "taxInstallments": {
                            "taxSupplementalAPN": "12345",
                            "improvementValue": 6000,
                            "landValue": 5000,
                            "assessedTotalValue": 11000,
                            "taxInstallmentDetails": {
                                "taxInstallmentDetail": [
                                    {
                                        "authorities": "Jackson County Collector",
                                        "taxPeriod": "Quarterly",
                                        "taxYear": "2022",
                                        "amount": 25000,
                                        "status": "Delinquent",
                                        "paymentDate": "06/30/2022",
                                        "amountDue": 0,
                                        "dueDate": "06/30/2022",
                                        "delinquentDate": "08/01/2022",
                                        "penaltyDate": "07/01/2022",
                                        "penalty": 0
                                    },
                                    {
                                        "authorities": "Jackson County Collector",
                                        "taxPeriod": "Semi-Annual",
                                        "taxYear": "2022",
                                        "amount": 12500,
                                        "status": "Paid",
                                        "paymentDate": "06/01/2022",
                                        "amountDue": 0,
                                        "dueDate": "06/30/2022",
                                        "delinquentDate": "09/01/2022",
                                        "penaltyDate": "08/01/2022",
                                        "penalty": 0
                                    }
                                ]
                            }
                        }
                    },
                    {
                        "receivedDate": "",
                        "taxAPN": "45678",
                        "taxInstallments": {
                            "taxSupplementalAPN": "45678",
                            "improvementValue": 14000,
                            "landValue": 12000,
                            "assessedTotalValue": 26000,
                            "taxInstallmentDetails": {
                                "taxInstallmentDetail": [
                                    {
                                        "authorities": "Jackson County Collector",
                                        "taxPeriod": "Other",
                                        "taxYear": "2021",
                                        "amount": 25000,
                                        "status": "Exempt",
                                        "paymentDate": "06/22/2022",
                                        "amountDue": 0,
                                        "dueDate": "06/30/2022",
                                        "delinquentDate": "09/01/2022",
                                        "penaltyDate": "08/01/2022",
                                        "penalty": 0
                                    }
                                ]
                            }
                        }
                    }
                ]
            },
            "documents": {
                "document": [
                    {
                        "documentId": "1734409",
                        "type": "Tax Invoice",
                        "name": "tax-invoice.pdf",
                        "fileType": "PDF",
                        "contentMediaType": "application/pdf",
                        "contentUnicodeTextEncodingType": "UTF8",
                        "contentBinaryEncodingType": "Base64",
                        "content": "Base64 String",
                        "description": "Brief overview of the document"
                    }
                ]
            }
        }
    },
    "transactionExtensions": {
        "transactionExtension": [
            {
                "key": "Client Specific Key 1",
                "value": "Client Specific Value 1"
            },
            {
                "key": "Client Specific Key 2",
                "value": "Client Specific Value 2"
            }
        ]
    }
}
/* Copyright © 2023 Mortgage Connect LP */

<!-- Copyright © 2023 Mortgage Connect LP -->
<root>
    <transactionHeader>
        <transactionIdempotentId>3B34A671-Bb17-400D-90Bf-7Cbf9C96E8Ed</transactionIdempotentId>
        <transactionDate>2022-07-11T02:03:40</transactionDate>
        <clientCode>1799</clientCode>
        <clientName>Acmeinc</clientName>
        <vendorCode>MC</vendorCode>
        <vendorName>Mortgage Connect</vendorName>
    </transactionHeader>
    <transactionBody>
        <transactionCode>Product-Delivery</transactionCode>
        <transactionId>7832143</transactionId>
        <productTransactionId></productTransactionId>
        <orderNumber>2429888</orderNumber>
        <itemNumber>1</itemNumber>
        <productCode>TTL</productCode>
        <loanNumber>7313993</loanNumber>
        <propertyType>Single Family</propertyType>
        <estateOwnership>Fee Simple</estateOwnership>
        <openDate>05/10/2022</openDate>
        <legalDescription>Being The Same Property As Conveyed From Katie To John As Set Forth In Deed Instrument #18 Dated 06/02/2022, Recorded 06/02/2022, Allegheny County, Pennsylvania.</legalDescription>
        <shortLegalDescription>Deed Instrument #18 Dated 06/02/2022, Recorded 06/02/2022, Allegheny County</shortLegalDescription>
        <landRecordsType>Torrens</landRecordsType>
        <transferCertTitleNumber>53867</transferCertTitleNumber>
        <lot>127</lot>
        <block>1100</block>
        <censusTract>6032.02</censusTract>
        <isTrust>true</isTrust>
        <projectName>Fernbrook III Condominiums</projectName>
        <acreage>1.52</acreage>
        <titleEffectiveDate>06/01/2022</titleEffectiveDate>
        <liabilityAmount>250000</liabilityAmount>
        <comments>tax comment</comments>
        <etaTaxDate>TBD</etaTaxDate> 
        <propertyInfo>
            <address1>1204 New York Drive</address1>
            <city>Mckees Rocks</city>
            <state>Pa</state>
            <zipCode>15136</zipCode>
            <county>Allegheny</county>
        </propertyInfo>
        <title>
            <deeds>
                <deed>
                    <grantee>Jim</grantee>
                    <grantor>Laker</grantor>
                    <deedDate>05/10/2022</deedDate>
                    <book>11</book>
                    <page>12</page>
                    <instrument>234</instrument>
                    <recordedDate>05/10/2022</recordedDate>
                    <considerationAmount>0.00</considerationAmount>
                    <currentDeed>false</currentDeed>
                    <deedType>Warranty</deedType>
                    <comments>Deed Created On 05/10/2022</comments>
                </deed>
                <deed>
                    <grantee>John</grantee>
                    <grantor>Katie</grantor>
                    <deedDate>06/02/2022</deedDate>
                    <book>15</book>
                    <page>16</page>
                    <instrument>18</instrument>
                    <recordedDate>06/02/2022</recordedDate>
                    <considerationAmount>25000</considerationAmount>
                    <currentDeed>true</currentDeed>
                    <deedType>Grant Deed</deedType>
                    <comments>Deed Created On 06/02/2022</comments>
                </deed>
            </deeds>
            <judgmentsAndLiens>
                <judgmentAndLien>
                    <plaintiff>Shart</plaintiff>
                    <defendant>Sura</defendant>
                    <datedDate>06/01/2022</datedDate>
                    <book>11</book>
                    <page>12</page>
                    <instrument>14</instrument>
                    <recordedDate>06/01/2022</recordedDate>
                    <amount>50000</amount>
                    <docketNumber>Dn12345</docketNumber>
                    <lienType>Judgment</lienType>
                </judgmentAndLien>
                <judgmentAndLien>
                    <plaintiff>Jefferson</plaintiff>
                    <defendant>Donald</defendant>
                    <datedDate>06/01/2022</datedDate>
                    <book>31</book>
                    <page>32</page>
                    <instrument>34</instrument>
                    <recordedDate>06/01/2022</recordedDate>
                    <amount>25000</amount>
                    <docketNumber>2016-U-409</docketNumber>
                    <lienType>Judgment</lienType>
                </judgmentAndLien>
            </judgmentsAndLiens>
            <mortgages>
                <mortgage>
                    <mortgagee>Baro</mortgagee>
                    <mortgagor>Lopez</mortgagor>
                    <datedDate>05/10/2022</datedDate>
                    <book>56</book>
                    <page>57</page>
                    <instrument>23432432</instrument>
                    <recordedDate>05/10/2022</recordedDate>
                    <taxPaid>423423</taxPaid>
                    <amount>333330</amount>
                    <mersIndicator>true</mersIndicator>
                    <mers>Redacted</mers>
                    <openEnded>true</openEnded>
                    <trustee>
                        <name>John</name>
                        <trusteeAddress>
                            <address1>1204 New York Drive</address1>
                            <address2></address2>
                            <city>Mckees Rocks</city>
                            <state>PA</state>
                            <zipCode>15136</zipCode>
                            <county>Allegheny</county>
                        </trusteeAddress>
                    </trustee>
                    <comments>Gracia And Lopez</comments>
                    <texas50A6>true</texas50A6>
                    <subjectMortgage>false</subjectMortgage>
                    <isConsolidated>false</isConsolidated>
                    <position>1</position>
                    <mortgagorDetails>
                        <mortgagorDetail>
                            <entityType>Corporation</entityType>
                            <firstName>Garcia</firstName>
                            <middleName>M</middleName>
                            <lastName>Test</lastName>
                        </mortgagorDetail>
                        <mortgagorDetail>
                            <entityType>Individual/Entity</entityType>
                            <firstName>Oscar</firstName>
                            <middleName>Oscar M</middleName>
                            <lastName>Test</lastName>
                        </mortgagorDetail>
                    </mortgagorDetails>
                    <mortgageAssignments>
                        <mortgageAssignment>
                            <assignor>Michell</assignor>
                            <assignee>Test</assignee>
                            <datedDate>06/01/2022</datedDate>
                            <book>61</book>
                            <page>62</page>
                            <instrument>64</instrument>
                            <recordedDate>06/01/2022</recordedDate>
                            <type>Mortgage</type>
                        </mortgageAssignment>
                        <mortgageAssignment>
                            <assignor>Arnold</assignor>
                            <assignee>Test</assignee>
                            <datedDate>05/30/2022</datedDate>
                            <book>71</book>
                            <page>72</page>
                            <instrument>74</instrument>
                            <recordedDate>05/31/2022</recordedDate>
                            <type>Name Affidavit</type>
                        </mortgageAssignment>
                    </mortgageAssignments>
                    <mortgageModifications>
                        <mortgageModification>
                            <modFrom>Gracia</modFrom>
                            <modTo>Lopez</modTo>
                            <datedDate>06/01/2022</datedDate>
                            <book>31</book>
                            <page>32</page>
                            <instrument>34</instrument>
                            <recordedDate>06/01/2022</recordedDate>
                            <amount>17500</amount>
                        </mortgageModification>
                        <mortgageModification>
                            <modFrom>Lopez</modFrom>
                            <modTo>Gracia</modTo>
                            <datedDate>06/01/2022</datedDate>
                            <book>51</book>
                            <page>52</page>
                            <instrument>55</instrument>
                            <recordedDate>06/01/2022</recordedDate>
                            <amount>25000</amount>
                        </mortgageModification>
                    </mortgageModifications>
                    <mortgageSubordinates>
                        <mortgageSubordinate>
                            <mortgage>(2022) John</mortgage>
                            <subordinatedTo>(2022) Garcia</subordinatedTo>
                            <datedDate>06/02/2022</datedDate>
                            <book>11</book>
                            <page>12</page>
                            <instrument>14</instrument>
                            <recordedDate>06/02/2022</recordedDate>
                        </mortgageSubordinate>
                        <mortgageSubordinate>
                            <mortgage>(2022) John</mortgage>
                            <subordinatedTo>(2022) Test Mortgage Corporation</subordinatedTo>
                            <datedDate>06/03/2022</datedDate>
                            <book>51</book>
                            <page>52</page>
                            <instrument>54</instrument>
                            <recordedDate>06/03/2022</recordedDate>
                        </mortgageSubordinate>
                    </mortgageSubordinates>
                </mortgage>
                <mortgage>
                    <mortgagee>John</mortgagee>
                    <mortgagor>Donell</mortgagor>
                    <datedDate>05/31/2022</datedDate>
                    <book>41</book>
                    <page>42</page>
                    <instrument>25</instrument>
                    <recordedDate>05/31/2022</recordedDate>
                    <taxPaid>30000.00</taxPaid>
                    <amount>500000.00</amount>
                    <mersIndicator>true</mersIndicator>
                    <mers>Redacted</mers>
                    <openEnded>false</openEnded>
                    <trustee>
                        <name>Mitchell</name>
                        <trusteeAddress>
                            <address1>1204 New York Drive</address1>
                            <address2></address2>
                            <city>Mckees Rocks</city>
                            <state>PA</state>
                            <zipCode>15136</zipCode>
                            <county>Allegheny</county>
                        </trusteeAddress>
                    </trustee>
                    <comments>John And Donell</comments>
                    <texas50A6>true</texas50A6>
                    <subjectMortgage>false</subjectMortgage>
                    <isConsolidated>false</isConsolidated>
                    <position>1</position>
                    <mortgagorDetails>
                        <mortgagorDetail>
                            <entityType>Individual/Entity</entityType>
                            <firstName>John</firstName>
                            <middleName>M</middleName>
                            <lastName>Donell</lastName>
                        </mortgagorDetail>
                    </mortgagorDetails>
                </mortgage>
                <mortgage>
                    <mortgagee>Test Mortgage Corporation</mortgagee>
                    <mortgagor>Clarke</mortgagor>
                    <datedDate>06/01/2022</datedDate>
                    <book>41</book>
                    <page>42</page>
                    <instrument>44</instrument>
                    <recordedDate>06/01/2022</recordedDate>
                    <taxPaid>0.00</taxPaid>
                    <amount>55000</amount>
                    <mersIndicator>true</mersIndicator>
                    <mers>Redacted</mers>
                    <openEnded>false</openEnded>
                    <trustee>
                        <name></name>
                        <trusteeAddress>
                            <address1></address1>
                            <address2></address2>
                            <city></city>
                            <state></state>
                            <zipCode></zipCode>
                            <county></county>
                        </trusteeAddress>
                    </trustee>
                    <comments></comments>
                    <texas50A6>true</texas50A6>
                    <subjectMortgage>false</subjectMortgage>
                    <isConsolidated>true</isConsolidated>
                    <position>1</position>
                    <mortgageAssignments>
                        <mortgageAssignment>
                            <assignor>Arnold</assignor>
                            <assignee>Orurke</assignee>
                            <datedDate>06/01/2022</datedDate>
                            <book>81</book>
                            <page>82</page>
                            <instrument>84</instrument>
                            <recordedDate>06/01/2022</recordedDate>
                            <type>Invoice</type>
                        </mortgageAssignment>
                    </mortgageAssignments>
                    <mortgageModifications>
                        <mortgageModification>
                            <modFrom>Aditya Sain</modFrom>
                            <modTo>Test Mortgage Corporation</modTo>
                            <datedDate>06/01/2022</datedDate>
                            <book>11</book>
                            <page>569</page>
                            <instrument>14</instrument>
                            <recordedDate>06/01/2022</recordedDate>
                            <amount>15000</amount>
                        </mortgageModification>
                    </mortgageModifications>
                    <mortgageSubordinates>
                        <mortgageSubordinate>
                            <mortgage>(2022) Test Mortgage Corporation</mortgage>
                            <subordinatedTo>(2022) Garcia</subordinatedTo>
                            <datedDate>06/03/2022</datedDate>
                            <book>61</book>
                            <page>62</page>
                            <instrument>64</instrument>
                            <recordedDate>06/03/2022</recordedDate>
                        </mortgageSubordinate>
                    </mortgageSubordinates>
                </mortgage>
            </mortgages>
            <mortgageRecordings>
                <mortgageRecording>
                    <mortgagor>Manish Gupta And Spouse If Any</mortgagor>
                    <mortgagee>Test Mortgage Corporation</mortgagee>
                    <datedDate>04/23/2021</datedDate>
                    <book>748</book>
                    <page>68</page>
                    <instrument>2175315477</instrument>
                    <recordedDate>05/10/2022</recordedDate>
                    <entryType>Modification Agreement</entryType>
                    <amount>1200</amount>
                </mortgageRecording>
                <mortgageRecording>
                    <mortgagor>Manish Gupta And Spouse If Any</mortgagor>
                    <mortgagee>Test Mortgage Corporation</mortgagee>
                    <datedDate>04/23/2021</datedDate>
                    <book>21</book>
                    <page>22</page>
                    <instrument>24</instrument>
                    <entryType>Modification Agreement</entryType>
                    <amount>1200</amount>
                </mortgageRecording>
                <mortgageRecording>
                    <mortgagor>Manish Gupta And Spouse If Any</mortgagor>
                    <mortgagee>Test Mortgage Corporation</mortgagee>
                    <datedDate>04/23/2021</datedDate>
                    <book>91</book>
                    <page>92</page>
                    <instrument>94</instrument>
                    <entryType>Modification Agreement</entryType>
                    <amount>1200</amount>
                </mortgageRecording>
            </mortgageRecordings>
            <requirements>
                <requirement>
                    <description>Daniel's Law</description>
                    <text>You Must Tell Us In Writing The Name Of Anyone Referred To In This Commitment Who Is Or May Be An Individual Protected By The Provisions Of Any Address Confidentiality Program That Applies To Recorded Documents.. We May Then Make Additional Requirements Or Exceptions.</text>
                </requirement>
                <requirement>
                    <description>Additional Party Being Added (Standard)</description>
                    <text>The Company Must Be Notified Of All Parties Being Added To Title, Prior To The Loan Closing.  A Judgment Search Must Be Completed For Any Parties Being Added To Title.  The Company Reserves The Right To Add Additional Requirements And/Or Exceptions As May Be Deemed Necessary, Upon Review Of The Judgment Search.</text>
                </requirement>
            </requirements>
            <exceptions>
                <exception>
                    <description>Rights Or Claims Omission(Standard)</description>
                    <text>Rights Or Claims Of Parties In Possession Not Shown By The Public Records.</text>
                </exception>
                <exception>
                    <description>Spousal</description>
                    <text>Rights Of Dower, Homestead Or Other Marital Right Of The Spouse, If Any, Of Any Individual Insured.</text>
                </exception>
            </exceptions>
            <borrowers>
                <borrower>
                    <firstName>Johnny</firstName>
                    <middleName>J</middleName>
                    <lastName>Doe</lastName>
                    <suffix>Sr.</suffix>
                    <type>Borrower</type>
                    <email>johnnydoe@gmail.com</email>
                    <cellPhone>724-323-4234</cellPhone>
                    <ssn>111-11-1111</ssn>
                    <maritalStatus>Married</maritalStatus>
                    <dateOfBirth>7/4/1965</dateOfBirth>
                    <borrowerAddress>
                        <address1>100 Willow St</address1>
                        <address2>Suite 2</address2>
                        <city>Shawnee</city>
                        <state>CA</state>
                        <zipCode>93950</zipCode>
                        <county>Monterey</county>
                    </borrowerAddress>
                </borrower>
                <borrower>
                    <firstName>Janie</firstName>
                    <middleName>J</middleName>
                    <lastName>Doe</lastName>
                    <type>Borrower</type>
                    <email>janiedoe@gmail.com</email>
                    <cellPhone>724-123-4545</cellPhone>
                    <ssn>222-22-2222</ssn>
                    <maritalStatus>Married</maritalStatus>
                    <dateOfBirth>9/22/1967</dateOfBirth>
                    <borrowerAddress>
                        <address1>100 Willow St</address1>
                        <address2>Suite 2</address2>
                        <city>Shawnee</city>
                        <state>CA</state>
                        <zipCode>93950</zipCode>
                        <county>Monterey</county>
                    </borrowerAddress>
                </borrower>
            </borrowers>
            <parties>
                <party>
                    <sequenceNo>1</sequenceNo>
                    <firstName>John</firstName>
                    <lastName>Doe</lastName>
                    <phone>724-420-3341</phone>
                    <email>johndoe@acmeinc.com</email>
                    <role>Processor</role>
                </party>
                <party>
                    <sequenceNo>2</sequenceNo>
                    <firstName>Jane</firstName>
                    <lastName>Doe</lastName>
                    <phone>724-420-1833</phone>
                    <email>janedoe@acmeinc.com</email>
                    <role>LoanOfficer</role>
                </party>
            </parties>
            <documents>
                <document>
                    <documentId>1734433</documentId>
                    <type>Property Report</type>
                    <name>property-report.pdf</name>
                    <fileType>Pdf</fileType>
                    <contentMediaType>application/pdf</contentMediaType>
                    <contentUnicodeTextEncodingType>UTF8</contentUnicodeTextEncodingType>
                    <contentBinaryEncodingType>Base64</contentBinaryEncodingType>
                    <content>Base64 String</content>
                    <description>Brief overview of the document</description>				
                </document>
            </documents>
        </title>
        <tax>
            <taxParsedAddress>
                <address1>1204 New York Drive</address1>
                <city>Mckees Rocks</city>
                <state>Pa</state>
                <county>Allegheny</county>
                <zipCode>15136</zipCode>
                <countyFips>42003</countyFips>
                <stateFips>42</stateFips>
            </taxParsedAddress>
            <taxAssessment>
                <assessmentArea>Mckeesport</assessmentArea>
                <address1>1204</address1>
                <address2>New York Drive</address2>
                <city>Mckees Rocks</city>
                <state>Pa</state>
                <zipCode>15136</zipCode>
            </taxAssessment>
            <taxDetails>
                <taxDetail>
                    <receivedDate></receivedDate>
                    <taxAPN>12345</taxAPN>
                    <taxInstallments>
                        <taxSupplementalAPN>12345</taxSupplementalAPN>
                        <improvementValue>6000</improvementValue>
                        <landValue>5000</landValue>
                        <assessedTotalValue>11000</assessedTotalValue>
                        <taxInstallmentDetails>
                            <taxInstallmentDetail>
                                <authorities>Jackson County Collector</authorities>
                                <taxPeriod>Quarterly</taxPeriod>
                                <taxYear>2022</taxYear>
                                <amount>25000</amount>
                                <status>Delinquent</status>
                                <paymentDate>06/30/2022</paymentDate>
                                <amountDue>0.00</amountDue>
                                <dueDate>06/30/2022</dueDate>
                                <delinquentDate>08/01/2022</delinquentDate>
                                <penaltyDate>07/01/2022</penaltyDate>
                                <penalty>0.00</penalty>
                            </taxInstallmentDetail>
                            <taxInstallmentDetail>
                                <authorities>Jackson County Collector</authorities>
                                <taxPeriod>Semi-Annual</taxPeriod>
                                <taxYear>2022</taxYear>
                                <amount>12500</amount>
                                <status>Paid</status>
                                <paymentDate>06/01/2022</paymentDate>
                                <amountDue>0.00</amountDue>
                                <dueDate>06/30/2022</dueDate>
                                <delinquentDate>09/01/2022</delinquentDate>
                                <penaltyDate>08/01/2022</penaltyDate>
                                <penalty>0.00</penalty>
                            </taxInstallmentDetail>
                        </taxInstallmentDetails>
                    </taxInstallments>
                </taxDetail>
                <taxDetail>
                    <receivedDate></receivedDate>
                    <taxAPN>45678</taxAPN>
                    <taxInstallments>
                        <taxSupplementalAPN>45678</taxSupplementalAPN>
                        <improvementValue>14000</improvementValue>
                        <landValue>12000</landValue>
                        <assessedTotalValue>26000</assessedTotalValue>
                        <taxInstallmentDetails>
                            <taxInstallmentDetail>
                                <authorities>Jackson County Collector</authorities>
                                <taxPeriod>Other</taxPeriod>
                                <taxYear>2021</taxYear>
                                <amount>25000</amount>
                                <status>Exempt</status>
                                <paymentDate>06/22/2022</paymentDate>
                                <amountDue>0.00</amountDue>
                                <dueDate>06/30/2022</dueDate>
                                <delinquentDate>09/01/2022</delinquentDate>
                                <penaltyDate>08/01/2022</penaltyDate>
                                <penalty>0.00</penalty>
                            </taxInstallmentDetail>
                        </taxInstallmentDetails>
                    </taxInstallments>
                </taxDetail>
            </taxDetails>
            <documents>
                <document>
                    <documentId>1734409</documentId>
                    <type>Tax Invoice</type>
                    <name>Tax-Invoice.pdf</name>
                    <fileType>Pdf</fileType>
                    <contentMediaType>application/pdf</contentMediaType>
                    <contentUnicodeTextEncodingType>UTF8</contentUnicodeTextEncodingType>
                    <contentBinaryEncodingType>Base64</contentBinaryEncodingType>
                    <content>Base64 String</content>
                    <description>Brief overview of the document</description>				
                </document>
            </documents>
        </tax>
    </transactionBody>
    <transactionExtensions>
        <transactionExtension>
            <key>Client Specific Key 1</key>
            <value>Client Specific Value 1</value>
        </transactionExtension>
        <transactionExtension>
            <key>Client Specific Key 2</key>
            <value>Client Specific Value 1</value>
        </transactionExtension>
    </transactionExtensions>
</root>
<!-- Copyright © 2023 Mortgage Connect LP -->

👍 The request payload can be verified using the following validation schema.

/* Copyright © 2023 Mortgage Connect LP */
{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "$id": "root",
  "description": "Copyright @ 2022 Mortgage Connect LP - Title & Tax Schema.",
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "legalHeader": {
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "version": {
          "examples": [
            "1.0.8.0"
          ],
          "type": "string",
          "minLength": 1,
          "maxLength": 20
        },
        "disclosingParty": {
          "examples": [
            "Copyright @ 2022 Mortgage Connect LP"
          ],
          "type": "string",
          "minLength": 1,
          "maxLength": 100
        },
        "proprietaryInformationAndConfidential": {
          "examples": [
            "Ownership of Proprietary Information. The Recipient agrees that it shall not receive any right, title or interest, or any license or right to use, the Disclosing Partys Proprietary Information, including, but not limited to, technology, ideas, concepts, drawings, documentation, designs, prototypes, processes, trade secrets, trademarks or other intellectual property rights therein, by implication or otherwise."
          ],
          "type": "string",
          "minLength": 1,
          "maxLength": 2000
        }
      },
      "required": [
        "version",
        "disclosingParty",
        "proprietaryInformationAndConfidential"
      ],
      "minProperties": 3,
      "maxProperties": 3
    },
    "transactionHeader": {
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "transactionIdempotentId": {
          "examples": [
            "3B34A671-BB17-400D-90BF-7CBF9C96E8ED"
          ],
          "type": "string",
          "minLength": 36,
          "maxLength": 36,
          "pattern": "^[\\da-fA-F]{8}-[\\da-fA-F]{4}-[\\da-fA-F]{4}-[\\da-fA-F]{4}-[\\da-fA-F]{12}$"
        },
        "transactionDate": {
          "examples": [
            "2022-07-11T02:03:40"
          ],
          "type": "string",
          "format": "date-time"
        },
        "clientCode": {
          "examples": [
            "1799"
          ],
          "type": "string",
          "minLength": 1,
          "maxLength": 100,
          "format": "integer"
        },
        "clientName": {
          "examples": [
            "AcmeInc"
          ],
          "type": "string",
          "minLength": 1,
          "maxLength": 100
        },
        "vendorCode": {
          "examples": [
            "MC"
          ],
          "type": "string",
          "minLength": 1,
          "maxLength": 100
        },
        "vendorName": {
          "examples": [
            "Mortgage Connect"
          ],
          "type": "string",
          "minLength": 1,
          "maxLength": 100
        }
      },
      "required": [
        "transactionIdempotentId",
        "transactionDate",
        "clientCode",
        "clientName",
        "vendorCode",
        "vendorName"
      ],
      "minProperties": 6,
      "maxProperties": 6
    },
    "transactionBody": {
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "transactionCode": {
          "examples": [
            "Product-Delivery"
          ],
          "type": "string",
          "const": "Product-Delivery"
        },
        "transactionId": {
          "examples": [
            "7832143"
          ],
          "type": "string",
          "minLength": 1,
          "maxLength": 50
        },
        "productTransactionId": {
          "examples": [
            "7832143"
          ],
          "type": "string",
          "minLength": 0,
          "maxLength": 50
        },
        "orderNumber": {
          "examples": [
            "2429888"
          ],
          "type": "integer"
        },
        "itemNumber": {
          "examples": [
            "1"
          ],
          "type": "integer",
          "minimum": 1.0,
          "maximum": 40.0
        },
        "productCode": {
          "type": "string",
          "minLength": 3,
          "maxLength": 4,
          "enum": [
            "LVR",
            "PRT",
            "PUR",
            "TTL"
          ]
        },
        "loanNumber": {
          "examples": [
            "7313993"
          ],
          "type": "string",
          "minLength": 1,
          "maxLength": 64
        },
        "propertyType": {
          "type": "string",
          "maxLength": 64
        },
        "estateOwnership": {
          "type": "string",
          "maxLength": 16
        },        
        "openDate": {
          "type": "string",
          "format": "date-time"
        },
        "legalDescription": {
          "examples": [
            "Being the same property as conveyed from Katie to John as set forth in Deed Instrument #18 dated 06/02/2022, recorded 06/02/2022, Allegheny County, PENNSYLVANIA."
          ],
          "type": "string"
        },
        "shortLegalDescription": {
          "examples": [
            "Deed Instrument #18 dated 06/02/2022, recorded 06/02/2022, Allegheny County"
          ],
          "type": "string"
        },
        "landRecordsType": {
          "examples": [
            "Torrens"
          ],
          "type": "string",
          "enum": [
            "Condo",
            "PUD",
            "Torrens",
            "Waterfront - Bay, Ocean, etc.",
            "Waterfront - River, Stream, etc.",
            "Mobile Home",
            ""
          ]
        },
        "transferCertTitleNumber": {
          "examples": [
            "53867"
          ],
          "type": "string",
          "maxLength": 128
        },
        "comments": {
          "type": "string",
          "examples": [ "tax comment" ]
        },
        "etaTaxDate": {
          "type": "string",      
          "examples": [ "TBD OR 05-10-2022" ]
        },                
        "propertyInfo": {
          "type": "object",
          "additionalProperties": false,
          "properties": {
            "address1": {
              "examples": [
                "1204 New York Drive"
              ],
              "type": "string",
              "maxLength": 32
            },
            "address2": {
              "examples": [
                "1204 New York Drive"
              ],
              "type": "string",
              "maxLength": 32
            },
            "city": {
              "examples": [
                "Mckees Rocks"
              ],
              "type": "string",
              "maxLength": 32
            },
            "state": {
              "examples": [
                "PA"
              ],
              "type": "string",
              "enum": [
                "AK",
                "AL",
                "AR",
                "AS",
                "AZ",
                "CA",
                "CO",
                "CT",
                "DC",
                "DE",
                "FL",
                "FM",
                "GA",
                "GU",
                "HI",
                "IA",
                "ID",
                "IL",
                "IN",
                "KS",
                "KY",
                "LA",
                "MA",
                "MD",
                "ME",
                "MH",
                "MI",
                "MN",
                "MO",
                "MP",
                "MS",
                "MT",
                "NC",
                "ND",
                "NE",
                "NH",
                "NJ",
                "NM",
                "NV",
                "NY",
                "OH",
                "OK",
                "OR",
                "PA",
                "PR",
                "PW",
                "RI",
                "SC",
                "SD",
                "TN",
                "TX",
                "UT",
                "VA",
                "VI",
                "VT",
                "WA",
                "WI",
                "WV",
                "WY"
              ]
            },
            "zipCode": {
              "examples": [
                "15136"
              ],
              "type": "string",
              "minLength": 5,
              "maxLength": 5,
              "pattern": "^[0-9]{5}$"
            },
            "county": {
              "examples": [
                "Allegheny"
              ],
              "type": "string",
              "maxLength": 32
            }
          },
          "required": [
            "address1",
            "city",
            "state",
            "zipCode"
          ],
          "minProperties": 4,
          "maxProperties": 6
        },
        "lotNumber": {
          "examples": [
            "127"
          ],
          "type": "string",
          "maxLength": 100
        },
        "blockNumber": {
          "examples": [
            "1100"
          ],
          "type": "string",
          "maxLength": 100
        },
        "censusTract": {
          "examples": [
            "6032.02"
          ],
          "type": "string",
          "maxLength": 250
        },
        "isTrust": {
          "type": "boolean",
          "examples": [ true ]
        }
        "title": {
          "type": "object",
          "properties": {
            "deeds": {
              "type": "object",
              "properties": {
                "deed": {
                  "type": "array",
                  "items": {
                    "type": "object",
                    "properties": {
                      "grantee": {
                        "examples": [
                          "Jim"
                        ],
                        "type": "string"
                      },
                      "grantor": {
                        "examples": [
                          "Laker"
                        ],
                        "type": "string"
                      },
                      "deedDate": {
                        "examples": [
                          "05-10-2022"
                        ],
                        "type": "string",
                        "format": "date"
                      },
                      "book": {
                        "examples": [
                          "11"
                        ],
                        "type": "string",
                        "maxLength": 32
                      },
                      "page": {
                        "examples": [
                          "12"
                        ],
                        "type": "string",
                        "maxLength": 32
                      },
                      "instrument": {
                        "examples": [
                          "234"
                        ],
                        "type": "string",
                        "maxLength": 32
                      },
                      "recordedDate": {
                        "examples": [
                          "05-10-2022"
                        ],
                        "type": "string",
                        "format": "date"
                      },
                      "considerationAmount": {
                        "examples": [
                          "0.00"
                        ],
                        "type": "string",
                        "format": "money"
                      },
                      "currentDeed": {
                        "examples": [
                          true
                        ],
                        "type": "boolean"
                      },
                      "deedType": {
                        "examples": [
                          "Warranty"
                        ],
                        "type": "string",
                        "maxLength": 50
                      },
                      "comments": {
                        "examples": [
                          "Deed created on 05/10/2022"
                        ],
                        "type": "string"
                      }
                    },
                    "required": [
                      "grantee",
                      "grantor",
                      "deedDate",
                      "recordedDate",
                      "considerationAmount",
                      "currentDeed"
                    ]
                  },
                  "minItems": 1
                }
              }
            },
            "judgmentsAndLiens": {
              "type": "object",
              "properties": {
                "judgmentsAndLien": {
                  "type": "array",
                  "items": {
                    "type": "object",
                    "properties": {
                      "plaintiff": {
                        "examples": [
                          "Shart"
                        ],
                        "type": "string"
                      },
                      "defendant": {
                        "examples": [
                          "Sura"
                        ],
                        "type": "string"
                      },
                      "datedDate": {
                        "examples": [
                          "05-10-2022"
                        ],
                        "type": "string",
                        "format": "date"
                      },
                      "book": {
                        "$ref": "root#/properties/transactionBody/properties/title/properties/deeds/properties/deed/items/properties/book"
                      },
                      "page": {
                        "$ref": "root#/properties/transactionBody/properties/title/properties/deeds/properties/deed/items/properties/page"
                      },
                      "instrument": {
                        "$ref": "root#/properties/transactionBody/properties/title/properties/deeds/properties/deed/items/properties/instrument"
                      },
                      "recordedDate": {
                        "$ref": "root#/properties/transactionBody/properties/title/properties/deeds/properties/deed/items/properties/recordedDate"
                      },
                      "amount": {
                        "$ref": "root#/properties/transactionBody/properties/title/properties/deeds/properties/deed/items/properties/considerationAmount"
                      },
                      "docketNumber": {
                        "examples": [
                          "DN12345"
                        ],
                        "type": "string",
                        "maxLength": 256
                      },
                      "lienType": {
                        "examples": [
                          "Judgment"
                        ],
                        "type": "string",
                        "maxLength": 64
                      }
                    },
                    "required": [
                      "datedDate",
                      "recordedDate",
                      "amount",
                      "lienType"
                    ]
                  }
                }
              }
            },
            "mortgages": {
              "type": "object",
              "properties": {
                "mortgage": {
                  "type": "array",
                  "items": {
                    "type": "object",
                    "properties": {
                      "mortgagee": {
                        "examples": [
                          "Baro"
                        ],
                        "type": "string"
                      },
                      "mortgagor": {
                        "examples": [
                          "Lopez"
                        ],
                        "type": "string"
                      },
                      "datedDate": {
                        "$ref": "root#/properties/transactionBody/properties/title/properties/judgmentsAndLiens/properties/judgmentsAndLien/items/properties/datedDate"
                      },
                      "book": {
                        "$ref": "root#/properties/transactionBody/properties/title/properties/deeds/properties/deed/items/properties/book"
                      },
                      "page": {
                        "$ref": "root#/properties/transactionBody/properties/title/properties/deeds/properties/deed/items/properties/page"
                      },
                      "instrument": {
                        "$ref": "root#/properties/transactionBody/properties/title/properties/deeds/properties/deed/items/properties/instrument"
                      },
                      "recordedDate": {
                        "$ref": "root#/properties/transactionBody/properties/title/properties/deeds/properties/deed/items/properties/recordedDate"
                      },
                      "taxPaid": {
                        "$ref": "root#/properties/transactionBody/properties/title/properties/deeds/properties/deed/items/properties/considerationAmount"
                      },
                      "amount": {
                        "$ref": "root#/properties/transactionBody/properties/title/properties/deeds/properties/deed/items/properties/considerationAmount"
                      },
                      "mersIndicator": {
                        "examples": [
                          true
                        ],
                        "type": "boolean"
                      },
                      "mers": {
                        "examples": [
                          "Redacted"
                        ],
                        "type": "string",
                        "maxLength": 100
                      },
                      "openEnded": {
                        "examples": [
                          true
                        ],
                        "type": "boolean"
                      },
                      "trustee": {
                        "type": "object",
                        "properties": {
                          "name": {
                            "examples": [
                              "John"
                            ],
                            "type": "string",
                            "maxLength": 255
                          },
                          "trusteeAddress": {
                            "$ref": "root#/properties/transactionBody/properties/propertyInfo"
                          }
                        }
                      },
                      "comments": {
                        "examples": [
                          "Gracia and Lopez"
                        ],
                        "type": "string"
                      },
                      "texas50A6": {
                        "examples": [
                          true
                        ],
                        "type": "boolean"
                      },
                      "subjectMortgage": {
                        "examples": [
                          true
                        ],
                        "type": "boolean"
                      },
                      "isConsolidated": {
                        "examples": [
                          true
                        ],
                        "type": "boolean"
                      },
                      "mortgagorDetails": {
                        "type": "object",
                        "properties": {
                          "mortgagorDetail": {
                            "type": "array",
                            "items": {
                              "Required": [
                                "entityType",
                                "firstName",
                                "lastName"
                              ],
                              "type": "object",
                              "properties": {
                                "entityType": {
                                  "type": "string",
                                  "enum": [
                                    "Church",
                                    "Corporation",
                                    "Development Company",
                                    "Individual/Entity",
                                    "LLC",
                                    "Partnership",
                                    "Trust"
                                  ]
                                },
                                "firstName": {
                                  "examples": [
                                    "John"
                                  ],
                                  "type": "string",
                                  "maxLength": 100
                                },
                                "middleName": {
                                  "examples": [
                                    "M"
                                  ],
                                  "type": "string",
                                  "maxLength": 100
                                },
                                "lastName": {
                                  "examples": [
                                    "Smith"
                                  ],
                                  "type": "string",
                                  "maxLength": 100
                                }
                              }
                            }
                          }
                        }
                      },
                      "mortgageAssignments": {
                        "type": "object",
                        "properties": {
                          "mortgageAssignment": {
                            "type": "array",
                            "items": {
                              "type": "object",
                              "properties": {
                                "assignor": {
                                  "examples": [
                                    "Michell"
                                  ],
                                  "type": "string",
                                  "maxLength": 300
                                },
                                "assignee": {
                                  "examples": [
                                    "TEST"
                                  ],
                                  "type": "string",
                                  "maxLength": 128
                                },
                                "datedDate": {
                                  "$ref": "root#/properties/transactionBody/properties/title/properties/judgmentsAndLiens/properties/judgmentsAndLien/items/properties/datedDate"
                                },
                                "book": {
                                  "$ref": "root#/properties/transactionBody/properties/title/properties/deeds/properties/deed/items/properties/book"
                                },
                                "page": {
                                  "$ref": "root#/properties/transactionBody/properties/title/properties/deeds/properties/deed/items/properties/page"
                                },
                                "instrument": {
                                  "$ref": "root#/properties/transactionBody/properties/title/properties/deeds/properties/deed/items/properties/instrument"
                                },
                                "recordedDate": {
                                  "$ref": "root#/properties/transactionBody/properties/title/properties/deeds/properties/deed/items/properties/recordedDate"
                                },
                                "type": {
                                  "examples": [
                                    "MORTGAGE"
                                  ],
                                  "type": "string",
                                  "maxLength": 255
                                }
                              },
                              "required": [
                                "assignor",
                                "assignee",
                                "datedDate",
                                "recordedDate",
                                "type"
                              ]
                            }
                          }
                        }
                      },
                      "mortgageModifications": {
                        "type": "object",
                        "properties": {
                          "mortgageModification": {
                            "type": "array",
                            "items": {
                              "type": "object",
                              "properties": {
                                "modFrom": {
                                  "examples": [
                                    "Gracia"
                                  ],
                                  "type": "string",
                                  "maxLength": 256
                                },
                                "modTo": {
                                  "examples": [
                                    "Lopez"
                                  ],
                                  "type": "string",
                                  "maxLength": 256
                                },
                                "datedDate": {
                                  "$ref": "root#/properties/transactionBody/properties/title/properties/judgmentsAndLiens/properties/judgmentsAndLien/items/properties/datedDate"
                                },
                                "book": {
                                  "$ref": "root#/properties/transactionBody/properties/title/properties/deeds/properties/deed/items/properties/book"
                                },
                                "page": {
                                  "$ref": "root#/properties/transactionBody/properties/title/properties/deeds/properties/deed/items/properties/page"
                                },
                                "instrument": {
                                  "$ref": "root#/properties/transactionBody/properties/title/properties/deeds/properties/deed/items/properties/instrument"
                                },
                                "recordedDate": {
                                  "$ref": "root#/properties/transactionBody/properties/title/properties/deeds/properties/deed/items/properties/recordedDate"
                                },
                                "amount": {
                                  "$ref": "root#/properties/transactionBody/properties/title/properties/deeds/properties/deed/items/properties/considerationAmount"
                                }
                              },
                              "required": [
                                "modFrom",
                                "modTo",
                                "datedDate",
                                "recordedDate",
                                "amount"
                              ]
                            }
                          }
                        }
                      },
                      "mortgageSubordinates": {
                        "type": "object",
                        "properties": {
                          "mortgageSubordinate": {
                            "type": "array",
                            "items": {
                              "type": "object",
                              "properties": {
                                "mortgage": {
                                  "examples": [
                                    "(2022) John"
                                  ],
                                  "type": "string",
                                  "maxLength": 300
                                },
                                "subordinateTo": {
                                  "examples": [
                                    "(2022) Garcia"
                                  ],
                                  "type": "string",
                                  "maxLength": 128
                                },
                                "datedDate": {
                                  "$ref": "root#/properties/transactionBody/properties/title/properties/judgmentsAndLiens/properties/judgmentsAndLien/items/properties/datedDate"
                                },
                                "book": {
                                  "$ref": "root#/properties/transactionBody/properties/title/properties/deeds/properties/deed/items/properties/book"
                                },
                                "page": {
                                  "$ref": "root#/properties/transactionBody/properties/title/properties/deeds/properties/deed/items/properties/page"
                                },
                                "instrument": {
                                  "$ref": "root#/properties/transactionBody/properties/title/properties/deeds/properties/deed/items/properties/instrument"
                                },
                                "recordedDate": {
                                  "$ref": "root#/properties/transactionBody/properties/title/properties/deeds/properties/deed/items/properties/recordedDate"
                                }
                              },
                              "required": [
                                "mortgage",
                                "subordinateTo",
                                "datedDate",
                                "recordedDate"
                              ]
                            }
                          }
                        }
                      }
                    },
                    "required": [
                      "mortgagee",
                      "mortgagor",
                      "datedDate",
                      "recordedDate",
                      "amount",
                      "mersIndicator",
                      "openEnded"
                    ]
                  }
                }
              }
            },
            "mortgageRecordings": {
              "type": "object",
              "properties": {
                "mortgageRecording": {
                  "type": "array",
                  "items": {
                    "type": "object",
                    "properties": {
                      "mortgagor": {
                        "examples": [
                          "Manish Gupta and spouse if any"
                        ],
                        "type": "string",
                        "maxLength": 256
                      },
                      "mortgagee": {
                        "examples": [
                          "TEST MORTGAGE CORPORATION"
                        ],
                        "type": "string",
                        "maxLength": 128
                      },
                      "datedDate": {
                        "$ref": "root#/properties/transactionBody/properties/title/properties/judgmentsAndLiens/properties/judgmentsAndLien/items/properties/datedDate"
                      },
                      "book": {
                        "$ref": "root#/properties/transactionBody/properties/title/properties/deeds/properties/deed/items/properties/book"
                      },
                      "page": {
                        "$ref": "root#/properties/transactionBody/properties/title/properties/deeds/properties/deed/items/properties/page"
                      },
                      "instrument": {
                        "$ref": "root#/properties/transactionBody/properties/title/properties/deeds/properties/deed/items/properties/instrument"
                      },
                      "recordedDate": {
                        "$ref": "root#/properties/transactionBody/properties/title/properties/deeds/properties/deed/items/properties/recordedDate"
                      },
                      "entryType": {
                        "examples": [
                          "Modification Agreement"
                        ],
                        "type": "string",
                        "enum": [
                          "Assignment",
                          "CDOC",
                          "CEMA Mtg/DOT",
                          "Correction Affidavit",
                          "Death Certification",
                          "Deed",
                          "Deed - Already",
                          "Transferred",
                          "Divorce Decree",
                          "Heirship Affidavit",
                          "Lease",
                          "Memorandum of Trust",
                          "Modification Agreement",
                          "Mortgage/Deed of Trust",
                          "Notice of Commencement",
                          "Notice of Resignation of Trustee",
                          "Notice of Settlement",
                          "Other",
                          "Power of Attny",
                          "Quit Claim Deed",
                          "Release/Satisfaction",
                          "Reverse Mtg",
                          "Special Warranty Deed",
                          "Subordination",
                          "TX Home Equity Affidavit and Agreement",
                          "UCC",
                          "UCC-1",
                          "UCC-3"
                        ]
                      },
                      "amount": {
                        "$ref": "root#/properties/transactionBody/properties/title/properties/deeds/properties/deed/items/properties/considerationAmount"
                      }
                    },
                    "required": [
                      "mortgagor",
                      "mortgagee",
                      "datedDate",
                      "recordedDate",
                      "entryType",
                      "amount"
                    ]
                  }
                }
              }
            },
            "requirements": {
              "type": "object",
              "properties": {
                "requirement": {
                  "type": "array",
                  "items": {
                    "type": "object",
                    "properties": {
                      "description": {
                        "examples": [
                          "Daniel's Law"
                        ],
                        "type": "string",
                        "maxLength": 255
                      },
                      "text": {
                        "examples": [
                          "You must tell us in writing the name of anyone referred to in this Commitment who is or may be an individual protected by the provisions of any Address Confidentiality Program that applies to recorded documents.. We may then make additional requirements or exceptions."
                        ],
                        "type": "string",
                        "maxLength": 4096
                      }
                    },
                    "required": [
                      "description",
                      "text"
                    ]
                  }
                }
              }
            },
            "exceptions": {
              "type": "object",
              "properties": {
                "exception": {
                  "type": "array",
                  "items": {
                    "type": "object",
                    "properties": {
                      "description": {
                        "examples": [
                          "Rights or Claims Omission(standard)"
                        ],
                        "type": "string",
                        "maxLength": 255
                      },
                      "text": {
                        "examples": [
                          "Rights or claims of parties in possession not shown by the public records."
                        ],
                        "type": "string",
                        "maxLength": 4096
                      }
                    },
                    "required": [
                      "description",
                      "text"
                    ]
                  }
                }
              }
            },
            "borrowers": {
              "type": "object",
              "properties": {
                "borrower": {
                  "type": "array",
                  "items": {
                    "title": "Borrower",
                    "type": "object",
                    "additionalProperties": false,
                    "properties": {
                      "firstName": {
                        "examples": [
                          "John"
                        ],
                        "type": "string",
                        "minLength": 1,
                        "maxLength": 150
                      },
                      "middleName": {
                        "examples": [
                          "M"
                        ],
                        "type": "string",
                        "minLength": 0,
                        "maxLength": 150
                      },
                      "lastName": {
                        "examples": [
                          "Smith"
                        ],
                        "type": "string",
                        "minLength": 1,
                        "maxLength": 255
                      },
                      "suffix": {
                        "examples": [
                          "Sr."
                        ],
                        "type": "string",
                        "minLength": 0,
                        "maxLength": 4,
                        "enum": [
                          "II",
                          "III",
                          "Esq.",
                          "Jr.",
                          "M.D.",
                          "P.A.",
                          "Sr.",
                          ""
                        ]
                      },
                      "type": {
                        "type": "string",
                        "enum": [
                          "Asset Management Company",
                          "Asset Manager",
                          "Assignee",
                          "Assignor",
                          "Attorney",
                          "Bank Attorney",
                          "Borrower",
                          "Borrower/Buyer",
                          "Builder",
                          "Buyer",
                          "Buyer Agent",
                          "Buyer Attorney",
                          "Buyer Title Company",
                          "Buyers Broker",
                          "Condo Association",
                          "Custodian",
                          "Foreclosed Party",
                          "Investor",
                          "LENDER",
                          "Lender Loan Officer",
                          "Listing Agent",
                          "MC MC Auction Company",
                          "Mortgage Connect Closer",
                          "Non-HUD Borrower",
                          "Non-Vested Signer",
                          "Other",
                          "Processor",
                          "Property Access",
                          "Real Estate Agent",
                          "Real Estate Agent - Seller",
                          "Seller",
                          "Seller Attorney",
                          "Sellers Broker",
                          "Selling Agent",
                          "Servicer",
                          "Settlement Agent",
                          "Title Company",
                          "Underwriter",
                          "Vested Signer - Non-Borrower"
                        ]
                      },
                      "email": {
                        "type": "string",
                        "maxLength": 255,
                        "format": "email"
                      },
                      "cellPhone": {
                        "type": "string",
                        "maxLength": 24
                      },
                      "ssn": {
                        "type": "string",
                        "maxLength": 128
                      },
                      "maritalStatus": {
                        "type": "string",
                        "enum": [
                          "Divorced",
                          "Married",
                          "Separated",
                          "Single",
                          "Widowed",
                          ""
                        ]
                      },
                      "language": {
                        "type": "string",
                        "enum": [
                          "English",
                          "Spanish"
                        ]
                      },
                      "dateOfBirth": {
                        "type": "string",
                        "format": "date"
                      },
                      "borrowerAddress": {
                        "$ref": "root#/properties/transactionBody/properties/propertyInfo"
                      }
                    },
                    "required": [
                      "firstName",
                      "lastName",
                      "type"
                    ]
                  },
                  "minItems": 1
                }
              }
            },
            "parties": {
              "type": "object",
              "properties": {
                "party": {
                  "type": "array",
                  "items": {
                    "title": "Party",
                    "type": "object",
                    "additionalProperties": false,
                    "properties": {
                      "sequenceNo": {
                        "type": "integer"
                      },
                      "firstName": {
                        "type": "string",
                        "maxLength": 150
                      },
                      "lastName": {
                        "type": "string",
                        "maxLength": 150
                      },
                      "phone": {
                        "type": "string",
                        "maxLength": 24
                      },
                      "email": {
                        "type": "string",
                        "maxLength": 255,
                        "format": "email"
                      },
                      "role": {
                        "type": "string",
                        "enum": [
                          "Closer",
                          "LoanOfficer",
                          "LoanOfficerAssistant",
                          "Other",
                          "Processor",
                          "ProcessorAssistant",
                          "Underwriter",
                          "User"
                        ]
                      }
                    },
                    "required": [
                      "firstName",
                      "lastName",
                      "role"
                    ]
                  }
                }
              }
            },
            "documents": {
              "type": "object",
              "properties": {
                "document": {
                  "type": "array",
                  "items": {
                    "type": "object",
                    "properties": {
                      "documentId": {
                        "examples": [
                          "1243992"
                        ],
                        "type": "string"
                      },
                      "type": {
                        "type": "string",
                        "minLength": 0,
                        "maxLength": 0,
                        "enum": [
                          "Other"
                        ]
                      },
                      "name": {
                        "examples": [
                          "patriot-search.pdf"
                        ],
                        "type": "string",
                        "maxLength": 100
                      },
                      "fileType": {
                        "type": "string",
                        "enum": [
                          "DOC",
                          "DOCX",
                          "PDF",
                          "doc",
                          "docx",
                          "pdf"
                        ]
                      },
                      "contentMediaType": {
                        "type": "string",
                        "enum": [
                          "application/msword",
                          "application/vnd.openxmlformats-officedocument.wordprocessingml.document",
                          "application/pdf"
                        ]
                      },
                      "contentUnicodeTextEncodingType": {
                        "type": "string",
                        "enum": [
                          "UTF8"
                        ]
                      },
                      "contentBinaryEncodingType": {
                        "type": "string",
                        "enum": [
                          "Base64"
                        ]
                      },
                      "content": {
                        "contentEncoding": "base64",
                        "type": "string"
                      },
                      "description": {
                        "type": "string",
                        "maxLength": 255
                      }
                    },
                    "required": [
                      "documentId",
                      "type",
                      "name",
                      "fileType",
                      "contentMediaType",
                      "contentUnicodeTextEncodingType",
                      "contentBinaryEncodingType",
                      "content"
                    ],
                    "allOf": [
                      {
                        "if": {
                          "properties": {
                            "fileType": {
                              "enum": [
                                "DOC",
                                "doc"
                              ]
                            }
                          }
                        },
                        "then": {
                          "properties": {
                            "contentMediaType": "application/msword"
                          }
                        }
                      },
                      {
                        "if": {
                          "properties": {
                            "fileType": {
                              "enum": [
                                "DOCX",
                                "docx"
                              ]
                            }
                          }
                        },
                        "then": {
                          "properties": {
                            "contentMediaType": "application/vnd.openxmlformats-officedocument.wordprocessingml.document"
                          }
                        }
                      },
                      {
                        "if": {
                          "properties": {
                            "fileType": {
                              "enum": [
                                "PDF",
                                "pdf"
                              ]
                            }
                          }
                        },
                        "then": {
                          "properties": {
                            "contentMediaType": "application/pdf"
                          }
                        }
                      }
                    ]
                  }
                }
              }
            }
          },
          "required": [
            "deeds"
          ]
        },
        "tax": {
          "type": "object",
          "properties": {
            "taxParsedAddress": {
              "type": "object",
              "properties": {
                "address1": {
                  "examples": [
                    "1204 New York Drive"
                  ],
                  "type": "string",
                  "maxLength": 78
                },
                "city": {
                  "$ref": "root#/properties/transactionBody/properties/propertyInfo/properties/city"
                },
                "state": {
                  "$ref": "root#/properties/transactionBody/properties/propertyInfo/properties/state"
                },
                "zipCode": {
                  "$ref": "root#/properties/transactionBody/properties/propertyInfo/properties/zipCode"
                },
                "county": {
                  "$ref": "root#/properties/transactionBody/properties/propertyInfo/properties/county"
                },
                "countyFips": {
                  "examples": [
                    "42003"
                  ],
                  "type": "string",
                  "minLength": 5,
                  "maxLength": 5
                },
                "stateFips": {
                  "examples": [
                    "42"
                  ],
                  "type": "string",
                  "minLength": 2,
                  "maxLength": 2
                }
              },
              "required": [
                "address1",
                "city",
                "state",
                "zipCode",
                "countyFips",
                "stateFips"
              ]
            },
            "taxAssessment": {
              "type": "object",
              "properties": {
                "assessmentArea": {
                  "examples": [
                    "McKeesport"
                  ],
                  "type": "string",
                  "maxLength": 32
                },
                "address1": {
                  "examples": [
                    "1204 New York Drive"
                  ],
                  "type": "string",
                  "maxLength": 100
                },
                "address2": {
                  "examples": [
                    "1204 New York Drive"
                  ],
                  "type": "string",
                  "maxLength": 100
                },
                "city": {
                  "$ref": "root#/properties/transactionBody/properties/propertyInfo/properties/city"
                },
                "state": {
                  "$ref": "root#/properties/transactionBody/properties/propertyInfo/properties/state"
                },
                "zipCode": {
                  "$ref": "root#/properties/transactionBody/properties/propertyInfo/properties/zipCode"
                }
              },
              "required": [
                "assessmentArea",
                "address1",
                "city",
                "state",
                "zipCode"
              ]
            },
            "taxDetails": {
              "type": "object",
              "properties": {
                "taxDetail": {
                  "type": "array",
                  "items": {
                    "type": "object",
                    "properties": {
                      "receivedDate": {
                        "examples": [
                          "05-10-2022"
                        ],
                        "type": "string",
                        "format": "date-time"
                      },
                      "taxAPN": {
                        "examples": [
                          "12345"
                        ],
                        "type": "string",
                        "maxLength": 64
                      },
                      "taxType": {
                        "examples": [
                          "County"
                        ],
                        "type": "string",
                        "maxLength": 32
                      },
                      "taxInstallments": {
                        "type": "object",
                        "properties": {
                          "taxSupplementalAPN": {
                            "examples": [
                              "12345"
                            ],
                            "type": "string",
                            "maxLength": 64
                          },
                          "improvementValue": {
                            "$ref": "root#/properties/transactionBody/properties/title/properties/deeds/properties/deed/items/properties/considerationAmount"
                          },
                          "landValue": {
                            "$ref": "root#/properties/transactionBody/properties/title/properties/deeds/properties/deed/items/properties/considerationAmount"
                          },
                          "assessedTotalValue": {
                            "$ref": "root#/properties/transactionBody/properties/title/properties/deeds/properties/deed/items/properties/considerationAmount"
                          },
                          "taxInstallmentDetails": {
                            "taxInstallmentDetail": {
                              "type": "array",
                              "items": {
                                "type": "object",
                                "properties": {
                                  "taxPeriod": {
                                    "type": "string",
                                    "maxLength": 32,
                                    "examples": [
                                      "Quarterly"
                                    ]
                                  },
                                  "taxYear": {
                                    "type": "string",
                                    "minLength": 4,
                                    "maxLength": 32,
                                    "examples": [
                                      "2022"
                                    ]
                                  },
                                  "amount": {
                                    "$ref": "CommonTypes#/$defs/money"
                                  },
                                  "status": {
                                    "type": "string",
                                    "enum": [
                                      "Delinquent",
                                      "Due",
                                      "Exempt",
                                      "No Tax Due",
                                      "Open",
                                      "Paid",
                                      "Partial Pay"
                                    ]
                                  },
                                  "paymentDate": {
                                    "type": "string",
                                    "format": "date",
                                    "examples": [
                                      "05-10-2022"
                                    ]
                                  },
                                  "amountDue": {
                                    "$ref": "CommonTypes#/$defs/money"
                                  },
                                  "dueDate": {
                                    "type": "string",
                                    "format": "date",
                                    "examples": [
                                      "05-10-2022"
                                    ]
                                  },
                                  "delinquentDate": {
                                    "type": "string",
                                    "format": "date",
                                    "examples": [
                                      "05-10-2022"
                                    ]
                                  },
                                  "penaltyDate": {
                                    "type": "string",
                                    "format": "date",
                                    "examples": [
                                      "05-10-2022"
                                    ]
                                  },
                                  "penalty": {
                                    "$ref": "CommonTypes#/$defs/money"
                                  }
                                },
                                "required": [
                                  "taxPeriod",
                                  "taxYear",
                                  "amount",
                                  "amountDue",
                                  "penalty"
                                ]
                              }
                            }
                          }
                        },
                        "required": [
                          "taxSupplementalAPN",
                          "taxInstallmentDetails"
                        ]
                      }
                    },
                    "required": [
                      "taxAPN",
                      "taxInstallments"
                    ]
                  }
                }
              }
            },
            "documents": {
              "type": "object",
              "properties": {
                "document": {
                  "type": "array",
                  "items": {
                    "$ref": "root#/properties/transactionBody/properties/title/properties/documents/properties/document/items"
                  }
                }
              }
            }
          },
          "required": [
            "taxParsedAddress",
            "taxAssessment"
          ]
        }
      },
      "required": [
        "transactionCode",
        "transactionId",
        "orderNumber",
        "itemNumber",
        "productCode",
        "loanNumber",
        "openDate",
        "legalDescription"
      ]
    },
    "transactionExtensions": {
      "type": "object",
      "properties": {
        "transactionExtension": {
          "type": "array",
          "items": {
            "type": "object",
            "additionalProperties": false,
            "properties": {
              "key": {
                "examples": [
                  "Client Specific Key"
                ],
                "type": "string",
                "minLength": 1,
                "maxLength": 200
              },
              "value": {
                "examples": [
                  "Client Specific Value"
                ],
                "type": "string",
                "minLength": 1
              }
            },
            "required": [
              "key",
              "value"
            ],
            "minProperties": 2,
            "maxProperties": 2
          },
          "minItems": 0
        }
      }
    }
  },
  "required": [
    "transactionHeader",
    "transactionBody"
  ],
  "minProperties": 2,
  "maxProperties": 4
}
/* Copyright © 2023 Mortgage Connect LP */

The request payload XML schema validation is under construction. 🚧

✅ The following is an 'Accepted' example payload to be returned in the HTTP response.

Accepted Acknowledgment payloads are typically message type agnostic.

Accepted Acknowledgment payloads are typically message type agnostic.

⛔ The following is a 'Rejected' example payload to be returned in the HTTP response.

Rejected Acknowledgment payloads are typically message type agnostic.

Rejected Acknowledgment payloads are typically message type agnostic.

The Product Delivery API method is the mechanism in which Mortgage Connect can submit a message to the Client to deliver the Final Title Document and supporting metadata.

View Workflow Orchestration

Client URL

POST 🔒 To be determined during onboarding process.

Property Definitions - Transaction Header

Defines the properties represented in the Transaction Header object (JSON) or node (XML). Note that this message artifact is identical for each and every message type.

View Transaction Header Details

Property Definitions - Transaction Body

Defines the properties represented in the Transaction Body object (JSON) or node (XML).

Property	Requirement	Data Type	Min / Max	Description
transactionBody	Required			A parent object (JSON) or node (XML) that contains the transaction metadata.
transactionCode	Required	String	16 / 16	A static value of `Product-Delivery`. The transaction code is meant to identify the message type and the context or action that should be taken. In this context it implies that the product and all supporting metadata are to be delivered to the client. Possible Values: Product-Delivery
transactionId	Required	String	1 / 50	Represents the Client's unique order number.
productTransactionId	Optional	String	0 / 50	Represents the Client's unique product order number. Note that the `productTransactionId` field is not used in most circumstances. However, when there is a need to further differentiate order numbers at a product level, that share the same `transactionId`, (i.e. the primary order level id), then the `productTransactionId` can be used to ensure uniqueness across the integration transactions. This makes it possible for multiple orders of the same product type to be placed using the same `transactionId`. The use of the `productTransactionId` field and any specific workflow deviations will be vetted during the onboarding process.
orderNumber	Required	Integer		Represents Mortgage Connects unique order number.
itemNumber	Required	Integer	Integer	Represents Mortgage Connects product sequencing number (i.e `1 through 40`) that is associated with each product ordered.
productCode	Required	String	3 / 4	Represents Mortgage Connect's product code. Possible Values: LVR `LEGAL & VEString REPORT` PRT `PROPERTY REPORT` PUR `PURCHASE` TTL `TITLE INSURANCE` etc. Traditionally, clients use Mortgage Connects `Product Code` names and thus there is a one to one mapping relationship that is maintained by the client. However, Mortgage Connect is aware that our naming conventions may not resonate and that there are many inconsistencies in product code naming conventions and nomenclatures. It is for this reason that Mortgage Connect is able to map the client's product code to Mortgage Connect's product code to ease the transition. Any required product code mapping exercises will be addressed during the onboarding process. The supported `productCode`(s) are specific per integration and will be determined during the onboarding process. Note that the minimum/maximum length requirement of 3/4 is only applicable if using Mortgage Connect's internal product codes, otherwise when mapping to the client's product codes, the minimum/maximum is 1/50.
loanNumber	Required	String	1 / 64	The client's loan number that is associated with the order.
propertyType	Optional	String	1 / 64	The type of property, i.e., Single Family, PUD, etc. Possible Values: Condominium Cooperative Manufactured Other PUD Single Family Two to Four Family
estateOwnership	Optional	String	1 / 16	The estate ownership in the context of its uninsured state. Possible Values: Fee Simple Lease Hold
openDate	Required	DateTime		The date when the product was added to Mortgage Connect.
legalDescription	Required	String	1 / max	The legal description associated with the Title. (if applicable)
shortLegalDescription	Optional	String	0 / max	The short legal description associated with the Title. (if applicable)
landRecordsType	Optional	String	0 / 100	The land record type. Possible Values: Condo PUD Torrens Waterfront - Bay, Ocean, etc. Waterfront - River, Stream, etc. Mobile Home
transferCertTitleNumber	Optional	String	0 / 128	The transfer certificate title number.
lot	Optional	String	0 / 100	The property lot number, which identifies the specific parcel of land within a block.
block	Optional	String	0 / 100	The property block number, which identifies the group of lots within a subdivision or a development project.
censusTract	Optional	String	0 / 250	The property census tract, which is a statistical subdivisions of a county that aims to have roughly 4,000 inhabitants. Tract boundaries are usually visible features, such as roads or rivers, but they can also follow the boundaries of national parks, military reservations, or American Indian reservations.
isTrust	Optional	Boolean		Indicates that the property is in a Trust. Possible Values: true false
projectName	Optional	String	0 / 1000	The name of the property project. For example, a `Condo`, i.e. Condominium or `PUD', i.e. a Planned Unit Development consisting of a community that contains multiple single-family homes.
acreage	Optional	String	0 / 100	The property acreage, which identifies the size of the property land in acres.
titleEffectiveDate	Optional	DateTime		The effective date of the recordation of the deed or mortgage.
liabilityAmount	Optional	Money		The portion of the `Purchase Price` that was not paid in cash by the purchaser.
comments	Optional	String		The eta tax comment for expected date if any
etaTaxDate	Optional	String		The expected date for tax to be added. Note that if the date cannot be determined that a value of `TBD` will be assigned. All other values are expected to be valid dates in the form of mm-dd-yyyy.
propertyInfo	Required			A parent object (JSON) or node (XML) that contains metadata associated with a property address.
address1	Required	String	1 / 78	The property street address line 1.
city	Required	String	1 / 32	The property city.
state	Required	String	2 / 2	The property state abbreviation. Possible Values: AK, AL, AR, AS, AZ, CA, CO, CT, DC, DE, FL, FM, GA, GU, HI, IA, ID, IL, IN, KS, KY, LA, MA, MD, ME, MH, MI, MN, MO, MP, MS, MT, NC, ND, NE, NH, NJ, NM, NV, NY, OH, OK, OR, PA, PR, PW, RI, SC, SD, TN, TX, UT, VA, VI, VT, WA, WI, WV, WY.
zipCode	Required	String	5 / 5	The property zip code.
county	Required	String	1 / 32	The property county.

Property Definitions - Transaction Body - Title

Defines the properties represented in the Transaction/Title object (JSON) or node (XML).

Property	Requirement	Data Type	Min / Max	Description
title	Required			A parent object (JSON) or node (XML) that contains metadata associated with the title.
deeds	Required			A parent object (JSON) or node (XML) that contains a list of deeds. `(1 to Many)`
deed	Required			A parent object (JSON) or node (XML) that contains metadata associated with deeds.
grantee	Required	String	1 / max	The deed grantee.
grantor	Required	String	1 / max	The deed grantor.
deedDate	Required	DateTime		The deed date.
book	Optional	String	0 / 32	The deed book.
page	Optional	String	0 / 32	The deed page.
instrument	Optional	String	0 / 32	The deed instrument number.
recordedDate	Required	DateTime		The deed recorded date.
considerationAmount	Required	Money		The deed consideration amount, can be 0.0.
currentDeed	Required	Boolean		Indicates whether it is the current deed. Possible Values: true false
deedType	Optional	String	1 / 50	Indicates the type of deed.
comments	Optional	String	0 / max	The deed comments.
judgmentsAndLiens	Optional			A parent object (JSON) or node (XML) that contains list of judgments and liens. `(0 to Many)`
judgmentAndLien	Optional			A parent object (JSON) or node (XML) that contains metadata associated with judgments and liens.
plaintiff	Optional	String	0 / max	The judgement and lien plaintiff.
defendant	Optional	String	0 / max	The judgement and lien defendant.
datedDate	Optional	DateTime		The judgement and lien dated date.
book	Optional	String	0 / 32	The judgement and lien book
page	Optional	String	0 / 32	The judgement and lien page.
instrument	Optional	String	0 / 32	The judgement and lien instrument number.
recordedDate	Required	DateTime		The judgement and lien recorded date.
amount	Required	Money		The judgement and lien amount.
docketNumber	Optional	String	0 / 256	The judgement and lien docket number.
lienType	Required	String	1 / 64	The judgement and lien type.
mortgages	Optional			A parent object (JSON) or node (XML) that contains a list of mortgages. `(0 to Many)`
mortgage	Optional			A parent object (JSON) or node (XML) that contains metadata associated with mortgages.
mortgagee	Required	String	1 / max	The mortgagee.
mortgagor	Required	String	1 / max	The mortgagor.
datedDate	Required	DateTime		The mortgage dated date.
book	Optional	String	0 / 32	The mortgage book.
page	Optional	String	0 / 32	The mortgage page.
instrument	Optional	String	0 / 32	The mortgage instrument number.
recordedDate	Required	DateTime		The mortgage recorded date.
taxPaid	Optional	Money		The mortgage tax paid.
amount	Required	Money		The mortgage amount.
mersIndicator	Required	Boolean		The MERS indicator. Possible Values: true false
mers	Optional	String	0 / 100	The mortgage MERS min.
openEnded	Required	Boolean		Indicates whether the mortage is open ended. Possible Values: true false
trustee	Optional			A parent object (JSON) or node (XML) that contains metadata associated with mortgage trustee.
name	Optional	String	0 / 255	The mortgage trustee name.
trusteeAddress	Optional			A parent object (JSON) or node (XML) that contains metadata associated with mortgage trustee address.
address1	Optional	String	0 / 255	The mortgage trustee street address.
address2	Optional	String	0 / 255	The mortgage trustee street address 2.
city	Optional	String	0 / 32	The mortgage trustee city name.
state	Optional	String	0 / 2	The mortgage trustee state abbreviation. Possible Values: AK, AL, AR, AS, AZ, CA, CO, CT, DC, DE, FL, FM, GA, GU, HI, IA, ID, IL, IN, KS, KY, LA, MA, MD, ME, MH, MI, MN, MO, MP, MS, MT, NC, ND, NE, NH, NJ, NM, NV, NY, OH, OK, OR, PA, PR, PW, RI, SC, SD, TN, TX, UT, VA, VI, VT, WA, WI, WV, WY. "" `(i.e. empty string)`
zipCode	Optional	String	0 / 5	The mortgage trustee zip code.
county	Optional	String	0 / 32	The mortgage trustee county.
comments	Optional	String	0 / max	The mortage comments.
texas50A6	Optional	Boolean		Indicates whether the mortgage is a `Texas 50A6 / Home Equity` transaction. Possible Values: true false
subjectMortgage	Optional	Boolean		The mortgage subject. Possible Values: true false
isConsolidated	Optional	Boolean		Indicates whether the mortgage is consolidated. Possible Values: true false
position	Optional	Integer		Indicates the mortgage lien position.
mortgagorDetails	Optional			A parent object (JSON) or node (XML) that contains a list of mortgage details. `(0 to Many)`
mortgagorDetail	Optional			A parent object (JSON) or node (XML) that contains metadata associated with mortgage details.
entityType	Required	String	1 / 100	The mortgage detail entity type. Possible Values: Church Corporation Development Company Individual/Entity LLC Partnership Trust
firstName	Required	String	1 / 100	The mortgage detail first name.
middleName	Optional	String	0 / 100	The mortgage detail middle name.
lastName	Required	String	1 / 100	The mortgage detail last name.
mortgageAssignments	Optional			A parent object (JSON) or node (XML) that contains a list of mortgage assignments. `(0 to Many)`
mortgageAssignment	Optional			A parent object (JSON) or node (XML) that contains metadata associated with mortgage assignments.
assignor	Optional	String	1 / 300	The mortgage assignment assignor.
assignee	Required	String	1 / 128	The mortgage assignment assignee.
datedDate	Required	DateTime		The mortgage assignment dated date.
book	Optional	String	0 / 32	The mortgage assignment book.
page	Optional	String	0 / 32	The mortgagr assignment page.
instrument	Optional	String	0 / 32	The mortgage assignment instrument number.
recordedDate	Required	DateTime		The mortgage assignment recorded date.
type	Optional	String	1 / 255	The mortgage assignment type.
mortgageModifications	Optional			A parent object (JSON) or node (XML) that contains a list of mortgage modifications. `(0 to Many)`
mortgageModification	Optional			A parent object (JSON) or node (XML) that contains metadata associated with mortgage modifications.
modFrom	Required	String	1 / 256	The mortgage modification from.
modTo	Required	String	1 / 256	The mortgage modification to.
datedDate	Required	DateTime		The mortgage modification dated date.
book	Optional	String	0 / 32	The mortgage modification book.
page	Optional	String	0 / 32	The mortgagr modification page.
instrument	Optional	String	0 / 32	The mortgage modification instrument number.
recordedDate	Required	DateTime		The mortgage modification recorded date.
amount	Required	Money		The mortgage modification amount.
mortgageSubordinates	Optional			A parent object (JSON) or node (XML) that contains a list of mortgage subordinates. `(0 to Many)`
mortgageSubordinate	Optional			A parent object (JSON) or node (XML) that contains metadata associated with mortgage subordinates.
mortage	Required	String	1 / 300	The mortgage subordinate from.
subordinateTo	Required	String	1 / 128	The mortgage subordinate to.
datedDate	Required	DateTime		The mortgage subordinate dated date.
book	Optional	String	0 / 32	The mortgage subordinate book.
page	Optional	String	0 / 32	The mortgagr subordinate page.
instrument	Optional	String	0 / 32	The mortgage subordinate instrument number.
recordedDate	Required	DateTime		The mortgage subordinate recorded date.
mortgageRecordings	Optional			A parent object (JSON) or node (XML) that contains a list of mortgage recordings. `(0 to Many)`
mortgageRecording	Optional			A parent object (JSON) or node (XML) that contains metadata associated with mortgage recordings.
mortgagor	Optional	String	1 / 256	The mortgage recording morgagor.
mortgagee	Optional	String	1 / 128	The mortgage recording mortgagee.
datedDate	Optional	DateTime		The mortgage recording dated date.
book	Optional	String	0 / 32	The mortgage recording book.
page	Optional	String	0 / 32	The mortgagr recording page.
instrument	Optional	String	0 / 32	The mortgage recording instrument number.
recordedDate	Optional	DateTime		The mortgage recording recorded date.
entryType	Required	String	1 / 64	The mortgage recording entry type. Possible Values: Assignment CDOC CEMA Mtg/DOT Correction Affidavit Death Certification Deed Deed - Already Transferred Divorce Decree Heirship Affidavit Lease Memorandum of Trust Modification Agreement Mortgage/Deed of Trust Notice of Commencement Notice of Resignation of Trustee Notice of Settlement Other Power of Attny Quit Claim Deed Release/Satisfaction Reverse Mtg Special Warranty Deed Subordination TX Home Equity Affidavit and Agreement UCC UCC-1 UCC-3
amount	Required	Money		The mortgage recording amount.
requirements	Optional			A parent object (JSON) or node (XML) that contains a list of mortgage requirements. `(0 to Many)`
requirement	Optional			A parent object (JSON) or node (XML) that contains metadata associated with mortgage requirements.
description	Required	String	1 / 255	The requirement description.
text	Required	String	1 / 4096	The requirement text.
exceptions	Optional			A parent object (JSON) or node (XML) that contains a list of mortgage exceptions. `(0 to Many)`
exception	Optional			A parent object (JSON) or node (XML) that contains metadata associated with mortgage exceptions.
description	Required	String	1 / 255	The exception description.
text	Required	String	1 / 4096	The exception text.
borrowers	Required			A parent object (JSON) or node (XML) that contains a list of borrowers. `(1 to Many)` Note that the first borrower is assumed to `always` be the `Primary` borrower.
borrower	Required			A parent object (JSON) or node (XML) that contains the metadata associated with a single borrower.
firstName	Required	String	1 / 150	The borrower’s first name.
middleName	Optional	String	0 / 150	The borrower’s middle name.
lastName	Required	String	1 / 255	The borrower’s last name.
suffix	Optional	String	0 / 4	The borrower's suffix. Possible Values: II III Esq. Jr. Sr.
type	Required	String	1 / 32	The borrower's type. Note that typically this value will be set to `Borrower`. Possible Values: Asset Management Company Asset Manager Assignee Assignor Attorney Bank Attorney Borrower Borrower/Buyer Builder Buyer Buyer Agent Buyer Attorney Buyer Title Company Buyers Broker Condo Association Custodian Foreclosed Party Investor LENDER Lender Loan Officer Listing Agent MC MC Auction Company Mortgage Connect Closer Non-HUD Borrower Non-Vested Signer Other Processor Property Access Real Estate Agent Real Estate Agent - Seller Seller Seller Attorney Sellers Broker Selling Agent Servicer Settlement Agent Title Company Underwriter Vested Signer - Non-Borrower
email	Optional	String	0 / 255	The borrower’s email address.
cellPhone	Optional	String	0 / 24	The borrower's cell phone number.
ssn	Optional	String	0 / 128	The borrower's social security number.
maritalStatus	Optional	String	0 / 128	The borrower’s marital status. Possible Values: Divorced Married Separated Single Widowed
dateOfBirth	Optional	DateTime		The borrower’s date of birth. Format: `mm/dd/yyyy`
borrowerAddress	Optional			A parent object (JSON) or node (XML) that contains metadata associated with a borrower address.
address1	Required	String	1 / 255	The borrower street address.
address2	Optional	String	0 / 255	The borrower street address 2.
city	Required	String	1 / 32	The borrower city name.
state	Required	String	2 / 2	The borrower state abbreviation. Possible Values: AK, AL, AR, AS, AZ, CA, CO, CT, DC, DE, FL, FM, GA, GU, HI, IA, ID, IL, IN, KS, KY, LA, MA, MD, ME, MH, MI, MN, MO, MP, MS, MT, NC, ND, NE, NH, NJ, NM, NV, NY, OH, OK, OR, PA, PR, PW, RI, SC, SD, TN, TX, UT, VA, VI, VT, WA, WI, WV, WY.
zipCode	Required	String	5 / 5	The borrower zip code.
county	Optional	String	0 / 32	The borrower county.
parties	Required			A parent object (JSON) or node (XML) that contains a list of mortgage parties. `(1 to Many)`
party	Required			A parent object (JSON) or node (XML) that contains metadata associated with mortgage parties.
sequenceNo	Required	Integer		The party sequence number.
firstName	Required	String	1 / 150	The party first name.
lastName	Required	String	1 / 255	The party last name.
phone	Optional	String	0 / 24	The party's phone number.
email	Optional	String	0 / 255	The party's email address.
role	Required	String	1 / 32	The party's role. Possible Values: Closer LoanOfficer Processor
documents	Optional			A parent object (JSON) or node (XML) that contains a list of title documents. `(0 to Many)`
document	Optional			A parent object (JSON) or node (XML) that contains metadata associated with title documents.
documentId	Required	Integer		A number or string that uniquely identifies the document within the host system. When an outbound Product-Delivery event is sent by Mortgage Connect to the Client, the documentId will be a string in the form of an integer. The integer value represents the Identity Field and Primary Key associated with the corresponding document record. There is no hard requirement to capture this information. However, both parties are encouraged to do so, in order that conversations or any triaging of exceptions around these values can be correlated across systems.
type	Required	String	1 / 255	A name that uniquely identifies the document type. Traditionally, clients use Mortgage Connects `Document Type` names and thus there is a one to one mapping relationship that is maintained by the client. However, Mortgage Connect is aware that our naming conventions may not resonate and that there are many inconsistencies in document type naming conventions and nomenclatures. It is for this reason that Mortgage Connect is able to map the client's document type to Mortgage Connect's document type to ease the transition. Any required document mapping exercises will be addressed during the onboarding process. The supported `types`(s) are specific per integration and will be determined during the onboarding process.
name	Required	String	1 / 100	This is the user friendly name that is associated with the document.
fileType	Required	String	3 / 4	This indicates what type of document it is. This in the context of what the file extension represents. Possible Values: DOC DOCX PDF Future Values: CSV HTML JSON TXT XLS XLSX XML `DOC`, `DOCX`, and `PDF` are currently supported with the vast majority of the documents being delivered as `PDF` documents. The other types are included to support additional documents in the future.
contentMediaType	Required	String	1 / 100	This represents the content media type, i.e. `MIME Type`. Possible Values: application/msword (DOC) application/vnd.openxmlformats-officedocument.wordprocessingml.document (DOCX) application/pdf (PDF) Future Values: text/csv (CSV) text/html (HTML) application/json (JSON) text/plain (TXT) application/vnd.ms-excel (XLS) application/vnd.openxmlformats-officedocument.spreadsheetml.sheet (XLSX) application/xml (XML) At this time `application/msword (DOC)`, `application/vnd.openxmlformats-officedocument.wordprocessingml.document (DOCX)`, and `application/pdf (PDF)` are supported with `application/pdf (PDF)` being used 90+% of the time. The other types are added to support future media types.
contentUnicode TextEncodingType	Required	String	4 / 4	This indicates what unicode text encoding type was used to generate the document. Possible Values: UTF8
contentBinary EncodingType	Required	String	6 / 6	This indicates what binary encoding type was used to generate the document content. Possible Values: Base64
content	Required	String	1 / MAX	This represents the digital representation of the document after it has been encoded using Base64. See: https://en.wikipedia.org/wiki/Base64 for more information regarding Base64 formatting.
description	Optional	String	0 / 255	Provides a brief overview of the document contents.

Property Definitions - Transaction Body - Tax

Defines the properties represented in the Transaction/Tax object (JSON) or node (XML).

Property	Requirement	Data Type	Min / Max	Description
tax	Optional			A parent object (JSON) or node (XML) that contains metadata associated with the taxes.
taxParsedAddress	Required			A parent object (JSON) or node (XML) that contains metadata associated with the parsed tax address.
address1	Required	String	1 / 78	The property street address line 1.
city	Required	String	1 / 32	The property city name.
state	Required	String	2 / 2	The property state abbreviation. Possible Values: AK, AL, AR, AS, AZ, CA, CO, CT, DC, DE, FL, FM, GA, GU, HI, IA, ID, IL, IN, KS, KY, LA, MA, MD, ME, MH, MI, MN, MO, MP, MS, MT, NC, ND, NE, NH, NJ, NM, NV, NY, OH, OK, OR, PA, PR, PW, RI, SC, SD, TN, TX, UT, VA, VI, VT, WA, WI, WV, WY.
county	Required	String	1 / 32	The property county.
zipCode	Required	String	1 / 5	The property zip code.
countyFips	Required	String	1 / 5	The FIPS code for the county.
stateFips	Required	String	1 / 2	The FIPS code for the state.
taxAssessment	Required			A parent object (JSON) or node (XML) that contains metadata associated with the tax assessment.
assessmentArea	Required	String	1 / 32	the assessed area name.
address1	Optional	String	1 / 100	the assessed property street address line 1.
address2	Optional	String	0 / 100	the assessed property street address line 2.
city	Optional	String	1 / 32	the assessed property city.
state	Optional	String	2 / 2	The assessed property state abbreviation. Possible Values: AK, AL, AR, AS, AZ, CA, CO, CT, DC, DE, FL, FM, GA, GU, HI, IA, ID, IL, IN, KS, KY, LA, MA, MD, ME, MH, MI, MN, MO, MP, MS, MT, NC, ND, NE, NH, NJ, NM, NV, NY, OH, OK, OR, PA, PR, PW, RI, SC, SD, TN, TX, UT, VA, VI, VT, WA, WI, WV, WY.
zipCode	Optional	String	1 / 5	the assessed property zip code.
taxDetails	Required			A parent object (JSON) or node (XML) that contains a list of tax details. `(1 to Many)`
taxDetail	Required			A parent object (JSON) or node (XML) that contains metadata associated with the tax details.
receivedDate	Optional	DateTime		The tax received date.
taxAPN	Required	String	1 / 64	The parcel Id on the tax.
taxInstallments	Required			A parent object (JSON) or node (XML) that contains metadata associated with the tax installments.
taxSupplementalAPN	Required	String	1 / 64	The tax supplemental APN.
improvementValue	Optional	Money		The tax improvement value.
landValue	Optional	Money		The tax land value.
assessedTotalValue	Optional	Money		The tax assessed total value.
taxInstallmentDetails	Required			A parent object (JSON) or node (XML) that contains a list of tax installment details. `(1 to Many)`
taxInstallmentDetail	Required			A parent object (JSON) or node (XML) that contains metadata associated with the tax installment details.
authorities	Optional	String	0 / 64	The tax contact name.
taxPeriod	Required	String	1 / 32	The tax period.
taxYear	Required	String	4 / 32	The tax year.
amount	Required	Money		The tax amount.
status	Optional	String	0 / 12	The tax payment status Possible Values: Delinquent Due Exempt No Tax Due Open Paid Partial Pay "" i.e. `Empty String`
paymentDate	Optional	DateTime		The tax payment date.
amountDue	Required	Money		The tax good through amount due.
dueDate	Optional	DateTime		The tax due date.
delinquentDate	Optional	DateTime		The last delinquent due date on the tax.
penaltyDate	Optional	DateTime		The tax penalty date.
penalty	Required	Money		The tax penalty amount.
documents	Optional			A parent object (JSON) or node (XML) that contains metadata associated with tax documents. `(0 to Many)`
document	Optional			A parent object (JSON) or node (XML) that contains metadata associated with tax documents.
documentId	Required	Integer		A number or string that uniquely identifies the document within the host system. When an outbound Product-Delivery event is sent by Mortgage Connect to the Client, the documentId will be a string in the form of an integer. The integer value represents the Identity Field and Primary Key associated with the corresponding document record. There is no hard requirement to capture this information. However, both parties are encouraged to do so, in order that conversations or any triaging of exceptions around these values can be correlated across systems.
type	Required	String	1 / 255	A name that uniquely identifies the document type. Traditionally, clients use Mortgage Connects `Document Type` names and thus there is a one to one mapping relationship that is maintained by the client. However, Mortgage Connect is aware that our naming conventions may not resonate and that there are many inconsistencies in document type naming conventions and nomenclatures. It is for this reason that Mortgage Connect is able to map the client's document type to Mortgage Connect's document type to ease the transition. Any required document mapping exercises will be addressed during the onboarding process. The supported `types`(s) are specific per integration and will be determined during the onboarding process.
name	Required	String	1 / 100	This is the user friendly name that is associated with the document.
fileType	Required	String	3 / 4	This indicates what type of document it is. This in the context of what the file extension represents. Possible Values: DOC DOCX PDF Future Values: CSV HTML JSON TXT XLS XLSX XML `DOC`, `DOCX`, and `PDF` are currently supported with the vast majority of the documents being delivered as `PDF` documents. The other types are included to support additional documents in the future.
contentMediaType	Required	String	1 / 100	This represents the content media type, i.e. `MIME Type`. Possible Values: application/msword (DOC) application/vnd.openxmlformats-officedocument.wordprocessingml.document (DOCX) application/pdf (PDF) Future Values: text/csv (CSV) text/html (HTML) application/json (JSON) text/plain (TXT) application/vnd.ms-excel (XLS) application/vnd.openxmlformats-officedocument.spreadsheetml.sheet (XLSX) application/xml (XML) At this time `application/msword (DOC)`, `application/vnd.openxmlformats-officedocument.wordprocessingml.document (DOCX)`, and `application/pdf (PDF)` are supported with `application/pdf (PDF)` being used 90+% of the time. The other types are added to support future media types.
contentUnicode TextEncodingType	Required	String	4 / 4	This indicates what unicode text encoding type was used to generate the document. Possible Values: UTF8
contentBinary EncodingType	Required	String	6 / 6	This indicates what binary encoding type was used to generate the document content. Possible Values: Base64
content	Required	String	1 / MAX	This represents the digital representation of the document after it has been encoded using Base64. See: https://en.wikipedia.org/wiki/Base64 for more information regarding Base64 formatting.
description	Optional	String	0 / 255	Provides a brief overview of the document contents.

Property Definitions - Transaction Extensions

Defines the properties represented in the TransactionExtensions object (JSON) or node (XML). Note that this message artifact is identical for each and every message type.

View Transaction Extension Details

Title - MC165 - Fee Sheet

🌐 The following is an example payload to be posted in the body of the HTTP request.

/* Copyright © 2023 Mortgage Connect LP */
{
        "transactionHeader": {
                "transactionIdempotentId": "3B34A671-BB17-400D-90BF-7CBF9C96E8ED",
                "transactionDate": "2022-07-11T02:03:40",
                "clientCode": "1799",
                "clientName": "AcmeInc",
                "vendorCode": "MC",
                "vendorName": "Mortgage Connect"
        },
        "transactionBody": {
                "transactionCode": "Fee-Sheet",
                "transactionId": "7832143",
                "productTransactionId": "",
                "orderNumber": 2429888,
                "productCode": "TTL",
                "issuedBy": {
                        "branchName": "Mortgage Connect LP",
                        "address1": "600 Clubhouse Dr",
                        "address2": "",
                        "city": "Moon Twp",
                        "state": "PA",
                        "zipCode": "15108",
                        "phone": "866-789-1814",
                        "fax": "866-622-1183"
                },
                "issuedTo": {
                        "address1": "2021 Hawkins Circle",
                        "address2": "",
                        "city": "Los Angeles",
                        "state": "CA",
                        "zipCode": "90001",						
                        "clientName": "AcmeInc",
                        "clientNumber": 2476
                },
                "referenceNo": "1620493",
                "borrowers": {
                        "borrower": [
                                {
                                        "fullName": "John Doe"
                                }
                        ]
                },
                "propertyAddress": {
                        "address1": "113 Magnolia Dr",
                        "address2": "",
                        "city": "Pittsburgh",
                        "state": "PA",
                        "zipCode": "15009",
                        "County": "Allegheny"
                },
                "fees": {
                        "fee": [
                                {
                                        "name": "Fee 1",
                                        "amount": 5000
                                }
                        ]
                },
                "documents": {
                    "document": [
                        {
                            "documentId": "1243992",
                            "type": "Fee Sheet",
                            "name": "FeeSheet.pdf",
                            "fileType": "PDF",
                            "contentMediaType": "application/pdf",
                            "contentUnicodeTextEncodingType": "UTF8",
                            "contentBinaryEncodingType": "Base64",
                            "content": "Base64 String"							
                        }
                    ]
                }
        },
        "transactionExtensions": {
                "transactionExtension": [
                        {
                                "key": "Client Specific Key 1",
                                "value": "Client Specific Value 1"
                        },
                        {
                                "key": "Client Specific Key 2",
                                "value": "Client Specific Value 2"
                        }
                ]
        }
}
/* Copyright © 2023 Mortgage Connect LP */

<!-- Copyright © 2023 Mortgage Connect LP -->
<root>
    <transactionHeader>
        <transactionIdempotentId>3B34A671-BB17-400D-90BF-7CBF9C96E8ED</transactionIdempotentId>
        <transactionDate>022-07-11T02:03:40</transactionDate>
        <clientCode>1799</clientCode>
        <clientName>AcmeInc</clientName>
        <vendorCode>MC</vendorCode>
        <vendorName>Mortgage Connect</vendorName>
    </transactionHeader>
    <transactionBody>
        <transactionCode>Fee-Sheet</transactionCode>
        <transactionId>7832143</transactionId>
        <productTransactionId></productTransactionId>
        <orderNumber>2429888</orderNumber>
        <productCode>TTL</productCode>
        <issuedBy>
            <branchName>Mortgage Connect LP</branchName>
            <address1>600 Clubhouse Dr</address1>
            <address2></address2>
            <city>Moon Twp</city>
            <state>PA</state>
            <zipCode>15108</zipCode>
            <phone>866-789-1814</phone>
            <fax>866-622-1183</fax>
        </issuedBy>
        <issuedTo>
            <address1>2021 Hawkins Circle</address1>
            <address2></address2>
            <city>Los Angeles</city>
            <state>CA</state>
            <zipCode>90001</zipCode>
            <clientName>AcmeInc</clientName>
            <clientNumber>2476</clientNumber>
        </issuedTo>
        <referenceNo>1620493</referenceNo>
        <borrowers>
            <borrower>
                <fullName>John Doe</fullName>
            </borrower>
        </borrowers>
        <propertyAddress>
            <address1>113 Magnolia Dr</address1>
            <address2></address2>
            <city>Pittsburgh</city>
            <state>PA</state>
            <zipCode>15009</zipCode>
            <county>Allegheny</county>
        </propertyAddress>
        <fees>
            <fee>
                <name>Fee 1</name>
                <amount>5000.00</amount>
            </fee>
        </fees>
        <documents>
            <document>
                <documentId>1243992</documentId>
                <type>Fee Sheet</type>
                <name>FeeSheet.pdf</name>
                <fileType>PDF</fileType>
                <contentMediaType>application/pdf</contentMediaType>
                <contentUnicodeTextEncodingType>UTF8</contentUnicodeTextEncodingType>
                <contentBinaryEncodingType>Base64</contentBinaryEncodingType>
                <content>Base64 String</content>				
            </document>
        </documents>
    </transactionBody>
    <transactionExtensions>
        <transactionExtension>
            <key>Client Specific Key 1</key>
            <value>Client Specific Value 1</value>
        </transactionExtension>
        <transactionExtension>
            <key>Client Specific Key 2</key>
            <value>Client Specific Value 1</value>
        </transactionExtension>
    </transactionExtensions>
</root>
<!-- Copyright © 2023 Mortgage Connect LP -->

👍 The request payload can be verified using the following validation schema.

/* Copyright © 2023 Mortgage Connect LP */
{
    "$schema": "http://json-schema.org/draft-07/schema#",
    "$id": "root",
    "description": "Copyright @ 2022 Mortgage Connect LP - Title & Tax Schema.",
    "type": "object",
    "additionalProperties": false,
    "properties": {
        "legalHeader": {
            "type": "object",
            "additionalProperties": false,
            "properties": {
                "version": {
                    "examples": [
                        "1.0.8.0"
                    ],
                    "type": "string",
                    "minLength": 1,
                    "maxLength": 20
                },
                "disclosingParty": {
                    "examples": [
                        "Copyright @ 2022 Mortgage Connect LP"
                    ],
                    "type": "string",
                    "minLength": 1,
                    "maxLength": 100
                },
                "proprietaryInformationAndConfidential": {
                    "examples": [
                        "Ownership of Proprietary Information. The Recipient agrees that it shall not receive any right, title or interest, or any license or right to use, the Disclosing Partys Proprietary Information, including, but not limited to, technology, ideas, concepts, drawings, documentation, designs, prototypes, processes, trade secrets, trademarks or other intellectual property rights therein, by implication or otherwise."
                    ],
                    "type": "string",
                    "minLength": 1,
                    "maxLength": 2000
                }
            },
            "required": [
                "version",
                "disclosingParty",
                "proprietaryInformationAndConfidential"
            ],
            "minProperties": 3,
            "maxProperties": 3
        },
        "transactionHeader": {
            "type": "object",
            "additionalProperties": false,
            "properties": {
                "transactionIdempotentId": {
                    "examples": [
                        "3B34A671-BB17-400D-90BF-7CBF9C96E8ED"
                    ],
                    "type": "string",
                    "minLength": 36,
                    "maxLength": 36,
                    "pattern": "^[\\da-fA-F]{8}-[\\da-fA-F]{4}-[\\da-fA-F]{4}-[\\da-fA-F]{4}-[\\da-fA-F]{12}$"
                },
                "transactionDate": {
                    "examples": [
                        "2022-07-11T02:03:40"
                    ],
                    "type": "string",
                    "format": "date-time"
                },
                "clientCode": {
                    "examples": [
                        "1799"
                    ],
                    "type": "string",
                    "minLength": 1,
                    "maxLength": 100,
                    "format": "integer"
                },
                "clientName": {
                    "examples": [
                        "AcmeInc"
                    ],
                    "type": "string",
                    "minLength": 1,
                    "maxLength": 100
                },
                "vendorCode": {
                    "examples": [
                        "MC"
                    ],
                    "type": "string",
                    "minLength": 1,
                    "maxLength": 100
                },
                "vendorName": {
                    "examples": [
                        "Mortgage Connect"
                    ],
                    "type": "string",
                    "minLength": 1,
                    "maxLength": 100
                }
            },
            "required": [
                "transactionIdempotentId",
                "transactionDate",
                "clientCode",
                "clientName",
                "vendorCode",
                "vendorName"
            ],
            "minProperties": 6,
            "maxProperties": 6
        },
        "transactionBody": {
            "type": "object",
            "additionalProperties": false,
            "properties": {
                "transactionCode": {
                    "examples": [
                        "FeeSheet"
                    ],
                    "type": "string",
                    "const": "FeeSheet"
                },
                "transactionId": {
                    "examples": [
                        "7832143"
                    ],
                    "type": "string",
                    "minLength": 1,
                    "maxLength": 50
                },
                "productTransactionId": {
                    "examples": [
                        "7832143"
                    ],
                    "type": "string",
                    "minLength": 0,
                    "maxLength": 50
                },     
                "orderNumber": {
                    "examples": [
                        "2429888"
                    ],
                    "type": "integer"
                },
                "productCode": {
                    "type": "string",
                    "minLength": 3,
                    "maxLength": 4,
                    "enum": [
                        "LVR",
                        "PRT",
                        "PUR",
                        "TTL"
                    ]
                },
                "issuedBy": {
                    "type": "object",
                    "properties": {
                        "branchName": {
                            "examples": [
                                "Mortgage Connect LP"
                            ],
                            "type": "string"
                        },
                        "address1": {
                            "examples": [
                                "1204 New York Drive"
                            ],
                            "type": "string",
                            "maxLength": 32
                        },
                        "address2": {
                            "examples": [
                                "1204 New York Drive"
                            ],
                            "type": "string",
                            "maxLength": 32
                        },
                        "city": {
                            "examples": [
                                "Mckees Rocks"
                            ],
                            "type": "string",
                            "maxLength": 32
                        },
                        "state": {
                            "examples": [
                                "PA"
                            ],
                            "type": "string",
                            "enum": [
                                "AK",
                                "AL",
                                "AR",
                                "AS",
                                "AZ",
                                "CA",
                                "CO",
                                "CT",
                                "DC",
                                "DE",
                                "FL",
                                "FM",
                                "GA",
                                "GU",
                                "HI",
                                "IA",
                                "ID",
                                "IL",
                                "IN",
                                "KS",
                                "KY",
                                "LA",
                                "MA",
                                "MD",
                                "ME",
                                "MH",
                                "MI",
                                "MN",
                                "MO",
                                "MP",
                                "MS",
                                "MT",
                                "NC",
                                "ND",
                                "NE",
                                "NH",
                                "NJ",
                                "NM",
                                "NV",
                                "NY",
                                "OH",
                                "OK",
                                "OR",
                                "PA",
                                "PR",
                                "PW",
                                "RI",
                                "SC",
                                "SD",
                                "TN",
                                "TX",
                                "UT",
                                "VA",
                                "VI",
                                "VT",
                                "WA",
                                "WI",
                                "WV",
                                "WY"
                            ]
                        },
                        "zipCode": {
                            "examples": [
                                "15136"
                            ],
                            "type": "string",
                            "minLength": 5,
                            "maxLength": 5,
                            "pattern": "^[0-9]{5}$"
                        },
                        "phone": {
                            "examples": [
                                "866-789-1814"
                            ],
                            "type": "string"
                        },
                        "fax": {
                            "examples": [
                                "866-789-1845"
                            ],
                            "type": "string"
                        }
                    },
                    "required": [
                        "branchName",
                        "address1",
                        "city",
                        "state",
                        "zipCode"
                    ]
                },
                "issuedTo": {
                    "type": "object",
                    "properties": {
                        "address1": {
                            "$ref": "root#/properties/transactionBody/properties/issuedBy/properties/address1"
                        },
                        "address2": {
                            "$ref": "root#/properties/transactionBody/properties/issuedBy/properties/address2"
                        },
                        "city": {
                            "$ref": "root#/properties/transactionBody/properties/issuedBy/properties/city"
                        },
                        "state": {
                            "$ref": "root#/properties/transactionBody/properties/issuedBy/properties/state"
                        },
                        "zipCode": {
                            "$ref": "root#/properties/transactionBody/properties/issuedBy/properties/zipCode"
                        },
                        "clientName": {
                            "examples": [
                                "Acme Bank and Trust"
                            ],
                            "type": "string"
                        },
                        "clientNumber": {
                            "examples": [
                                "2476"
                            ],
                            "type": "integer"
                        }
                    },
                    "required": [
                        "address1",
                        "city",
                        "state",
                        "zipCode"
                    ]
                },
                "referenceNo": {
                    "examples": [
                        "1620493"
                    ],
                    "type": "string"
                },
                "borrowers": {
                    "type": "object",
                    "properties": {
                        "borrower": {
                            "type": "array",
                            "items": {
                                "fullName": {
                                    "type": "string"
                                }
                            },
                            "minItems": 1
                        }
                    }
                },
                "propertyAddress": {
                    "type": "object",
                    "additionalProperties": false,
                    "properties": {
                        "address1": {
                            "$ref": "root#/properties/transactionBody/properties/issuedBy/properties/address1"
                        },
                        "address2": {
                            "$ref": "root#/properties/transactionBody/properties/issuedBy/properties/address2"
                        },
                        "city": {
                            "$ref": "root#/properties/transactionBody/properties/issuedBy/properties/city"
                        },
                        "state": {
                            "$ref": "root#/properties/transactionBody/properties/issuedBy/properties/state"
                        },
                        "zipCode": {
                            "$ref": "root#/properties/transactionBody/properties/issuedBy/properties/zipCode"
                        },
                        "county": {
                            "examples": [
                                "Allegheny"
                            ],
                            "type": "string",
                            "maxLength": 32
                        }
                    },
                    "required": [
                        "address1",
                        "city",
                        "state",
                        "zipCode"
                    ],
                    "minProperties": 4,
                    "maxProperties": 6
                },
                "fees": {
                    "type": "object",
                    "properties": {
                        "fee": {
                            "type": "array",
                            "items": {
                                "name": {
                                    "type": "string"
                                },
                                "amount": {
                                    "$ref": "CommonTypes#/$defs/money"
                                }
                            },
                            "minItems": 1
                        }
                    }
                },
                 "documents": {
                    "type": "object",
                    "properties": {
                        "document": {
                        "type": "array",
                        "items": {
                            "type": "object",
                            "properties": {
                            "documentId": {
                                "examples": [
                                "1243992"
                                ],
                                "type": "string"
                            },
                            "type": {
                                "type": "string",
                                "minLength": 0,
                                "maxLength": 0,
                                "enum": [
                                "Other"
                                ]
                            },
                            "name": {
                                "examples": [
                                "patriot-search.pdf"
                                ],
                                "type": "string",
                                "maxLength": 100
                            },
                            "fileType": {
                                "type": "string",
                                "enum": [
                                "DOC",
                                "DOCX",
                                "PDF",
                                "doc",
                                "docx",
                                "pdf"
                                ]
                            },
                            "contentMediaType": {
                                "type": "string",
                                "enum": [
                                "application/msword",
                                "application/vnd.openxmlformats-officedocument.wordprocessingml.document",
                                "application/pdf"
                                ]
                            },
                            "contentUnicodeTextEncodingType": {
                                "type": "string",
                                "enum": [
                                "UTF8"
                                ]
                            },
                            "contentBinaryEncodingType": {
                                "type": "string",
                                "enum": [
                                "Base64"
                                ]
                            },
                            "content": {
                                "contentEncoding": "base64",
                                "type": "string"
                            }							
                            },
                            "allOf": [
                            {
                                "if": {
                                "properties": { "fileType": { "enum": [ "DOC", "doc" ] } }
                                },
                                "then": {
                                "properties": { "contentMediaType": { "enum": [ "application/msword" ] } }
                                }
                            },
                            {
                                "if": {
                                "properties": { "fileType": { "enum": [ "DOCX", "docx" ] } }
                                },
                                "then": {
                                "properties": { "contentMediaType": { "enum": [ "application/vnd.openxmlformats-officedocument.wordprocessingml.document" ] } }
                                }
                            },
                            {
                                "if": {
                                "properties": { "fileType": { "enum": [ "PDF", "pdf" ] } }
                                },
                                "then": {
                                "properties": { "contentMediaType": { "enum": [ "application/pdf" ] } }
                                }
                            }
                            ],
                            "required": [
                            "documentId",
                            "type",
                            "name",
                            "fileType",
                            "contentMediaType",
                            "contentUnicodeTextEncodingType",
                            "contentBinaryEncodingType",
                            "content"
                            ]
                        },
                        "minItems": 1
                        }
                    }
                }
            },
            "required": [
                "transactionCode",
                "transactionId",
                "orderNumber",
                "issuedBy",
                "issuedTo",
                "propertyAddress"
            ]
        },
        "transactionExtensions": {
            "type": "object",
            "properties": {
                "transactionExtension": {
                    "type": "array",
                    "items": {
                        "type": "object",
                        "additionalProperties": false,
                        "properties": {
                            "key": {
                                "examples": [
                                    "Client Specific Key"
                                ],
                                "type": "string",
                                "minLength": 1,
                                "maxLength": 200
                            },
                            "value": {
                                "examples": [
                                    "Client Specific Value"
                                ],
                                "type": "string",
                                "minLength": 1
                            }
                        },
                        "required": [
                            "key",
                            "value"
                        ],
                        "minProperties": 2,
                        "maxProperties": 2
                    },
                    "minItems": 0
                }
            }
        }
    },
    "required": [
        "transactionHeader",
        "transactionBody"
    ],
    "minProperties": 2,
    "maxProperties": 4
}
/* Copyright © 2023 Mortgage Connect LP */

<!-- Copyright © 2023 Mortgage Connect LP -->
<?xml version="1.0" encoding="utf-8"?>
<xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema">
    <xs:element name="root">
    <xs:complexType>
        <xs:sequence>
            <xs:element ref="legalHeader" minOccurs="0"/>
            <xs:element ref="transactionHeader"/>
            <xs:element name="transactionBody">
                <xs:complexType>
                    <xs:all>
                        <xs:element name="transactionCode" type="xs:string" fixed="FeeSheet"/>
                        <xs:element ref="transactionId"/>
                        <xs:element name="productTransactionId" type="xs:string" minOccurs="0"/>
                        <xs:element name="orderNumber" type="orderNo"/>
                        <xs:element ref="productCode"/>
                        <xs:element name="issuedBy" minOccurs="1">
                            <xs:complexType>
                                <xs:all>
                                    <xs:element name="branchName" type="xs:string"/>
                                    <xs:element name="address1" type="addressLine"/>
                                    <xs:element name="address2" type="addressLine" minOccurs="0"/>
                                    <xs:element name="city" type="city"/>
                                    <xs:element name="state" type="state"/>
                                    <xs:element name="zipCode" type="zipCode"/>
                                    <xs:element name="phone" type="phone"/>
                                    <xs:element name="fax" type="phone"/>
                                </xs:all>
                            </xs:complexType>
                        </xs:element>
                        <xs:element name="issuedTo" minOccurs="1">
                            <xs:complexType>
                                <xs:all>
                                    <xs:element name="address1" type="addressLine"/>
                                    <xs:element name="address2" type="addressLine" minOccurs="0"/>
                                    <xs:element name="city" type="city"/>
                                    <xs:element name="state" type="state"/>
                                    <xs:element name="zipCode" type="zipCode"/>
                                    <xs:element name="clientName" type="xs:string"/>
                                    <xs:element name="clientNumber" type="xs:int"/>
                                </xs:all>
                            </xs:complexType>
                        </xs:element>
                        <xs:element name="referenceNo" type="xs:string"/>
                        <xs:element name="borrowers">
                            <xs:complexType>
                                <xs:sequence>
                                    <xs:element name="borrower" maxOccurs="unbounded">
                                        <xs:complexType>
                                            <xs:all>
                                                <xs:element name="fullName" type="xs:string"/>
                                            </xs:all>
                                        </xs:complexType>
                                    </xs:element>
                                </xs:sequence>
                            </xs:complexType>
                        </xs:element>
                        <xs:element name="propertyAddress" type="address" minOccurs="1"/>
                        <xs:element name="fees">
                            <xs:complexType>
                                <xs:sequence>
                                    <xs:element name="fee" maxOccurs="unbounded">
                                        <xs:complexType>
                                            <xs:all>
                                                <xs:element name="name" type="xs:string"/>
                                                <xs:element name="amount" type="money"/>
                                            </xs:all>
                                        </xs:complexType>
                                    </xs:element>
                                </xs:sequence>
                            </xs:complexType>
                        </xs:element>
                        <xs:element name="documents" minOccurs="0" maxOccurs="1">
                            <xs:complexType>
                                <xs:sequence>
                                    <xs:element ref="document" minOccurs="1" maxOccurs="unbounded"/>
                                </xs:sequence>
                            </xs:complexType>
                        </xs:element>  						
            <xs:element ref="transactionExtensions" minOccurs="0"/>
        </xs:sequence>
    </xs:complexType>
    </xs:element>
</xs:schema>
<!-- Copyright © 2023 Mortgage Connect LP -->

✅ The following is an 'Accepted' example payload to be returned in the HTTP response.

Accepted Acknowledgment payloads are typically message type agnostic.

Accepted Acknowledgment payloads are typically message type agnostic.

⛔ The following is a 'Rejected' example payload to be returned in the HTTP response.

Rejected Acknowledgment payloads are typically message type agnostic.

Rejected Acknowledgment payloads are typically message type agnostic.

The Fee Sheet API method is the mechanism in which Mortgage Connect can submit a message to the Client to deliver the Fee Sheet information and supporting metadata.

View Workflow Orchestration

Client URL

POST 🔒 To be determined during onboarding process.

Property Definitions - Transaction Header

Defines the properties represented in the Transaction Header object (JSON) or node (XML). Note that this message artifact is identical for each and every message type.

View Transaction Header Details

Property Definitions - Transaction Body

Defines the properties represented in the Transaction Body object (JSON) or node (XML).

Property	Requirement	Data Type	Min / Max	Description
transactionBody	Required			A parent object (JSON) or node (XML) that contains the transaction metadata.
transactionCode	Required	String	14 / 14	A static value of `Fee-Sheet`. The transaction code is meant to identify the message type and the context or action that should be taken. In this context it implies that a Fee Sheet should be delivered to the client. Possible Values: Fee-Sheet
transactionId	Required	String	1 / 50	Represents the Client's unique order number.
productTransactionId	Optional	String	0 / 50	Represents the Client's unique product order number. Note that the `productTransactionId` field is not used in most circumstances. However, when there is a need to further differentiate order numbers at a product level, that share the same `transactionId`, (i.e. the primary order level id), then the `productTransactionId` can be used to ensure uniqueness across the integration transactions. This makes it possible for multiple orders of the same product type to be placed using the same `transactionId`. The use of the `productTransactionId` field and any specific workflow deviations will be vetted during the onboarding process.
orderNumber	Required	Integer		Represents Mortgage Connects unique order number.
productCode	Required	String	3 / 4	Represents Mortgage Connect's product code. Possible Values: LVR `LEGAL & VEString REPORT` PRT `PROPERTY REPORT` PUR `PURCHASE` TTL `TITLE INSURANCE` etc. Traditionally, clients use Mortgage Connects `Product Code` names and thus there is a one to one mapping relationship that is maintained by the client. However, Mortgage Connect is aware that our naming conventions may not resonate and that there are many inconsistencies in product code naming conventions and nomenclatures. It is for this reason that Mortgage Connect is able to map the client's product code to Mortgage Connect's product code to ease the transition. Any required product code mapping exercises will be addressed during the onboarding process. The supported `productCode`(s) are specific per integration and will be determined during the onboarding process. Note that the minimum/maximum length requirement of 3/4 is only applicable if using Mortgage Connect's internal product codes, otherwise when mapping to the client's product codes, the minimum/maximum is 1/50.
issuedBy	Required			A parent object (JSON) or node (XML) that contains issued by metadata.
branchName	Required	String	1 / 50	The name of issuing branch.
address1	Required	String	1 / 255	The branch street address.
address2	Optional	String	0 / 255	The branch street address 2.
city	Required	String	1 / 32	The branch city name.
state	Required	String	2 / 2	The branch state abbreviation. Possible Values: AK, AL, AR, AS, AZ, CA, CO, CT, DC, DE, FL, FM, GA, GU, HI, IA, ID, IL, IN, KS, KY, LA, MA, MD, ME, MH, MI, MN, MO, MP, MS, MT, NC, ND, NE, NH, NJ, NM, NV, NY, OH, OK, OR, PA, PR, PW, RI, SC, SD, TN, TX, UT, VA, VI, VT, WA, WI, WV, WY.
zipCode	Required	String	5 / 5	The branch zip code.
phone	Optional	String	0 / 24	The branch phone number.
fax	Optional	String	0 / 24	The branch fax number.
issuedTo	Required			A parent object (JSON) or node (XML) that contains issued to metadata.
address1	Required	String	1 / 255	The client street address.
address2	Optional	String	0 / 255	The client street address 2.
city	Required	String	1 / 32	The client city name.
state	Required	String	2 / 2	The client state abbreviation. Possible Values: AK, AL, AR, AS, AZ, CA, CO, CT, DC, DE, FL, FM, GA, GU, HI, IA, ID, IL, IN, KS, KY, LA, MA, MD, ME, MH, MI, MN, MO, MP, MS, MT, NC, ND, NE, NH, NJ, NM, NV, NY, OH, OK, OR, PA, PR, PW, RI, SC, SD, TN, TX, UT, VA, VI, VT, WA, WI, WV, WY.
zipCode	Required	String	5 / 5	The client zip code.
clientName	Optional	String	1 / 50	The name of the issued client.
clientNumber	Optional	Integer		The client number.
referenceNo	Required	String	1 / 50	This represents the reference number.
borrowers	Required			A parent object (JSON) or node (XML) that contains borrowers metadata. (1 to Many)
borrower	Required			A parent object (JSON) or node (XML) that contains borrow metadata.
fullName	Required	String	1 / 100	The full name of a borrower.
propertyAddress	Required			A parent object (JSON) or node (XML) that contains issued to metadata.
address1	Required	String	1 / 255	The property street address.
address2	Optional	String	0 / 255	The property street address 2.
city	Required	String	1 / 32	The property city name.
state	Required	String	2 / 2	The property state abbreviation. Possible Values: AK, AL, AR, AS, AZ, CA, CO, CT, DC, DE, FL, FM, GA, GU, HI, IA, ID, IL, IN, KS, KY, LA, MA, MD, ME, MH, MI, MN, MO, MP, MS, MT, NC, ND, NE, NH, NJ, NM, NV, NY, OH, OK, OR, PA, PR, PW, RI, SC, SD, TN, TX, UT, VA, VI, VT, WA, WI, WV, WY.
zipCode	Required	String	5 / 5	The property zip code.
county	Optional	String	1 / 32	The property county name.
fees	Required			A parent object (JSON) or node (XML) that contains fees metadata. (1 to Many)
fee	Required			A parent object (JSON) or node (XML) that contains fee metadata.
name	Required	String	1 / 100	The name of a fee.
amount	Required	Money	1 / 100	The amount associated with a fee.
documents	Optional			A parent object (JSON) or node (XML) that contains a list of document metadata. `(0 to Many)`
document	Optional			A parent object (JSON) or node (XML) that contains the metadata associated with a single document.
documentId	Required	String	1/36	A number or string that uniquely identifies the document within the host system. When an outbound Add-Attachment event is sent by Mortgage Connect to the Client, the documentId will be a string in the form of an integer. The integer value represents the Identity Field and Primary Key associated with the corresponding document record. Likewise, when the Client sends Mortgage Connect an Add-Attachment event, the documentId could also represent an Integer, however, there is no reason why the value could not be a unique string like a GUID. No matter what value is passed, the value needs to represent a unique value that uniquely identifies the attached document. There is no hard requirement to capture this information. However, both parties are encouraged to do so, in order that conversations or any triaging of exceptions around these values can be correlated across systems.
type	Required	String	1 / 255	A name that uniquely identifies the document type. Traditionally, clients use Mortgage Connects `Document Type` names and thus there is a one to one mapping relationship that is maintained by the client. However, Mortgage Connect is aware that our naming conventions may not resonate and that there are many inconsistencies in document type naming conventions and nomenclatures. It is for this reason that Mortgage Connect is able to map the client's document type to Mortgage Connect's document type to ease the transition. Any required document mapping exercises will be addressed during the onboarding process. The supported `types`(s) are specific per integration and will be determined during the onboarding process.
name	Required	String	1 / 100	This is the user friendly name that is associated with the document.
fileType	Required	String	3 / 4	This indicates what type of document it is. This in the context of what the file extension represents. Possible Values: DOC DOCX PDF Future Values: CSV HTML JSON TXT XLS XLSX XML `DOC`, `DOCX`, and `PDF` are currently supported with the vast majority of the documents being delivered as `PDF` documents. The other types are included to support additional documents in the future.
contentMediaType	Required	String	1 / 100	This represents the content media type, i.e. `MIME Type`. Possible Values: application/msword (DOC) application/vnd.openxmlformats-officedocument.wordprocessingml.document (DOCX) application/pdf (PDF) Future Values: text/csv (CSV) text/html (HTML) application/json (JSON) text/plain (TXT) application/vnd.ms-excel (XLS) application/vnd.openxmlformats-officedocument.spreadsheetml.sheet (XLSX) application/xml (XML) At this time `application/msword (DOC)`, `application/vnd.openxmlformats-officedocument.wordprocessingml.document (DOCX)`, and `application/pdf (PDF)` are supported with `application/pdf (PDF)` being used 90+% of the time. The other types are added to support future media types.
contentUnicode TextEncodingType	Required	String	4 / 4	This indicates what unicode text encoding type was used to generate the document. Possible Values: UTF8
contentBinary EncodingType	Required	String	6 / 6	This indicates what binary encoding type was used to generate the document content. Possible Values: Base64
content	Required	String	1 / MAX	This represents the digital representation of the document after it has been encoded using Base64. See: https://en.wikipedia.org/wiki/Base64 for more information regarding Base64 formatting.

Property Definitions - Transaction Extensions

Defines the properties represented in the TransactionExtensions object (JSON) or node (XML). Note that this message artifact is identical for each and every message type.

View Transaction Extension Details

Title - MC170 - Clear Title

🌐 The following is an example payload to be posted in the body of the HTTP request.

/* Copyright © 2023 Mortgage Connect LP */
{
    "transactionHeader": {
        "transactionIdempotentId": "3B34A671-BB17-400D-90BF-7CBF9C96E8ED",
        "transactionDate": "2022-07-11T02:03:40",
        "clientCode": "1799",
        "clientName": "AcmeInc",
        "vendorCode": "MC",
        "vendorName": "Mortgage Connect"
    },
    "transactionBody": {
        "transactionCode": "Clear-Title",
        "transactionId": "7832143",
        "productTransactionId": "",
        "orderNumber": 2429888,
        "productCode": "TTL",
        "comment": "Clear to close.",
        "commentDate": "2022-07-11T02:03:40"
    },
    "transactionExtensions": {
        "transactionExtension": [
            {
                "key": "Client Specific Key 1",
                "value": "Client Specific Value 1"
            },
            {
                "key": "Client Specific Key 2",
                "value": "Client Specific Value 2"
            }
        ]
    }
}
/* Copyright © 2023 Mortgage Connect LP */

<!-- Copyright © 2023 Mortgage Connect LP -->
<root>
    <transactionHeader>
        <transactionIdempotentId>3B34A671-BB17-400D-90BF-7CBF9C96E8ED</transactionIdempotentId>
        <transactionDate>022-07-11T02:03:40</transactionDate>
        <clientCode>1799</clientCode>
        <clientName>AcmeInc</clientName>
        <vendorCode>MC</vendorCode>
        <vendorName>Mortgage Connect</vendorName>
    </transactionHeader>
    <transactionBody>
        <transactionCode>Clear-Title</transactionCode>
        <transactionId>7832143</transactionId>
        <productTransactionId></productTransactionId>
        <orderNumber>2429888</orderNumber>
        <productCode>TTL</productCode>
        <comment>Clear to close.</comment>
        <commentDate>2022-07-11T02:03:40</commentDate>
    </transactionBody>
    <transactionExtensions>
        <transactionExtension>
            <key>Client Specific Key 1</key>
            <value>Client Specific Value 1</value>
        </transactionExtension>
        <transactionExtension>
            <key>Client Specific Key 2</key>
            <value>Client Specific Value 1</value>
        </transactionExtension>
    </transactionExtensions>
</root>
<!-- Copyright © 2023 Mortgage Connect LP -->

👍 The request payload can be verified using the following validation schema.

/* Copyright © 2023 Mortgage Connect LP */
{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "$id": "root",
  "description": "Copyright @ 2022 Mortgage Connect LP - Title & Tax Schema.",
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "legalHeader": {
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "version": {
          "examples": [
            "1.0.8.0"
          ],
          "type": "string",
          "minLength": 1,
          "maxLength": 20
        },
        "disclosingParty": {
          "examples": [
            "Copyright @ 2022 Mortgage Connect LP"
          ],
          "type": "string",
          "minLength": 1,
          "maxLength": 100
        },
        "proprietaryInformationAndConfidential": {
          "examples": [
            "Ownership of Proprietary Information. The Recipient agrees that it shall not receive any right, title or interest, or any license or right to use, the Disclosing Partys Proprietary Information, including, but not limited to, technology, ideas, concepts, drawings, documentation, designs, prototypes, processes, trade secrets, trademarks or other intellectual property rights therein, by implication or otherwise."
          ],
          "type": "string",
          "minLength": 1,
          "maxLength": 2000
        }
      },
      "required": [
        "version",
        "disclosingParty",
        "proprietaryInformationAndConfidential"
      ],
      "minProperties": 3,
      "maxProperties": 3
    },
    "transactionHeader": {
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "transactionIdempotentId": {
          "examples": [
            "3B34A671-BB17-400D-90BF-7CBF9C96E8ED"
          ],
          "type": "string",
          "minLength": 36,
          "maxLength": 36,
          "pattern": "^[\\da-fA-F]{8}-[\\da-fA-F]{4}-[\\da-fA-F]{4}-[\\da-fA-F]{4}-[\\da-fA-F]{12}$"
        },
        "transactionDate": {
          "examples": [
            "2022-07-11T02:03:40"
          ],
          "type": "string",
          "format": "date-time"
        },
        "clientCode": {
          "examples": [
            "1799"
          ],
          "type": "string",
          "minLength": 1,
          "maxLength": 100,
          "format": "integer"
        },
        "clientName": {
          "examples": [
            "AcmeInc"
          ],
          "type": "string",
          "minLength": 1,
          "maxLength": 100
        },
        "vendorCode": {
          "examples": [
            "MC"
          ],
          "type": "string",
          "minLength": 1,
          "maxLength": 100
        },
        "vendorName": {
          "examples": [
            "Mortgage Connect"
          ],
          "type": "string",
          "minLength": 1,
          "maxLength": 100
        }
      },
      "required": [
        "transactionIdempotentId",
        "transactionDate",
        "clientCode",
        "clientName",
        "vendorCode",
        "vendorName"
      ],
      "minProperties": 6,
      "maxProperties": 6
    },
    "transactionBody": {
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "transactionCode": {
          "examples": [
            "Clear-Title"
          ],
          "type": "string",
          "const": "Clear-Title"
        },
        "transactionId": {
          "examples": [
            "7832143"
          ],
          "type": "string",
          "minLength": 1,
          "maxLength": 50
        },
        "productTransactionId": {
          "examples": [
            "7832143"
          ],
          "type": "string",
          "minLength": 0,
          "maxLength": 50
        },
        "orderNumber": {
          "examples": [
            "2429888"
          ],
          "type": "integer"
        },
        "productCode": {
          "type": "string",
          "minLength": 3,
          "maxLength": 4,
          "enum": [
            "LVR",
            "PRT",
            "PUR",
            "TTL"
          ]
        },
        "comment": {
          "example": [
            "Clear to close."
          ],
          "type": "string"
        },
        "commentDate": {
          "example": [
            "07-11-2022T14:00:00-4:00"
          ],
          "type": "string",
          "format": "date-time"
        }
      },
      "required": [
        "transactionCode",
        "transactionId",
        "orderNumber",
        "productCode",
        "comment",
        "commentDate"
      ]
    },
    "transactionExtensions": {
      "type": "object",
      "properties": {
        "transactionExtension": {
          "type": "array",
          "items": {
            "type": "object",
            "additionalProperties": false,
            "properties": {
              "key": {
                "examples": [
                  "Client Specific Key"
                ],
                "type": "string",
                "minLength": 1,
                "maxLength": 200
              },
              "value": {
                "examples": [
                  "Client Specific Value"
                ],
                "type": "string",
                "minLength": 1
              }
            },
            "required": [
              "key",
              "value"
            ],
            "minProperties": 2,
            "maxProperties": 2
          },
          "minItems": 0
        }
      }
    }
  },
  "required": [
    "transactionHeader",
    "transactionBody"
  ],
  "minProperties": 2,
  "maxProperties": 4
}
/* Copyright © 2023 Mortgage Connect LP */

The request payload XML schema validation is under construction. 🚧

✅ The following is an 'Accepted' example payload to be returned in the HTTP response.

Accepted Acknowledgment payloads are typically message type agnostic.

Accepted Acknowledgment payloads are typically message type agnostic.

⛔ The following is a 'Rejected' example payload to be returned in the HTTP response.

Rejected Acknowledgment payloads are typically message type agnostic.

Rejected Acknowledgment payloads are typically message type agnostic.

The Clear Title API method is the mechanism in which Mortgage Connect can submit a message to the Client to deliver the Title Clearance Status and supporting metadata.

View Workflow Orchestration

Client URL

POST 🔒 To be determined during onboarding process.

Property Definitions - Transaction Header

Defines the properties represented in the Transaction Header object (JSON) or node (XML). Note that this message artifact is identical for each and every message type.

View Transaction Header Details

Property Definitions - Transaction Body

Defines the properties represented in the Transaction Body object (JSON) or node (XML).

Property	Requirement	Data Type	Min / Max	Description
transactionBody	Required			A parent object (JSON) or node (XML) that contains the transaction metadata.
transactionCode	Required	String	11 / 11	A static value of `Clear-Title`. The transaction code is meant to identify the message type and the context or action that should be taken. In this context it implies that the title is cleared and you can proceed to close. Possible Values: Clear-Title
transactionId	Required	String	1 / 50	Represents the Client's unique order number.
productTransactionId	Optional	String	0 / 50	Represents the Client's unique product order number. Note that the `productTransactionId` field is not used in most circumstances. However, when there is a need to further differentiate order numbers at a product level, that share the same `transactionId`, (i.e. the primary order level id), then the `productTransactionId` can be used to ensure uniqueness across the integration transactions. This makes it possible for multiple orders of the same product type to be placed using the same `transactionId`. The use of the `productTransactionId` field and any specific workflow deviations will be vetted during the onboarding process.
orderNumber	Required	Integer		Represents Mortgage Connects unique order number.
productCode	Required	String	3 / 4	Represents Mortgage Connect's product code. Possible Values: LVR `LEGAL & VEString REPORT` PRT `PROPERTY REPORT` PUR `PURCHASE` TTL `TITLE INSURANCE` etc. Traditionally, clients use Mortgage Connects `Product Code` names and thus there is a one to one mapping relationship that is maintained by the client. However, Mortgage Connect is aware that our naming conventions may not resonate and that there are many inconsistencies in product code naming conventions and nomenclatures. It is for this reason that Mortgage Connect is able to map the client's product code to Mortgage Connect's product code to ease the transition. Any required product code mapping exercises will be addressed during the onboarding process. The supported `productCode`(s) are specific per integration and will be determined during the onboarding process. Note that the minimum/maximum length requirement of 3/4 is only applicable if using Mortgage Connect's internal product codes, otherwise when mapping to the client's product codes, the minimum/maximum is 1/50.
comment	Required	String	1 / MAX	A general comment indicating that the title order is cleared.
commentDate	Required	DateTime		The date when the title order was cleared.

Property Definitions - Transaction Extensions

Defines the properties represented in the TransactionExtensions object (JSON) or node (XML). Note that this message artifact is identical for each and every message type.

View Transaction Extension Details

Title - MC172 - Settlement Agent

🌐 The following is an example payload to be posted in the body of the HTTP request.

/* Copyright © 2023 Mortgage Connect LP */
{
    "transactionHeader": {
        "transactionIdempotentId": "3B34A671-BB17-400D-90BF-7CBF9C96E8ED",
        "transactionDate": "2022-07-11T02:03:40",
        "clientCode": "1799",
        "clientName": "AcmeInc",
        "vendorCode": "MC",
        "vendorName": "Mortgage Connect"
    },
    "transactionBody": {
        "transactionCode": "Settlement-Agent",
        "transactionId": "7832143",
        "productTransactionId": "",
        "orderNumber": 2429888,
        "productCode": "TTL",
        "providerName": "Mortgage Connect",
        "providerAddress": {
            "address1": "600 Clubhouse Road",
            "city": "Coraopolis",
            "state": "PA",
            "zipCode": "15108"
        },
        "providerNMLSID": "96DBO-48663",
        "providerSTLicenseID": "96DBO48663",
        "agentName": "Mortgage Connect",
        "agentNMLSID": "96DBO-48663",
        "agentSTLicenseID": "96DBO48663",
        "agentEMail": "ubs@mortgageconnectlp.com",
        "agentPhone": "866-789-1814"
    },
    "transactionExtensions": {
        "transactionExtension": [
            {
                "key": "Client Specific Key 1",
                "value": "Client Specific Value 1"
            },
            {
                "key": "Client Specific Key 2",
                "value": "Client Specific Value 2"
            }
        ]
    }
}
/* Copyright © 2023 Mortgage Connect LP */

<!-- Copyright © 2023 Mortgage Connect LP -->
<root>
    <transactionHeader>
        <transactionIdempotentId>3B34A671-BB17-400D-90BF-7CBF9C96E8ED</transactionIdempotentId>
        <transactionDate>022-07-11T02:03:40</transactionDate>
        <clientCode>1799</clientCode>
        <clientName>AcmeInc</clientName>
        <vendorCode>MC</vendorCode>
        <vendorName>Mortgage Connect</vendorName>
    </transactionHeader>
    <transactionBody>
        <transactionCode>Settlement-Agent</transactionCode>
        <transactionId>7832143</transactionId>
        <productTransactionId></productTransactionId>
        <orderNumber>2429888</orderNumber>
        <productCode>TTL</productCode>
        <providerName>Mortgage Connect</providerName>
        <providerAddress>
            <address1>600 Clubhouse Road</address1>
            <city>Coraopolis</city>
            <state>PA</state>
            <zipCode>15108</zipCode>
        </providerAddress>
        <providerNMLSID>96DBO-48663</providerNMLSID>
        <providerSTLicenseID>96DBO48663</providerSTLicenseID>
        <agentName>Mortgage Connect</agentName>
        <agentNMLSID>96DBO-48663</agentNMLSID>
        <agentSTLicenseID>96DBO48663</agentSTLicenseID>
        <agentEMail>ubs@mortgageconnectlp.com</agentEMail>
        <agentPhone>866-789-1814</agentPhone>
    </transactionBody>
    <transactionExtensions>
        <transactionExtension>
            <key>Client Specific Key 1</key>
            <value>Client Specific Value 1</value>
        </transactionExtension>
        <transactionExtension>
            <key>Client Specific Key 2</key>
            <value>Client Specific Value 1</value>
        </transactionExtension>
    </transactionExtensions>
</root>
<!-- Copyright © 2023 Mortgage Connect LP -->

👍 The request payload can be verified using the following validation schema.

/* Copyright © 2023 Mortgage Connect LP */
{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "$id": "root",
  "description": "Copyright @ 2022 Mortgage Connect LP - Title & Tax Schema.",
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "legalHeader": {
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "version": {
          "examples": [
            "1.0.8.0"
          ],
          "type": "string",
          "minLength": 1,
          "maxLength": 20
        },
        "disclosingParty": {
          "examples": [
            "Copyright @ 2022 Mortgage Connect LP"
          ],
          "type": "string",
          "minLength": 1,
          "maxLength": 100
        },
        "proprietaryInformationAndConfidential": {
          "examples": [
            "Ownership of Proprietary Information. The Recipient agrees that it shall not receive any right, title or interest, or any license or right to use, the Disclosing Partys Proprietary Information, including, but not limited to, technology, ideas, concepts, drawings, documentation, designs, prototypes, processes, trade secrets, trademarks or other intellectual property rights therein, by implication or otherwise."
          ],
          "type": "string",
          "minLength": 1,
          "maxLength": 2000
        }
      },
      "required": [
        "version",
        "disclosingParty",
        "proprietaryInformationAndConfidential"
      ],
      "minProperties": 3,
      "maxProperties": 3
    },
    "transactionHeader": {
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "transactionIdempotentId": {
          "examples": [
            "3B34A671-BB17-400D-90BF-7CBF9C96E8ED"
          ],
          "type": "string",
          "minLength": 36,
          "maxLength": 36,
          "pattern": "^[\\da-fA-F]{8}-[\\da-fA-F]{4}-[\\da-fA-F]{4}-[\\da-fA-F]{4}-[\\da-fA-F]{12}$"
        },
        "transactionDate": {
          "examples": [
            "2022-07-11T02:03:40"
          ],
          "type": "string",
          "format": "date-time"
        },
        "clientCode": {
          "examples": [
            "1799"
          ],
          "type": "string",
          "minLength": 1,
          "maxLength": 100,
          "format": "integer"
        },
        "clientName": {
          "examples": [
            "AcmeInc"
          ],
          "type": "string",
          "minLength": 1,
          "maxLength": 100
        },
        "vendorCode": {
          "examples": [
            "MC"
          ],
          "type": "string",
          "minLength": 1,
          "maxLength": 100
        },
        "vendorName": {
          "examples": [
            "Mortgage Connect"
          ],
          "type": "string",
          "minLength": 1,
          "maxLength": 100
        }
      },
      "required": [
        "transactionIdempotentId",
        "transactionDate",
        "clientCode",
        "clientName",
        "vendorCode",
        "vendorName"
      ],
      "minProperties": 6,
      "maxProperties": 6
    },
    "transactionBody": {
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "transactionCode": {
          "examples": [
            "Settlement-Agent"
          ],
          "type": "string",
          "const": "Settlement-Agent"
        },
        "transactionId": {
          "examples": [
            "7832143"
          ],
          "type": "string",
          "minLength": 1,
          "maxLength": 50
        },
        "productTransactionId": {
          "examples": [
            "7832143"
          ],
          "type": "string",
          "minLength": 0,
          "maxLength": 50
        },
        "orderNumber": {
          "examples": [
            "2429888"
          ],
          "type": "integer"
        },
        "productCode": {
          "type": "string",
          "minLength": 3,
          "maxLength": 4,
          "enum": [
            "LVR",
            "PRT",
            "PUR",
            "TTL"
          ]
        },
        "providerName": {
          "example": [
            "Mortgage Connect"
          ],
          "type": "string",
          "maxLength": 100
        },
        "providerAddress": {
          "type": "object",
          "additionalProperties": false,
          "properties": {
            "address1": {
              "examples": [
                "1204 New York Drive"
              ],
              "type": "string",
              "maxLength": 255
            },
            "address2": {
              "examples": [
                "Suite 210"
              ],
              "type": "string",
              "maxLength": 255
            },
            "city": {
              "examples": [
                "Mckees Rocks"
              ],
              "type": "string",
              "maxLength": 32
            },
            "state": {
              "examples": [
                "PA"
              ],
              "type": "string",
              "enum": [
                "AK",
                "AL",
                "AR",
                "AS",
                "AZ",
                "CA",
                "CO",
                "CT",
                "DC",
                "DE",
                "FL",
                "FM",
                "GA",
                "GU",
                "HI",
                "IA",
                "ID",
                "IL",
                "IN",
                "KS",
                "KY",
                "LA",
                "MA",
                "MD",
                "ME",
                "MH",
                "MI",
                "MN",
                "MO",
                "MP",
                "MS",
                "MT",
                "NC",
                "ND",
                "NE",
                "NH",
                "NJ",
                "NM",
                "NV",
                "NY",
                "OH",
                "OK",
                "OR",
                "PA",
                "PR",
                "PW",
                "RI",
                "SC",
                "SD",
                "TN",
                "TX",
                "UT",
                "VA",
                "VI",
                "VT",
                "WA",
                "WI",
                "WV",
                "WY"
              ]
            },
            "zipCode": {
              "examples": [
                "15136"
              ],
              "type": "string",
              "minLength": 5,
              "maxLength": 5,
              "pattern": "^[0-9]{5}$"
            }
          },
          "required": [
            "address1",
            "city",
            "state",
            "zipCode"
          ],
          "minProperties": 4,
          "maxProperties": 6
        },
        "providerNMLSID": {
          "example": [
            "96DBO-48663"
          ],
          "type": "string",
          "maxLength": 100
        },
        "providerSTLicenseID": {
          "example": [
            "96DBO48663"
          ],
          "type": "string",
          "maxLength": 100
        },
        "agentName": {
          "example": [
            "Mortgage Connect"
          ],
          "type": "string",
          "maxLength": 100
        },
        "agentNMLSID": {
          "example": [
            "96DBO-48663"
          ],
          "type": "string",
          "maxLength": 100
        },
        "agentSTLicenseID": {
          "example": [
            "96DBO48663"
          ],
          "type": "string",
          "maxLength": 100
        },
        "agentEMail": {
          "type": "string",
          "maxLength": 250,
          "format": "email"
        },
        "agentPhone": {
          "type": "string",
          "maxLength": 25
        }
    },
      "required": [
        "transactionCode",
        "transactionId",
        "orderNumber",
        "productCode"
      ]
    },
    "transactionExtensions": {
      "type": "object",
      "properties": {
        "transactionExtension": {
          "type": "array",
          "items": {
            "type": "object",
            "additionalProperties": false,
            "properties": {
              "key": {
                "examples": [
                  "Client Specific Key"
                ],
                "type": "string",
                "minLength": 1,
                "maxLength": 200
              },
              "value": {
                "examples": [
                  "Client Specific Value"
                ],
                "type": "string",
                "minLength": 1
              }
            },
            "required": [
              "key",
              "value"
            ],
            "minProperties": 2,
            "maxProperties": 2
          },
          "minItems": 0
        }
      }
    }
  },
  "required": [
    "transactionHeader",
    "transactionBody"
  ],
  "minProperties": 2,
  "maxProperties": 4
}
/* Copyright © 2023 Mortgage Connect LP */

The request payload XML schema validation is under construction. 🚧

✅ The following is an 'Accepted' example payload to be returned in the HTTP response.

Accepted Acknowledgment payloads are typically message type agnostic.

Accepted Acknowledgment payloads are typically message type agnostic.

⛔ The following is a 'Rejected' example payload to be returned in the HTTP response.

Rejected Acknowledgment payloads are typically message type agnostic.

Rejected Acknowledgment payloads are typically message type agnostic.

The Settlement Agent API method is the mechanism in which Mortgage Connect can return the settlement agent and supporting metadata to the client.

View Workflow Orchestration

Client URL

POST 🔒 To be determined during onboarding process.

Property Definitions - Transaction Header

Defines the properties represented in the Transaction Header object (JSON) or node (XML). Note that this message artifact is identical for each and every message type.

View Transaction Header Details

Property Definitions - Transaction Body

Defines the properties represented in the Transaction Body object (JSON) or node (XML).

Property	Requirement	Data Type	Min / Max	Description
transactionBody	Required			A parent object (JSON) or node (XML) that contains the transaction metadata.
transactionCode	Required	String	11 / 11	A static value of `Settlement-Agent`. The transaction code is meant to identify the message type and the context or action that should be taken. In this context the message is informational in nature. Possible Values: Settlement-Agent
transactionId	Required	String	1 / 50	Represents the Client's unique order number.
productTransactionId	Optional	String	0 / 50	Represents the Client's unique product order number. Note that the `productTransactionId` field is not used in most circumstances. However, when there is a need to further differentiate order numbers at a product level, that share the same `transactionId`, (i.e. the primary order level id), then the `productTransactionId` can be used to ensure uniqueness across the integration transactions. This makes it possible for multiple orders of the same product type to be placed using the same `transactionId`. The use of the `productTransactionId` field and any specific workflow deviations will be vetted during the onboarding process.
orderNumber	Required	Integer		Represents Mortgage Connects unique order number.
productCode	Required	String	3 / 4	Represents Mortgage Connect's product code. Possible Values: LVR `LEGAL & VEString REPORT` PRT `PROPERTY REPORT` PUR `PURCHASE` TTL `TITLE INSURANCE` etc. Traditionally, clients use Mortgage Connects `Product Code` names and thus there is a one to one mapping relationship that is maintained by the client. However, Mortgage Connect is aware that our naming conventions may not resonate and that there are many inconsistencies in product code naming conventions and nomenclatures. It is for this reason that Mortgage Connect is able to map the client's product code to Mortgage Connect's product code to ease the transition. Any required product code mapping exercises will be addressed during the onboarding process. The supported `productCode`(s) are specific per integration and will be determined during the onboarding process. Note that the minimum/maximum length requirement of 3/4 is only applicable if using Mortgage Connect's internal product codes, otherwise when mapping to the client's product codes, the minimum/maximum is 1/50.
providerName	Optional	String	0 / 100	The agency providing the settlement services.
providerAddress	Optional			A parent object (JSON) or node (XML) that contains metadata associated with an address.
address1	Required	String	1 / 255	The street address.
address2	Optional	String	0 / 255	The street address 2.
city	Required	String	1 / 32	The city name.
state	Required	String	2 / 2	The state abbreviation. Possible Values: AK, AL, AR, AS, AZ, CA, CO, CT, DC, DE, FL, FM, GA, GU, HI, IA, ID, IL, IN, KS, KY, LA, MA, MD, ME, MH, MI, MN, MO, MP, MS, MT, NC, ND, NE, NH, NJ, NM, NV, NY, OH, OK, OR, PA, PR, PW, RI, SC, SD, TN, TX, UT, VA, VI, VT, WA, WI, WV, WY.
zipCode	Required	String	5 / 5	The zip code.
providerNMLSID	Optional	String	0 / 100	The provider's Nationwide Multistate Licensing System (NMLS) Id.
providerSTLicenseID	Optional	String	0 / 100	The provider's state license id.
agentName	Optional	String	0 / 100	The settlement agents name.
agentNMLSID	Optional	String	0 / 100	The agent's Nationwide Multistate Licensing System (NMLS) Id.
agentSTLicenseID	Optional	String	0 / 100	The agent's state license id.
agentEMail	Optional	String	0 / 250	The agent's email address.
agentPhone	Optional	String	0 / 25	The agent's phone number.

Property Definitions - Transaction Extensions

Defines the properties represented in the TransactionExtensions object (JSON) or node (XML). Note that this message artifact is identical for each and every message type.

View Transaction Extension Details

Title - MC180 - Order Complete

🌐 The following is an example payload to be posted in the body of the HTTP request.

/* Copyright © 2023 Mortgage Connect LP */
{
    "transactionHeader": {
        "transactionIdempotentId": "3B34A671-BB17-400D-90BF-7CBF9C96E8ED",
        "transactionDate": "2022-07-11T02:03:40",
        "clientCode": "1799",
        "clientName": "AcmeInc",
        "vendorCode": "MC",
        "vendorName": "Mortgage Connect"
    },
    "transactionBody": {
        "transactionCode": "Order-Complete",
        "transactionId": "7832143",
        "productTransactionId": "",
        "orderNumber": 2429888,
        "productCode": "TTL",
        "comment": "The order is complete.",
        "commentDate": "2022-07-11T02:03:40"
    },
    "transactionExtensions": {
        "transactionExtension": [
            {
                "key": "Client Specific Key 1",
                "value": "Client Specific Value 1"
            },
            {
                "key": "Client Specific Key 2",
                "value": "Client Specific Value 2"
            }
        ]
    }
}
/* Copyright © 2023 Mortgage Connect LP */

<!-- Copyright © 2023 Mortgage Connect LP -->
<root>
    <transactionHeader>
        <transactionIdempotentId>3B34A671-BB17-400D-90BF-7CBF9C96E8ED</transactionIdempotentId>
        <transactionDate>022-07-11T02:03:40</transactionDate>
        <clientCode>1799</clientCode>
        <clientName>AcmeInc</clientName>
        <vendorCode>MC</vendorCode>
        <vendorName>Mortgage Connect</vendorName>
    </transactionHeader>
    <transactionBody>
        <transactionCode>Order-Complete</transactionCode>
        <transactionId>7832143</transactionId>
        <productTransactionId></productTransactionId>
        <orderNumber>2429888</orderNumber>
        <productCode>TTL</productCode>
        <comment>The order is complete.</comment>
        <commentDate>2022-07-11T02:03:40</commentDate>
    </transactionBody>
    <transactionExtensions>
        <transactionExtension>
            <key>Client Specific Key 1</key>
            <value>Client Specific Value 1</value>
        </transactionExtension>
        <transactionExtension>
            <key>Client Specific Key 2</key>
            <value>Client Specific Value 1</value>
        </transactionExtension>
    </transactionExtensions>
</root>
<!-- Copyright © 2023 Mortgage Connect LP -->

👍 The request payload can be verified using the following validation schema.

/* Copyright © 2023 Mortgage Connect LP */
{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "$id": "root",
  "description": "Copyright @ 2022 Mortgage Connect LP - Title & Tax Schema.",
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "legalHeader": {
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "version": {
          "examples": [
            "1.0.8.0"
          ],
          "type": "string",
          "minLength": 1,
          "maxLength": 20
        },
        "disclosingParty": {
          "examples": [
            "Copyright @ 2022 Mortgage Connect LP"
          ],
          "type": "string",
          "minLength": 1,
          "maxLength": 100
        },
        "proprietaryInformationAndConfidential": {
          "examples": [
            "Ownership of Proprietary Information. The Recipient agrees that it shall not receive any right, title or interest, or any license or right to use, the Disclosing Partys Proprietary Information, including, but not limited to, technology, ideas, concepts, drawings, documentation, designs, prototypes, processes, trade secrets, trademarks or other intellectual property rights therein, by implication or otherwise."
          ],
          "type": "string",
          "minLength": 1,
          "maxLength": 2000
        }
      },
      "required": [
        "version",
        "disclosingParty",
        "proprietaryInformationAndConfidential"
      ],
      "minProperties": 3,
      "maxProperties": 3
    },
    "transactionHeader": {
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "transactionIdempotentId": {
          "examples": [
            "3B34A671-BB17-400D-90BF-7CBF9C96E8ED"
          ],
          "type": "string",
          "minLength": 36,
          "maxLength": 36,
          "pattern": "^[\\da-fA-F]{8}-[\\da-fA-F]{4}-[\\da-fA-F]{4}-[\\da-fA-F]{4}-[\\da-fA-F]{12}$"
        },
        "transactionDate": {
          "examples": [
            "2022-07-11T02:03:40"
          ],
          "type": "string",
          "format": "date-time"
        },
        "clientCode": {
          "examples": [
            "1799"
          ],
          "type": "string",
          "minLength": 1,
          "maxLength": 100,
          "format": "integer"
        },
        "clientName": {
          "examples": [
            "AcmeInc"
          ],
          "type": "string",
          "minLength": 1,
          "maxLength": 100
        },
        "vendorCode": {
          "examples": [
            "MC"
          ],
          "type": "string",
          "minLength": 1,
          "maxLength": 100
        },
        "vendorName": {
          "examples": [
            "Mortgage Connect"
          ],
          "type": "string",
          "minLength": 1,
          "maxLength": 100
        }
      },
      "required": [
        "transactionIdempotentId",
        "transactionDate",
        "clientCode",
        "clientName",
        "vendorCode",
        "vendorName"
      ],
      "minProperties": 6,
      "maxProperties": 6
    },
    "transactionBody": {
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "transactionCode": {
          "examples": [
            "Order-Complete"
          ],
          "type": "string",
          "const": "Order-Complete"
        },
        "transactionId": {
          "examples": [
            "7832143"
          ],
          "type": "string",
          "minLength": 1,
          "maxLength": 50
        },
        "productTransactionId": {
          "examples": [
            "7832143"
          ],
          "type": "string",
          "minLength": 0,
          "maxLength": 50
        },
        "orderNumber": {
          "examples": [
            "2429888"
          ],
          "type": "integer"
        },
        "productCode": {
          "type": "string",
          "minLength": 3,
          "maxLength": 4,
          "enum": [
            "LVR",
            "PRT",
            "PUR",
            "TTL"
          ]
        },
        "comment": {
          "example": [
            "Clear to close."
          ],
          "type": "string"
        },
        "commentDate": {
          "example": [
            "07-11-2022T14:00:00-4:00"
          ],
          "type": "string",
          "format": "date-time"
        }
      },
      "required": [
        "transactionCode",
        "transactionId",
        "orderNumber",
        "productCode",
        "comment",
        "commentDate"
      ]
    },
    "transactionExtensions": {
      "type": "object",
      "properties": {
        "transactionExtension": {
          "type": "array",
          "items": {
            "type": "object",
            "additionalProperties": false,
            "properties": {
              "key": {
                "examples": [
                  "Client Specific Key"
                ],
                "type": "string",
                "minLength": 1,
                "maxLength": 200
              },
              "value": {
                "examples": [
                  "Client Specific Value"
                ],
                "type": "string",
                "minLength": 1
              }
            },
            "required": [
              "key",
              "value"
            ],
            "minProperties": 2,
            "maxProperties": 2
          },
          "minItems": 0
        }
      }
    }
  },
  "required": [
    "transactionHeader",
    "transactionBody"
  ],
  "minProperties": 2,
  "maxProperties": 4
}
/* Copyright © 2023 Mortgage Connect LP */

The request payload XML schema validation is under construction. 🚧

✅ The following is an 'Accepted' example payload to be returned in the HTTP response.

Accepted Acknowledgment payloads are typically message type agnostic.

Accepted Acknowledgment payloads are typically message type agnostic.

⛔ The following is a 'Rejected' example payload to be returned in the HTTP response.

Rejected Acknowledgment payloads are typically message type agnostic.

Rejected Acknowledgment payloads are typically message type agnostic.

The Order Complete API method is the mechanism in which Mortgage Connect can submit a message to the Client to indicate that the Title order is complete.

View Workflow Orchestration

Client URL

POST 🔒 To be determined during onboarding process.

Property Definitions - Transaction Header

Defines the properties represented in the Transaction Header object (JSON) or node (XML). Note that this message artifact is identical for each and every message type.

View Transaction Header Details

Property Definitions - Transaction Body

Defines the properties represented in the Transaction Body object (JSON) or node (XML).

Property	Requirement	Data Type	Min / Max	Description
transactionBody	Required			A parent object (JSON) or node (XML) that contains the transaction metadata.
transactionCode	Required	String	14 / 14	A static value of `Order-Complete`. The transaction code is meant to identify the message type and the context or action that should be taken. In this context it implies that a order has been completed. Possible Values: Order-Complete
transactionId	Required	String	1 / 50	Represents the Client's unique order number.
productTransactionId	Optional	String	0 / 50	Represents the Client's unique product order number. Note that the `productTransactionId` field is not used in most circumstances. However, when there is a need to further differentiate order numbers at a product level, that share the same `transactionId`, (i.e. the primary order level id), then the `productTransactionId` can be used to ensure uniqueness across the integration transactions. This makes it possible for multiple orders of the same product type to be placed using the same `transactionId`. The use of the `productTransactionId` field and any specific workflow deviations will be vetted during the onboarding process.
orderNumber	Required	Integer		Represents Mortgage Connects unique order number.
productCode	Required	String	3 / 4	Represents Mortgage Connect's product code. Possible Values: LVR `LEGAL & VEString REPORT` PRT `PROPERTY REPORT` PUR `PURCHASE` TTL `TITLE INSURANCE` etc. Traditionally, clients use Mortgage Connects `Product Code` names and thus there is a one to one mapping relationship that is maintained by the client. However, Mortgage Connect is aware that our naming conventions may not resonate and that there are many inconsistencies in product code naming conventions and nomenclatures. It is for this reason that Mortgage Connect is able to map the client's product code to Mortgage Connect's product code to ease the transition. Any required product code mapping exercises will be addressed during the onboarding process. The supported `productCode`(s) are specific per integration and will be determined during the onboarding process. Note that the minimum/maximum length requirement of 3/4 is only applicable if using Mortgage Connect's internal product codes, otherwise when mapping to the client's product codes, the minimum/maximum is 1/50.
comment	Required	String	1 / MAX	A general comment indicating that the order is complete.
commentDate	Required	DateTime		The date when the order was completed.

Property Definitions - Transaction Extensions

Defines the properties represented in the TransactionExtensions object (JSON) or node (XML). Note that this message artifact is identical for each and every message type.

View Transaction Extension Details

Title - MC190 - Title Policy

🌐 The following is an example payload to be posted in the body of the HTTP request.

/* Copyright © 2023 Mortgage Connect LP */
{
    "transactionHeader": {
        "transactionIdempotentId": "3B34A671-BB17-400D-90BF-7CBF9C96E8ED",
        "transactionDate": "2022-07-11T02:03:40",
        "clientCode": "1799",
        "clientName": "AcmeInc",
        "vendorCode": "MC",
        "vendorName": "Mortgage Connect"
    },
    "transactionBody": {
        "transactionCode": "Title-Policy",
        "transactionId": "7832143",
        "productTransactionId": "",
        "orderNumber": 2429888,
        "productCode": "TTL",
        "comment": "Title policy completed.",
        "commentDate": "2022-07-11T02:03:40",
        "policyNumber": "73194-34",
        "policyDate": "2022-07-11T02:03:40",
        "documents": {
            "document": [
                {
                    "documentId": "1388109",
                    "type": "Final Title Policy",
                    "name": "final-title-policy.pdf",
                    "fileType": "PDF",
                    "contentMediaType": "application/pdf",
                    "contentUnicodeTextEncodingType": "UTF8",
                    "contentBinaryEncodingType": "Base64",
                    "content": "Base64 String",
                    "description": "Brief overview of the document"
                }
            ]
        }
    },
    "transactionExtensions": {
        "transactionExtension": [
            {
                "key": "Client Specific Key 1",
                "value": "Client Specific Value 1"
            },
            {
                "key": "Client Specific Key 2",
                "value": "Client Specific Value 2"
            }
        ]
    }
}
/* Copyright © 2023 Mortgage Connect LP */

<!-- Copyright © 2023 Mortgage Connect LP -->
<root>
    <transactionHeader>
        <transactionIdempotentId>3B34A671-BB17-400D-90BF-7CBF9C96E8ED</transactionIdempotentId>
        <transactionDate>022-07-11T02:03:40</transactionDate>
        <clientCode>1799</clientCode>
        <clientName>AcmeInc</clientName>
        <vendorCode>MC</vendorCode>
        <vendorName>Mortgage Connect</vendorName>
    </transactionHeader>
    <transactionBody>
        <transactionCode>Title-Policy</transactionCode>
        <transactionId>7832143</transactionId>
        <productTransactionId></productTransactionId>
        <orderNumber>2429888</orderNumber>
        <productCode>TTL</productCode>
        <comment>Title policy completed.</comment>
        <commentDate>2022-07-11T02:03:40</commentDate>
        <policyNumber>73194-34</policyNumber>
        <policyDate>2022-07-11T02:03:40</policyDate>
        <documents>
            <document>
                <documentId>1388109</documentId>
                <type>Final Title Policy</type>
                <name>final-title-policy.pdf</name>
                <fileType>PDF</fileType>
                <contentMediaType>application/pdf</contentMediaType>
                <contentUnicodeTextEncodingType>UTF8</contentUnicodeTextEncodingType>
                <contentBinaryEncodingType>Base64</contentBinaryEncodingType>
                <content>Base64 String</content>
                <description>Brief overview of the document</description>
            </document>
        </documents>
    </transactionBody>
    <transactionExtensions>
        <transactionExtension>
            <key>Client Specific Key 1</key>
            <value>Client Specific Value 1</value>
        </transactionExtension>
        <transactionExtension>
            <key>Client Specific Key 2</key>
            <value>Client Specific Value 1</value>
        </transactionExtension>
    </transactionExtensions>
</root>
<!-- Copyright © 2023 Mortgage Connect LP -->

👍 The request payload can be verified using the following validation schema.

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "$id": "root",
  "description": "Copyright @ 2022 Mortgage Connect LP - Title & Tax Schema.",
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "legalHeader": {
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "version": {
          "examples": [
            "1.0.8.0"
          ],
          "type": "string",
          "minLength": 1,
          "maxLength": 20
        },
        "disclosingParty": {
          "examples": [
            "Copyright @ 2022 Mortgage Connect LP"
          ],
          "type": "string",
          "minLength": 1,
          "maxLength": 100
        },
        "proprietaryInformationAndConfidential": {
          "examples": [
            "Ownership of Proprietary Information. The Recipient agrees that it shall not receive any right, title or interest, or any license or right to use, the Disclosing Partys Proprietary Information, including, but not limited to, technology, ideas, concepts, drawings, documentation, designs, prototypes, processes, trade secrets, trademarks or other intellectual property rights therein, by implication or otherwise."
          ],
          "type": "string",
          "minLength": 1,
          "maxLength": 2000
        }
      },
      "required": [
        "version",
        "disclosingParty",
        "proprietaryInformationAndConfidential"
      ],
      "minProperties": 3,
      "maxProperties": 3
    },
    "transactionHeader": {
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "transactionIdempotentId": {
          "examples": [
            "3B34A671-BB17-400D-90BF-7CBF9C96E8ED"
          ],
          "type": "string",
          "minLength": 36,
          "maxLength": 36,
          "pattern": "^[\\da-fA-F]{8}-[\\da-fA-F]{4}-[\\da-fA-F]{4}-[\\da-fA-F]{4}-[\\da-fA-F]{12}$"
        },
        "transactionDate": {
          "examples": [
            "2022-07-11T02:03:40"
          ],
          "type": "string",
          "format": "date-time"
        },
        "clientCode": {
          "examples": [
            "1799"
          ],
          "type": "string",
          "minLength": 1,
          "maxLength": 100,
          "format": "integer"
        },
        "clientName": {
          "examples": [
            "AcmeInc"
          ],
          "type": "string",
          "minLength": 1,
          "maxLength": 100
        },
        "vendorCode": {
          "examples": [
            "MC"
          ],
          "type": "string",
          "minLength": 1,
          "maxLength": 100
        },
        "vendorName": {
          "examples": [
            "Mortgage Connect"
          ],
          "type": "string",
          "minLength": 1,
          "maxLength": 100
        }
      },
      "required": [
        "transactionIdempotentId",
        "transactionDate",
        "clientCode",
        "clientName",
        "vendorCode",
        "vendorName"
      ],
      "minProperties": 6,
      "maxProperties": 6
    },
    "transactionBody": {
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "transactionCode": {
          "examples": [
            "Title-Policy"
          ],
          "type": "string",
          "const": "Title-Policy"
        },
        "transactionId": {
          "examples": [
            "7832143"
          ],
          "type": "string",
          "minLength": 1,
          "maxLength": 50
        },
        "productTransactionId": {
          "examples": [
            "7832143"
          ],
          "type": "string",
          "minLength": 0,
          "maxLength": 50
        },
        "orderNumber": {
          "examples": [
            "2429888"
          ],
          "type": "integer"
        },
        "productCode": {
          "type": "string",
          "minLength": 3,
          "maxLength": 4,
          "enum": [
            "LVR",
            "PRT",
            "PUR",
            "TTL"
          ]
        },
        "comment": {
          "example": [
            "Clear to close."
          ],
          "type": "string"
        },
        "commentDate": {
          "example": [
            "07-11-2022T14:00:00-4:00"
          ],
          "type": "string",
          "format": "date-time"
        },
        "policyNumber": {
          "example": [
            "73194-34"
          ],
          "type": "string",
          "maxLength": 100
        },
        "policyDate": {
          "example": [
            "07-11-2022T14:00:00-4:00"
          ],
          "type": "string",
          "format": "date-time"
        },
        "documents": {
          "type": "object",
          "properties": {
            "document": {
              "type": "array",
              "items": {
                "type": "object",
                "properties": {
                  "documentId": {
                    "examples": [
                      "1243992"
                    ],
                    "type": "string"
                  },
                  "type": {
                    "type": "string",
                    "minLength": 0,
                    "maxLength": 0,
                    "enum": [
                      "Other"
                    ]
                  },
                  "name": {
                    "examples": [
                      "patriot-search.pdf"
                    ],
                    "type": "string",
                    "maxLength": 100
                  },
                  "fileType": {
                    "type": "string",
                    "enum": [
                      "DOC",
                      "DOCX",
                      "PDF",
                      "doc",
                      "docx",
                      "pdf"
                    ]
                  },
                  "contentMediaType": {
                    "type": "string",
                    "enum": [
                      "application/msword",
                      "application/vnd.openxmlformats-officedocument.wordprocessingml.document",
                      "application/pdf"
                    ]
                  },
                  "contentUnicodeTextEncodingType": {
                    "type": "string",
                    "enum": [
                      "UTF8"
                    ]
                  },
                  "contentBinaryEncodingType": {
                    "type": "string",
                    "enum": [
                      "Base64"
                    ]
                  },
                  "content": {
                    "contentEncoding": "base64",
                    "type": "string"
                  },
                  "description": {
                    "type": "string",
                    "maxLength": 255
                  }
                },
                "required": [
                  "documentId",
                  "type",
                  "name",
                  "fileType",
                  "contentMediaType",
                  "contentUnicodeTextEncodingType",
                  "contentBinaryEncodingType",
                  "content"
                ],
                "allOf": [
                  {
                    "if": {
                      "properties": {
                        "fileType": {
                          "enum": [
                            "DOC",
                            "doc"
                          ]
                        }
                      }
                    },
                    "then": {
                      "properties": {
                        "contentMediaType": "application/msword"
                      }
                    }
                  },
                  {
                    "if": {
                      "properties": {
                        "fileType": {
                          "enum": [
                            "DOCX",
                            "docx"
                          ]
                        }
                      }
                    },
                    "then": {
                      "properties": {
                        "contentMediaType": "application/vnd.openxmlformats-officedocument.wordprocessingml.document"
                      }
                    }
                  },
                  {
                    "if": {
                      "properties": {
                        "fileType": {
                          "enum": [
                            "PDF",
                            "pdf"
                          ]
                        }
                      }
                    },
                    "then": {
                      "properties": {
                        "contentMediaType": "application/pdf"
                      }
                    }
                  }
                ]
              },
              "minItems": 1
            }
          }
        }
      },
      "required": [
        "transactionCode",
        "transactionId",
        "orderNumber",
        "productCode",
        "comment",
        "commentDate",
        "policyNumber",
        "policyDate",
        "documents"
      ]
    },
    "transactionExtensions": {
      "type": "object",
      "properties": {
        "transactionExtension": {
          "type": "array",
          "items": {
            "type": "object",
            "additionalProperties": false,
            "properties": {
              "key": {
                "examples": [
                  "Client Specific Key"
                ],
                "type": "string",
                "minLength": 1,
                "maxLength": 200
              },
              "value": {
                "examples": [
                  "Client Specific Value"
                ],
                "type": "string",
                "minLength": 1
              }
            },
            "required": [
              "key",
              "value"
            ],
            "minProperties": 2,
            "maxProperties": 2
          },
          "minItems": 0
        }
      }
    }
  },
  "required": [
    "transactionHeader",
    "transactionBody"
  ],
  "minProperties": 2,
  "maxProperties": 4
}

The request payload XML schema validation is under construction. 🚧

✅ The following is an 'Accepted' example payload to be returned in the HTTP response.

Accepted Acknowledgment payloads are typically message type agnostic.

Accepted Acknowledgment payloads are typically message type agnostic.

⛔ The following is a 'Rejected' example payload to be returned in the HTTP response.

Rejected Acknowledgment payloads are typically message type agnostic.

Rejected Acknowledgment payloads are typically message type agnostic.

The Title Policy API method is the mechanism in which Mortgage Connect can submit a message to the Client to deliver the Final Title Policy and supporting metadata.

View Workflow Orchestration

Client URL

POST 🔒 To be determined during onboarding process.

Property Definitions - Transaction Header

Defines the properties represented in the Transaction Header object (JSON) or node (XML). Note that this message artifact is identical for each and every message type.

View Transaction Header Details

Property Definitions - Transaction Body

Defines the properties represented in the Transaction Body object (JSON) or node (XML).

Property	Requirement	Data Type	Min / Max	Description
transactionBody	Required			A parent object (JSON) or node (XML) that contains the transaction metadata.
transactionCode	Required	String	12 / 12	A static value of `Title-Policy`. The transaction code is meant to identify the message type and the context or action that should be taken. In this context it implies that the title is policy is complete and being delivered. Possible Values: Title-Policy
transactionId	Required	String	1 / 50	Represents the Client's unique order number.
productTransactionId	Optional	String	0 / 50	Represents the Client's unique product order number. Note that the `productTransactionId` field is not used in most circumstances. However, when there is a need to further differentiate order numbers at a product level, that share the same `transactionId`, (i.e. the primary order level id), then the `productTransactionId` can be used to ensure uniqueness across the integration transactions. This makes it possible for multiple orders of the same product type to be placed using the same `transactionId`. The use of the `productTransactionId` field and any specific workflow deviations will be vetted during the onboarding process.
orderNumber	Required	Integer		Represents Mortgage Connects unique order number.
productCode	Required	String	3 / 4	Represents Mortgage Connect's product code. Possible Values: LVR `LEGAL & VEString REPORT` PRT `PROPERTY REPORT` PUR `PURCHASE` TTL `TITLE INSURANCE` etc. Traditionally, clients use Mortgage Connects `Product Code` names and thus there is a one to one mapping relationship that is maintained by the client. However, Mortgage Connect is aware that our naming conventions may not resonate and that there are many inconsistencies in product code naming conventions and nomenclatures. It is for this reason that Mortgage Connect is able to map the client's product code to Mortgage Connect's product code to ease the transition. Any required product code mapping exercises will be addressed during the onboarding process. The supported `productCode`(s) are specific per integration and will be determined during the onboarding process. Note that the minimum/maximum length requirement of 3/4 is only applicable if using Mortgage Connect's internal product codes, otherwise when mapping to the client's product codes, the minimum/maximum is 1/50.
comment	Required	String	1 / MAX	A general comment indicating that the title policy is completed.
commentDate	Required	DateTime		The date when the title policy was completed.
policyNumber	Required	String	1 / 100	The title policy number.
policyDate	Required	DateTime		The title policy date.
documents	Required			A parent object (JSON) or node (XML) that contains a list of document metadata. `(1 to Many)`
document	Required			A parent object (JSON) or node (XML) that contains the metadata associated with a single document.
documentId	Required	Integer		A number or string that uniquely identifies the document within the host system. When an outbound Title-Policy event is sent by Mortgage Connect to the Client, the documentId will be a string in the form of an integer. The integer value represents the Identity Field and Primary Key associated with the corresponding document record. There is no hard requirement to capture this information. However, both parties are encouraged to do so, in order that conversations or any triaging of exceptions around these values can be correlated across systems.
type	Required	String	1 / 255	A name that uniquely identifies the document type. Traditionally, clients use Mortgage Connects `Document Type` names and thus there is a one to one mapping relationship that is maintained by the client. However, Mortgage Connect is aware that our naming conventions may not resonate and that there are many inconsistencies in document type naming conventions and nomenclatures. It is for this reason that Mortgage Connect is able to map the client's document type to Mortgage Connect's document type to ease the transition. Any required document mapping exercises will be addressed during the onboarding process. The supported `types`(s) are specific per integration and will be determined during the onboarding process.
name	Required	String	1 / 100	This is the user friendly name that is associated with the document.
fileType	Required	String	3 / 4	This indicates what type of document it is. This in the context of what the file extension represents. Possible Values: DOC DOCX PDF Future Values: CSV HTML JSON TXT XLS XLSX XML `DOC`, `DOCX`, and `PDF` are currently supported with the vast majority of the documents being delivered as `PDF` documents. The other types are included to support additional documents in the future.
contentMediaType	Required	String	1 / 100	This represents the content media type, i.e. `MIME Type`. Possible Values: application/msword (DOC) application/vnd.openxmlformats-officedocument.wordprocessingml.document (DOCX) application/pdf (PDF) Future Values: text/csv (CSV) text/html (HTML) application/json (JSON) text/plain (TXT) application/vnd.ms-excel (XLS) application/vnd.openxmlformats-officedocument.spreadsheetml.sheet (XLSX) application/xml (XML) At this time `application/msword (DOC)`, `application/vnd.openxmlformats-officedocument.wordprocessingml.document (DOCX)`, and `application/pdf (PDF)` are supported with `application/pdf (PDF)` being used 90+% of the time. The other types are added to support future media types.
contentUnicode TextEncodingType	Required	String	4 / 4	This indicates what unicode text encoding type was used to generate the document. Possible Values: UTF8
contentBinary EncodingType	Required	String	6 / 6	This indicates what binary encoding type was used to generate the document content. Possible Values: Base64
content	Required	String	1 / MAX	This represents the digital representation of the document after it has been encoded using Base64. See: https://en.wikipedia.org/wiki/Base64 for more information regarding Base64 formatting.
description	Optional	String	0 / 255	Provides a brief overview of the document contents.

Property Definitions - Transaction Extensions

Defines the properties represented in the TransactionExtensions object (JSON) or node (XML). Note that this message artifact is identical for each and every message type.

View Transaction Extension Details

Closing API

The following sections detail the Closing API methods that are specific to Mortgage Connect's Closing workflow pipeline.

Closing - API Event Matrix

The following matrix details the API event matrix supported by the Integration Closing API. The EventId is an internal Mortgage Connect code that the individual methods are often referenced by.

Client & Mortgage Connect Acknowledgments

The Integration Closing workflow orchestration currently supports the following acknowledgment events. While technically speaking an Acknowledgment response is not an event, it is being loosely grouped in this category for documentation purposes.

EventId	Event Code	HTTP	Description
MC010 ⇄	Acknowledgment	POST	The `Acknowledgment` response is the mechanism in which the Client and Mortgage Connect can communicate that a message was processed succesfully or failed. In addition, exception information can be returned as well if applicable. These are essentially the response payloads returned in response to a request and are virtually the same for each request with a couple deviations that are outlined in the `MC010 - Acknowledgment` section. All events whether initiated by the Client or Mortgage Connect should return a `MC010 Acknowledgment` message. View Details

Client Initiated Events

The Integration Closing workflow orchestration currently supports the following events that are to be initiated by the Client LOS and sent to the Mortgage Connect Integration API.

flowchart LR Client(Client LOS) -- POST --> API(MC Integration API)

EventId	Event Code	HTTP	Description
MC100 →	New-Order	POST	The `New Order` API method is the mechanism in which a Client can submit a request to Mortgage Connect to create a new Closing order. View Details
MC117 →	Cancel-Order	POST	The `Cancel Order` API method is the mechanism in which a Client can submit a request to Mortgage Connect to cancel a Closing order. View Details
MC120 →	Update-Order	POST	The `Update Order` API method is the mechanism in which a Client can submit a request to Mortgage Connect to update a Closing order. View Details
MC130 ⇄	Add-Note	POST	The `Add Note` API method is the mechanism in which a Client can submit a request to Mortgage Connect to annotated a Closing order with notes. View Details
MC140 ⇄	Add-Note-Action	POST	The `Add Note Action` API method is the mechanism in which a Client can submit a request to Mortgage Connect to annotate a Closing order with notes, with the expectation that Mortgage Connect needs to perform an urgent `Action` such as contacting the borrower. View Details
MC150 ⇄	Add-Attachment	POST	The `Add Attachment` API method is the mechanism in which a Client can submit a request to Mortgage Connect to add documents to a Closing order. View Details
MC200 →	Schedule-Signing	POST	The `Schedule Signing` API method is the mechanism in which a Client notifies Mortgage Connect that a closing signing should be scheduled. View Details
MC205 →	ReSchedule-Signing	POST	The `ReSchedule Signing` API method is the mechanism in which a Client notifies Mortgage Connect that a closing signing should be rescheduled. View Details
MC220 →	Closing-Instructions	POST	The `Closing Instructions` API method is the mechanism in which a Client conveys to Mortgage Connect what the closing instructions are. View Details
MC224 ⇄	Closing-Disclosure-Revision	POST	The `Closing Disclosure Revision` API method is the mechanism in which the Client notifies Mortgage Connect that the Closing Disclosure has been revised. The Closing Disclosure provides details about the mortgage loan, including the loan terms, monthly payments, fees, and other ancillary costs. View Details
MC226 ⇄	Final-Closing-Disclosure	POST	The `Final Closing Disclosure` API method is the mechanism in which the client notifies Mortgage Connect that the Closing Disclosure has been finalized. The Closing Disclosure provides details about the mortgage loan, including the loan terms, monthly payments, fees, and other ancillary costs. View Details
MC240 →	Clear-ToFund	POST	The `Clear To Fund` API method is the mechanism in which a Client notifies Mortgage Connect that an order is clear to be funded (i.e. funds to be disbursed). View Details
MC243 →	Not-Clear-ToFund	POST	The `Not Clear To Fund` API method is the mechanism in which a Client notifies Mortgage Connect that an order is not clear to be funded (i.e. funds to be disbursed). View Details
MC245 →	Funds-Sent-By-Lender	POST	The `Funds Sent By Lender` API method is the mechanism in which a Client notifies Mortgage Connect that funds were sent by the Lender. View Details

Mortgage Connect Initiated Events

The Integration Closing workflow orchestration currently supports the following events that are to be initiated by the Mortgage Connect Integration API and sent to the Client LOS.

flowchart RL API(MC Integration API) -- POST --> Client(Client LOS)

EventId	Event Code	HTTP	Description
MC110 ←	Order-Confirmation	POST	The `Order Confirmation` API method is the mechanism in which Mortgage Connect notifies the Client that a Closing order has been created. This applies to new orders where `transactionIsAsynchronous` is true. View Details
MC120 ⇄	Add-Note	POST	The `Add Note` API method is the mechanism in which Mortgage Connect can submit a request to the Client to annotated a Closing order with notes. View Details
MC130 ⇄	Add-Note-Action	POST	The `Add Note Action` API method is the mechanism in which Mortgage Connect can submit a request to the Client to annotate a Closing order with notes, with the expectation that the Client needs to pPerform an urgent `Action` such as contacting the borrower. View Details
MC140 ⇄	Add-Attachment	POST	The `Add Attachment` API method is the mechanism in which Mortgage Connect can submit a request to the Client to add documents to a Closing order. View Details
MC210 ←	Schedule-Confirmation	POST	The `Schedule Signing Confirmation` API method is the mechanism in which Mortgage Connect notifies the Client that the closing signing has been officially scheduled and confirmed. View Details
MC213 ←	Reschedule-Confirmation	POST	The `Reschedule Signing Confirmation` API method is the mechanism in which Mortgage Connect notifies the Client that the closing signing has been officially rescheduled and confirmed. View Details
MC215 ←	Closing-Confirmation	POST	The `Closing Confirmation` API method is the mechanism in which Mortgage Connect notifies the Client that the closing has been confirmed. View Details
MC222 ←	Initial-Closing-Disclosure	POST	The `Initial Closing Disclosure` API method is the mechanism in which Mortgage Connect notifies the Client that the initial draft of the Closing Disclosure has been completed. The Closing Disclosure provides details about the mortgage loan, including the loan terms, monthly payments, fees, and other ancillary costs. View Details
MC224 ⇄	Closing-Disclosure-Revision	POST	The `Closing Disclosure Revision` API method is the mechanism in which Mortgage Connect notifies the Client that the Closing Disclosure has been revised. The Closing Disclosure provides details about the mortgage loan, including the loan terms, monthly payments, fees, and other ancillary costs. View Details
MC226 ⇄	Final-Closing-Disclosure	POST	The `Final Closing Disclosure` API method is the mechanism in which Mortgage Connect notifies the Client that the Closing Disclosure has been finalized. The Closing Disclosure provides details about the mortgage loan, including the loan terms, monthly payments, fees, and other ancillary costs. View Details
MC230 ←	Closing-Package	POST	The `Closing Package` API method is the mechanism in which Mortgage Connect sends the Client the final closing package. View Details
MC247 ←	Funds-Received	POST	The `Funds Received` API method is the mechanism in which Mortgage Connect notifies the Client that an order's funds have been received. View Details
MC250 ←	Funds-Disbursed	POST	The `Funds Disbursed` API method is the mechanism in which Mortgage Connect notifies the Client that an order has been disbursed. View Details
MC260 ←	Send-To-Record	POST	The `Send To Record` API method is the mechanism in which Mortgage Connect notifies the Client that the order was sent to be recorded. View Details
MC270 ←	Completed-Recording	POST	The `Completed Recording` API method is the mechanism in which Mortgage Connect notifies the Client that the recording has been completed. View Details
MC180 ←	Order-Complete	POST	The `Order Complete` API method is the mechanism in which Mortgage Connect can submit a request to the Client to indicate that the Closing order is complete. View Details

Closing - API Message Structure

✅ The following is an example 'Message Envelope'.

/* Copyright © 2023 Mortgage Connect LP */
{
    "transactionHeader": {
        "transactionIdempotentId": "90039F81-73C1-4788-98BC-90553888D301",
        "transactionDate": "2022-07-11T02:03:40",
        "clientCode": "1799",
        "clientName": "AcmeInc",
        "vendorCode": "MC",
        "vendorName": "Mortgage Connect"
    },
    "transactionBody": {
        /* Message Type Specific Metadata Goes Here */
    },
    "transactionExtensions": {
        "transactionExtension": [
            {
                "key": "Client Specific Key 1",
                "value": "Client Specific Value 1"
            },
            {
                "key": "Client Specific Key 2",
                "value": "Client Specific Value 2"
            }
        ]
    }
}
/* Copyright © 2023 Mortgage Connect LP */

<!-- Copyright © 2023 Mortgage Connect LP -->
<root>
    <transactionHeader>
        <transactionIdempotentId>90039F81-73C1-4788-98BC-90553888D301</transactionIdempotentId>
        <transactionDate>022-07-11T02:03:40</transactionDate>
        <clientCode>1799</clientCode>
        <clientName>AcmeInc</clientName>
        <vendorCode>MC</vendorCode>
        <vendorName>Mortgage Connect</vendorName>
    </transactionHeader>
    <transactionBody>
        <!-- Message Type Specific Metadata Goes Here -->
    </transactionBody>
    <transactionExtensions>
        <transactionExtension>
            <key>Client Specific Key 1</key>
            <value>Client Specific Value 1</value>
        </transactionExtension>
        <transactionExtension>
            <key>Client Specific Key 2</key>
            <value>Client Specific Value 1</value>
        </transactionExtension>
    </transactionExtensions>
</root>
<!-- Copyright © 2023 Mortgage Connect LP -->

All of the messages are wrapped in a parent object which serves as the Message Envelope that encompasses all of the message's metadata.

Within the Message Envelope you will find three (3) root level objects.

Transaction Header (transactionHeader)
Transaction Body (transactionBody)
Transaction Extensions (transactionExtensions)

The Transaction Body on the other hand is message type specific and will be documentated separately in a section dedicated to each supported message type.

Property Definitions - Transaction Header

Defines the properties represented in the Transaction Header object (JSON) or node (XML). Note that this message artifact is identical for each and every message type.

Property	Requirement	Data Type	Min / Max	Description
transactionHeader	Required			A parent object (JSON) or node (XML) that contains the transaction header metadata.
transactionIdempotentId	Conditional	GUID		A new globally unique identifier to be generated per every single response. This value is used to ensure transactions are processed idempotently. Idempotent message identification is `NOT` currently implemented. However when a need for this feature bubbles up to the top and it is added to the development pipeline it will work as follows. The API supports idempotency for safely retrying requests without accidentally performing the same operation twice. This is useful when an API call is disrupted in transit and you do not receive a response. For example, if a request to create a new order does not respond due to a network connection error, you can retry the request with the same idempotency Id to guarantee that no more than one order is created. Idempotency works by saving the resulting status code and body of the first request made for any given idempotency Id, regardless of whether it succeeded or failed. Subsequent requests with the same idempotency Id will return the same result, including 500 errors. An idempotency key is a unique value generated by the client which the server uses to recognize subsequent retries of the same request. Idempotent Ids should be GUIDs to ensure uniqueness. Under consideration is also the ability to expire previously processed idempotent Ids, for example ignoring those that are 24 hours old or more. Thus enabling the same transaction to be sent again. Results are only saved if an API endpoint started executing. If incoming parameters failed validation, or the request conflicted with another that was executing concurrently, no idempotent result is saved because no API endpoint began execution. It is safe to retry these requests. All POST requests will accept idempotency keys. Sending idempotent Id in GET and DELETE requests has no effect, as these requests are idempotent by definition. `TransactionIdempotentId` will be required for all `POST` messages once this feature is implemented.
transactionDate	Required	DateTime		The date and time that is associated with the message request.
clientCode	Required	String		This represents Mortgage Connect's client code which uniquely identifies a client. Internally Mortgage Connect often refers to this property as the `ClientId`. A given integration can be associated with one or more `ClientCode`(s). As part of the onboarding process, the Client will need to map their client codes to Mortgage Connects `ClientCode`(s).
clientName	Required	String	1 / 100	This represents the name associated with the client. It is not uncommon for multiple clients, i.e. `ClientCode`(s) to be grouped under the same parent client and thus this field often reflects the parent name instead of individual branch names. This field is not technically of importance from a mapping perspective and is only included to aid in identifying the client when viewing the raw payload, versus memorizing or looking up the `ClientCode`.
vendorCode	Required	String	1 / 100	A code supplied by Mortgage Connect that uniquely identifes the `Integration Platform Instance` or `Tenant` being used to service the integration. Note that typically this value is static per integration.
vendorName	Required	String	1 / 100	A name supplied by Mortgage Connect that uniquely identifes the `Integration Platform Instance` or `Tenant` being used to service the integration. While this value is essentially synonymous to the `VendorCode` it is included for readability, much like the `ClientName` property.

Property Definitions - Transaction Body

Defines the properties represented in the Transaction Body object (JSON) or node (XML).

Property Definitions - Transaction Extensions

Defines the properties represented in the TransactionExtensions object (JSON) or node (XML). Note that this message artifact is identical for each and every message type.

Property	Requirement	Data Type	Min / Max	Description
transactionExtensions	Optional			A parent object (JSON) or node (XML) that contains a list of transaction extensions. `(0 to Many)`.
transactionExtension	Required			A parent object (JSON) or node (XML) that contains the metadata associated with a transaction extension.
key	Required	String	1 / 200	The key (i.e. name) that uniquely identifies the transaction extension.
value	Required	String	1 / MAX	The value that is associated with the transaction extension.

Closing - API Workflow Orchestration

The following sections provide a graphical overview of the typical Closing API worflow, from an API sequencing and orchestration perspective.

Closing - MC010 - Acknowledgment

✅ The following is an 'Accepted' example payload to be returned in the HTTP response.

/* Copyright © 2023 Mortgage Connect LP */
{
    "transactionHeader": {
        "transactionIdempotentId": "90039F81-73C1-4788-98BC-90553888D301",
        "transactionDate": "2022-07-11T02:03:40",
        "clientCode": "1799",
        "clientName": "AcmeInc",
        "vendorCode": "MC",
        "vendorName": "Mortgage Connect"
    },
    "transactionBody": {
        "transactionCode": "Acknowledgment",
        "transactionId": "7832143",
        "productTransactionId": "",
        "orderNumber": 2429888,
        "ackStatus": true,
        "ackMessage": "Accepted",
        "ackException": ""
    },
    "transactionExtensions": {
        "transactionExtension": [
            {
                "key": "Client Specific Key 1",
                "value": "Client Specific Value 1"
            },
            {
                "key": "Client Specific Key 2",
                "value": "Client Specific Value 2"
            }
        ]
    }
}
/* Copyright © 2023 Mortgage Connect LP */

<!-- Copyright © 2023 Mortgage Connect LP -->
<root>
    <transactionHeader>
        <transactionIdempotentId>90039F81-73C1-4788-98BC-90553888D301</transactionIdempotentId>
        <transactionDate>022-07-11T02:03:40</transactionDate>
        <clientCode>1799</clientCode>
        <clientName>AcmeInc</clientName>
        <vendorCode>MC</vendorCode>
        <vendorName>Mortgage Connect</vendorName>
    </transactionHeader>
    <transactionBody>
        <transactionCode>Acknowledgment</transactionCode>
        <transactionId>7832143</transactionId>
        <productTransactionId></productTransactionId>
        <orderNumber>2429888</orderNumber>
        <ackStatus>true</ackStatus>
        <ackMessage>Accepted</ackMessage>
        <ackException></ackException>
    </transactionBody>
    <transactionExtensions>
        <transactionExtension>
            <key>Client Specific Key 1</key>
            <value>Client Specific Value 1</value>
        </transactionExtension>
        <transactionExtension>
            <key>Client Specific Key 2</key>
            <value>Client Specific Value 1</value>
        </transactionExtension>
    </transactionExtensions>
</root>
<!-- Copyright © 2023 Mortgage Connect LP -->

⛔ The following is a 'Rejected' example payload to be returned in the HTTP response.

/* Copyright © 2023 Mortgage Connect LP */
{
    "transactionHeader": {
        "transactionIdempotentId": "90039F81-73C1-4788-98BC-90553888D301",
        "transactionDate": "2022-07-11T02:03:40",
        "clientCode": "1799",
        "clientName": "AcmeInc",
        "vendorCode": "MC",
        "vendorName": "Mortgage Connect"
    },
    "transactionBody": {
        "transactionCode": "Acknowledgment",
        "transactionId": "7832143",
        "orderNumber": 0,
        "ackStatus": false,
        "ackMessage": "Rejected",
        "ackException": "Invalid Credentials"
    },
    "transactionExtensions": {
        "transactionExtension": [
            {
                "key": "Client Specific Key 1",
                "value": "Client Specific Value 1"
            },
            {
                "key": "Client Specific Key 2",
                "value": "Client Specific Value 2"
            }
        ]
    }
}
/* Copyright © 2023 Mortgage Connect LP */

<!-- Copyright © 2023 Mortgage Connect LP -->
<root>
    <transactionHeader>
        <transactionIdempotentId>90039F81-73C1-4788-98BC-90553888D301</transactionIdempotentId>
        <transactionDate>022-07-11T02:03:40</transactionDate>
        <clientCode>1799</clientCode>
        <clientName>AcmeInc</clientName>
        <vendorCode>MC</vendorCode>
        <vendorName>Mortgage Connect</vendorName>
    </transactionHeader>
    <transactionBody>
        <transactionCode>Acknowledgment</transactionCode>
        <transactionId>7832143</transactionId>
        <orderNumber>0</orderNumber>
        <ackStatus>false</ackStatus>
        <ackMessage>Rejected</ackMessage>
        <ackException>Invalid Credentials</ackException>
    </transactionBody>
    <transactionExtensions>
        <transactionExtension>
            <key>Client Specific Key 1</key>
            <value>Client Specific Value 1</value>
        </transactionExtension>
        <transactionExtension>
            <key>Client Specific Key 2</key>
            <value>Client Specific Value 1</value>
        </transactionExtension>
    </transactionExtensions>
</root>
<!-- Copyright © 2023 Mortgage Connect LP -->

👍 The response payload can be verified using the following validation schema.

/* Copyright © 2023 Mortgage Connect LP */
{
    "description": "Copyright @ 2022 Mortgage Connect LP - Title & Tax Schema.",
    "$id": "root",
    "$schema": "http://json-schema.org/draft-07/schema#",
    "type": "object",
    "properties": {
        "legalHeader": {
            "type": "object",
            "properties": {
                "version": {
                    "type": "string",
                    "examples": [
                        "1.0.8.0"
                    ],
                    "minLength": 1,
                    "maxLength": 20
                },
                "disclosingParty": {
                    "type": "string",
                    "examples": [
                        "Copyright @ 2022 Mortgage Connect LP"
                    ],
                    "minLength": 1,
                    "maxLength": 100
                },
                "proprietaryInformationAndConfidential": {
                    "type": "string",
                    "examples": [
                        "Ownership of Proprietary Information. The Recipient agrees that it shall not receive any right, title or interest, or any license or right to use, the Disclosing Party’s Proprietary Information, including, but not limited to, technology, ideas, concepts, drawings, documentation, designs, prototypes, processes, trade secrets, trademarks or other intellectual property rights therein, by implication or otherwise."
                    ],
                    "minLength": 1,
                    "maxLength": 2000
                }
            },
            "required": [
                "version",
                "disclosingParty",
                "proprietaryInformationAndConfidential"
            ],
            "additionalProperties": false,
            "maxProperties": 3,
            "minProperties": 3
        },
        "transactionHeader": {
            "type": "object",
            "properties": {
                "transactionIdempotentId": {
                    "type": "string",
                    "pattern": "^[\\da-fA-F]{8}-[\\da-fA-F]{4}-[\\da-fA-F]{4}-[\\da-fA-F]{4}-[\\da-fA-F]{12}$",
                    "examples": [
                        "3B34A671-BB17-400D-90BF-7CBF9C96E8ED"
                    ],
                    "minLength": 36,
                    "maxLength": 36
                },
                "transactionDate": {
                    "type": "string",
                    "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}$",
                    "examples": [
                        "2022-07-11T02:03:40"
                    ],
                    "minLength": 19,
                    "maxLength": 19
                },
                "clientCode": {
                    "type": "string",
                    "examples": [
                        "1799"
                    ],
                    "minLength": 1,
                    "maxLength": 100
                },
                "clientName": {
                    "type": "string",
                    "examples": [
                        "AcmeInc"
                    ],
                    "minLength": 1,
                    "maxLength": 100
                },
                "vendorCode": {
                    "type": "string",
                    "examples": [
                        "MC"
                    ],
                    "minLength": 1,
                    "maxLength": 100
                },
                "vendorName": {
                    "type": "string",
                    "examples": [
                        "Mortgage Connect"
                    ],
                    "minLength": 1,
                    "maxLength": 100
                }
            },
            "required": [
                "transactionIdempotentId",
                "transactionDate",
                "clientCode",
                "clientName",
                "vendorCode",
                "vendorName"
            ],
            "additionalProperties": false,
            "maxProperties": 6,
            "minProperties": 6
        },
        "transactionBody": {
            "type": "object",
            "properties": {
                "transactionCode": {
                    "type": "string",
                    "examples": [
                        "Acknowledgment"
                    ],
                    "enum": [
                        "Acknowledgment"
                    ],
                    "minLength": 14,
                    "maxLength": 14
                },
                "transactionId": {
                    "type": "string",
                    "examples": [
                        "7832143"
                    ],
                    "minLength": 1,
                    "maxLength": 50
                },
                "productTransactionId": {
                    "examples": [
                        "7832143"
                    ],
                    "type": "string",
                    "minLength": 0,
                    "maxLength": 50
                },
                "orderNumber": {
                    "type": "number",
                    "examples": [
                        "2429888"
                    ],
                    "minLength": 7,
                    "maxLength": 7
                },
                "ackStatus": {
                    "type": "boolean",
                    "examples": [ true, false ]
                },
                "ackMessage": {
                    "type": "string",
                    "examples": [
                        "Accepted"
                    ],
                    "minLength": 1
                },
                "ackException": {
                    "type": "string",
                    "examples": [
                        "Invalid Credentials"
                    ],
                    "minLength": 0
                },
                "responseType": {
                    "type": "string"
                },
                "response": {
                    "type": "object"
                }
            },
            "required": [
                "transactionCode",
                "transactionId",
                "ackStatus",
                "ackMessage"
            ],
            "additionalProperties": false,
            "maxProperties": 6,
            "minProperties": 4
        },
        "transactionExtensions": {
            "type": "object",
            "properties": {
                "transactionExtension": {
                    "type": "array",
                    "items": {
                        "type": "object",
                        "properties": {
                            "key": {
                                "type": "string",
                                "examples": [
                                    "Client Specific Key"
                                ],
                                "minLength": 0
                            },
                            "value": {
                                "type": "string",
                                "examples": [
                                    "Client Specific Value"
                                ],
                                "minLength": 0
                            }
                        },
                        "required": [
                            "key",
                            "value"
                        ],
                        "additionalProperties": false,
                        "maxProperties": 2,
                        "minProperties": 2
                    },
                    "minItems": 0
                }
            },
            "required": [
                "transactionExtension"
            ],
            "additionalProperties": false,
            "maxProperties": 1,
            "minProperties": 1
        }
    },
    "required": [
        "transactionHeader",
        "transactionBody"
    ],
    "additionalProperties": false,
    "maxProperties": 3,
    "minProperties": 2
}
/* Copyright © 2023 Mortgage Connect LP */

The response payload XML schema validation is under construction. 🚧

The Acknowledgment event is essentially the payload that is to be returned by all HTTP requests whether it was initialized by the Client or Mortgage Connect.

Property Definitions - Transaction Header

Defines the properties represented in the Transaction Header object (JSON) or node (XML). Note that this message artifact is identical for each and every message type.

View Transaction Header Details

Property Definitions - Transaction Body

Defines the properties represented in the Transaction Body object (JSON) or node (XML).

Property	Requirement	Data Type	Min / Max	Description
transactionBody	Required			A parent object (JSON) or node (XML) that contains the transaction metadata.
transactionCode	Required	String	14 / 14	A static value of `Acknowledgment`. The transaction code is meant to identify the message type and the context or action that should be taken. An `Acknowledgment` transaction code is unique from all other transaction codes in that the context is actually derived from the value of the `AckStatus` property. Possible Values: Acknowledgment
transactionId	Required	String	1 / 50	Represents the Client's unique order number.
productTransactionId	Optional	String	0 / 50	Represents the Client's unique product order number. Note that the `productTransactionId` field is not used in most circumstances. However, when there is a need to further differentiate order numbers at a product level, that share the same `transactionId`, (i.e. the primary order level id), then the `productTransactionId` can be used to ensure uniqueness across the integration transactions. This makes it possible for multiple orders of the same product type to be placed using the same `transactionId`. The use of the `productTransactionId` field and any specific workflow deviations will be vetted during the onboarding process.
orderNumber	Conditional	Integer		Represents Mortgage Connects unique order number. Note this property `Must` be populated in response to a `MC100 - New Order` message that is successfully processed `Synchronously`. For all other messages types, if the `OrderNumber` can be ascertained then it should be included, otherwise it should be set to zero (0) by default.
ackStatus	Required	Boolean		A boolean code indicating whether the request message was successfully processed. This is the property you should interrogate to determine if the message was successful or a failure. Possible Values: true false
ackMessage	Required	String	1 / MAX	A message indicating whether the request message was successfully processed. This property is typically just populated with `Success` or `Failure`. However, it can optionally be populated with additional metadata that provides additional context as to why it was a successful or failed message. It is for this reason you should key off of the `ackStatus` field to determine whether it was a successful or failed message. `Typical` Values: Accepted Rejected
ackException	Conditional	String	0 / MAX	A message that provides additional exception details in the event the message was not sucessfully processed. This property is only ever populated if the message failed to be processed and there are applicable exception details that are appropriate to share, such as `Invalid Credentials` when trying to authenticate the request.
responseType	Conditional	String	0 / MAX	The requested action has returned a response object of the type specified by this property's value. The response type is defined in the `Response Definition` section of the event providing the reponse. Currently applicable to the following events: N/A
response	Conditional	String	0 / MAX	A string containing the JSON or XML representation of the response object. The response object is defined in the `Response Definition` section of the event providing the reponse.

Property Definitions - Transaction Extensions

Defines the properties represented in the TransactionExtensions object (JSON) or node (XML). Note that this message artifact is identical for each and every message type.

View Transaction Extension Details

Closing - MC100 - New Order

🌐 The following is an example payload to be posted in the body of the HTTP request.

/* Copyright © 2023 -Mortgage Connect LP */
{
    "transactionHeader": {
        "transactionIdempotentId": "3B34A671-BB17-400D-90BF-7CBF9C96E8ED",
        "transactionDate": "2022-07-11T02:03:40",
        "clientCode": "1799",
        "clientName": "AcmeInc",
        "vendorCode": "MC",
        "vendorName": "Mortgage Connect"
    },
    "transactionBody": {
        "transactionCode": "New-Order",
        "transactionId": "7832143",
        "productTransactionId": "",
        "transactionIsAsynchronous": false,
        "productCode": "CWI",
        "loanNumber": "73201-3433",
        "loanAmount": "200000",
        "originalLoanAmount": "59900",
        "unpaidPrincipalAmount": "158698",
        "salePrice": "210000",
        "loanType": "Refinance",
        "amortizationType": "Fixed",
        "expectedClosingDate": "8/31/2022",
        "cema": "CEMA loan option requested",
        "occupancyType": "Primary",
        "propertyType": "Single Family",
        "propertyAddress": {
            "address1": "1234 Main St",
            "address2": "",
            "city": "Shawnee",
            "state": "CA",
            "zipCode": "93950",
            "county": "Monterey"
        },
        "borrowers": {
            "borrower": [
                {
                    "firstName": "Johnny",
                    "middleName": "J",
                    "lastName": "Doe",
                    "suffix": "Sr.",
                    "type": "Borrower",
                    "email": "johnnydoe@gmail.com",
                    "cellPhone": "724-323-4234",
                    "ssn": "111-11-1111",
                    "maritalStatus": "Married",
                    "dateOfBirth": "7/4/1965",
                    "borrowerAddress": {
                        "address1": "100 Willow St",
                        "address2": "",
                        "city": "Shawnee",
                        "state": "CA",
                        "zipCode": "93950",
                        "county": "Monterey"
                    }
                },
                {
                    "firstName": "Janie",
                    "middleName": "J",
                    "lastName": "Doe",
                    "type": "Borrower",
                    "email": "janiedoe@gmail.com",
                    "cellPhone": "724-123-4545",
                    "ssn": "222-22-2222",
                    "maritalStatus": "Married",
                    "dateOfBirth": "9/22/1967",
                    "borrowerAddress": {
                        "address1": "100 Willow St",
                        "address2": "",
                        "city": "Shawnee",
                        "state": "CA",
                        "zipCode": "93950",
                        "county": "Monterey"
                    }
                }
            ]
        },
        "parties": {
            "party" : [
                {
                    "firstName": "John",
                    "lastName": "Doe",
                    "phone": "724-420-3341",
                    "email": "johndoe@acmeinc.com",
                    "role": "Processor"
                },
                {
                    "firstName": "Jane",
                    "lastName": "Doe",
                    "phone": "724-420-1833",
                    "email": "janedoe@acmeinc.com",
                    "role": "LoanOfficer"
                }
            ]
        },
        "lender": {
            "name": "Direct",
            "address": "26642 Towne Centre Dr",
            "city": "Lake Forest",
            "state": "CA",
            "zipCode": "92630"
        },
        "specialInstruction": "Conveyance of easement."
    },
    "transactionExtensions": {
        "transactionExtension": [
            {
                "key": "Client Specific Key 1",
                "value": "Client Specific Value 1"
            },
            {
                "key": "Client Specific Key 2",
                "value": "Client Specific Value 2"
            }
        ]
    }
}
/* Copyright © 2023 Mortgage Connect LP */

<!-- Copyright © 2023 Mortgage Connect LP -->
<root>
    <transactionHeader>
        <transactionIdempotentId>3B34A671-BB17-400D-90BF-7CBF9C96E8ED</transactionIdempotentId>
        <transactionDate>022-07-11T02:03:40</transactionDate>
        <clientCode>1799</clientCode>
        <clientName>AcmeInc</clientName>
        <vendorCode>MC</vendorCode>
        <vendorName>Mortgage Connect</vendorName>
    </transactionHeader>
    <transactionBody>
        <transactionCode>New-Order</transactionCode>
        <transactionId>7832143</transactionId>
        <productTransactionId></productTransactionId>
        <transactionIsAsynchronous>false</transactionIsAsynchronous>
        <productCode>CWI</productCode>
        <loanNumber>73201-3433</loanNumber>
        <loanAmount>200000</loanAmount>
        <originalLoanAmount>59900</originalLoanAmount>
        <unpaidPrincipalAmount>158698</unpaidPrincipalAmount>
        <salePrice>210000</salePrice>
        <loanType>Refinance</loanType>
        <amortizationType>Fixed</amortizationType>
        <expectedClosingDate>8/31/2022</expectedClosingDate>
        <cema>CEMA loan option requested</cema>
        <occupancyType>Primary</occupancyType>
        <propertyType>Single Family</propertyType>
        <propertyAddress>
            <address1>1234 Main St</address1>
            <address2>Suite 2</address2>
            <city>Shawnee</city>
            <state>CA</state>
            <zipCode>93950</zipCode>
            <county>Monterey</county>
        </propertyAddress>
        <borrowers>
            <borrower>
                <firstName>Johnny</firstName>
                <middleName>J</middleName>
                <lastName>Doe</lastName>
                <suffix>Sr.</suffix>
                <type>Borrower</type>
                <email>johnnydoe@gmail.com</email>
                <cellPhone>724-323-4234</cellPhone>
                <ssn>111-11-1111</ssn>
                <maritalStatus>Married</maritalStatus>
                <dateOfBirth>7/4/1965</dateOfBirth>
                <borrowerAddress>
                    <address1>100 Willow St</address1>
                    <address2>Suite 2</address2>
                    <city>Shawnee</city>
                    <state>CA</state>
                    <zipCode>93950</zipCode>
                    <county>Monterey</county>
                </borrowerAddress>
            </borrower>
            <borrower>
                <firstName>Janie</firstName>
                <middleName>J</middleName>
                <lastName>Doe</lastName>
                <type>Borrower</type>
                <email>janiedoe@gmail.com</email>
                <cellPhone>724-123-4545</cellPhone>
                <ssn>222-22-2222</ssn>
                <maritalStatus>Married</maritalStatus>
                <dateOfBirth>9/22/1967</dateOfBirth>
                <borrowerAddress>
                    <address1>100 Willow St</address1>
                    <address2>Suite 2</address2>
                    <city>Shawnee</city>
                    <state>CA</state>
                    <zipCode>93950</zipCode>
                    <county>Monterey</county>
                </borrowerAddress>
            </borrower>
        </borrowers>
        <parties>
            <party>
                <firstName>John</firstName>
                <lastName>Doe</lastName>
                <phone>724-420-3341</phone>
                <email>johndoe@acmeinc.com</email>
                <role>Processor</role>
            </party>
            <party>
                <firstName>Jane</firstName>
                <lastName>Doe</lastName>
                <phone>724-420-1833</phone>
                <email>janedoe@acmeinc.com</email>
                <role>LoanOfficer</role>
            </party>
        </parties>
        <lender>
            <name>Direct</name>
            <address>26642 Towne Centre Dr</address>
            <city>Lake Forest</city>
            <state>CA</state>
            <zipCode>92630</zipCode>
        </lender>
        <specialInstruction>Conveyance of easement.</specialInstruction>
    </transactionBody>
    <transactionExtensions>
        <transactionExtension>
            <key>Client Specific Key 1</key>
            <value>Client Specific Value 1</value>
        </transactionExtension>
        <transactionExtension>
            <key>Client Specific Key 2</key>
            <value>Client Specific Value 1</value>
        </transactionExtension>
    </transactionExtensions>
</root>
<!-- Copyright © 2023 Mortgage Connect LP -->

👍 The request payload can be verified using the following validation schema.

The request payload JSON schema validation is under construction. 🚧

The request payload XML schema validation is under construction. 🚧

✅ The following is an 'Accepted' example payload to be returned in the HTTP response.

Accepted Acknowledgment payloads are typically message type agnostic.

Accepted Acknowledgment payloads are typically message type agnostic.

⛔ The following is a 'Rejected' example payload to be returned in the HTTP response.

Rejected Acknowledgment payloads are typically message type agnostic.

Rejected Acknowledgment payloads are typically message type agnostic.

The New Order API method is the mechanism in which a Client can submit a message to Mortgage Connect to create a new Title Order.

View Workflow Orchestration

Mortgage Connect URL

POST 🔒 https://{BaseUrl}/Api/V1.0/{ClientCode}/SubmitMessage

Mortgage Connect URL Properties

Property	Requirement	Description
BaseUrl	Required	A unique base Url that represents a specific Mortgage Connect endpoint and targeted environment.
ClientCode	Required	A unique code assigned to all clients that is used for identification, authentication, and customization purposes.

Property Definitions - Transaction Header

Defines the properties represented in the Transaction Header object (JSON) or node (XML). Note that this message artifact is identical for each and every message type.

View Transaction Header Details

Property Definitions - Transaction Body

Defines the properties represented in the Transaction Body object (JSON) or node (XML).

Property	Requirement	Data Type	Min / Max	Description
transactionBody	Required			A parent object (JSON) or node (XML) that contains the transaction metadata.
transactionCode	Required	String	9 / 9	A static value of `New-Order`. The transaction code is meant to identify the message type and the context or action that should be taken. In this context it implies that a new Title Order should be placed. Possible Values: New-Order
transactionId	Required	String	1 / 50	Represents the Client's unique order number.
productTransactionId	Optional	String	0 / 50	Represents the Client's unique product order number. Note that the `productTransactionId` field is not used in most circumstances. However, when there is a need to further differentiate order numbers at a product level, that share the same `transactionId`, (i.e. the primary order level id), then the `productTransactionId` can be used to ensure uniqueness across the integration transactions. This makes it possible for multiple orders of the same product type to be placed using the same `transactionId`. The use of the `productTransactionId` field and any specific workflow deviations will be vetted during the onboarding process.
transactionIsAsynchronous	Required	Boolean		Indicates whether the transaction is processed asynchronously (i.e. `true`) or synchronously (i.e. `false`). The `New-Order` transaction is unique in that it is the only transaction that supports this feature. Synchronous (i.e `false`) processing might be perferred by some clients who's system architecture are dependent on receiving an actual `Order Number` at the time of order submission. If the transaction is processed asynchronous then an `Order-Confirmation` message will be sent to the client once the `New-Order` transaction is actually processed, which will contain the actual `Order Number`. Possible Values: true false
productCode	Required	String	3 / 4	Represents Mortgage Connect's product codes. Note that these are just an example subset of the many products Mortgage Connect supports. Possible Values: LVR `LEGAL & VESTING REPORT` PRT `PROPERTY REPORT` PUR `PURCHASE` TTL `TITLE INSURANCE` etc. Traditionally, clients use Mortgage Connects `Product Code` names and thus there is a one to one mapping relationship that is maintained by the client. However, Mortgage Connect is aware that our naming conventions may not resonate and that there are many inconsistencies in product code naming conventions and nomenclatures. It is for this reason that Mortgage Connect is able to map the client's product code to Mortgage Connect's product code to ease the transition. Any required product code mapping exercises will be addressed during the onboarding process. The supported `productCode`(s) are specific per integration and will be determined during the onboarding process. Note that the minimum/maximum length requirement of 3/4 is only applicable if using Mortgage Connect's internal product codes, otherwise when mapping to the client's product codes, the minimum/maximum is 1/50. Note that from an ordering perspective, there often is a correlation and synchronization process that occurs between Title and Closing orders. Specifically, due to the typical workflow requirements of Mortgage Connect's Title Platform, if a Closing order is placed before a Title order, a temporary placeholder Title order is automatically created at the same time the Closing order request is received. In this scenario, it is assumed that the Title order request will be received shortly afterwards. At which time, the temporary placeholder Title order will be updated with the actual Title product type requested by the client. For example, assume a client sends a New Order request for a CWO (Closing Without Insurance - Loan Amount < 250K) or CWI (Closing With Insurance - Loan Amount > 250K) product prior to sending a New Order Title request. In this scenario, a TPLC (Title Place Holder) order will be placed as a temporary Title order and the requested Closing will also be placed. Later, if the client sends a New Order request for a PRT (Property Report) or TTL (Title Insurance) product, then the original TPLC (Title Place Holder) order will be updated with the actual Title product requested by the client. Lastly, it is important to recognize that this an example of one of many workflows (Originations, Default, Loss Mitigation, Originations) supported by Mortgage Connect and will not be applicable to all clients. Subsequently, these specific scenarios will vetted during the onboarding process and can be configured per client integration partner.
loanNumber	Required	String	1 / 64	The clients loan number `alpha-numeric`.
loanAmount	Optional	Money		The loan amount
originalLoanAmount	Optional	Money		The original Loan amount.
unpaidPrincipalAmount	Optional	Money		The unpaid principle amount `if any` in dollars.
salePrice	Conditional	Money		The property sale price. The `salePrice` is optional but is `Required` if the `loanType` is `Purchase`.
loanType	Required	String	1 / 24	The loan type. Possible Values: Equity Purchase Refinance Reverse
propertyType	Required	String	1 / 64	The property usage type. Possible Values: Condominium Cooperative Manufactured Multi-Family Other PUD SingleFamily
amortizationType	Optional	String	0 / 64	The amortization type, i.e. how the loan will be paid. Possible Values: ARM Fixed Interest Only Reverse
expectedClosingDate	Optional	DateTime		The expected closing data `if known`. Format: `mm/dd/yyyy`
cema	Optional	String	0 / 100	Information regarding a CEMA (Consolidation, Extension and Modification Agreement) mortgage loan.
occupancyType	Required	String	1 / 64	The occupancy type, i.e. how the property will be used Possible Values: Primary Secondary Investment
propertyAddress	Required			A parent object (JSON) or node (XML) that contains metadata associated with a property address.
address1	Required	String	1 / 255	The property street address.
address2	Optional	String	0 / 255	The property street address 2.
city	Required	String	1 / 32	The property city name.
state	Required	String	2 / 2	The property state abbreviation. Possible Values: AK, AL, AR, AS, AZ, CA, CO, CT, DC, DE, FL, FM, GA, GU, HI, IA, ID, IL, IN, KS, KY, LA, MA, MD, ME, MH, MI, MN, MO, MP, MS, MT, NC, ND, NE, NH, NJ, NM, NV, NY, OH, OK, OR, PA, PR, PW, RI, SC, SD, TN, TX, UT, VA, VI, VT, WA, WI, WV, WY.
zipCode	Required	String	5 / 5	The property zip code.
county	Optional	String	0 / 32	The property county.
borrowers	Required			A parent object (JSON) or node (XML) that contains a list of borrowers. `(1 to Many)` Note that the first borrower is assumed to `always` be the `Primary` borrower.
borrower	Required			A parent object (JSON) or node (XML) that contains the metadata associated with a single borrower.
firstName	Required	String	1 / 150	The borrower’s first name.
middleName	Optional	String	0 / 150	The borrower’s middle name.
lastName	Required	String	1 / 255	The borrower’s last name.
suffix	Optional	String	0 / 4	The borrower's suffix. Possible Values: II III Esq. Jr. Sr.
type	Required	String	1 / 32	The borrower's type. Note that typically this value will be set to `Borrower`. Possible Values: Asset Management Company Asset Manager Assignee Assignor Attorney Bank Attorney Borrower Borrower/Buyer Builder Buyer Buyer Agent Buyer Attorney Buyer Title Company Buyers Broker Condo Association Custodian Foreclosed Party Investor LENDER Lender Loan Officer Listing Agent MC MC Auction Company Mortgage Connect Closer Non-HUD Borrower Non-Vested Signer Other Processor Property Access Real Estate Agent Real Estate Agent - Seller Seller Seller Attorney Sellers Broker Selling Agent Servicer Settlement Agent Title Company Underwriter Vested Signer - Non-Borrower
email	Optional	String	0 / 255	The borrower’s email address.
cellPhone	Optional	String	0 / 24	The borrower's cell phone number.
ssn	Optional	String	0 / 128	The borrower's social security number.
maritalStatus	Optional	String	0 / 128	The borrower’s marital status. Possible Values: Divorced Married Separated Single Widowed
dateOfBirth	Optional	DateTime		The borrower’s date of birth. Format: `mm/dd/yyyy`
borrowerAddress	Optional			A parent object (JSON) or node (XML) that contains metadata associated with a borrower address.
address1	Required	String	1 / 255	The borrower street address.
address2	Optional	String	0 / 255	The borrower street address 2.
city	Required	String	1 / 32	The borrower city name.
state	Required	String	2 / 2	The borrower state abbreviation. Possible Values: AK, AL, AR, AS, AZ, CA, CO, CT, DC, DE, FL, FM, GA, GU, HI, IA, ID, IL, IN, KS, KY, LA, MA, MD, ME, MH, MI, MN, MO, MP, MS, MT, NC, ND, NE, NH, NJ, NM, NV, NY, OH, OK, OR, PA, PR, PW, RI, SC, SD, TN, TX, UT, VA, VI, VT, WA, WI, WV, WY.
zipCode	Required	String	5 / 5	The borrower zip code.
county	Optional	String	0 / 32	The borrower county.
parties	Optional			A parent object (JSON) or node (XML) that contains a list of parties (i.e. those working on the loan). `(0 to Many)`
party	Optional			A parent object (JSON) or node (XML) that contains the metadata associated with a single borrower.
firstName	Required	String	1 / 150	The party's first name.
lastName	Required	String	1 / 150	The party's last name.
phone	Optional	String	0 / 24	The party's phone number.
email	Optional	String	0 / 255	The party's email address.
role	Required	String	1 / 32	The party's role. Possible Values: Closer LoanOfficer LoanOfficerAssistant Other Processor ProcessorAssistant Underwriter User
lender	Optional			A parent object (JSON) or node (XML) that contains the metadata associated with a single lender.
name	Optional	String	0 / 255	The lender's name.
address	Required	String	1 / 255	The lender's address.
city	Required	String	1 / 32	The lender's city.
state	Required	String	2 / 2	The lender's state.
zipCode	Required	String	5 / 5	The lender's zip code.
specialInstruction	Optional	String	0 / MAX	The special instruction associated with the Title. `(if applcable)`

Property Definitions - Transaction Extensions

Defines the properties represented in the TransactionExtensions object (JSON) or node (XML). Note that this message artifact is identical for each and every message type.

View Transaction Extension Details

Closing - MC110 - Order Confirmation

🌐 The following is an example payload to be posted in the body of the HTTP request.

/* Copyright © 2023 Mortgage Connect LP */
{
    "transactionHeader": {
        "transactionIdempotentId": "3B34A671-BB17-400D-90BF-7CBF9C96E8ED",
        "transactionDate": "2022-07-11T02:03:40",
        "clientCode": "1799",
        "clientName": "AcmeInc",
        "vendorCode": "MC",
        "vendorName": "Mortgage Connect"
    },
    "transactionBody": {
        "transactionCode": "Order-Confirmation",
        "transactionId": "7832143",
        "productTransactionId": "",
        "orderNumber": 2429888,
        "itemNumber": 1,
        "productCode": "CWI",
        "loanNumber": "7313993"
    },
    "transactionExtensions": {
        "transactionExtension": [
            {
                "key": "Client Specific Key 1",
                "value": "Client Specific Value 1"
            },
            {
                "key": "Client Specific Key 2",
                "value": "Client Specific Value 2"
            }
        ]
    }
}
/* Copyright © 2023 Mortgage Connect LP */

<!-- Copyright © 2023 Mortgage Connect LP -->
<root>
    <transactionHeader>
        <transactionIdempotentId>3B34A671-Bb17-400D-90Bf-7Cbf9C96E8Ed</transactionIdempotentId>
        <transactionDate>2022-07-11T02:03:40</transactionDate>
        <clientCode>1799</clientCode>
        <clientName>Acmeinc</clientName>
        <vendorCode>MC</vendorCode>
        <vendorName>Mortgage Connect</vendorName>
    </transactionHeader>
    <transactionBody>
        <transactionCode>Order-Confirmation</transactionCode>
        <transactionId>7832143</transactionId>
        <productTransactionId></productTransactionId>
        <orderNumber>2429888</orderNumber>
        <itemNumber>1</itemNumber>
        <productCode>CWI</productCode>
        <loanNumber>7313993</loanNumber>
    </transactionBody>
    <transactionExtensions>
        <transactionExtension>
            <key>Client Specific Key 1</key>
            <value>Client Specific Value 1</value>
        </transactionExtension>
        <transactionExtension>
            <key>Client Specific Key 2</key>
            <value>Client Specific Value 1</value>
        </transactionExtension>
    </transactionExtensions>
</root>
<!-- Copyright © 2023 Mortgage Connect LP -->

👍 The request payload can be verified using the following validation schema.

The request payload JSON schema validation is under construction. 🚧

The request payload XML schema validation is under construction. 🚧

✅ The following is an 'Accepted' example payload to be returned in the HTTP response.

Accepted Acknowledgment payloads are typically message type agnostic.

Accepted Acknowledgment payloads are typically message type agnostic.

⛔ The following is a 'Rejected' example payload to be returned in the HTTP response.

Rejected Acknowledgment payloads are typically message type agnostic.

Rejected Acknowledgment payloads are typically message type agnostic.

View Workflow Orchestration

Client URL

POST 🔒 To be determined during onboarding process.

Property Definitions - Transaction Header

Defines the properties represented in the Transaction Header object (JSON) or node (XML). Note that this message artifact is identical for each and every message type.

View Transaction Header Details

Property Definitions - Transaction Body

Defines the properties represented in the Transaction Body object (JSON) or node (XML).

Property	Requirement	Data Type	Min / Max	Description
transactionBody	Required			A parent object (JSON) or node (XML) that contains the transaction metadata.
transactionCode	Required	String	14 / 14	A static value of `Order-Confirmation`. The transaction code is meant to identify the message type and the context or action that should be taken. An `Order-Confirmation` transaction code indicates that the previously submitted `New-Order` transaction was successfully processed. As part of the payload, Mortgage Connect's Order and Item Number will be returned. Possible Values: Order-Confirmation
transactionId	Required	String	1 / 50	Represents the Client's unique order number.
productTransactionId	Optional	String	0 / 50	Represents the Client's unique product order number. Note that the `productTransactionId` field is not used in most circumstances. However, when there is a need to further differentiate order numbers at a product level, that share the same `transactionId`, (i.e. the primary order level id), then the `productTransactionId` can be used to ensure uniqueness across the integration transactions. This makes it possible for multiple orders of the same product type to be placed using the same `transactionId`. The use of the `productTransactionId` field and any specific workflow deviations will be vetted during the onboarding process.
orderNumber	Required	Integer		Represents Mortgage Connects unique order number.
itemNumber	Required	Integer	Integer	Represents Mortgage Connects product sequencing number (i.e `1 through 40`) that is associated with each product ordered.
productCode	Required	String	3 / 4	Represents Mortgage Connect's product code. Possible Values: LVR `LEGAL & VESTING REPORT` PRT `PROPERTY REPORT` PUR `PURCHASE` TTL `TITLE INSURANCE` etc. Traditionally, clients use Mortgage Connects `Product Code` names and thus there is a one to one mapping relationship that is maintained by the client. However, Mortgage Connect is aware that our naming conventions may not resonate and that there are many inconsistencies in product code naming conventions and nomenclatures. It is for this reason that Mortgage Connect is able to map the client's product code to Mortgage Connect's product code to ease the transition. Any required product code mapping exercises will be addressed during the onboarding process. The supported `productCode`(s) are specific per integration and will be determined during the onboarding process. Note that the minimum/maximum length requirement of 3/4 is only applicable if using Mortgage Connect's internal product codes, otherwise when mapping to the client's product codes, the minimum/maximum is 1/50.
loanNumber	Required	String	1 / 64	The client's loan number that is associated with the order.

Property Definitions - Transaction Extensions

Defines the properties represented in the TransactionExtensions object (JSON) or node (XML). Note that this message artifact is identical for each and every message type.

View Transaction Extension Details

Closing - MC117 - Cancel Order

🌐 The following is an example payload to be posted in the body of the HTTP request.

/* Copyright © 2023 Mortgage Connect LP */
{
    "transactionHeader": {
        "transactionIdempotentId": "3B34A671-BB17-400D-90BF-7CBF9C96E8ED",
        "transactionDate": "2022-07-11T02:03:40",
        "clientCode": "1799",
        "clientName": "AcmeInc",
        "vendorCode": "MC",
        "vendorName": "Mortgage Connect"
    },
    "transactionBody": {
        "transactionCode": "Cancel-Order",
        "transactionId": "7832143",
        "productTransactionId": "",
        "orderNumber": 2429888,
        "productCode": "TTL"
    },
    "transactionExtensions": {
        "transactionExtension": [
            {
                "key": "Client Specific Key 1",
                "value": "Client Specific Value 1"
            },
            {
                "key": "Client Specific Key 2",
                "value": "Client Specific Value 2"
            }
        ]
    }
}
/* Copyright © 2023 Mortgage Connect LP */

<!-- Copyright © 2023 Mortgage Connect LP -->
<root>
    <transactionHeader>
        <transactionIdempotentId>3B34A671-Bb17-400D-90Bf-7Cbf9C96E8Ed</transactionIdempotentId>
        <transactionDate>2022-07-11T02:03:40</transactionDate>
        <clientCode>1799</clientCode>
        <clientName>Acmeinc</clientName>
        <vendorCode>MC</vendorCode>
        <vendorName>Mortgage Connect</vendorName>
    </transactionHeader>
    <transactionBody>
        <transactionCode>Cancel-Order</transactionCode>
        <transactionId>7832143</transactionId>
        <productTransactionId></productTransactionId>
        <orderNumber>2429888</orderNumber>
        <productCode>TTL</productCode>
  </transactionBody>
    <transactionExtensions>
        <transactionExtension>
            <key>Client Specific Key 1</key>
            <value>Client Specific Value 1</value>
        </transactionExtension>
        <transactionExtension>
            <key>Client Specific Key 2</key>
            <value>Client Specific Value 1</value>
        </transactionExtension>
    </transactionExtensions>
</root>
<!-- Copyright © 2023 Mortgage Connect LP -->

👍 The request payload can be verified using the following validation schema.

/* Copyright © 2023 Mortgage Connect LP */
{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "$id": "root",
  "description": "Copyright @ 2022 Mortgage Connect LP - Title & Tax Schema.",
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "legalHeader": {
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "version": {
          "examples": [
            "1.0.8.0"
          ],
          "type": "string",
          "minLength": 1,
          "maxLength": 20
        },
        "disclosingParty": {
          "examples": [
            "Copyright @ 2022 Mortgage Connect LP"
          ],
          "type": "string",
          "minLength": 1,
          "maxLength": 100
        },
        "proprietaryInformationAndConfidential": {
          "examples": [
            "Ownership of Proprietary Information. The Recipient agrees that it shall not receive any right, title or interest, or any license or right to use, the Disclosing Partys Proprietary Information, including, but not limited to, technology, ideas, concepts, drawings, documentation, designs, prototypes, processes, trade secrets, trademarks or other intellectual property rights therein, by implication or otherwise."
          ],
          "type": "string",
          "minLength": 1,
          "maxLength": 2000
        }
      },
      "required": [
        "version",
        "disclosingParty",
        "proprietaryInformationAndConfidential"
      ],
      "minProperties": 3,
      "maxProperties": 3
    },
    "transactionHeader": {
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "transactionIdempotentId": {
          "examples": [
            "3B34A671-BB17-400D-90BF-7CBF9C96E8ED"
          ],
          "type": "string",
          "minLength": 36,
          "maxLength": 36,
          "pattern": "^[\\da-fA-F]{8}-[\\da-fA-F]{4}-[\\da-fA-F]{4}-[\\da-fA-F]{4}-[\\da-fA-F]{12}$"
        },
        "transactionDate": {
          "examples": [
            "2022-07-11T02:03:40"
          ],
          "type": "string",
          "format": "date-time"
        },
        "clientCode": {
          "examples": [
            "1799"
          ],
          "type": "string",
          "minLength": 1,
          "maxLength": 100,
          "format": "integer"
        },
        "clientName": {
          "examples": [
            "AcmeInc"
          ],
          "type": "string",
          "minLength": 1,
          "maxLength": 100
        },
        "vendorCode": {
          "examples": [
            "MC"
          ],
          "type": "string",
          "minLength": 1,
          "maxLength": 100
        },
        "vendorName": {
          "examples": [
            "Mortgage Connect"
          ],
          "type": "string",
          "minLength": 1,
          "maxLength": 100
        }
      },
      "required": [
        "transactionIdempotentId",
        "transactionDate",
        "clientCode",
        "clientName",
        "vendorCode",
        "vendorName"
      ],
      "minProperties": 6,
      "maxProperties": 6
    },
    "transactionBody": {
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "transactionCode": {
          "examples": [
            "Cancel-Order"
          ],
          "type": "string",
          "const": "Cancel-Order"
        },
        "transactionId": {
          "examples": [
            "7832143"
          ],
          "type": "string",
          "minLength": 1,
          "maxLength": 50
        },
        "productTransactionId": {
          "examples": [
            "7832143"
          ],
          "type": "string",
          "minLength": 0,
          "maxLength": 50
        },
        "orderNumber": {
          "examples": [
            "2429888"
          ],
          "type": "integer"
        },
        "productCode": {
          "type": "string",
          "minLength": 3,
          "maxLength": 4,
          "enum": [
            "LVR",
            "PRT",
            "PUR",
            "TTL"
          ]
        }
      },
      "required": [
        "transactionCode",
        "transactionId",
        "orderNumber",
        "productCode",
      ]
    },
    "transactionExtensions": {
      "type": "object",
      "properties": {
        "transactionExtension": {
          "type": "array",
          "items": {
            "type": "object",
            "additionalProperties": false,
            "properties": {
              "key": {
                "examples": [
                  "Client Specific Key"
                ],
                "type": "string",
                "minLength": 1,
                "maxLength": 200
              },
              "value": {
                "examples": [
                  "Client Specific Value"
                ],
                "type": "string",
                "minLength": 1
              }
            },
            "required": [
              "key",
              "value"
            ],
            "minProperties": 2,
            "maxProperties": 2
          },
          "minItems": 0
        }
      }
    }
  },
  "required": [
    "transactionHeader",
    "transactionBody"
  ],
  "minProperties": 2,
  "maxProperties": 4
}
/* Copyright © 2023 Mortgage Connect LP */

The request payload XML schema validation is under construction. 🚧

✅ The following is an 'Accepted' example payload to be returned in the HTTP response.

Accepted Acknowledgment payloads are typically message type agnostic.

Accepted Acknowledgment payloads are typically message type agnostic.

⛔ The following is a 'Rejected' example payload to be returned in the HTTP response.

Rejected Acknowledgment payloads are typically message type agnostic.

Rejected Acknowledgment payloads are typically message type agnostic.

The Cancel-Order API method is the mechanism in which a Client can submit a message to Mortage Connect to cancel a Closing Order.

The order to cancel is identified by the combination of the OrderNumber and ProductCode.

View Workflow Orchestration

Mortgage Connect URL

POST 🔒 https://{BaseUrl}/Api/V1.0/{ClientCode}/SubmitMessage

Mortgage Connect URL Properties

Property	Requirement	Description
BaseUrl	Required	A unique base Url that represents a specific Mortgage Connect endpoint and targeted environment.
ClientCode	Required	A unique code assigned to all clients that is used for identification, authentication, and customization purposes.

Property Definitions - Transaction Header

Defines the properties represented in the Transaction Header object (JSON) or node (XML). Note that this message artifact is identical for each and every message type.

View Transaction Header Details

Property Definitions - Transaction Body

Defines the properties represented in the Transaction Body object (JSON) or node (XML).

Property	Requirement	Data Type	Min / Max	Description
transactionBody	Required			A parent object (JSON) or node (XML) that contains the transaction metadata.
transactionCode	Required	String	12 / 12	A static value of `Cancel-Order`. The transaction code is meant to identify the message type and the context or action that should be taken. A `Cancel-Order` transaction code indicates that a Closing Order should be canceled. Possible Values: Cancel-Order
transactionId	Required	String	1 / 50	Represents the Client's unique order number.
productTransactionId	Optional	String	0 / 50	Represents the Client's unique product order number. Note that the `productTransactionId` field is not used in most circumstances. However, when there is a need to further differentiate order numbers at a product level, that share the same `transactionId`, (i.e. the primary order level id), then the `productTransactionId` can be used to ensure uniqueness across the integration transactions. This makes it possible for multiple orders of the same product type to be placed using the same `transactionId`. The use of the `productTransactionId` field and any specific workflow deviations will be vetted during the onboarding process.
orderNumber	Required	Integer		Represents Mortgage Connects unique order number.
productCode	Required	String	3 / 4	Represents Mortgage Connect's product code. Possible Values: LVR `LEGAL & VESTING REPORT` PRT `PROPERTY REPORT` PUR `PURCHASE` TTL `TITLE INSURANCE` etc. Traditionally, clients use Mortgage Connects `Product Code` names and thus there is a one to one mapping relationship that is maintained by the client. However, Mortgage Connect is aware that our naming conventions may not resonate and that there are many inconsistencies in product code naming conventions and nomenclatures. It is for this reason that Mortgage Connect is able to map the client's product code to Mortgage Connect's product code to ease the transition. Any required product code mapping exercises will be addressed during the onboarding process. The supported `productCode`(s) are specific per integration and will be determined during the onboarding process. Note that the minimum/maximum length requirement of 3/4 is only applicable if using Mortgage Connect's internal product codes, otherwise when mapping to the client's product codes, the minimum/maximum is 1/50.

Property Definitions - Transaction Extensions

Defines the properties represented in the TransactionExtensions object (JSON) or node (XML). Note that this message artifact is identical for each and every message type.

View Transaction Extension Details

Closing - MC120 - Update Order

🌐 The following is an example payload to be posted in the body of the HTTP request.

/* Copyright © 2023 Mortgage Connect LP */
{
    "transactionHeader": {
        "transactionIdempotentId": "3B34A671-BB17-400D-90BF-7CBF9C96E8ED",
        "transactionDate": "2022-07-11T02:03:40",
        "clientCode": "1799",
        "clientName": "AcmeInc",
        "vendorCode": "MC",
        "vendorName": "Mortgage Connect"
    },
    "transactionBody": {
        "transactionCode": "Update-Order",
        "transactionId": "7832143",
        "productTransactionId": "",
        "orderNumber": 2429888,
        "productCode": "CWI",
        "loanNumber": "73201-3433",
        "loanAmount": "200000",
        "originalLoanAmount": "59900",
        "unpaidPrincipalAmount": "158698",
        "salePrice": "210000",
        "loanType": "Refinance",
        "amortizationType": "Fixed",
        "expectedClosingDate": "8/31/2022",
        "cema": "CEMA loan option requested",
        "occupancyType": "Primary",
        "propertyType": "Single Family",
        "propertyAddress": {
            "address1": "1234 Main St",
            "address2": "",
            "city": "Shawnee",
            "state": "CA",
            "zipCode": "93950",
            "county": "Monterey"
        },
        "borrowers": {
            "borrower": [
                {
                    "firstName": "Johnny",
                    "middleName": "J",
                    "lastName": "Doe",
                    "suffix": "Sr.",
                    "type": "Borrower",
                    "email": "johnnydoe@gmail.com",
                    "cellPhone": "724-323-4234",
                    "ssn": "111-11-1111",
                    "maritalStatus": "Married",
                    "dateOfBirth": "7/4/1965",
                    "borrowerAddress": {
                        "address1": "100 Willow St",
                        "address2": "",
                        "city": "Shawnee",
                        "state": "CA",
                        "zipCode": "93950",
                        "county": "Monterey"
                    }
                },
                {
                    "firstName": "Janie",
                    "middleName": "J",
                    "lastName": "Doe",
                    "type": "Borrower",
                    "email": "janiedoe@gmail.com",
                    "cellPhone": "724-123-4545",
                    "ssn": "222-22-2222",
                    "maritalStatus": "Married",
                    "dateOfBirth": "9/22/1967",
                    "borrowerAddress": {
                        "address1": "100 Willow St",
                        "address2": "",
                        "city": "Shawnee",
                        "state": "CA",
                        "zipCode": "93950",
                        "county": "Monterey"
                    }
                }
            ]
        },
        "parties": {
            "party": [
                {
                    "firstName": "John",
                    "lastName": "Doe",
                    "phone": "724-420-3341",
                    "email": "johndoe@acmeinc.com",
                    "role": "Processor"
                },
                {
                    "firstName": "Jane",
                    "lastName": "Doe",
                    "phone": "724-420-1833",
                    "email": "janedoe@acmeinc.com",
                    "role": "LoanOfficer"
                }
            ]
        },
        "lender": {
            "name": "Direct",
            "address": "26642 Towne Centre Dr",
            "city": "Lake Forest",
            "state": "CA",
            "zipCode": "92630"
        },
        "specialInstruction": "Conveyance of easement."
    },
    "transactionExtensions": {
        "transactionExtension": [
            {
                "key": "Client Specific Key 1",
                "value": "Client Specific Value 1"
            },
            {
                "key": "Client Specific Key 2",
                "value": "Client Specific Value 2"
            }
        ]
    }
}
/* Copyright © 2023 Mortgage Connect LP */

<!-- Copyright © 2023 Mortgage Connect LP -->
<root>
    <transactionHeader>
        <transactionIdempotentId>3B34A671-BB17-400D-90BF-7CBF9C96E8ED</transactionIdempotentId>
        <transactionDate>022-07-11T02:03:40</transactionDate>
        <clientCode>1799</clientCode>
        <clientName>AcmeInc</clientName>
        <vendorCode>MC</vendorCode>
        <vendorName>Mortgage Connect</vendorName>
    </transactionHeader>
    <transactionBody>
        <transactionCode>Update-Order</transactionCode>
        <transactionId>7832143</transactionId>
        <productTransactionId></productTransactionId>
        <orderNumber>2429888</orderNumber>
        <productCode>CWI</productCode>
        <loanNumber>73201-3433</loanNumber>
        <loanAmount>200000</loanAmount>
        <originalLoanAmount>59900</originalLoanAmount>
        <unpaidPrincipalAmount>158698</unpaidPrincipalAmount>
        <salePrice>210000</salePrice>
        <loanType>Refinance</loanType>
        <amortizationType>Fixed</amortizationType>
        <expectedClosingDate>8/31/2022</expectedClosingDate>
        <cema>CEMA loan option requested</cema>
        <occupancyType>Primary</occupancyType>
        <propertyType>Single Family</propertyType>
        <propertyAddress>
            <address1>1234 Main St</address1>
            <address2>Suite 2</address2>
            <city>Shawnee</city>
            <state>CA</state>
            <zipCode>93950</zipCode>
            <county>Monterey</county>
        </propertyAddress>
        <borrowers>
            <borrower>
                <firstName>Johnny</firstName>
                <middleName>J</middleName>
                <lastName>Doe</lastName>
                <suffix>Sr.</suffix>
                <type>Borrower</type>
                <email>johnnydoe@gmail.com</email>
                <cellPhone>724-323-4234</cellPhone>
                <ssn>111-11-1111</ssn>
                <maritalStatus>Married</maritalStatus>
                <dateOfBirth>7/4/1965</dateOfBirth>
                <borrowerAddress>
                    <address1>100 Willow St</address1>
                    <address2>Suite 2</address2>
                    <city>Shawnee</city>
                    <state>CA</state>
                    <zipCode>93950</zipCode>
                    <county>Monterey</county>
                </borrowerAddress>
            </borrower>
            <borrower>
                <firstName>Janie</firstName>
                <middleName>J</middleName>
                <lastName>Doe</lastName>
                <type>Borrower</type>
                <email>janiedoe@gmail.com</email>
                <cellPhone>724-123-4545</cellPhone>
                <ssn>222-22-2222</ssn>
                <maritalStatus>Married</maritalStatus>
                <dateOfBirth>9/22/1967</dateOfBirth>
                <borrowerAddress>
                    <address1>100 Willow St</address1>
                    <address2>Suite 2</address2>
                    <city>Shawnee</city>
                    <state>CA</state>
                    <zipCode>93950</zipCode>
                    <county>Monterey</county>
                </borrowerAddress>
            </borrower>
        </borrowers>
        <parties>
            <party>
                <firstName>John</firstName>
                <lastName>Doe</lastName>
                <phone>724-420-3341</phone>
                <email>johndoe@acmeinc.com</email>
                <role>Processor</role>
            </party>
            <party>
                <firstName>Jane</firstName>
                <lastName>Doe</lastName>
                <phone>724-420-1833</phone>
                <email>janedoe@acmeinc.com</email>
                <role>LoanOfficer</role>
            </party>
        </parties>
        <lender>
            <name>Direct</name>
            <address>26642 Towne Centre Dr</address>
            <city>Lake Forest</city>
            <state>CA</state>
            <zipCode>92630</zipCode>
        </lender>
        <specialInstruction>Conveyance of easement.</specialInstruction>
    </transactionBody>
    <transactionExtensions>
        <transactionExtension>
            <key>Client Specific Key 1</key>
            <value>Client Specific Value 1</value>
        </transactionExtension>
        <transactionExtension>
            <key>Client Specific Key 2</key>
            <value>Client Specific Value 1</value>
        </transactionExtension>
    </transactionExtensions>
</root>
<!-- Copyright © 2023 Mortgage Connect LP -->

👍 The request payload can be verified using the following validation schema.

The request payload JSON schema validation is under construction. 🚧

The request payload XML schema validation is under construction. 🚧

✅ The following is an 'Accepted' example payload to be returned in the HTTP response.

Accepted Acknowledgment payloads are typically message type agnostic.

Accepted Acknowledgment payloads are typically message type agnostic.

⛔ The following is a 'Rejected' example payload to be returned in the HTTP response.

Rejected Acknowledgment payloads are typically message type agnostic.

Rejected Acknowledgment payloads are typically message type agnostic.

The Update Order API method is the mechanism in which a Client can submit a message to Mortgage Connect to update a Title Order.

The order to update is identified by the combination of the OrderNumber and ProductCode.

View Workflow Orchestration

Mortgage Connect URL

POST 🔒 https://{BaseUrl}/Api/V1.0/{ClientCode}/SubmitMessage

Mortgage Connect URL Properties

Property	Requirement	Description
BaseUrl	Required	A unique base Url that represents a specific Mortgage Connect endpoint and targeted environment.
ClientCode	Required	A unique code assigned to all clients that is used for identification, authentication, and customization purposes.

Property Definitions - Transaction Header

Defines the properties represented in the Transaction Header object (JSON) or node (XML). Note that this message artifact is identical for each and every message type.

View Transaction Header Details

Property Definitions - Transaction Body

Defines the properties represented in the Transaction Body object (JSON) or node (XML).

Property	Requirement	Data Type	Min / Max	Description
transactionBody	Required			A parent object (JSON) or node (XML) that contains the transaction metadata.
transactionCode	Required	String	12 / 12	A static value of `Update-Order`. The transaction code is meant to identify the message type and the context or action that should be taken. In this context it implies that a new Title Order should be updated with additional or changed data. Possible Values: Update-Order
transactionId	Required	String	1 / 50	Represents the Client's unique order number.
productTransactionId	Optional	String	0 / 50	Represents the Client's unique product order number. Note that the `productTransactionId` field is not used in most circumstances. However, when there is a need to further differentiate order numbers at a product level, that share the same `transactionId`, (i.e. the primary order level id), then the `productTransactionId` can be used to ensure uniqueness across the integration transactions. This makes it possible for multiple orders of the same product type to be placed using the same `transactionId`. The use of the `productTransactionId` field and any specific workflow deviations will be vetted during the onboarding process.
orderNumber	Required	Integer		Represents Mortgage Connects unique order number.
productCode	Required	String	3 / 4	Represents Mortgage Connect's product code. Possible Values: LVR `LEGAL & VEString REPORT` PRT `PROPERTY REPORT` PUR `PURCHASE` TTL `TITLE INSURANCE` etc. Traditionally, clients use Mortgage Connects `Product Code` names and thus there is a one to one mapping relationship that is maintained by the client. However, Mortgage Connect is aware that our naming conventions may not resonate and that there are many inconsistencies in product code naming conventions and nomenclatures. It is for this reason that Mortgage Connect is able to map the client's product code to Mortgage Connect's product code to ease the transition. Any required product code mapping exercises will be addressed during the onboarding process. The supported `productCode`(s) are specific per integration and will be determined during the onboarding process. Note that the minimum/maximum length requirement of 3/4 is only applicable if using Mortgage Connect's internal product codes, otherwise when mapping to the client's product codes, the minimum/maximum is 1/50.
loanNumber	Required	String	1 / 64	The clients loan number `alpha-numeric`.
loanAmount	Optional	Money		The loan amount
originalLoanAmount	Optional	Money		The original Loan amount.
unpaidPrinipalAmount	Optional	Money		The unpaid principle amount `if any` in dollars.
salePrice	Conditional	Money		The property sale price. The `salePrice` is optional but is `Required` if the `loanType` is `Purchase`.
loanType	Required	String	1 / 24	The loan type. Possible Values: Equity Purchase Refinance Reverse
propertyType	Required	String	1 / 64	The property usage type. Possible Values: Condominium Cooperative Manufactured Multi-Family Other PUD SingleFamily
amortizationType	Optional	String	0 / 64	The amortization type, i.e. how the loan will be paid. Possible Values: ARM Fixed Interest Only Reverse
expectedClosingDate	Optional	DateTime		The expected closing data `if known`. Format: `mm/dd/yyyy`
cema	Optional	String	0 / 100	Information regarding a CEMA (Consolidation, Extension and Modification Agreement) mortgage loan.
occupancyType	Required	String	1 / 64	The occupancy type, i.e. how the property will be used Possible Values: Primary Secondary Investment
propertyAddress	Required			A parent object (JSON) or node (XML) that contains metadata associated with a property address.
address1	Required	String	1 / 255	The property street address.
address2	Optional	String	0 / 255	The property street address 2.
city	Required	String	1 / 32	The property city name.
state	Required	String	2 / 2	The property state abbreviation. Possible Values: AK, AL, AR, AS, AZ, CA, CO, CT, DC, DE, FL, FM, GA, GU, HI, IA, ID, IL, IN, KS, KY, LA, MA, MD, ME, MH, MI, MN, MO, MP, MS, MT, NC, ND, NE, NH, NJ, NM, NV, NY, OH, OK, OR, PA, PR, PW, RI, SC, SD, TN, TX, UT, VA, VI, VT, WA, WI, WV, WY.
zipCode	Required	String	5 / 5	The property zip code.
county	Optional	String	0 / 32	The property county.
borrowers	Required			A parent object (JSON) or node (XML) that contains a list of borrowers. `(1 to Many)` Note that the first borrower is assumed to `always` be the `Primary` borrower.
borrower	Required			A parent object (JSON) or node (XML) that contains the metadata associated with a single borrower.
firstName	Required	String	1 / 150	The borrower’s first name.
middleName	Required	String	1 / 150	The borrower’s middle name.
lastName	Required	String	1 / 255	The borrower’s last name.
suffix	Optional	String	0 / 4	The borrower's suffix. Possible Values: II III Esq. Jr. Sr.
type	Required	String	1 / 32	The borrower's type. Note that typically this value will be set to `Borrower`. Possible Values: Asset Management Company Asset Manager Assignee Assignor Attorney Bank Attorney Borrower Borrower/Buyer Builder Buyer Buyer Agent Buyer Attorney Buyer Title Company Buyers Broker Condo Association Custodian Foreclosed Party Investor LENDER Lender Loan Officer Listing Agent MC MC Auction Company Mortgage Connect Closer Non-HUD Borrower Non-Vested Signer Other Processor Property Access Real Estate Agent Real Estate Agent - Seller Seller Seller Attorney Sellers Broker Selling Agent Servicer Settlement Agent Title Company Underwriter Vested Signer - Non-Borrower
email	Optional	String	0 / 255	The borrower’s email address.
cellPhone	Optional	String	0 / 24	The borrower's cell phone number.
ssn	Optional	String	0 / 128	The borrower's social security number.
maritalStatus	Optional	String	0 / 128	The borrower’s marital status. Possible Values: Divorced Married Separated Single Widowed
dateOfBirth	Optional	DateTime		The borrower’s date of birth. Format: `mm/dd/yyyy`
borrowerAddress	Optional			A parent object (JSON) or node (XML) that contains metadata associated with a borrower address.
address1	Required	String	1 / 255	The borrower street address.
address2	Optional	String	0 / 255	The borrower street address 2.
city	Required	String	1 / 32	The borrower city name.
state	Required	String	2 / 2	The borrower state abbreviation. Possible Values: AK, AL, AR, AS, AZ, CA, CO, CT, DC, DE, FL, FM, GA, GU, HI, IA, ID, IL, IN, KS, KY, LA, MA, MD, ME, MH, MI, MN, MO, MP, MS, MT, NC, ND, NE, NH, NJ, NM, NV, NY, OH, OK, OR, PA, PR, PW, RI, SC, SD, TN, TX, UT, VA, VI, VT, WA, WI, WV, WY.
zipCode	Required	String	5 / 5	The borrower zip code.
county	Optional	String	0 / 32	The borrower county.
parties	Optional			A parent object (JSON) or node (XML) that contains a list of parties (i.e. those working on the loan). `(0 to Many)`
party	Optional			A parent object (JSON) or node (XML) that contains the metadata associated with a single borrower.
firstName	Required	String	1 / 150	The party's first name.
lastName	Required	String	1 / 150	The party's last name.
phone	Optional	String	0 / 24	The party's phone number.
email	Optional	String	0 / 255	The party's email address.
role	Required	String	1 / 32	The party's role. Possible Values: Closer LoanOfficer Processor
lender	Optional			A parent object (JSON) or node (XML) that contains the metadata associated with a single lender.
name	Optional	String	0 / 255	The lender's name.
address	Required	String	1 / 255	The lender's address.
city	Required	String	1 / 32	The lender's city.
state	Required	String	5 / 2	The lender's state.
zipCode	Required	String	5 / 5	The lender's zip code.
specialInstruction	Optional	String	0 / MAX	The special instruction associated with the Title. `(if applcable)`

Property Definitions - Transaction Extensions

Defines the properties represented in the TransactionExtensions object (JSON) or node (XML). Note that this message artifact is identical for each and every message type.

View Transaction Extension Details

Closing - MC130 - Add Note

🌐 The following is an example payload to be posted in the body of the HTTP request.

/* Copyright © 2023 Mortgage Connect LP */
{
    "transactionHeader": {
        "transactionIdempotentId": "3B34A671-BB17-400D-90BF-7CBF9C96E8ED",
        "transactionDate": "2022-07-11T02:03:40",
        "clientCode": "1799",
        "clientName": "AcmeInc",
        "vendorCode": "MC",
        "vendorName": "Mortgage Connect"
    },
    "transactionBody": {
        "transactionCode": "Add-Note",
        "transactionId": "7832143",
        "productTransactionId": "",
        "orderNumber": 2429888,
        "productCode": "CWI",
        "note": "We have scheduled a trustees sale of the property.",
        "noteDate": "07/11/2022 07:26:25.012 PM"
    },
    "transactionExtensions": {
        "transactionExtension": [
            {
                "key": "Client Specific Key 1",
                "value": "Client Specific Value 1"
            },
            {
                "key": "Client Specific Key 2",
                "value": "Client Specific Value 2"
            }
        ]
    }
}
/* Copyright © 2023 Mortgage Connect LP */

<!-- Copyright © 2023 Mortgage Connect LP -->
<root>
    <transactionHeader>
        <transactionIdempotentId>3B34A671-BB17-400D-90BF-7CBF9C96E8ED</transactionIdempotentId>
        <transactionDate>022-07-11T02:03:40</transactionDate>
        <clientCode>1799</clientCode>
        <clientName>AcmeInc</clientName>
        <vendorCode>MC</vendorCode>
        <vendorName>Mortgage Connect</vendorName>
    </transactionHeader>
    <transactionBody>
        <transactionCode>Add-Note</transactionCode>
        <transactionId>7832143</transactionId>
        <productTransactionId></productTransactionId>
        <orderNumber>2429888</orderNumber>
        <productCode>CWI</productCode>
        <note>We have scheduled a trustees sale of the property.</note>
        <noteDate>07/11/2022 07:26:25.012 PM</noteDate>
    </transactionBody>
    <transactionExtensions>
        <transactionExtension>
            <key>Client Specific Key 1</key>
            <value>Client Specific Value 1</value>
        </transactionExtension>
        <transactionExtension>
            <key>Client Specific Key 2</key>
            <value>Client Specific Value 1</value>
        </transactionExtension>
    </transactionExtensions>
</root>
<!-- Copyright © 2023 Mortgage Connect LP -->

👍 The request payload can be verified using the following validation schema.

The request payload JSON schema validation is under construction. 🚧

The request payload XML schema validation is under construction. 🚧

✅ The following is an 'Accepted' example payload to be returned in the HTTP response.

Accepted Acknowledgment payloads are typically message type agnostic.

Accepted Acknowledgment payloads are typically message type agnostic.

⛔ The following is a 'Rejected' example payload to be returned in the HTTP response.

Rejected Acknowledgment payloads are typically message type agnostic.

Rejected Acknowledgment payloads are typically message type agnostic.

The Add Note API method is the mechanism in which a Client or Mortgage Connect can submit a message to add a note to the Title Order.

View Workflow Orchestration

Client URL

POST 🔒 To be determined during onboarding process.

Mortgage Connect URL

POST 🔒 https://{BaseUrl}/Api/V1.0/{ClientCode}/SubmitMessage

Mortgage Connect URL Properties

Property	Requirement	Description
BaseUrl	Required	A unique base Url that represents a specific Mortgage Connect endpoint and targeted environment.
ClientCode	Required	A unique code assigned to all clients that is used for identification, authentication, and customization purposes.

Property Definitions - Transaction Header

Defines the properties represented in the Transaction Header object (JSON) or node (XML). Note that this message artifact is identical for each and every message type.

View Transaction Header Details

Property Definitions - Transaction Body

Defines the properties represented in the Transaction Body object (JSON) or node (XML).

Property	Requirement	Data Type	Min / Max	Description
transactionBody	Required			A parent object (JSON) or node (XML) that contains the transaction metadata.
**transactionCode	Required	String	8 / 8	A static value of `Add-Note`. The transaction code is meant to identify the message type and the context or action that should be taken. In this context it implies that a note should be added to the Title Order. Possible Values: Add-Note
transactionId	Required	String	1 / 50	Represents the Client's unique order number.
productTransactionId	Optional	String	0 / 50	Represents the Client's unique product order number. Note that the `productTransactionId` field is not used in most circumstances. However, when there is a need to further differentiate order numbers at a product level, that share the same `transactionId`, (i.e. the primary order level id), then the `productTransactionId` can be used to ensure uniqueness across the integration transactions. This makes it possible for multiple orders of the same product type to be placed using the same `transactionId`. The use of the `productTransactionId` field and any specific workflow deviations will be vetted during the onboarding process.
orderNumber	Required	Integer		Represents Mortgage Connects unique order number.
productCode	Required	String	3 / 4	Represents Mortgage Connect's product code. Possible Values: LVR `LEGAL & VEString REPORT` PRT `PROPERTY REPORT` PUR `PURCHASE` TTL `TITLE INSURANCE` etc. Traditionally, clients use Mortgage Connects `Product Code` names and thus there is a one to one mapping relationship that is maintained by the client. However, Mortgage Connect is aware that our naming conventions may not resonate and that there are many inconsistencies in product code naming conventions and nomenclatures. It is for this reason that Mortgage Connect is able to map the client's product code to Mortgage Connect's product code to ease the transition. Any required product code mapping exercises will be addressed during the onboarding process. The supported `productCode`(s) are specific per integration and will be determined during the onboarding process. Note that the minimum/maximum length requirement of 3/4 is only applicable if using Mortgage Connect's internal product codes, otherwise when mapping to the client's product codes, the minimum/maximum is 1/50.
note	Required	String	1 / MAX	The actual note text to be associated with the Order/Product.
noteDate	Required	DateTime		The date when the note was entered.

Property Definitions - Transaction Extensions

Defines the properties represented in the TransactionExtensions object (JSON) or node (XML). Note that this message artifact is identical for each and every message type.

View Transaction Extension Details

Closing - MC140 - Add Note Action

🌐 The following is an example payload to be posted in the body of the HTTP request.

/* Copyright © 2023 Mortgage Connect LP */
{
    "transactionHeader": {
        "transactionIdempotentId": "3B34A671-BB17-400D-90BF-7CBF9C96E8ED",
        "transactionDate": "2022-07-11T02:03:40",
        "clientCode": "1799",
        "clientName": "AcmeInc",
        "vendorCode": "MC",
        "vendorName": "Mortgage Connect"
    },
    "transactionBody": {
        "transactionCode": "Add-Note-Action",
        "transactionId": "7832143",
        "productTransactionId": "",
        "orderNumber": 2429888,
        "productCode": "CWI",
        "note": "Please call borrower immediately to confirm martial status.",
        "noteDate": "07/11/2022 07:26:25.012 PM"
    },
    "transactionExtensions": {
        "transactionExtension": [
            {
                "key": "Client Specific Key 1",
                "value": "Client Specific Value 1"
            },
            {
                "key": "Client Specific Key 2",
                "value": "Client Specific Value 2"
            }
        ]
    }
}
/* Copyright © 2023 Mortgage Connect LP */

<!-- Copyright © 2023 Mortgage Connect LP -->
<root>
    <transactionHeader>
        <transactionIdempotentId>3B34A671-BB17-400D-90BF-7CBF9C96E8ED</transactionIdempotentId>
        <transactionDate>022-07-11T02:03:40</transactionDate>
        <clientCode>1799</clientCode>
        <clientName>AcmeInc</clientName>
        <vendorCode>MC</vendorCode>
        <vendorName>Mortgage Connect</vendorName>
    </transactionHeader>
    <transactionBody>
        <transactionCode>Add-Note-Action</transactionCode>
        <transactionId>7832143</transactionId>
        <productTransactionId></productTransactionId>
        <orderNumber>2429888</orderNumber>
        <productCode>CWI</productCode>
        <note>Please call borrower immediately to confirm martial status.</note>
        <noteDate>07/11/2022 07:26:25.012 PM</noteDate>
    </transactionBody>
    <transactionExtensions>
        <transactionExtension>
            <key>Client Specific Key 1</key>
            <value>Client Specific Value 1</value>
        </transactionExtension>
        <transactionExtension>
            <key>Client Specific Key 2</key>
            <value>Client Specific Value 1</value>
        </transactionExtension>
    </transactionExtensions>
</root>
<!-- Copyright © 2023 Mortgage Connect LP -->

👍 The request payload can be verified using the following validation schema.

The request payload JSON schema validation is under construction. 🚧

The request payload XML schema validation is under construction. 🚧

✅ The following is an 'Accepted' example payload to be returned in the HTTP response.

Accepted Acknowledgment payloads are typically message type agnostic.

Accepted Acknowledgment payloads are typically message type agnostic.

⛔ The following is a 'Rejected' example payload to be returned in the HTTP response.

Rejected Acknowledgment payloads are typically message type agnostic.

Rejected Acknowledgment payloads are typically message type agnostic.

The Add Note Action API method is the mechanism in which a Client or Mortgage Connect can submit a message to add a note to the Title Order with escalation.

View Workflow Orchestration

Client URL

POST 🔒 To be determined during onboarding process.

Mortgage Connect URL

POST 🔒 https://{BaseUrl}/Api/V1.0/{ClientCode}/SubmitMessage

Mortgage Connect URL Properties

Property	Requirement	Description
BaseUrl	Required	A unique base Url that represents a specific Mortgage Connect endpoint and targeted environment.
ClientCode	Required	A unique code assigned to all clients that is used for identification, authentication, and customization purposes.

Property Definitions - Transaction Header

Defines the properties represented in the Transaction Header object (JSON) or node (XML). Note that this message artifact is identical for each and every message type.

View Transaction Header Details

Property Definitions - Transaction Body

Defines the properties represented in the Transaction Body object (JSON) or node (XML).

Property	Requirement	Data Type	Min / Max	Description
transactionBody	Required			A parent object (JSON) or node (XML) that contains the transaction metadata.
transactionCode	Required	String	15 / 15	A static value of `Add-Note-Action`. The transaction code is meant to identify the message type and the context or action that should be taken. In this context it implies that a note should be added to the Title Order and it should be escalated to the proper personnel. Possible Values: Add-Note-Action
transactionId	Required	String	1 / 50	Represents the Client's unique order number.
productTransactionId	Optional	String	0 / 50	Represents the Client's unique product order number. Note that the `productTransactionId` field is not used in most circumstances. However, when there is a need to further differentiate order numbers at a product level, that share the same `transactionId`, (i.e. the primary order level id), then the `productTransactionId` can be used to ensure uniqueness across the integration transactions. This makes it possible for multiple orders of the same product type to be placed using the same `transactionId`. The use of the `productTransactionId` field and any specific workflow deviations will be vetted during the onboarding process.
orderNumber	Required	Integer		Represents Mortgage Connects unique order number.
productCode	Required	String	3 / 4	Represents Mortgage Connect's product code. Possible Values: LVR `LEGAL & VEString REPORT` PRT `PROPERTY REPORT` PUR `PURCHASE` TTL `TITLE INSURANCE` etc. Traditionally, clients use Mortgage Connects `Product Code` names and thus there is a one to one mapping relationship that is maintained by the client. However, Mortgage Connect is aware that our naming conventions may not resonate and that there are many inconsistencies in product code naming conventions and nomenclatures. It is for this reason that Mortgage Connect is able to map the client's product code to Mortgage Connect's product code to ease the transition. Any required product code mapping exercises will be addressed during the onboarding process. The supported `productCode`(s) are specific per integration and will be determined during the onboarding process. Note that the minimum/maximum length requirement of 3/4 is only applicable if using Mortgage Connect's internal product codes, otherwise when mapping to the client's product codes, the minimum/maximum is 1/50.
note	Required	String	1 / MAX	The actual text to be associated with the Order/Product.
noteDate	Required	DateTime		The date when the note was entered.

Property Definitions - Transaction Extensions

Defines the properties represented in the TransactionExtensions object (JSON) or node (XML). Note that this message artifact is identical for each and every message type.

View Transaction Extension Details

Closing - MC150 - Add Attachment

🌐 The following is an example payload to be posted in the body of the HTTP request.

/* Copyright © 2023 Mortgage Connect LP */
{
    "transactionHeader": {
        "transactionIdempotentId": "3B34A671-BB17-400D-90BF-7CBF9C96E8ED",
        "transactionDate": "2022-07-11T02:03:40",
        "clientCode": "1799",
        "clientName": "AcmeInc",
        "vendorCode": "MC",
        "vendorName": "Mortgage Connect"
    },
    "transactionBody": {
        "transactionCode": "Add-Attachment",
        "transactionId": "7832143",
        "productTransactionId": "",
        "orderNumber": 2429888,
        "productCode": "CWI",
        "documents": {
            "document": [
                {
                    "documentId": "1243992",
                    "type": "Patriot Search",
                    "name": "patriot-search.pdf",
                    "fileType": "PDF",
                    "contentMediaType": "application/pdf",
                    "contentUnicodeTextEncodingType": "UTF8",
                    "contentBinaryEncodingType": "Base64",
                    "content": "Base64 String",
                    "description": "Brief overview of the document"
                }
            ]
        }
    },
    "transactionExtensions": {
        "transactionExtension": [
            {
                "key": "Client Specific Key 1",
                "value": "Client Specific Value 1"
            },
            {
                "key": "Client Specific Key 2",
                "value": "Client Specific Value 2"
            }
        ]
    }
}
/* Copyright © 2023 Mortgage Connect LP */

<!-- Copyright © 2023 Mortgage Connect LP -->
<root>
    <transactionHeader>
        <transactionIdempotentId>3B34A671-BB17-400D-90BF-7CBF9C96E8ED</transactionIdempotentId>
        <transactionDate>2022-07-11T02:03:40</transactionDate>
        <clientCode>1799</clientCode>
        <clientName>AcmeInc</clientName>
        <vendorCode>MC</vendorCode>
        <vendorName>Mortgage Connect</vendorName>
    </transactionHeader>
    <transactionBody>
        <transactionCode>Add-Attachment</transactionCode>
        <transactionId>7832143</transactionId>
        <productTransactionId></productTransactionId>
        <orderNumber>2429888</orderNumber>
        <productCode>CWI</productCode>
        <documents>
            <document>
                <documentId>1243992</documentId>
                <type>Patriot Search</type>
                <name>patriot-search.pdf</name>
                <fileType>PDF</fileType>
                <contentMediaType>application/pdf</contentMediaType>
                <contentUnicodeTextEncodingType>UTF8</contentUnicodeTextEncodingType>
                <contentBinaryEncodingType>Base64</contentBinaryEncodingType>
                <content>Base64 String</content>
                <description>Brief overview of the document</description>
            </document>
        </documents>
    </transactionBody>
    <transactionExtensions>
        <transactionExtension>
            <key>Client Specific Key 1</key>
            <value>Client Specific Value 1</value>
        </transactionExtension>
        <transactionExtension>
            <key>Client Specific Key 2</key>
            <value>Client Specific Value 1</value>
        </transactionExtension>
    </transactionExtensions>
</root>
<!-- Copyright © 2023 Mortgage Connect LP -->

👍 The request payload can be verified using the following validation schema.

The request payload JSON schema validation is under construction. 🚧

The request payload XML schema validation is under construction. 🚧

✅ The following is an 'Accepted' example payload to be returned in the HTTP response.

Accepted Acknowledgment payloads are typically message type agnostic.

Accepted Acknowledgment payloads are typically message type agnostic.

⛔ The following is a 'Rejected' example payload to be returned in the HTTP response.

Rejected Acknowledgment payloads are typically message type agnostic.

Rejected Acknowledgment payloads are typically message type agnostic.

The Add Attachment API method is the mechanism in which a Client or Mortgage Connect can submit a message to add a document to a Title Order.

View Workflow Orchestration

Client URL

POST 🔒 To be determined during onboarding process.

Mortgage Connect URL

POST 🔒 https://{BaseUrl}/Api/V1.0/{ClientCode}/SubmitMessage

Mortgage Connect URL Properties

Property	Requirement	Description
BaseUrl	Required	A unique base Url that represents a specific Mortgage Connect endpoint and targeted environment.
ClientCode	Required	A unique code assigned to all clients that is used for identification, authentication, and customization purposes.

Property Definitions - Transaction Header

Defines the properties represented in the Transaction Header object (JSON) or node (XML). Note that this message artifact is identical for each and every message type.

View Transaction Header Details

Property Definitions - Transaction Body

Defines the properties represented in the Transaction Body object (JSON) or node (XML).

Property	Requirement	Data Type	Min / Max	Description
transactionBody	Required			A parent object (JSON) or node (XML) that contains the transaction metadata.
transactionCode	Required	String	14 / 14	A static value of `Add-Attachment`. The transaction code is meant to identify the message type and the context or action that should be taken. In this context it implies that an attachment should be added to the Title Order. Possible Values: Add-Attachment
transactionId	Required	String	1 / 50	Represents the Client's unique order number.
productTransactionId	Optional	String	0 / 50	Represents the Client's unique product order number. Note that the `productTransactionId` field is not used in most circumstances. However, when there is a need to further differentiate order numbers at a product level, that share the same `transactionId`, (i.e. the primary order level id), then the `productTransactionId` can be used to ensure uniqueness across the integration transactions. This makes it possible for multiple orders of the same product type to be placed using the same `transactionId`. The use of the `productTransactionId` field and any specific workflow deviations will be vetted during the onboarding process.
orderNumber	Required	Integer		Represents Mortgage Connects unique order number.
productCode	Required	String	3 / 4	Represents Mortgage Connect's product code. Possible Values: LVR `LEGAL & VEString REPORT` PRT `PROPERTY REPORT` PUR `PURCHASE` TTL `TITLE INSURANCE` etc. Traditionally, clients use Mortgage Connects `Product Code` names and thus there is a one to one mapping relationship that is maintained by the client. However, Mortgage Connect is aware that our naming conventions may not resonate and that there are many inconsistencies in product code naming conventions and nomenclatures. It is for this reason that Mortgage Connect is able to map the client's product code to Mortgage Connect's product code to ease the transition. Any required product code mapping exercises will be addressed during the onboarding process. The supported `productCode`(s) are specific per integration and will be determined during the onboarding process. Note that the minimum/maximum length requirement of 3/4 is only applicable if using Mortgage Connect's internal product codes, otherwise when mapping to the client's product codes, the minimum/maximum is 1/50.
documents	Required			A parent object (JSON) or node (XML) that contains a list of document metadata. `(1 to Many)`
document	Required			A parent object (JSON) or node (XML) that contains the metadata associated with a single document.
documentId	Required	String	1/36	A number or string that uniquely identifies the document within the host system. When an outbound Add-Attachment event is sent by Mortgage Connect to the Client, the documentId will be a string in the form of an integer. The integer value represents the Identity Field and Primary Key associated with the corresponding document record. Likewise, when the Client sends Mortgage Connect an Add-Attachment event, the documentId could also represent an Integer, however, there is no reason why the value could not be a unique string like a GUID. No matter what value is passed, the value needs to represent a unique value that uniquely identifies the attached document. There is no hard requirement to capture this information. However, both parties are encouraged to do so, in order that conversations or any triaging of exceptions around these values can be correlated across systems.
type	Required	String	1 / 255	A name that uniquely identifies the document type. Traditionally, clients use Mortgage Connects `Document Type` names and thus there is a one to one mapping relationship that is maintained by the client. However, Mortgage Connect is aware that our naming conventions may not resonate and that there are many inconsistencies in document type naming conventions and nomenclatures. It is for this reason that Mortgage Connect is able to map the client's document type to Mortgage Connect's document type to ease the transition. Any required document mapping exercises will be addressed during the onboarding process. The supported `types`(s) are specific per integration and will be determined during the onboarding process.
name	Required	String	1 / 100	This is the user friendly name that is associated with the document.
fileType	Required	String	3 / 4	This indicates what type of document it is. This in the context of what the file extension represents. Possible Values: DOC DOCX PDF Future Values: CSV HTML JSON TXT XLS XLSX XML `DOC`, `DOCX`, and `PDF` are currently supported with the vast majority of the documents being delivered as `PDF` documents. The other types are included to support additional documents in the future.
contentMediaType	Required	String	1 / 100	This represents the content media type, i.e. `MIME Type`. Possible Values: application/msword (DOC) application/vnd.openxmlformats-officedocument.wordprocessingml.document (DOCX) application/pdf (PDF) Future Values: text/csv (CSV) text/html (HTML) application/json (JSON) text/plain (TXT) application/vnd.ms-excel (XLS) application/vnd.openxmlformats-officedocument.spreadsheetml.sheet (XLSX) application/xml (XML) At this time `application/msword (DOC)`, `application/vnd.openxmlformats-officedocument.wordprocessingml.document (DOCX)`, and `application/pdf (PDF)` are supported with `application/pdf (PDF)` being used 90+% of the time. The other types are added to support future media types.
contentUnicode TextEncodingType	Required	String	4 / 4	This indicates what unicode text encoding type was used to generate the document. Possible Values: UTF8
contentBinary EncodingType	Required	String	6 / 6	This indicates what binary encoding type was used to generate the document content. Possible Values: Base64
content	Required	String	1 / MAX	This represents the digital representation of the document after it has been encoded using Base64. See: https://en.wikipedia.org/wiki/Base64 for more information regarding Base64 formatting.
description	Optional	String	0 / 255	Provides a brief overview of the document contents.

Property Definitions - Transaction Extensions

Defines the properties represented in the TransactionExtensions object (JSON) or node (XML). Note that this message artifact is identical for each and every message type.

View Transaction Extension Details

Closing - MC200 - Schedule Signing

🌐 The following is an example payload to be posted in the body of the HTTP request.

/* Copyright © 2023 Mortgage Connect LP */
{
    "transactionHeader": {
        "transactionIdempotentId": "3B34A671-BB17-400D-90BF-7CBF9C96E8ED",
        "transactionDate": "2022-07-11T02:03:40",
        "clientCode": "1799",
        "clientName": "AcmeInc",
        "vendorCode": "MC",
        "vendorName": "Mortgage Connect"
    },
    "transactionBody": {
        "transactionCode": "Schedule-Signing",
        "transactionId": "7832143",
        "productTransactionId": "",
        "orderNumber": "2429888",
        "productCode": "CWI",
        "signingDetails": {
            "signer": {
                "firstName": "John",
                "middleName": "",
                "lastName": "Doe",
                "homePhone": "724-471-3551",
                "workPhone": "412-655-0021",
                "cellPhone": "724-421-0055",
                "otherPhone": "",
                "email": "johndoe@gmail.com",
                "signingDateTime": "2023-09-14T14:00:00",
                "closingLocation": "In-Home",
                "signingAddress": {
                    "address1": "113 Magnolia Dr",
                    "address2": "",
                    "city": "Pittsburgh",
                    "state": "PA",
                    "zipCode": "15136",
                    "county": "Allegheny"
                }
           },
           "coSigner": {
                "firstName": "Jane",
                "middleName": "",
                "lastName": "Doe",
                "homePhone": "",
                "workPhone": "",
                "cellPhone": "412-421-4883",
                "otherPhone": "",
                "email": "janedoe@gmail.com",
                "signingDateTime": "2022-09-15T12:00:00",
                "closingLocation": "Other",
                "signingAddress": {
                    "address1": "7322 Allen Lane",
                    "address2": "",
                    "city": "Pittsburgh",
                    "state": "PA",
                    "zipCode": "15136",
                    "county": "Allegheny"
                }
            },
            "additionalSigners": {
              "additionalSigner":[
                  {
                    "firstName": "Jane Sr",
                    "middleName": "",
                    "lastName": "Doe",
                    "homePhone": "",
                    "workPhone": "",
                    "cellPhone": "412-421-4883",
                    "otherPhone": "",
                    "email": "janedoeSr@gmail.com",
                    "signingDateTime": "2022-09-15T12:00:00",
                    "closingLocation": "Other",
                    "signingAddress": {
                        "address1": "7322 Allen Lane",
                        "address2": "",
                        "city": "Pittsburgh",
                        "state": "PA",
                        "zipCode": "15136",
                        "county": "Allegheny"
                    }
                  },        
                  {
                    "firstName": "Jane Jr",
                    "middleName": "",
                    "lastName": "Doe",
                    "homePhone": "",
                    "workPhone": "",
                    "cellPhone": "412-421-4883",
                    "otherPhone": "",
                    "email": "janedoeJr@gmail.com",
                    "signingDateTime": "2022-09-15T12:00:00",
                    "closingLocation": "Other",
                    "signingAddress": {
                        "address1": "7322 Allen Lane",
                        "address2": "",
                        "city": "Pittsburgh",
                        "state": "PA",
                        "zipCode": "15136",
                        "county": "Allegheny"
                    }
                  }        
                ]
            }
        },        
        "dualSigning": true,
        "language": "English",
        "specialInstructions": ""
    },
    "transactionExtensions": {
        "transactionExtension": [
            {
                "key": "Client Specific Key 1",
                "value": "Client Specific Value 1"
            },
            {
                "key": "Client Specific Key 2",
                "value": "Client Specific Value 2"
            }
        ]
    }
}
/* Copyright © 2023 Mortgage Connect LP */

<!-- Copyright © 2023 Mortgage Connect LP -->
<root>
    <transactionHeader>
        <transactionIdempotentId>3B34A671-BB17-400D-90BF-7CBF9C96E8ED</transactionIdempotentId>
        <transactionDate>022-07-11T02:03:40</transactionDate>
        <clientCode>1799</clientCode>
        <clientName>AcmeInc</clientName>
        <vendorCode>MC</vendorCode>
        <vendorName>Mortgage Connect</vendorName>
    </transactionHeader>
    <transactionBody>
        <transactionCode>Schedule-Signing</transactionCode>
        <transactionId>7832143</transactionId>
        <productTransactionId></productTransactionId>
        <orderNumber>2429888</orderNumber>
        <productCode>CWI</productCode>
        <signingDetails>
            <signer>
                <firstName>John</firstName>
                <middleName></middleName>
                <lastName>Doe</lastName>
                <homePhone>724-471-3551</homePhone>
                <workPhone>412-655-0021</workPhone>
                <cellPhone>724-421-0055</cellPhone>
                <otherPhone></otherPhone>
                <email>johndoe@gmail.com</email>
                <signingDateTime>2023-09-14T14:00:00</signingDateTime>
                <closingLocation>In-Home</closingLocation>
                <signingAddress>
                    <address1>113 Magnolia Dr</address1>
                    <address2></address2>
                    <city>Pittsburgh</city>
                    <state>PA</state>
                    <zipCode>15136</zipCode>
                    <county>Allegheny</county>
                </signingAddress>
            </signer>
            <coSigner>
                <firstName>Jane</firstName>
                <middleName></middleName>
                <lastName>Doe</lastName>
                <homePhone></homePhone>
                <workPhone></workPhone>
                <cellPhone>412-421-4883</cellPhone>
                <otherPhone></otherPhone>
                <email>janedoe@gmail.com</email>
                <signingDateTime>2022-09-15T12:00:00</signingDateTime>
                <closingLocation>Other</closingLocation>
                <signingAddress>
                    <address1>7322 Allen Lane</address1>
                    <address2></address2
                    <city>Pittsburgh</city>
                    <state>PA</state>
                    <zipCode>15136</zipCode>
                    <county>Allegheny</county>
                </signingAddress>
            </coSigner>
            <additionalSigners>
                <additionalSigner>
                    <firstName>Jane Sr</firstName>
                    <middleName></middleName>
                    <lastName>Doe</lastName>
                    <homePhone></homePhone>
                    <workPhone></workPhone>
                    <cellPhone>412-421-4883</cellPhone>
                    <otherPhone></otherPhone>
                    <email>janedoe@gmail.com</email>
                    <signingDateTime>2022-09-15T12:00:00</signingDateTime>
                    <closingLocation>Other</closingLocation>
                    <signingAddress>
                        <address1>7322 Allen Lane</address1>
                        <address2></address2
                        <city>Pittsburgh</city>
                        <state>PA</state>
                        <zipCode>15136</zipCode>
                        <county>Allegheny</county>
                    </signingAddress>
                </additionalSigner>
                <additionalSigner>
                      <firstName>Jane Jr</firstName>
                      <middleName></middleName>
                      <lastName>Doe</lastName>
                      <homePhone></homePhone>
                      <workPhone></workPhone>
                      <cellPhone>412-421-4883</cellPhone>
                      <otherPhone></otherPhone>
                      <email>janedoe@gmail.com</email>
                      <signingDateTime>2022-09-15T12:00:00</signingDateTime>
                      <closingLocation>Other</closingLocation>
                      <signingAddress>
                          <address1>7322 Allen Lane</address1>
                          <address2></address2
                          <city>Pittsburgh</city>
                          <state>PA</state>
                          <zipCode>15136</zipCode>
                          <county>Allegheny</county>
                      </signingAddress>
                </additionalSigner>
          </additionalSigners>
          <dualSigning>true</dualSigning>
          <language>English</language>
          <specialInstructions></specialInstructions>
        </signingDetails>
    </transactionBody>
    <transactionExtensions>
        <transactionExtension>
            <key>Client Specific Key 1</key>
            <value>Client Specific Value 1</value>
        </transactionExtension>
        <transactionExtension>
            <key>Client Specific Key 2</key>
            <value>Client Specific Value 1</value>
        </transactionExtension>
    </transactionExtensions>
</root>
<!-- Copyright © 2023 Mortgage Connect LP -->

👍 The request payload can be verified using the following validation schema.

{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "transactionCode": {
      "type": "string",
      "const": "Schedule-Signing"
    },
    "transactionId": {
      "$ref": "CommonTypes#/$defs/transactionId"
    },
    "orderNumber": {
      "$ref": "CommonTypes#/$defs/orderNo"
    },
    "productCode": {
      "$ref": "ProductCodeType#"
    },
    "signingDetails": {
      "type": "object",
      "properties": {
        "signer": {
          "$ref": "CommonTypes#/$defs/signer"
        },
        "coSigner": {
          "$ref": "CommonTypes#/$defs/signer"
        },
        "additionalSigners": {
          "type": "object",
          "properties":{
              "additionalSigner":{
                "type": "array",
                "items": {
                  "$ref": "CommonTypes#/$defs/signer"
                }
              }
          }          
        },
        "dualSigning": {
          "type": "boolean",
          "examples": [ true, false ]
        },
        "language": {
          "$ref": "CommonTypes#/$defs/language"
        },
        "specialInstruction": {
          "type": "string"
        }
      },
      "required": [
        "signer",
        "dualSigning"
      ]
    }
  },
  "required": [
    "transactionCode",
    "transactionId",
    "orderNumber",
    "productCode",
    "signingDetails"
  ]
}

The request payload XML schema validation is under construction. 🚧

✅ The following is an 'Accepted' example payload to be returned in the HTTP response.

Accepted Acknowledgment payloads are typically message type agnostic.

Accepted Acknowledgment payloads are typically message type agnostic.

⛔ The following is a 'Rejected' example payload to be returned in the HTTP response.

Rejected Acknowledgment payloads are typically message type agnostic.

Rejected Acknowledgment payloads are typically message type agnostic.

The Schedule Signing API method is the mechanism in which a Client notifies Mortgage Connect that a closing signing should be scheduled.

View Workflow Orchestration

Mortgage Connect URL

POST 🔒 https://{BaseUrl}/Api/V1.0/{ClientCode}/SubmitMessage

Mortgage Connect URL Properties

Property	Requirement	Description
BaseUrl	Required	A unique base Url that represents a specific Mortgage Connect endpoint and targeted environment.
ClientCode	Required	A unique code assigned to all clients that is used for identification, authentication, and customization purposes.

Property Definitions - Transaction Header

Defines the properties represented in the Transaction Header object (JSON) or node (XML). Note that this message artifact is identical for each and every message type.

View Transaction Header Details

Property Definitions - Transaction Body

Defines the properties represented in the Transaction Body object (JSON) or node (XML).

Property	Requirement	Data Type	Min / Max	Description
transactionBody	Required			A parent object (JSON) or node (XML) that contains the transaction metadata.
transactionCode	Required	String	16 / 16	A static value of `Schedule-Signing`. The transaction code is meant to identify the message type and the context or action that should be taken. In this context it implies that the closing signing should be scheduled. Possible Values: Schedule-Signing
transactionId	Required	String	1 / 50	Represents the Client's unique order number.
productTransactionId	Optional	String	0 / 50	Represents the Client's unique product order number. Note that the `productTransactionId` field is not used in most circumstances. However, when there is a need to further differentiate order numbers at a product level, that share the same `transactionId`, (i.e. the primary order level id), then the `productTransactionId` can be used to ensure uniqueness across the integration transactions. This makes it possible for multiple orders of the same product type to be placed using the same `transactionId`. The use of the `productTransactionId` field and any specific workflow deviations will be vetted during the onboarding process.
orderNumber	Required	Integer		Represents Mortgage Connects unique order number.
productCode	Required	String	3 / 4	Represents Mortgage Connect's product code. Possible Values: LVR `LEGAL & VEString REPORT` PRT `PROPERTY REPORT` PUR `PURCHASE` TTL `TITLE INSURANCE` etc. Traditionally, clients use Mortgage Connects `Product Code` names and thus there is a one to one mapping relationship that is maintained by the client. However, Mortgage Connect is aware that our naming conventions may not resonate and that there are many inconsistencies in product code naming conventions and nomenclatures. It is for this reason that Mortgage Connect is able to map the client's product code to Mortgage Connect's product code to ease the transition. Any required product code mapping exercises will be addressed during the onboarding process. The supported `productCode`(s) are specific per integration and will be determined during the onboarding process. Note that the minimum/maximum length requirement of 3/4 is only applicable if using Mortgage Connect's internal product codes, otherwise when mapping to the client's product codes, the minimum/maximum is 1/50.
signingDetails	Required			A parent object (JSON) or node (XML) that contains the signing details.
signer	Required			A parent object (JSON) or node (XML) that contains the signer details.
firstName	Required	String	1 / 150	The primary signers first name.
middleName	Optional	String	0 / 150	The primary signers middle name.
lastName	Required	String	1 / 255	The primary signers last name.
homePhone	Optional	String	1 / 24	The primary signers home phone number.
workPhone	Optional	String	1 / 24	The primary signers work phone number.
cellPhone	Required	String	1 / 24	The primary signers cell phone number.
otherPhone	Optional	String	1 / 24	The primary signers other phone number.
email	Optional	String	1 / 255	The primary signers email address.
signingDateTime	Required	DateTime		Represents when the signing will take place. The `DateTime` value always represents the time in the context of the signing location.
closingLocation	Required	String		Represents where the signing will take place. Possible Values: `In-Home` `Other`
signingAddress	Required			A parent object (JSON) or node (XML) that contains the signing address.
address1	Required	String	1 / 255	The signer's location street address.
address2	Optional	String	1 / 255	The signer's locations street address 2.
city	Required	String	1 / 32	The signer's locations city name.
state	Required	String	2 / 2	The signer's locations state abbreviation. Possible Values: AK, AL, AR, AS, AZ, CA, CO, CT, DC, DE, FL, FM, GA, GU, HI, IA, ID, IL, IN, KS, KY, LA, MA, MD, ME, MH, MI, MN, MO, MP, MS, MT, NC, ND, NE, NH, NJ, NM, NV, NY, OH, OK, OR, PA, PR, PW, RI, SC, SD, TN, TX, UT, VA, VI, VT, WA, WI, WV, WY.
zipCode	Required	String	5 / 5	The signer's locations zip code.
county	Optional	String	1 / 32	The signer's locations county.
coSigner	Conditional			A parent object (JSON) or node (XML) that contains the cosigners details. Note that the existence of the `coSigner` object is conditional. It is only required if `dualSigning` is `True`.
firstName	Required	String	1 / 150	The cosigners first name.
middleName	Optional	String	0 / 150	The cosigners middle name.
lastName	Required	String	1 / 255	The cosigners last name.
homePhone	Optional	String	1 / 24	The cosigners home phone number.
workPhone	Optional	String	1 / 24	The cosigners work phone number.
cellPhone	Required	String	1 / 24	The cosigners cell phone number.
otherPhone	Optional	String	1 / 24	The cosigners other phone number.
email	Optional	String	1 / 255	The cosigners email address.
signingDateTime	Required	DateTime		Represents when the signing will take place. The `DateTime` value always represents the time in the context of the signing location.
closingLocation	Required	String		Represents where the signing will take place. Possible Values: `In-Home` `Other`
signingAddress	Required			A parent object (JSON) or node (XML) that contains the signing address.
address1	Required	String	1 / 255	The cosigner's location street address.
address2	Optional	String	1 / 255	The cosigner's locations street address 2.
city	Required	String	1 / 32	The cosigner's locations city name.
state	Required	String	2 / 2	The cosigner's locations state abbreviation. Possible Values: AK, AL, AR, AS, AZ, CA, CO, CT, DC, DE, FL, FM, GA, GU, HI, IA, ID, IL, IN, KS, KY, LA, MA, MD, ME, MH, MI, MN, MO, MP, MS, MT, NC, ND, NE, NH, NJ, NM, NV, NY, OH, OK, OR, PA, PR, PW, RI, SC, SD, TN, TX, UT, VA, VI, VT, WA, WI, WV, WY.
zipCode	Required	String	5 / 5	The cosigner's locations zip code.
county	Optional	String	1 / 32	The cosigner's locations county.
additionalSigners	Conditional			A parent object (JSON) or node (XML) that contains the additional Signers details. Note that the existence of the `additionalSigners` object is conditional. It is only required if `dualSigning` is `True` and more than 2 signers exists.
additionalSigner	Conditional			A parent object (JSON) or node (XML) that contains the additional Signer details.
firstName	Required	String	1 / 150	The additionalSigner's first name.
middleName	Optional	String	0 / 150	The additionalSigner's middle name.
lastName	Required	String	1 / 255	The additionalSigner's last name.
homePhone	Optional	String	1 / 24	The additionalSigner's home phone number.
workPhone	Optional	String	1 / 24	The additionalSigner's work phone number.
cellPhone	Required	String	1 / 24	The additionalSigner's cell phone number.
otherPhone	Optional	String	1 / 24	The additionalSigner's other phone number.
email	Optional	String	1 / 255	The additioadditionalSigner'snalSigners email address.
signingDateTime	Required	DateTime		Represents when the signing will take place. The `DateTime` value always represents the time in the context of the signing location.
closingLocation	Required	String		Represents where the signing will take place. Possible Values: `In-Home` `Other`
signingAddress	Required			A parent object (JSON) or node (XML) that contains the signing address.
address1	Required	String	1 / 255	The additionalSigner's location street address.
address2	Optional	String	1 / 255	The additionalSigner's locations street address 2.
city	Required	String	1 / 32	The additionalSigner's locations city name.
state	Required	String	2 / 2	The additionalSigner's locations state abbreviation. Possible Values: AK, AL, AR, AS, AZ, CA, CO, CT, DC, DE, FL, FM, GA, GU, HI, IA, ID, IL, IN, KS, KY, LA, MA, MD, ME, MH, MI, MN, MO, MP, MS, MT, NC, ND, NE, NH, NJ, NM, NV, NY, OH, OK, OR, PA, PR, PW, RI, SC, SD, TN, TX, UT, VA, VI, VT, WA, WI, WV, WY.
zipCode	Required	String	5 / 5	The additionalSigner's locations zip code.
county	Optional	String	1 / 32	The additionalSigner's locations county.
dualSigning	Required	Boolean		Indicates whether or not there is a dual signing requiring a cosigner. Possible Values: true false
language	Required	String	0 / 255	The cosigners and cosigners language. Possible Values: English Spanish
specialInstructions	Optional	String	0 / MAX	Any special instructions regarding the scheduling of the closing signing.

Property Definitions - Transaction Extensions

Defines the properties represented in the TransactionExtensions object (JSON) or node (XML). Note that this message artifact is identical for each and every message type.

View Transaction Extension Details

Closing - MC205 - Reschedule Signing

🌐 The following is an example payload to be posted in the body of the HTTP request.

/* Copyright © 2023 Mortgage Connect LP */
{
    "transactionHeader": {
        "transactionIdempotentId": "3B34A671-BB17-400D-90BF-7CBF9C96E8ED",
        "transactionDate": "2022-07-11T02:03:40",
        "clientCode": "1799",
        "clientName": "AcmeInc",
        "vendorCode": "MC",
        "vendorName": "Mortgage Connect"
    },
    "transactionBody": {
        "transactionCode": "ReSchedule-Signing",
        "transactionId": "7832143",
        "productTransactionId": "",
        "orderNumber": "2429888",
        "productCode": "CWI",
        "signingDetails": {
            "signer": {
                "firstName": "John",
                "middleName": "",
                "lastName": "Doe",
                "homePhone": "724-471-3551",
                "workPhone": "412-655-0021",
                "cellPhone": "724-421-0055",
                "otherPhone": "",
                "email": "johndoe@gmail.com",
                "signingDateTime": "2023-09-14T14:00:00",
                "closingLocation": "In-Home",
                "signingAddress": {
                    "address1": "113 Magnolia Dr",
                    "address2": "",
                    "city": "Pittsburgh",
                    "state": "PA",
                    "zipCode": "15136",
                    "county": "Allegheny"
                }
           },
           "coSigner": {
                "firstName": "Jane",
                "middleName": "",
                "lastName": "Doe",
                "homePhone": "",
                "workPhone": "",
                "cellPhone": "412-421-4883",
                "otherPhone": "",
                "email": "janedoe@gmail.com",
                "signingDateTime": "2022-09-15T12:00:00",
                "closingLocation": "Other",
                "signingAddress": {
                    "address1": "7322 Allen Lane",
                    "address2": "",
                    "city": "Pittsburgh",
                    "state": "PA",
                    "zipCode": "15136",
                    "county": "Allegheny"
                }
            },
            "additionalSigners": {
              "additionalSigner":[
                  {
                    "firstName": "Jane Sr",
                    "middleName": "",
                    "lastName": "Doe",
                    "homePhone": "",
                    "workPhone": "",
                    "cellPhone": "412-421-4883",
                    "otherPhone": "",
                    "email": "janedoeSr@gmail.com",
                    "signingDateTime": "2022-09-15T12:00:00",
                    "closingLocation": "Other",
                    "signingAddress": {
                        "address1": "7322 Allen Lane",
                        "address2": "",
                        "city": "Pittsburgh",
                        "state": "PA",
                        "zipCode": "15136",
                        "county": "Allegheny"
                    }
                  },        
                  {
                    "firstName": "Jane Jr",
                    "middleName": "",
                    "lastName": "Doe",
                    "homePhone": "",
                    "workPhone": "",
                    "cellPhone": "412-421-4883",
                    "otherPhone": "",
                    "email": "janedoeJr@gmail.com",
                    "signingDateTime": "2022-09-15T12:00:00",
                    "closingLocation": "Other",
                    "signingAddress": {
                        "address1": "7322 Allen Lane",
                        "address2": "",
                        "city": "Pittsburgh",
                        "state": "PA",
                        "zipCode": "15136",
                        "county": "Allegheny"
                    }
                  }        
                ]
            }
        },
        "dualSigning": true,
        "language": "English",
        "specialInstructions": ""
    },
    "transactionExtensions": {
        "transactionExtension": [
            {
                "key": "Client Specific Key 1",
                "value": "Client Specific Value 1"
            },
            {
                "key": "Client Specific Key 2",
                "value": "Client Specific Value 2"
            }
        ]
    }
}
/* Copyright © 2023 Mortgage Connect LP */

<!-- Copyright © 2023 Mortgage Connect LP -->
<root>
    <transactionHeader>
        <transactionIdempotentId>3B34A671-BB17-400D-90BF-7CBF9C96E8ED</transactionIdempotentId>
        <transactionDate>022-07-11T02:03:40</transactionDate>
        <clientCode>1799</clientCode>
        <clientName>AcmeInc</clientName>
        <vendorCode>MC</vendorCode>
        <vendorName>Mortgage Connect</vendorName>
    </transactionHeader>
    <transactionBody>
        <transactionCode>ReSchedule-Signing</transactionCode>
        <transactionId>7832143</transactionId>
        <productTransactionId></productTransactionId>
        <orderNumber>2429888</orderNumber>
        <productCode>CWI</productCode>
        <signingDetails>
            <signer>
                <firstName>John</firstName>
                <middleName></middleName>
                <lastName>Doe</lastName>
                <homePhone>724-471-3551</homePhone>
                <workPhone>412-655-0021</workPhone>
                <cellPhone>724-421-0055</cellPhone>
                <otherPhone></otherPhone>
                <email>johndoe@gmail.com</email>
                <signingDateTime>2023-09-14T14:00:00</signingDateTime>
                <closingLocation>In-Home</closingLocation>
                <signingAddress>
                    <address1>113 Magnolia Dr</address1>
                    <address2></address2>
                    <city>Pittsburgh</city>
                    <state>PA</state>
                    <zipCode>15136</zipCode>
                    <county>Allegheny</county>
                </signingAddress>
            </signer>
            <coSigner>
                <firstName>Jane</firstName>
                <middleName></middleName>
                <lastName>Doe</lastName>
                <homePhone></homePhone>
                <workPhone></workPhone>
                <cellPhone>412-421-4883</cellPhone>
                <otherPhone></otherPhone>
                <email>janedoe@gmail.com</email>
                <signingDateTime>2022-09-15T12:00:00</signingDateTime>
                <closingLocation>Other</closingLocation>
                <signingAddress>
                    <address1>7322 Allen Lane</address1>
                    <address2></address2
                    <city>Pittsburgh</city>
                    <state>PA</state>
                    <zipCode>15136</zipCode>
                    <county>Allegheny</county>
                </signingAddress>
            </coSigner>
            <additionalSigners>
                <additionalSigner>
                    <firstName>Jane Sr</firstName>
                    <middleName></middleName>
                    <lastName>Doe</lastName>
                    <homePhone></homePhone>
                    <workPhone></workPhone>
                    <cellPhone>412-421-4883</cellPhone>
                    <otherPhone></otherPhone>
                    <email>janedoe@gmail.com</email>
                    <signingDateTime>2022-09-15T12:00:00</signingDateTime>
                    <closingLocation>Other</closingLocation>
                    <signingAddress>
                        <address1>7322 Allen Lane</address1>
                        <address2></address2
                        <city>Pittsburgh</city>
                        <state>PA</state>
                        <zipCode>15136</zipCode>
                        <county>Allegheny</county>
                    </signingAddress>
                </additionalSigner>
                <additionalSigner>
                      <firstName>Jane Jr</firstName>
                      <middleName></middleName>
                      <lastName>Doe</lastName>
                      <homePhone></homePhone>
                      <workPhone></workPhone>
                      <cellPhone>412-421-4883</cellPhone>
                      <otherPhone></otherPhone>
                      <email>janedoe@gmail.com</email>
                      <signingDateTime>2022-09-15T12:00:00</signingDateTime>
                      <closingLocation>Other</closingLocation>
                      <signingAddress>
                          <address1>7322 Allen Lane</address1>
                          <address2></address2
                          <city>Pittsburgh</city>
                          <state>PA</state>
                          <zipCode>15136</zipCode>
                          <county>Allegheny</county>
                      </signingAddress>
                </additionalSigner>
          </additionalSigners>
          <dualSigning>true</dualSigning>
          <language>English</language>
          <specialInstructions></specialInstructions>
        </signingDetails>
    </transactionBody>
    <transactionExtensions>
        <transactionExtension>
            <key>Client Specific Key 1</key>
            <value>Client Specific Value 1</value>
        </transactionExtension>
        <transactionExtension>
            <key>Client Specific Key 2</key>
            <value>Client Specific Value 1</value>
        </transactionExtension>
    </transactionExtensions>
</root>
<!-- Copyright © 2023 Mortgage Connect LP -->

👍 The request payload can be verified using the following validation schema.

{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "transactionCode": {
      "type": "string",
      "const": "Reschedule-Signing"
    },
    "transactionId": {
      "$ref": "CommonTypes#/$defs/transactionId"
    },
    "orderNumber": {
      "$ref": "CommonTypes#/$defs/orderNo"
    },
    "productCode": {
      "$ref": "ProductCodeType#"
    },
    "signingDetails": {
      "type": "object",
      "properties": {
        "signer": {
          "$ref": "CommonTypes#/$defs/signer"
        },
        "coSigner": {
          "$ref": "CommonTypes#/$defs/signer"
        },
        "additionalSigners": {
          "type": "object",
          "properties":{
              "additionalSigner":{
                "type": "array",
                "items": {
                  "$ref": "CommonTypes#/$defs/signer"
                }
              }
          }          
        },
        "dualSigning": {
          "type": "boolean",
          "examples": [ true, false ]
        },
        "language": {
          "$ref": "CommonTypes#/$defs/language"
        },
        "specialInstruction": {
          "type": "string"
        }
      },
      "required": [
        "signer",
        "dualSigning"
      ]
    }
  },
  "required": [
    "transactionCode",
    "transactionId",
    "orderNumber",
    "productCode",
    "signingDetails"
  ]
}

The request payload XML schema validation is under construction. 🚧

✅ The following is an 'Accepted' example payload to be returned in the HTTP response.

Accepted Acknowledgment payloads are typically message type agnostic.

Accepted Acknowledgment payloads are typically message type agnostic.

⛔ The following is a 'Rejected' example payload to be returned in the HTTP response.

Rejected Acknowledgment payloads are typically message type agnostic.

Rejected Acknowledgment payloads are typically message type agnostic.

The Reschedule Signing API method is the mechanism in which a Client notifies Mortgage Connect that a closing signing should be rescheduled.

View Workflow Orchestration

Mortgage Connect URL

POST 🔒 https://{BaseUrl}/Api/V1.0/{ClientCode}/SubmitMessage

Mortgage Connect URL Properties

Property	Requirement	Description
BaseUrl	Required	A unique base Url that represents a specific Mortgage Connect endpoint and targeted environment.
ClientCode	Required	A unique code assigned to all clients that is used for identification, authentication, and customization purposes.

Property Definitions - Transaction Header

Defines the properties represented in the Transaction Header object (JSON) or node (XML). Note that this message artifact is identical for each and every message type.

View Transaction Header Details

Property Definitions - Transaction Body

Defines the properties represented in the Transaction Body object (JSON) or node (XML).

Property	Requirement	Data Type	Min / Max	Description
transactionBody	Required			A parent object (JSON) or node (XML) that contains the transaction metadata.
transactionCode	Required	String	16 / 16	A static value of `Reschedule-Signing`. The transaction code is meant to identify the message type and the context or action that should be taken. In this context it implies that the closing signing should be rescheduled. Possible Values: Reschedule-Signing
transactionId	Required	String	1 / 50	Represents the Client's unique order number.
productTransactionId	Optional	String	0 / 50	Represents the Client's unique product order number. Note that the `productTransactionId` field is not used in most circumstances. However, when there is a need to further differentiate order numbers at a product level, that share the same `transactionId`, (i.e. the primary order level id), then the `productTransactionId` can be used to ensure uniqueness across the integration transactions. This makes it possible for multiple orders of the same product type to be placed using the same `transactionId`. The use of the `productTransactionId` field and any specific workflow deviations will be vetted during the onboarding process.
orderNumber	Required	Integer		Represents Mortgage Connects unique order number.
productCode	Required	String	3 / 4	Represents Mortgage Connect's product code. Possible Values: LVR `LEGAL & VEString REPORT` PRT `PROPERTY REPORT` PUR `PURCHASE` TTL `TITLE INSURANCE` etc. Traditionally, clients use Mortgage Connects `Product Code` names and thus there is a one to one mapping relationship that is maintained by the client. However, Mortgage Connect is aware that our naming conventions may not resonate and that there are many inconsistencies in product code naming conventions and nomenclatures. It is for this reason that Mortgage Connect is able to map the client's product code to Mortgage Connect's product code to ease the transition. Any required product code mapping exercises will be addressed during the onboarding process. The supported `productCode`(s) are specific per integration and will be determined during the onboarding process. Note that the minimum/maximum length requirement of 3/4 is only applicable if using Mortgage Connect's internal product codes, otherwise when mapping to the client's product codes, the minimum/maximum is 1/50.
signingDetails	Required			A parent object (JSON) or node (XML) that contains the signing details.
signer	Required			A parent object (JSON) or node (XML) that contains the signer details.
firstName	Required	String	1 / 150	The primary signers first name.
middleName	Optional	String	0 / 150	The primary signers middle name.
lastName	Required	String	1 / 255	The primary signers last name.
homePhone	Optional	String	1 / 24	The primary signers home phone number.
workPhone	Optional	String	1 / 24	The primary signers work phone number.
cellPhone	Required	String	1 / 24	The primary signers cell phone number.
otherPhone	Optional	String	1 / 24	The primary signers other phone number.
email	Optional	String	1 / 255	The primary signers email address.
signingDateTime	Required	DateTime		Represents when the signing will take place. The `DateTime` value always represents the time in the context of the signing location.
closingLocation	Required	String		Represents where the signing will take place. Possible Values: `In-Home` `Other`
signingAddress	Required			A parent object (JSON) or node (XML) that contains the signing address.
address1	Required	String	1 / 255	The signer's location street address.
address2	Optional	String	1 / 255	The signer's locations street address 2.
city	Required	String	1 / 32	The signer's locations city name.
state	Required	String	2 / 2	The signer's locations state abbreviation. Possible Values: AK, AL, AR, AS, AZ, CA, CO, CT, DC, DE, FL, FM, GA, GU, HI, IA, ID, IL, IN, KS, KY, LA, MA, MD, ME, MH, MI, MN, MO, MP, MS, MT, NC, ND, NE, NH, NJ, NM, NV, NY, OH, OK, OR, PA, PR, PW, RI, SC, SD, TN, TX, UT, VA, VI, VT, WA, WI, WV, WY.
zipCode	Required	String	5 / 5	The signer's locations zip code.
county	Optional	String	1 / 32	The signer's locations county.
coSigner	Conditional			A parent object (JSON) or node (XML) that contains the cosigners details. Note that the existence of the `coSigner` object is conditional. It is only required if `dualSigning` is `True`.
firstName	Required	String	1 / 150	The cosigners first name.
middleName	Optional	String	0 / 150	The cosigners middle name.
lastName	Required	String	1 / 255	The cosigners last name.
homePhone	Optional	String	1 / 24	The cosigners home phone number.
workPhone	Optional	String	1 / 24	The cosigners work phone number.
cellPhone	Required	String	1 / 24	The cosigners cell phone number.
otherPhone	Optional	String	1 / 24	The cosigners other phone number.
email	Optional	String	1 / 255	The cosigners email address.
signingDateTime	Required	DateTime		Represents when the signing will take place. The `DateTime` value always represents the time in the context of the signing location.
closingLocation	Required	String		Represents where the signing will take place. Possible Values: `In-Home` `Other`
signingAddress	Required			A parent object (JSON) or node (XML) that contains the signing address.
address1	Required	String	1 / 255	The cosigner's location street address.
address2	Optional	String	1 / 255	The cosigner's locations street address 2.
city	Required	String	1 / 32	The cosigner's locations city name.
state	Required	String	2 / 2	The cosigner's locations state abbreviation. Possible Values: AK, AL, AR, AS, AZ, CA, CO, CT, DC, DE, FL, FM, GA, GU, HI, IA, ID, IL, IN, KS, KY, LA, MA, MD, ME, MH, MI, MN, MO, MP, MS, MT, NC, ND, NE, NH, NJ, NM, NV, NY, OH, OK, OR, PA, PR, PW, RI, SC, SD, TN, TX, UT, VA, VI, VT, WA, WI, WV, WY.
zipCode	Required	String	5 / 5	The cosigner's locations zip code.
county	Optional	String	1 / 32	The cosigner's locations county.
additionalSigners	Conditional			A parent object (JSON) or node (XML) that contains the additional Signers details. Note that the existence of the `additionalSigners` object is conditional. It is only required if `dualSigning` is `True` and more than 2 signers exists.
additionalSigner	Conditional			A parent object (JSON) or node (XML) that contains the additional Signer details.
firstName	Required	String	1 / 150	The additionalSigner's first name.
middleName	Optional	String	0 / 150	The additionalSigner's middle name.
lastName	Required	String	1 / 255	The additionalSigner's last name.
homePhone	Optional	String	1 / 24	The additionalSigner's home phone number.
workPhone	Optional	String	1 / 24	The additionalSigner's work phone number.
cellPhone	Required	String	1 / 24	The additionalSigner's cell phone number.
otherPhone	Optional	String	1 / 24	The additionalSigner's other phone number.
email	Optional	String	1 / 255	The additioadditionalSigner'snalSigners email address.
signingDateTime	Required	DateTime		Represents when the signing will take place. The `DateTime` value always represents the time in the context of the signing location.
closingLocation	Required	String		Represents where the signing will take place. Possible Values: `In-Home` `Other`
signingAddress	Required			A parent object (JSON) or node (XML) that contains the signing address.
address1	Required	String	1 / 255	The additionalSigner's location street address.
address2	Optional	String	1 / 255	The additionalSigner's locations street address 2.
city	Required	String	1 / 32	The additionalSigner's locations city name.
state	Required	String	2 / 2	The additionalSigner's locations state abbreviation. Possible Values: AK, AL, AR, AS, AZ, CA, CO, CT, DC, DE, FL, FM, GA, GU, HI, IA, ID, IL, IN, KS, KY, LA, MA, MD, ME, MH, MI, MN, MO, MP, MS, MT, NC, ND, NE, NH, NJ, NM, NV, NY, OH, OK, OR, PA, PR, PW, RI, SC, SD, TN, TX, UT, VA, VI, VT, WA, WI, WV, WY.
zipCode	Required	String	5 / 5	The additionalSigner's locations zip code.
county	Optional	String	1 / 32	The additionalSigner's locations county.
dualSigning	Required	Boolean		Indicates whether or not there is a dual signing requiring a cosigner. Possible Values: true false
language	Required	String	0 / 255	The cosigners and cosigners language. Possible Values: English Spanish
specialInstructions	Optional	String	0 / MAX	Any special instructions regarding the scheduling of the closing signing.

Property Definitions - Transaction Extensions

Defines the properties represented in the TransactionExtensions object (JSON) or node (XML). Note that this message artifact is identical for each and every message type.

View Transaction Extension Details

Closing - MC210 - Schedule Confirmation

🌐 The following is an example payload to be posted in the body of the HTTP request.

/* Copyright © 2023 Mortgage Connect LP */
{
    "transactionHeader": {
        "transactionIdempotentId": "3B34A671-BB17-400D-90BF-7CBF9C96E8ED",
        "transactionDate": "2022-07-11T02:03:40",
        "clientCode": "1799",
        "clientName": "AcmeInc",
        "vendorCode": "MC",
        "vendorName": "Mortgage Connect"
    },
    "transactionBody": {
        "transactionCode": "Schedule-Confirmation",
        "transactionId": "7832143",
        "productTransactionId": "",
        "orderNumber": "2429888",
        "productCode": "CWI",
        "signingDetails": {
            "signingDateTime": "2022-09-30T02:00:00",
            "signingAddress": {
                "address1": "1234 Main St",
                "address2": "",
                "city": "Shawnee",
                "state": "CA",
                "zipCode": "93950",
                "county": "Monterey"
            },
            "signingNotary": {
                "notaryVendorName": "Thorp Notary Services",
                "notaryContact": {
                    "name": "Jim Thorp",
                    "phone": "724-100-1000",
                    "email": "jthorp@gmail.com"
                }
            },
            "language": "English",
            "specialInstruction": ""
        }
    },
    "transactionExtensions": {
        "transactionExtension": [
            {
                "key": "Client Specific Key 1",
                "value": "Client Specific Value 1"
            },
            {
                "key": "Client Specific Key 2",
                "value": "Client Specific Value 2"
            }
        ]
    }
}
/* Copyright © 2023 Mortgage Connect LP */

<!-- Copyright © 2023 Mortgage Connect LP -->
<root>
    <transactionHeader>
        <transactionIdempotentId>3B34A671-BB17-400D-90BF-7CBF9C96E8ED</transactionIdempotentId>
        <transactionDate>022-07-11T02:03:40</transactionDate>
        <clientCode>1799</clientCode>
        <clientName>AcmeInc</clientName>
        <vendorCode>MC</vendorCode>
        <vendorName>Mortgage Connect</vendorName>
    </transactionHeader>
    <transactionBody>
        <transactionCode>Schedule-Confirmation</transactionCode>
        <transactionId>7832143</transactionId>
        <productTransactionId></productTransactionId>
        <orderNumber>2429888</orderNumber>
        <productCode>CWI</productCode>
        <signingDetails>
            <signingDateTime>2022-09-30T02:00:00</signingDateTime>	
            <signingAddress>
                <address1>1234 Main St</address1>
                <address2></address2>
                <city>Shawnee</city>
                <state>CA</state>
                <zipCode>93950</zipCode>
                <county>Monterey</county>			
            </signingAddress>
            <signingNotary>
                <notaryVendorName>Thorp Notary Services</notaryVendorName>
                <notaryContact>
                    <name>Jim Thorp</name>
                    <phone>724-100-1000</phone>
                    <email>jthorp@gmail.com</email>
                </notaryContact>
            </signingNotary>
            <language>English</language>
            <specialInstruction></specialInstruction>
        </signingDetails>	
    </transactionBody>
    <transactionExtensions>
        <transactionExtension>
            <key>Client Specific Key 1</key>
            <value>Client Specific Value 1</value>
        </transactionExtension>
        <transactionExtension>
            <key>Client Specific Key 2</key>
            <value>Client Specific Value 1</value>
        </transactionExtension>
    </transactionExtensions>
</root>

<!-- Copyright © 2023 Mortgage Connect LP -->

👍 The request payload can be verified using the following validation schema.

{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "transactionCode": {
      "type": "string",
      "examples": [
        "Schedule-Confirmation"
      ],
      "const": "Schedule-Confirmation"
    },
    "transactionId": {
      "$ref": "CommonTypes#/$defs/transactionId"
    },
    "orderNumber": {
      "$ref": "CommonTypes#/$defs/orderNo"
    },
    "productCode": {
      "$ref": "ProductCodeType#"
    },
    "signingDetails": {
      "type": "object",
      "properties": {
        "signingDateTime": {
          "type": "string",
          "format": "date-time",
          "example": [ "07-11-2022T14:00:00-4:00" ]
        },
        "signingAddress": {
          "$ref": "CommonTypes#/$defs/address"
        },
        "signingNotary": {
          "type": "object",
          "properties": {
            "notaryVendorName": {
              "type": "string"
            },
            "notaryContact": {
              "type": "object",
              "properties": {
                "name": {
                  "type": "string"
                },
                "phone": {
                  "type": "string"
                },
                "email": {
                  "type": "string"
                }
              },
              "required": [
                "name",
                "phone"
              ]
            }
          },
          "required": [
            "notaryVendorName",
            "notaryContact"
          ]
        },
        "language": {
          "$ref": "CommonTypes#/$defs/language"
        },
        "specialInstruction": {
          "type": "string"
        }
      },
      "required": [
        "signingDateTime",
        "signingAddress",
        "signingNotary"
      ]
    }
  },
  "required": [
    "transactionCode",
    "transactionId",
    "orderNumber",
    "productCode",
    "signingDetails"
  ]
}

The request payload XML schema validation is under construction. 🚧

✅ The following is an 'Accepted' example payload to be returned in the HTTP response.

Accepted Acknowledgment payloads are typically message type agnostic.

Accepted Acknowledgment payloads are typically message type agnostic.

⛔ The following is a 'Rejected' example payload to be returned in the HTTP response.

/* Copyright © 2023 Mortgage Connect LP */
{
    "transactionHeader": {
        "transactionIdempotentId": "90039F81-73C1-4788-98BC-90553888D301",
        "transactionDate": "2022-07-11T02:03:40",
        "clientCode": "1799",
        "clientName": "AcmeInc",
        "vendorCode": "MC",
        "vendorName": "Mortgage Connect"
    },
    "transactionBody": {
        "transactionCode": "Acknowledgment",
        "transactionId": "7832143",
        "orderNumber": 0,
        "ackStatus": false,
        "ackMessage": "Rejected",
        "ackException": "Invalid Credentials"
    }
}
/* Copyright © 2023 Mortgage Connect LP */

<!-- Copyright © 2023 Mortgage Connect LP -->
<root>
    <transactionHeader>
        <transactionIdempotentId>90039F81-73C1-4788-98BC-90553888D301</transactionIdempotentId>
        <transactionDate>022-07-11T02:03:40</transactionDate>
        <clientCode>1799</clientCode>
        <clientName>AcmeInc</clientName>
        <vendorCode>MC</vendorCode>
        <vendorName>Mortgage Connect</vendorName>
    </transactionHeader>
    <transactionBody>
        <transactionCode>Acknowledgment</transactionCode>
        <transactionId>7832143</transactionId>
        <orderNumber>0</orderNumber>
        <ackStatus>false</ackStatus>
        <ackMessage>Rejected</ackMessage>
        <ackException>Invalid Credentials</ackException>
    </transactionBody>
</root>
<!-- Copyright © 2023 Mortgage Connect LP -->

The Schedule Signing Confirmation API method is the mechanism in which Mortgage Connect notifies the Client that the closing signing has been officially scheduled and confirmed.

View Workflow Orchestration

Client URL

POST 🔒 To be determined during onboarding process.

Property Definitions - Transaction Header

Defines the properties represented in the Transaction Header object (JSON) or node (XML). Note that this message artifact is identical for each and every message type.

View Transaction Header Details

Property Definitions - Transaction Body

Defines the properties represented in the Transaction Body object (JSON) or node (XML).

Property	Requirement	Data Type	Min / Max	Description
transactionBody	Required			A parent object (JSON) or node (XML) that contains the transaction metadata.
transactionCode	Required	String	21 / 21	A static value of `Schedule-Confirmation`. The transaction code is meant to identify the message type and the context or action that should be taken. In this context it implies that the scheduling of the closing signing has been confirmed. Possible Values: Schedule-Confirmation
transactionId	Required	String	1 / 50	Represents the Client's unique order number.
productTransactionId	Optional	String	0 / 50	Represents the Client's unique product order number. Note that the `productTransactionId` field is not used in most circumstances. However, when there is a need to further differentiate order numbers at a product level, that share the same `transactionId`, (i.e. the primary order level id), then the `productTransactionId` can be used to ensure uniqueness across the integration transactions. This makes it possible for multiple orders of the same product type to be placed using the same `transactionId`. The use of the `productTransactionId` field and any specific workflow deviations will be vetted during the onboarding process.
orderNumber	Required	Integer		Represents Mortgage Connects unique order number.
productCode	Required	String	3 / 4	Represents Mortgage Connect's product code. Possible Values: LVR `LEGAL & VEString REPORT` PRT `PROPERTY REPORT` PUR `PURCHASE` TTL `TITLE INSURANCE` etc. Traditionally, clients use Mortgage Connects `Product Code` names and thus there is a one to one mapping relationship that is maintained by the client. However, Mortgage Connect is aware that our naming conventions may not resonate and that there are many inconsistencies in product code naming conventions and nomenclatures. It is for this reason that Mortgage Connect is able to map the client's product code to Mortgage Connect's product code to ease the transition. Any required product code mapping exercises will be addressed during the onboarding process. The supported `productCode`(s) are specific per integration and will be determined during the onboarding process. Note that the minimum/maximum length requirement of 3/4 is only applicable if using Mortgage Connect's internal product codes, otherwise when mapping to the client's product codes, the minimum/maximum is 1/50.
signingDetails	Required			A parent object (JSON) or node (XML) that contains the signing details.
signingDateTime	Required	DateTime		Represents when the signing will take place. The `DateTime` value always represents the time in the context of the signing location.
signingAddress	Required			A parent object (JSON) or node (XML) that contains the signing address.
address1	Required	String	1 / 255	The signing location's street address.
address2	Optional	String	1 / 255	The signing location's street address 2.
city	Required	String	1 / 32	The signing location's city name.
state	Required	String	2 / 2	The signing location's state abbreviation. Possible Values: AK, AL, AR, AS, AZ, CA, CO, CT, DC, DE, FL, FM, GA, GU, HI, IA, ID, IL, IN, KS, KY, LA, MA, MD, ME, MH, MI, MN, MO, MP, MS, MT, NC, ND, NE, NH, NJ, NM, NV, NY, OH, OK, OR, PA, PR, PW, RI, SC, SD, TN, TX, UT, VA, VI, VT, WA, WI, WV, WY.
zipCode	Required	String	5 / 5	The signing location's zip code.
county	Optional	String	1 / 32	The signing location's county.
signingNotary	Required			A parent object (JSON) or node (XML) that contains the signing notary details.
NotaryVendorName	Required	String	1 / 32	The name of the notary's vendor/company name.
NotaryContact	Required			A parent object (JSON) or node (XML) that contains the signing notary contact details.
name	Required	String	1 / 150	The notary's name.
phone	Required	String	1 / 24	The notary's phone number.
email	Required	String	1 / 255	The notary's email address.
language	Required	String	0 / 255	The signers and cosigners language. Possible Values: English Spanish
specialInstruction	Optional	String	0 / MAX	Any special instructions regarding the scheduling of the closing signing.

Property Definitions - Transaction Extensions

Defines the properties represented in the TransactionExtensions object (JSON) or node (XML). Note that this message artifact is identical for each and every message type.

View Transaction Extension Details

Closing - MC213 - Reschedule Confirmation

🌐 The following is an example payload to be posted in the body of the HTTP request.

/* Copyright © 2023 Mortgage Connect LP */
{
    "transactionHeader": {
        "transactionIdempotentId": "3B34A671-BB17-400D-90BF-7CBF9C96E8ED",
        "transactionDate": "2022-07-11T02:03:40",
        "clientCode": "1799",
        "clientName": "AcmeInc",
        "vendorCode": "MC",
        "vendorName": "Mortgage Connect"
    },
    "transactionBody": {
        "transactionCode": "Reschedule-Confirmation",
        "transactionId": "7832143",
        "productTransactionId": "",
        "orderNumber": "2429888",
        "productCode": "CWI",
        "signingDetails": {
            "signingDateTime": "2022-09-30T02:00:00",
            "signingAddress": {
                "address1": "1234 Main St",
                "address2": "",
                "city": "Shawnee",
                "state": "CA",
                "zipCode": "93950",
                "county": "Monterey"
            },
            "signingNotary": {
                "notaryVendorName": "Thorp Notary Services",
                "notaryContact": {
                    "name": "Jim Thorp",
                    "phone": "724-100-1000",
                    "email": "jthorp@gmail.com"
                }
            },
            "language": "English",
            "specialInstructions": ""
        }
    },
    "transactionExtensions": {
        "transactionExtension": [
            {
                "key": "Client Specific Key 1",
                "value": "Client Specific Value 1"
            },
            {
                "key": "Client Specific Key 2",
                "value": "Client Specific Value 2"
            }
        ]
    }
}
/* Copyright © 2023 Mortgage Connect LP */

<!-- Copyright © 2023 Mortgage Connect LP -->
<root>
    <transactionHeader>
        <transactionIdempotentId>3B34A671-BB17-400D-90BF-7CBF9C96E8ED</transactionIdempotentId>
        <transactionDate>022-07-11T02:03:40</transactionDate>
        <clientCode>1799</clientCode>
        <clientName>AcmeInc</clientName>
        <vendorCode>MC</vendorCode>
        <vendorName>Mortgage Connect</vendorName>
    </transactionHeader>
    <transactionBody>
        <transactionCode>Reschedule-Confirmation</transactionCode>
        <transactionId>7832143</transactionId>
        <productTransactionId></productTransactionId>
        <orderNumber>2429888</orderNumber>
        <productCode>CWI</productCode>
        <signingDetails>
            <signingDateTime>2022-09-30T02:00:00</signingDateTime>	
            <signingAddress>
                <address1>1234 Main St</address1>
                <address2></address2>
                <city>Shawnee</city>
                <state>CA</state>
                <zipCode>93950</zipCode>
                <county>Monterey</county>			
            </signingAddress>
            <signingNotary>
                <notaryVendorName>Thorp Notary Services</notaryVendorName>
                <notaryContact>
                    <name>Jim Thorp</name>
                    <phone>724-100-1000</phone>
                    <email>jthorp@gmail.com</email>
                </notaryContact>
            </signingNotary>
            <language>English</language>
            <specialInstructions></specialInstructions>
        </signingDetails>	
    </transactionBody>
    <transactionExtensions>
        <transactionExtension>
            <key>Client Specific Key 1</key>
            <value>Client Specific Value 1</value>
        </transactionExtension>
        <transactionExtension>
            <key>Client Specific Key 2</key>
            <value>Client Specific Value 1</value>
        </transactionExtension>
    </transactionExtensions>
</root>

<!-- Copyright © 2023 Mortgage Connect LP -->

👍 The request payload can be verified using the following validation schema.

{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "transactionCode": {
      "type": "string",
      "examples": [
        "Reschedule-Confirmation"
      ],
      "const": "Reschedule-Confirmation"
    },
    "transactionId": {
      "$ref": "CommonTypes#/$defs/transactionId"
    },
    "orderNumber": {
      "$ref": "CommonTypes#/$defs/orderNo"
    },
    "productCode": {
      "$ref": "ProductCodeType#"
    },
    "signingDetails": {
      "type": "object",
      "properties": {
        "signingDateTime": {
          "type": "string",
          "format": "date-time",
          "example": [ "07-11-2022T14:00:00-4:00" ]
        },
        "signingAddress": {
          "$ref": "CommonTypes#/$defs/address"
        },
        "signingNotary": {
          "type": "object",
          "properties": {
            "notaryVendorName": {
              "type": "string"
            },
            "notaryContact": {
              "type": "object",
              "properties": {
                "name": {
                  "type": "string"
                },
                "phone": {
                  "type": "string"
                },
                "email": {
                  "type": "string"
                }
              },
              "required": [
                "name",
                "phone"
              ]
            }
          },
          "required": [
            "notaryVendorName",
            "notaryContact"
          ]
        },
        "language": {
          "$ref": "CommonTypes#/$defs/language"
        },
        "specialInstruction": {
          "type": "string"
        }
      },
      "required": [
        "signingDateTime",
        "signingAddress",
        "signingNotary"
      ]
    }
  },
  "required": [
    "transactionCode",
    "transactionId",
    "orderNumber",
    "productCode",
    "signingDetails"
  ]
}

The request payload XML schema validation is under construction. 🚧

✅ The following is an 'Accepted' example payload to be returned in the HTTP response.

Accepted Acknowledgment payloads are typically message type agnostic.

Accepted Acknowledgment payloads are typically message type agnostic.

⛔ The following is a 'Rejected' example payload to be returned in the HTTP response.

/* Copyright © 2023 Mortgage Connect LP */
{
    "transactionHeader": {
        "transactionIdempotentId": "90039F81-73C1-4788-98BC-90553888D301",
        "transactionDate": "2022-07-11T02:03:40",
        "clientCode": "1799",
        "clientName": "AcmeInc",
        "vendorCode": "MC",
        "vendorName": "Mortgage Connect"
    },
    "transactionBody": {
        "transactionCode": "Acknowledgment",
        "transactionId": "7832143",
        "orderNumber": 0,
        "ackStatus": false,
        "ackMessage": "Rejected",
        "ackException": "Invalid Credentials"
    }
}
/* Copyright © 2023 Mortgage Connect LP */

<!-- Copyright © 2023 Mortgage Connect LP -->
<root>
    <transactionHeader>
        <transactionIdempotentId>90039F81-73C1-4788-98BC-90553888D301</transactionIdempotentId>
        <transactionDate>022-07-11T02:03:40</transactionDate>
        <clientCode>1799</clientCode>
        <clientName>AcmeInc</clientName>
        <vendorCode>MC</vendorCode>
        <vendorName>Mortgage Connect</vendorName>
    </transactionHeader>
    <transactionBody>
        <transactionCode>Acknowledgment</transactionCode>
        <transactionId>7832143</transactionId>
        <orderNumber>0</orderNumber>
        <ackStatus>false</ackStatus>
        <ackMessage>Rejected</ackMessage>
        <ackException>Invalid Credentials</ackException>
    </transactionBody>
</root>
<!-- Copyright © 2023 Mortgage Connect LP -->

The Reschedule Signing Confirmation API method is the mechanism in which Mortgage Connect notifies the Client that the rescheduling of the closing signing has been officially scheduled and confirmed.

View Workflow Orchestration

Client URL

POST 🔒 To be determined during onboarding process.

Property Definitions - Transaction Header

Defines the properties represented in the Transaction Header object (JSON) or node (XML). Note that this message artifact is identical for each and every message type.

View Transaction Header Details

Property Definitions - Transaction Body

Defines the properties represented in the Transaction Body object (JSON) or node (XML).

Property	Requirement	Data Type	Min / Max	Description
transactionBody	Required			A parent object (JSON) or node (XML) that contains the transaction metadata.
transactionCode	Required	String	21 / 21	A static value of `Reschedule-Confirmation`. The transaction code is meant to identify the message type and the context or action that should be taken. In this context it implies that the rescheduling of the closing signing has been confirmed. Possible Values: Reschedule-Confirmation
transactionId	Required	String	1 / 50	Represents the Client's unique order number.
productTransactionId	Optional	String	0 / 50	Represents the Client's unique product order number. Note that the `productTransactionId` field is not used in most circumstances. However, when there is a need to further differentiate order numbers at a product level, that share the same `transactionId`, (i.e. the primary order level id), then the `productTransactionId` can be used to ensure uniqueness across the integration transactions. This makes it possible for multiple orders of the same product type to be placed using the same `transactionId`. The use of the `productTransactionId` field and any specific workflow deviations will be vetted during the onboarding process.
orderNumber	Required	Integer		Represents Mortgage Connects unique order number.
productCode	Required	String	3 / 4	Represents Mortgage Connect's product code. Possible Values: LVR `LEGAL & VEString REPORT` PRT `PROPERTY REPORT` PUR `PURCHASE` TTL `TITLE INSURANCE` etc. Traditionally, clients use Mortgage Connects `Product Code` names and thus there is a one to one mapping relationship that is maintained by the client. However, Mortgage Connect is aware that our naming conventions may not resonate and that there are many inconsistencies in product code naming conventions and nomenclatures. It is for this reason that Mortgage Connect is able to map the client's product code to Mortgage Connect's product code to ease the transition. Any required product code mapping exercises will be addressed during the onboarding process. The supported `productCode`(s) are specific per integration and will be determined during the onboarding process. Note that the minimum/maximum length requirement of 3/4 is only applicable if using Mortgage Connect's internal product codes, otherwise when mapping to the client's product codes, the minimum/maximum is 1/50.
signingDetails	Required			A parent object (JSON) or node (XML) that contains the signing details.
signingDateTime	Required	DateTime		Represents when the signing will take place. The `DateTime` value always represents the time in the context of the signing location.
signingAddress	Required			A parent object (JSON) or node (XML) that contains the signing address.
address1	Required	String	1 / 255	The signing location's street address.
address2	Optional	String	1 / 255	The signing location's street address 2.
city	Required	String	1 / 32	The signing location's city name.
state	Required	String	2 / 2	The signing location's state abbreviation. Possible Values: AK, AL, AR, AS, AZ, CA, CO, CT, DC, DE, FL, FM, GA, GU, HI, IA, ID, IL, IN, KS, KY, LA, MA, MD, ME, MH, MI, MN, MO, MP, MS, MT, NC, ND, NE, NH, NJ, NM, NV, NY, OH, OK, OR, PA, PR, PW, RI, SC, SD, TN, TX, UT, VA, VI, VT, WA, WI, WV, WY.
zipCode	Required	String	5 / 5	The signing location's zip code.
county	Optional	String	1 / 32	The signing location's county.
signingNotary	Required			A parent object (JSON) or node (XML) that contains the signing notary details.
NotaryVendorName	Required	String	1 / 32	The name of the notary's vendor/company name.
NotaryContact	Required			A parent object (JSON) or node (XML) that contains the signing notary contact details.
name	Required	String	1 / 150	The notary's name.
phone	Required	String	1 / 24	The notary's phone number.
email	Required	String	1 / 255	The notary's email address.
language	Required	String	0 / 255	The signers and cosigners language. Possible Values: English Spanish
specialInstructions	Optional	String	0 / MAX	Any special instructions regarding the scheduling of the closing signing.

Property Definitions - Transaction Extensions

Defines the properties represented in the TransactionExtensions object (JSON) or node (XML). Note that this message artifact is identical for each and every message type.

View Transaction Extension Details

Closing - MC215 - Closing Confirmation

🌐 The following is an example payload to be posted in the body of the HTTP request.

/* Copyright © 2023 Mortgage Connect LP */
{
    "transactionHeader": {
        "transactionIdempotentId": "3B34A671-BB17-400D-90BF-7CBF9C96E8ED",
        "transactionDate": "2022-07-11T02:03:40",
        "clientCode": "1799",
        "clientName": "AcmeInc",
        "vendorCode": "MC",
        "vendorName": "Mortgage Connect"
    },
    "transactionBody": {
        "transactionCode": "Closing-Confirmation",
        "transactionId": "7832143",
        "productTransactionId": "",
        "orderNumber": "2429888",
        "productCode": "CWI",
        "status": "Completed",
        "statusDate": "2022-07-11T02:03:40"
    },
    "transactionExtensions": {
        "transactionExtension": [
            {
                "key": "Client Specific Key 1",
                "value": "Client Specific Value 1"
            },
            {
                "key": "Client Specific Key 2",
                "value": "Client Specific Value 2"
            }
        ]
    }
}
/* Copyright © 2023 Mortgage Connect LP */

<!-- Copyright © 2023 Mortgage Connect LP -->
<root>
    <transactionHeader>
        <transactionIdempotentId>3B34A671-BB17-400D-90BF-7CBF9C96E8ED</transactionIdempotentId>
        <transactionDate>022-07-11T02:03:40</transactionDate>
        <clientCode>1799</clientCode>
        <clientName>AcmeInc</clientName>
        <vendorCode>MC</vendorCode>
        <vendorName>Mortgage Connect</vendorName>
    </transactionHeader>
    <transactionBody>
        <transactionCode>Closing-Confirmation</transactionCode>
        <transactionId>7832143</transactionId>
        <productTransactionId></productTransactionId>
        <orderNumber>2429888</orderNumber>
        <productCode>CWI</productCode>
        <comment>Completed</comment>
        <commentDate>2022-07-11T02:03:40</commentDate>
    </transactionBody>
    <transactionExtensions>
        <transactionExtension>
            <key>Client Specific Key 1</key>
            <value>Client Specific Value 1</value>
        </transactionExtension>
        <transactionExtension>
            <key>Client Specific Key 2</key>
            <value>Client Specific Value 1</value>
        </transactionExtension>
    </transactionExtensions>
</root>
<!-- Copyright © 2023 Mortgage Connect LP -->

👍 The request payload can be verified using the following validation schema.

The request payload JSON schema validation is under construction. 🚧

The request payload XML schema validation is under construction. 🚧

✅ The following is an 'Accepted' example payload to be returned in the HTTP response.

Accepted Acknowledgment payloads are typically message type agnostic.

Accepted Acknowledgment payloads are typically message type agnostic.

⛔ The following is a 'Rejected' example payload to be returned in the HTTP response.

Rejected Acknowledgment payloads are typically message type agnostic.

Rejected Acknowledgment payloads are typically message type agnostic.

The Closing Confirmation API method is the mechanism in which Mortgage Connect notifies the Client that the closing has been confirmed.

View Workflow Orchestration

Client URL

POST 🔒 To be determined during onboarding process.

Property Definitions - Transaction Header

Defines the properties represented in the Transaction Header object (JSON) or node (XML). Note that this message artifact is identical for each and every message type.

View Transaction Header Details

Property Definitions - Transaction Body

Defines the properties represented in the Transaction Body object (JSON) or node (XML).

Property	Requirement	Data Type	Min / Max	Description
transactionBody	Required			A parent object (JSON) or node (XML) that contains the transaction metadata.
transactionCode	Required	String	13 / 13	A static value of `Closing-Confirmation`. The transaction code is meant to identify the message type and the context or action that should be taken. In this context it implies that the orders closing has been confirmed. Possible Values: Closing-Confirmation
transactionId	Required	String	1 / 50	Represents the Client's unique order number.
productTransactionId	Optional	String	0 / 50	Represents the Client's unique product order number. Note that the `productTransactionId` field is not used in most circumstances. However, when there is a need to further differentiate order numbers at a product level, that share the same `transactionId`, (i.e. the primary order level id), then the `productTransactionId` can be used to ensure uniqueness across the integration transactions. This makes it possible for multiple orders of the same product type to be placed using the same `transactionId`. The use of the `productTransactionId` field and any specific workflow deviations will be vetted during the onboarding process.
orderNumber	Required	Integer		Represents Mortgage Connects unique order number.
productCode	Required	String	3 / 4	Represents Mortgage Connect's product code. Possible Values: LVR `LEGAL & VEString REPORT` PRT `PROPERTY REPORT` PUR `PURCHASE` TTL `TITLE INSURANCE` etc. Traditionally, clients use Mortgage Connects `Product Code` names and thus there is a one to one mapping relationship that is maintained by the client. However, Mortgage Connect is aware that our naming conventions may not resonate and that there are many inconsistencies in product code naming conventions and nomenclatures. It is for this reason that Mortgage Connect is able to map the client's product code to Mortgage Connect's product code to ease the transition. Any required product code mapping exercises will be addressed during the onboarding process. The supported `productCode`(s) are specific per integration and will be determined during the onboarding process. Note that the minimum/maximum length requirement of 3/4 is only applicable if using Mortgage Connect's internal product codes, otherwise when mapping to the client's product codes, the minimum/maximum is 1/50.
status	Required	String	1 / 1000	A general comment indicating that the order is cleared to fund.
statusDate	Required	DateTime		The date when the order was cleared to fund.

Property Definitions - Transaction Extensions

Defines the properties represented in the TransactionExtensions object (JSON) or node (XML). Note that this message artifact is identical for each and every message type.

View Transaction Extension Details

Closing - MC220 - Closing Instructions

🌐 The following is an example payload to be posted in the body of the HTTP request.

/* Copyright © 2023 Mortgage Connect LP */
{
    "transactionHeader": {
        "transactionIdempotentId": "3B34A671-BB17-400D-90BF-7CBF9C96E8ED",
        "transactionDate": "2022-07-11T02:03:40",
        "clientCode": "1799",
        "clientName": "AcmeInc",
        "vendorCode": "MC",
        "vendorName": "Mortgage Connect"
    },
    "transactionBody": {
        "transactionCode": "Closing-Instructions",
        "transactionId": "7832143",
        "productTransactionId": "",
        "orderNumber": "2429888",
        "productCode": "CWI",
        "comment": "Closing instructions",
        "commentDate": "2022-07-11T02:03:40"
    },
    "transactionExtensions": {
        "transactionExtension": [
            {
                "key": "Client Specific Key 1",
                "value": "Client Specific Value 1"
            },
            {
                "key": "Client Specific Key 2",
                "value": "Client Specific Value 2"
            }
        ]
    }
}
/* Copyright © 2023 Mortgage Connect LP */

<!-- Copyright © 2023 Mortgage Connect LP -->
<root>
    <transactionHeader>
        <transactionIdempotentId>3B34A671-BB17-400D-90BF-7CBF9C96E8ED</transactionIdempotentId>
        <transactionDate>022-07-11T02:03:40</transactionDate>
        <clientCode>1799</clientCode>
        <clientName>AcmeInc</clientName>
        <vendorCode>MC</vendorCode>
        <vendorName>Mortgage Connect</vendorName>
    </transactionHeader>
    <transactionBody>
        <transactionCode>Closing-Instructions</transactionCode>
        <transactionId>7832143</transactionId>
        <productTransactionId></productTransactionId>
        <orderNumber>2429888</orderNumber>
        <productCode>CWI</productCode>
        <comment>Closing instructions</comment>
        <commentDate>2022-07-11T02:03:40</commentDate>
    </transactionBody>
    <transactionExtensions>
        <transactionExtension>
            <key>Client Specific Key 1</key>
            <value>Client Specific Value 1</value>
        </transactionExtension>
        <transactionExtension>
            <key>Client Specific Key 2</key>
            <value>Client Specific Value 1</value>
        </transactionExtension>
    </transactionExtensions>
</root>
<!-- Copyright © 2023 Mortgage Connect LP -->

👍 The request payload can be verified using the following validation schema.

The request payload JSON schema validation is under construction. 🚧

The request payload XML schema validation is under construction. 🚧

✅ The following is an 'Accepted' example payload to be returned in the HTTP response.

Accepted Acknowledgment payloads are typically message type agnostic.

Accepted Acknowledgment payloads are typically message type agnostic.

⛔ The following is a 'Rejected' example payload to be returned in the HTTP response.

Rejected Acknowledgment payloads are typically message type agnostic.

Rejected Acknowledgment payloads are typically message type agnostic.

The Closing Instructions API method is the mechanism in which a Client conveys to Mortgage Connect what the closing instructions are.

View Workflow Orchestration

Mortgage Connect URL

POST 🔒 https://{BaseUrl}/Api/V1.0/{ClientCode}/SubmitMessage

Mortgage Connect URL Properties

Property	Requirement	Description
BaseUrl	Required	A unique base Url that represents a specific Mortgage Connect endpoint and targeted environment.
ClientCode	Required	A unique code assigned to all clients that is used for identification, authentication, and customization purposes.

Property Definitions - Transaction Header

Defines the properties represented in the Transaction Header object (JSON) or node (XML). Note that this message artifact is identical for each and every message type.

View Transaction Header Details

Property Definitions - Transaction Body

Defines the properties represented in the Transaction Body object (JSON) or node (XML).

Property	Requirement	Data Type	Min / Max	Description
transactionBody	Required			A parent object (JSON) or node (XML) that contains the transaction metadata.
transactionCode	Required	String	20 / 20	A static value of `Closing-Instructions`. The transaction code is meant to identify the message type and the context or action that should be taken. In this context the closing instructions are being conveyed by the client. Possible Values: Closing-Instructions
transactionId	Required	String	1 / 50	Represents the Client's unique order number.
productTransactionId	Optional	String	0 / 50	Represents the Client's unique product order number. Note that the `productTransactionId` field is not used in most circumstances. However, when there is a need to further differentiate order numbers at a product level, that share the same `transactionId`, (i.e. the primary order level id), then the `productTransactionId` can be used to ensure uniqueness across the integration transactions. This makes it possible for multiple orders of the same product type to be placed using the same `transactionId`. The use of the `productTransactionId` field and any specific workflow deviations will be vetted during the onboarding process.
orderNumber	Required	Integer		Represents Mortgage Connects unique order number.
productCode	Required	String	3 / 4	Represents Mortgage Connect's product code. Possible Values: LVR `LEGAL & VEString REPORT` PRT `PROPERTY REPORT` PUR `PURCHASE` TTL `TITLE INSURANCE` etc. Traditionally, clients use Mortgage Connects `Product Code` names and thus there is a one to one mapping relationship that is maintained by the client. However, Mortgage Connect is aware that our naming conventions may not resonate and that there are many inconsistencies in product code naming conventions and nomenclatures. It is for this reason that Mortgage Connect is able to map the client's product code to Mortgage Connect's product code to ease the transition. Any required product code mapping exercises will be addressed during the onboarding process. The supported `productCode`(s) are specific per integration and will be determined during the onboarding process. Note that the minimum/maximum length requirement of 3/4 is only applicable if using Mortgage Connect's internal product codes, otherwise when mapping to the client's product codes, the minimum/maximum is 1/50.
comment	Required	String	1 / 1000	A comment indicating what the closing instructions are.
commentDate	Required	DateTime		The date when the closing instructions were conveyed.

Property Definitions - Transaction Extensions

Defines the properties represented in the TransactionExtensions object (JSON) or node (XML). Note that this message artifact is identical for each and every message type.

View Transaction Extension Details

Closing - MC222 - Initial Closing Disclosure

🌐 The following is an example payload to be posted in the body of the HTTP request.

/* Copyright © 2023 Mortgage Connect LP */
{
    "transactionHeader": {
        "transactionIdempotentId": "3B34A671-BB17-400D-90BF-7CBF9C96E8ED",
        "transactionDate": "2023-08-16T03:55:00",
        "clientCode": "1799",
        "clientName": "AcmeInc",
        "vendorCode": "MC",
        "vendorName": "Mortgage Connect"
    },
    "transactionBody": {
        "transactionCode": "Initial-Closing-Disclosure",
        "transactionId": "7832143",
        "productTransactionId": "",
        "orderNumber": 2429888,
        "productCode": "CWI",
        "documents": {
            "document": [
                {
                    "documentId": "1243992",
                    "type": "CDF - PRELIM",
                    "name": "cfd-prelim-1.pdf",
                    "fileType": "PDF",
                    "contentMediaType": "application/pdf",
                    "contentUnicodeTextEncodingType": "UTF8",
                    "contentBinaryEncodingType": "Base64",
                    "content": "Base64 String",
                    "description": "Brief overview of the document"
                }
            ]
        }
    },
    "transactionExtensions": {
        "transactionExtension": [
            {
                "key": "Client Specific Key 1",
                "value": "Client Specific Value 1"
            },
            {
                "key": "Client Specific Key 2",
                "value": "Client Specific Value 2"
            }
        ]
    }
}
/* Copyright © 2023 Mortgage Connect LP */

<!-- Copyright © 2023 Mortgage Connect LP -->
<root>
    <transactionHeader>
        <transactionIdempotentId>3B34A671-BB17-400D-90BF-7CBF9C96E8ED</transactionIdempotentId>
        <transactionDate>2023-08-16T03:55:00/transactionDate>
        <clientCode>1799</clientCode>
        <clientName>AcmeInc</clientName>
        <vendorCode>MC</vendorCode>
        <vendorName>Mortgage Connect</vendorName>
    </transactionHeader>
    <transactionBody>
        <transactionCode>Initial-Closing-Disclosure</transactionCode>
        <transactionId>7832143</transactionId>
        <productTransactionId></productTransactionId>
        <orderNumber>2429888</orderNumber>
        <productCode>CWI</productCode>
        <documents>
            <document>
                <documentId>1243992</documentId>
                <type>CDF - PRELIM</type>
                <name>cfd-prelim-1.pdf</name>
                <fileType>PDF</fileType>
                <contentMediaType>application/pdf</contentMediaType>
                <contentUnicodeTextEncodingType>UTF8</contentUnicodeTextEncodingType>
                <contentBinaryEncodingType>Base64</contentBinaryEncodingType>
                <content>Base64 String</content>
                <description>Brief overview of the document</description>
            </document>
        </documents>
    </transactionBody>
    <transactionExtensions>
        <transactionExtension>
            <key>Client Specific Key 1</key>
            <value>Client Specific Value 1</value>
        </transactionExtension>
        <transactionExtension>
            <key>Client Specific Key 2</key>
            <value>Client Specific Value 1</value>
        </transactionExtension>
    </transactionExtensions>
</root>
<!-- Copyright © 2023 Mortgage Connect LP -->

👍 The request payload can be verified using the following validation schema.

The request payload JSON schema validation is under construction. 🚧

The request payload XML schema validation is under construction. 🚧

✅ The following is an 'Accepted' example payload to be returned in the HTTP response.

Accepted Acknowledgment payloads are typically message type agnostic.

Accepted Acknowledgment payloads are typically message type agnostic.

⛔ The following is a 'Rejected' example payload to be returned in the HTTP response.

Rejected Acknowledgment payloads are typically message type agnostic.

Rejected Acknowledgment payloads are typically message type agnostic.

The Initial Closing Disclosure API method is the mechanism in which Mortgage Connect notifies the Client that the initial draft of the Closing Disclosure has been completed. The Closing Disclosure provides details about the mortgage loan, including the loan terms, monthly payments, fees, and other ancillary costs.

View Workflow Orchestration

Client URL

POST 🔒 To be determined during onboarding process.

Property Definitions - Transaction Header

Defines the properties represented in the Transaction Header object (JSON) or node (XML). Note that this message artifact is identical for each and every message type.

View Transaction Header Details

Property Definitions - Transaction Body

Defines the properties represented in the Transaction Body object (JSON) or node (XML).

Property	Requirement	Data Type	Min / Max	Description
transactionBody	Required			A parent object (JSON) or node (XML) that contains the transaction metadata.
transactionCode	Required	String	14 / 14	A static value of `Initial-Closing-Disclosure`. The transaction code is meant to identify the message type and the context or action that should be taken. In this context it implies that the initial Closing Disclosure is completed and that the corresponding document is attached. Possible Values: Initial-Closing-Disclosure
transactionId	Required	String	1 / 50	Represents the Client's unique order number.
productTransactionId	Optional	String	0 / 50	Represents the Client's unique product order number. Note that the `productTransactionId` field is not used in most circumstances. However, when there is a need to further differentiate order numbers at a product level, that share the same `transactionId`, (i.e. the primary order level id), then the `productTransactionId` can be used to ensure uniqueness across the integration transactions. This makes it possible for multiple orders of the same product type to be placed using the same `transactionId`. The use of the `productTransactionId` field and any specific workflow deviations will be vetted during the onboarding process.
orderNumber	Required	Integer		Represents Mortgage Connects unique order number.
productCode	Required	String	3 / 4	Represents Mortgage Connect's product code. Possible Values: LVR `LEGAL & VEString REPORT` PRT `PROPERTY REPORT` PUR `PURCHASE` TTL `TITLE INSURANCE` etc. Traditionally, clients use Mortgage Connects `Product Code` names and thus there is a one to one mapping relationship that is maintained by the client. However, Mortgage Connect is aware that our naming conventions may not resonate and that there are many inconsistencies in product code naming conventions and nomenclatures. It is for this reason that Mortgage Connect is able to map the client's product code to Mortgage Connect's product code to ease the transition. Any required product code mapping exercises will be addressed during the onboarding process. The supported `productCode`(s) are specific per integration and will be determined during the onboarding process. Note that the minimum/maximum length requirement of 3/4 is only applicable if using Mortgage Connect's internal product codes, otherwise when mapping to the client's product codes, the minimum/maximum is 1/50.
documents	Required			A parent object (JSON) or node (XML) that contains a list of document metadata. `(1 to Many)`
document	Required			A parent object (JSON) or node (XML) that contains the metadata associated with a single document.
documentId	Required	String	1/36	A number or string that uniquely identifies the document within the host system. When an outbound Initial-Closing-Disclosure event is sent by Mortgage Connect to the Client, the documentId will be a string in the form of an integer. The integer value represents the Identity Field and Primary Key associated with the corresponding document record. There is no hard requirement to capture this information. However, both parties are encouraged to do so, in order that conversations or any triaging of exceptions around these values can be correlated across systems.
type	Required	String	1 / 255	A name that uniquely identifies the document type. Traditionally, clients use Mortgage Connects `Document Type` names and thus there is a one to one mapping relationship that is maintained by the client. However, Mortgage Connect is aware that our naming conventions may not resonate and that there are many inconsistencies in document type naming conventions and nomenclatures. It is for this reason that Mortgage Connect is able to map the client's document type to Mortgage Connect's document type to ease the transition. Any required document mapping exercises will be addressed during the onboarding process. The supported `types`(s) are specific per integration and will be determined during the onboarding process.
name	Required	String	1 / 100	This is the user friendly name that is associated with the document.
fileType	Required	String	3 / 4	This indicates what type of document it is. This in the context of what the file extension represents. Possible Values: DOC DOCX PDF Future Values: CSV HTML JSON TXT XLS XLSX XML `DOC`, `DOCX`, and `PDF` are currently supported with the vast majority of the documents being delivered as `PDF` documents. The other types are included to support additional documents in the future.
contentMediaType	Required	String	1 / 100	This represents the content media type, i.e. `MIME Type`. Possible Values: application/msword (DOC) application/vnd.openxmlformats-officedocument.wordprocessingml.document (DOCX) application/pdf (PDF) Future Values: text/csv (CSV) text/html (HTML) application/json (JSON) text/plain (TXT) application/vnd.ms-excel (XLS) application/vnd.openxmlformats-officedocument.spreadsheetml.sheet (XLSX) application/xml (XML) At this time `application/msword (DOC)`, `application/vnd.openxmlformats-officedocument.wordprocessingml.document (DOCX)`, and `application/pdf (PDF)` are supported with `application/pdf (PDF)` being used 90+% of the time. The other types are added to support future media types.
contentUnicode TextEncodingType	Required	String	4 / 4	This indicates what unicode text encoding type was used to generate the document. Possible Values: UTF8
contentBinary EncodingType	Required	String	6 / 6	This indicates what binary encoding type was used to generate the document content. Possible Values: Base64
content	Required	String	1 / MAX	This represents the digital representation of the document after it has been encoded using Base64. See: https://en.wikipedia.org/wiki/Base64 for more information regarding Base64 formatting.
description	Optional	String	0 / 255	Provides a brief overview of the document contents.

Property Definitions - Transaction Extensions

Defines the properties represented in the TransactionExtensions object (JSON) or node (XML). Note that this message artifact is identical for each and every message type.

View Transaction Extension Details

Closing - MC224 - Closing Disclosure Revision

🌐 The following is an example payload to be posted in the body of the HTTP request.

/* Copyright © 2023 Mortgage Connect LP */
{
    "transactionHeader": {
        "transactionIdempotentId": "3B34A671-BB17-400D-90BF-7CBF9C96E8ED",
        "transactionDate": "2023-08-16T03:55:00",
        "clientCode": "1799",
        "clientName": "AcmeInc",
        "vendorCode": "MC",
        "vendorName": "Mortgage Connect"
    },
    "transactionBody": {
        "transactionCode": "Closing-Disclosure-Revision",
        "transactionId": "7832143",
        "productTransactionId": "",
        "orderNumber": 2429888,
        "productCode": "CWI",
        "documents": {
            "document": [
                {
                    "documentId": "1243992",
                    "type": "CDF - ESTIMATED",
                    "name": "cfd-estimated-1.pdf",
                    "fileType": "PDF",
                    "contentMediaType": "application/pdf",
                    "contentUnicodeTextEncodingType": "UTF8",
                    "contentBinaryEncodingType": "Base64",
                    "content": "Base64 String",
                    "description": "Brief overview of the document"

                }
            ]
        }
    },
    "transactionExtensions": {
        "transactionExtension": [
            {
                "key": "Client Specific Key 1",
                "value": "Client Specific Value 1"
            },
            {
                "key": "Client Specific Key 2",
                "value": "Client Specific Value 2"
            }
        ]
    }
}
/* Copyright © 2023 Mortgage Connect LP */

<!-- Copyright © 2023 Mortgage Connect LP -->
<root>
    <transactionHeader>
        <transactionIdempotentId>3B34A671-BB17-400D-90BF-7CBF9C96E8ED</transactionIdempotentId>
        <transactionDate>2023-08-16T03:55:00/transactionDate>
        <clientCode>1799</clientCode>
        <clientName>AcmeInc</clientName>
        <vendorCode>MC</vendorCode>
        <vendorName>Mortgage Connect</vendorName>
    </transactionHeader>
    <transactionBody>
        <transactionCode>Closing-Disclosure-Revision</transactionCode>
        <transactionId>7832143</transactionId>
        <productTransactionId></productTransactionId>
        <orderNumber>2429888</orderNumber>
        <productCode>CWI</productCode>
        <documents>
            <document>
                <documentId>1243992</documentId>
                <type>CDF - ESTIMATED</type>
                <name>cfd-estimated-1.pdf</name>
                <fileType>PDF</fileType>
                <contentMediaType>application/pdf</contentMediaType>
                <contentUnicodeTextEncodingType>UTF8</contentUnicodeTextEncodingType>
                <contentBinaryEncodingType>Base64</contentBinaryEncodingType>
                <content>Base64 String</content>
                <description>Brief overview of the document</description>
            </document>
        </cocuments>
    </transactionBody>
    <transactionExtensions>
        <transactionExtension>
            <key>Client Specific Key 1</key>
            <value>Client Specific Value 1</value>
        </transactionExtension>
        <transactionExtension>
            <key>Client Specific Key 2</key>
            <value>Client Specific Value 1</value>
        </transactionExtension>
    </transactionExtensions>
</root>
<!-- Copyright © 2023 Mortgage Connect LP -->

👍 The request payload can be verified using the following validation schema.

The request payload JSON schema validation is under construction. 🚧

The request payload XML schema validation is under construction. 🚧

✅ The following is an 'Accepted' example payload to be returned in the HTTP response.

Accepted Acknowledgment payloads are typically message type agnostic.

Accepted Acknowledgment payloads are typically message type agnostic.

⛔ The following is a 'Rejected' example payload to be returned in the HTTP response.

Rejected Acknowledgment payloads are typically message type agnostic.

Rejected Acknowledgment payloads are typically message type agnostic.

The Closing Disclosure Revision API method is the mechanism in which Mortgage Connect notifies the Client or the Client notifies Mortgage Connect that the Closing Disclosure has been revised. The Closing Disclosure provides details about the mortgage loan, including the loan terms, monthly payments, fees, and other ancillary costs.

View Workflow Orchestration

Client URL

POST 🔒 To be determined during onboarding process.

Mortgage Connect URL

POST 🔒 https://{BaseUrl}/Api/V1.0/{ClientCode}/SubmitMessage

Mortgage Connect URL Properties

Property	Requirement	Description
BaseUrl	Required	A unique base Url that represents a specific Mortgage Connect endpoint and targeted environment.
ClientCode	Required	A unique code assigned to all clients that is used for identification, authentication, and customization purposes.

Property Definitions - Transaction Header

Defines the properties represented in the Transaction Header object (JSON) or node (XML). Note that this message artifact is identical for each and every message type.

View Transaction Header Details

Property Definitions - Transaction Body

Defines the properties represented in the Transaction Body object (JSON) or node (XML).

Property	Requirement	Data Type	Min / Max	Description
transactionBody	Required			A parent object (JSON) or node (XML) that contains the transaction metadata.
transactionCode	Required	String	14 / 14	A static value of `Closing-Disclosure-Revision`. The transaction code is meant to identify the message type and the context or action that should be taken. In this context it implies that the Closing Disclosure has been revised and that the corresponding document is attached. Possible Values: Closing-Disclosure-Revised
transactionId	Required	String	1 / 50	Represents the Client's unique order number.
productTransactionId	Optional	String	0 / 50	Represents the Client's unique product order number. Note that the `productTransactionId` field is not used in most circumstances. However, when there is a need to further differentiate order numbers at a product level, that share the same `transactionId`, (i.e. the primary order level id), then the `productTransactionId` can be used to ensure uniqueness across the integration transactions. This makes it possible for multiple orders of the same product type to be placed using the same `transactionId`. The use of the `productTransactionId` field and any specific workflow deviations will be vetted during the onboarding process.
orderNumber	Required	Integer		Represents Mortgage Connects unique order number.
productCode	Required	String	3 / 4	Represents Mortgage Connect's product code. Possible Values: LVR `LEGAL & VEString REPORT` PRT `PROPERTY REPORT` PUR `PURCHASE` TTL `TITLE INSURANCE` etc. Traditionally, clients use Mortgage Connects `Product Code` names and thus there is a one to one mapping relationship that is maintained by the client. However, Mortgage Connect is aware that our naming conventions may not resonate and that there are many inconsistencies in product code naming conventions and nomenclatures. It is for this reason that Mortgage Connect is able to map the client's product code to Mortgage Connect's product code to ease the transition. Any required product code mapping exercises will be addressed during the onboarding process. The supported `productCode`(s) are specific per integration and will be determined during the onboarding process. Note that the minimum/maximum length requirement of 3/4 is only applicable if using Mortgage Connect's internal product codes, otherwise when mapping to the client's product codes, the minimum/maximum is 1/50.
documents	Required			A parent object (JSON) or node (XML) that contains a list of document metadata. `(1 to Many)`
document	Required			A parent object (JSON) or node (XML) that contains the metadata associated with a single document.
documentId	Required	String	1/36	A number or string that uniquely identifies the document within the host system. When an outbound Closing-Disclosure-Revision event is sent by Mortgage Connect to the Client, the documentId will be a string in the form of an integer. The integer value represents the Identity Field and Primary Key associated with the corresponding document record. Likewise, when the Client sends Mortgage Connect an Closing-Disclosure-Revision event, the documentId could also represent an Integer, however, there is no reason why the value could not be a unique string like a GUID. No matter what value is passed, the value needs to represent a unique value that uniquely identifies the attached document. There is no hard requirement to capture this information. However, both parties are encouraged to do so, in order that conversations or any triaging of exceptions around these values can be correlated across systems.
type	Required	String	1 / 255	A name that uniquely identifies the document type. Traditionally, clients use Mortgage Connects `Document Type` names and thus there is a one to one mapping relationship that is maintained by the client. However, Mortgage Connect is aware that our naming conventions may not resonate and that there are many inconsistencies in document type naming conventions and nomenclatures. It is for this reason that Mortgage Connect is able to map the client's document type to Mortgage Connect's document type to ease the transition. Any required document mapping exercises will be addressed during the onboarding process. The supported `types`(s) are specific per integration and will be determined during the onboarding process.
name	Required	String	1 / 100	This is the user friendly name that is associated with the document.
fileType	Required	String	3 / 4	This indicates what type of document it is. This in the context of what the file extension represents. Possible Values: DOC DOCX PDF Future Values: CSV HTML JSON TXT XLS XLSX XML `DOC`, `DOCX`, and `PDF` are currently supported with the vast majority of the documents being delivered as `PDF` documents. The other types are included to support additional documents in the future.
contentMediaType	Required	String	1 / 100	This represents the content media type, i.e. `MIME Type`. Possible Values: application/msword (DOC) application/vnd.openxmlformats-officedocument.wordprocessingml.document (DOCX) application/pdf (PDF) Future Values: text/csv (CSV) text/html (HTML) application/json (JSON) text/plain (TXT) application/vnd.ms-excel (XLS) application/vnd.openxmlformats-officedocument.spreadsheetml.sheet (XLSX) application/xml (XML) At this time `application/msword (DOC)`, `application/vnd.openxmlformats-officedocument.wordprocessingml.document (DOCX)`, and `application/pdf (PDF)` are supported with `application/pdf (PDF)` being used 90+% of the time. The other types are added to support future media types.
contentUnicode TextEncodingType	Required	String	4 / 4	This indicates what unicode text encoding type was used to generate the document. Possible Values: UTF8
contentBinary EncodingType	Required	String	6 / 6	This indicates what binary encoding type was used to generate the document content. Possible Values: Base64
content	Required	String	1 / MAX	This represents the digital representation of the document after it has been encoded using Base64. See: https://en.wikipedia.org/wiki/Base64 for more information regarding Base64 formatting.
description	Optional	String	0 / 255	Provides a brief overview of the document contents.

Property Definitions - Transaction Extensions

Defines the properties represented in the TransactionExtensions object (JSON) or node (XML). Note that this message artifact is identical for each and every message type.

View Transaction Extension Details

Closing - MC226 - Final Closing Disclosure

🌐 The following is an example payload to be posted in the body of the HTTP request.

/* Copyright © 2023 Mortgage Connect LP */
{
    "transactionHeader": {
        "transactionIdempotentId": "3B34A671-BB17-400D-90BF-7CBF9C96E8ED",
        "transactionDate": "2023-08-16T03:55:00",
        "clientCode": "1799",
        "clientName": "AcmeInc",
        "vendorCode": "MC",
        "vendorName": "Mortgage Connect"
    },
    "transactionBody": {
        "transactionCode": "Final-Closing-Disclosure",
        "transactionId": "7832143",
        "productTransactionId": "",
        "orderNumber": 2429888,
        "productCode": "CWI",
        "documents": {
            "document": [
                {
                    "documentId": "1243992",
                    "type": "CDF - FINAL",
                    "name": "cfd-final-1.pdf",
                    "fileType": "PDF",
                    "contentMediaType": "application/pdf",
                    "contentUnicodeTextEncodingType": "UTF8",
                    "contentBinaryEncodingType": "Base64",
                    "content": "Base64 String",
                    "description": "Brief overview of the document"
                }
            ]
        }
    },
    "transactionExtensions": {
        "transactionExtension": [
            {
                "key": "Client Specific Key 1",
                "value": "Client Specific Value 1"
            },
            {
                "key": "Client Specific Key 2",
                "value": "Client Specific Value 2"
            }
        ]
    }
}
/* Copyright © 2023 Mortgage Connect LP */

<!-- Copyright © 2023 Mortgage Connect LP -->
<root>
    <transactionHeader>
        <transactionIdempotentId>3B34A671-BB17-400D-90BF-7CBF9C96E8ED</transactionIdempotentId>
        <transactionDate>2023-08-16T03:55:00/transactionDate>
        <clientCode>1799</clientCode>
        <clientName>AcmeInc</clientName>
        <vendorCode>MC</vendorCode>
        <vendorName>Mortgage Connect</vendorName>
    </transactionHeader>
    <transactionBody>
        <transactionCode>Final-Closing-Disclosure</transactionCode>
        <transactionId>7832143</transactionId>
        <productTransactionId></productTransactionId>
        <orderNumber>2429888</orderNumber>
        <productCode>CWI</productCode>
        <documents>
            <document>
                <documentId>1243992</documentId>
                <type>CDF - FINAL</type>
                <name>cfd-final-1.pdf</name>
                <fileType>PDF</fileType>
                <contentMediaType>application/pdf</contentMediaType>
                <contentUnicodeTextEncodingType>UTF8</contentUnicodeTextEncodingType>
                <contentBinaryEncodingType>Base64</contentBinaryEncodingType>
                <content>Base64 String</content>
                <description>Brief overview of the document</description>
            </document>
        </cocuments>
    </transactionBody>
    <transactionExtensions>
        <transactionExtension>
            <key>Client Specific Key 1</key>
            <value>Client Specific Value 1</value>
        </transactionExtension>
        <transactionExtension>
            <key>Client Specific Key 2</key>
            <value>Client Specific Value 1</value>
        </transactionExtension>
    </transactionExtensions>
</root>
<!-- Copyright © 2023 Mortgage Connect LP -->

👍 The request payload can be verified using the following validation schema.

The request payload JSON schema validation is under construction. 🚧

The request payload XML schema validation is under construction. 🚧

✅ The following is an 'Accepted' example payload to be returned in the HTTP response.

Accepted Acknowledgment payloads are typically message type agnostic.

Accepted Acknowledgment payloads are typically message type agnostic.

⛔ The following is a 'Rejected' example payload to be returned in the HTTP response.

Rejected Acknowledgment payloads are typically message type agnostic.

Rejected Acknowledgment payloads are typically message type agnostic.

The Final Closing Disclosure API method is the mechanism in which Mortgage Connect notifies the Client or the Client notifies Mortgage Connect that the Closing Disclosure has been finalized. The Closing Disclosure provides details about the mortgage loan, including the loan terms, monthly payments, fees, and other ancillary costs.

View Workflow Orchestration

Client URL

POST 🔒 To be determined during onboarding process.

Mortgage Connect URL

POST 🔒 https://{BaseUrl}/Api/V1.0/{ClientCode}/SubmitMessage

Mortgage Connect URL Properties

Property	Requirement	Description
BaseUrl	Required	A unique base Url that represents a specific Mortgage Connect endpoint and targeted environment.
ClientCode	Required	A unique code assigned to all clients that is used for identification, authentication, and customization purposes.

Property Definitions - Transaction Header

Defines the properties represented in the Transaction Header object (JSON) or node (XML). Note that this message artifact is identical for each and every message type.

View Transaction Header Details

Property Definitions - Transaction Body

Defines the properties represented in the Transaction Body object (JSON) or node (XML).

Property	Requirement	Data Type	Min / Max	Description
transactionBody	Required			A parent object (JSON) or node (XML) that contains the transaction metadata.
transactionCode	Required	String	14 / 14	A static value of `Final-Closing-Disclosure`. The transaction code is meant to identify the message type and the context or action that should be taken. In this context it implies that the Closing Disclosure has been finalized and that the corresponding document is attached. Possible Values: Final-Closing-Disclosure
transactionId	Required	String	1 / 50	Represents the Client's unique order number.
productTransactionId	Optional	String	0 / 50	Represents the Client's unique product order number. Note that the `productTransactionId` field is not used in most circumstances. However, when there is a need to further differentiate order numbers at a product level, that share the same `transactionId`, (i.e. the primary order level id), then the `productTransactionId` can be used to ensure uniqueness across the integration transactions. This makes it possible for multiple orders of the same product type to be placed using the same `transactionId`. The use of the `productTransactionId` field and any specific workflow deviations will be vetted during the onboarding process.
orderNumber	Required	Integer		Represents Mortgage Connects unique order number.
productCode	Required	String	3 / 4	Represents Mortgage Connect's product code. Possible Values: LVR `LEGAL & VEString REPORT` PRT `PROPERTY REPORT` PUR `PURCHASE` TTL `TITLE INSURANCE` etc. Traditionally, clients use Mortgage Connects `Product Code` names and thus there is a one to one mapping relationship that is maintained by the client. However, Mortgage Connect is aware that our naming conventions may not resonate and that there are many inconsistencies in product code naming conventions and nomenclatures. It is for this reason that Mortgage Connect is able to map the client's product code to Mortgage Connect's product code to ease the transition. Any required product code mapping exercises will be addressed during the onboarding process. The supported `productCode`(s) are specific per integration and will be determined during the onboarding process. Note that the minimum/maximum length requirement of 3/4 is only applicable if using Mortgage Connect's internal product codes, otherwise when mapping to the client's product codes, the minimum/maximum is 1/50.
documents	Required			A parent object (JSON) or node (XML) that contains a list of document metadata. `(1 to Many)`
document	Required			A parent object (JSON) or node (XML) that contains the metadata associated with a single document.
documentId	Required	String	1/36	A number or string that uniquely identifies the document within the host system. When an outbound Final-Closing-Disclosure event is sent by Mortgage Connect to the Client, the documentId will be a string in the form of an integer. The integer value represents the Identity Field and Primary Key associated with the corresponding document record. Likewise, when the Client sends Mortgage Connect an Final-Closing-Disclosure event, the documentId could also represent an Integer, however, there is no reason why the value could not be a unique string like a GUID. No matter what value is passed, the value needs to represent a unique value that uniquely identifies the attached document. There is no hard requirement to capture this information. However, both parties are encouraged to do so, in order that conversations or any triaging of exceptions around these values can be correlated across systems.
type	Required	String	1 / 255	A name that uniquely identifies the document type. Traditionally, clients use Mortgage Connects `Document Type` names and thus there is a one to one mapping relationship that is maintained by the client. However, Mortgage Connect is aware that our naming conventions may not resonate and that there are many inconsistencies in document type naming conventions and nomenclatures. It is for this reason that Mortgage Connect is able to map the client's document type to Mortgage Connect's document type to ease the transition. Any required document mapping exercises will be addressed during the onboarding process. The supported `types`(s) are specific per integration and will be determined during the onboarding process.
name	Required	String	1 / 100	This is the user friendly name that is associated with the document.
fileType	Required	String	3 / 4	This indicates what type of document it is. This in the context of what the file extension represents. Possible Values: DOC DOCX PDF Future Values: CSV HTML JSON TXT XLS XLSX XML `DOC`, `DOCX`, and `PDF` are currently supported with the vast majority of the documents being delivered as `PDF` documents. The other types are included to support additional documents in the future.
contentMediaType	Required	String	1 / 100	This represents the content media type, i.e. `MIME Type`. Possible Values: application/msword (DOC) application/vnd.openxmlformats-officedocument.wordprocessingml.document (DOCX) application/pdf (PDF) Future Values: text/csv (CSV) text/html (HTML) application/json (JSON) text/plain (TXT) application/vnd.ms-excel (XLS) application/vnd.openxmlformats-officedocument.spreadsheetml.sheet (XLSX) application/xml (XML) At this time `application/msword (DOC)`, `application/vnd.openxmlformats-officedocument.wordprocessingml.document (DOCX)`, and `application/pdf (PDF)` are supported with `application/pdf (PDF)` being used 90+% of the time. The other types are added to support future media types.
contentUnicode TextEncodingType	Required	String	4 / 4	This indicates what unicode text encoding type was used to generate the document. Possible Values: UTF8
contentBinary EncodingType	Required	String	6 / 6	This indicates what binary encoding type was used to generate the document content. Possible Values: Base64
content	Required	String	1 / MAX	This represents the digital representation of the document after it has been encoded using Base64. See: https://en.wikipedia.org/wiki/Base64 for more information regarding Base64 formatting.
description	Optional	String	0 / 255	Provides a brief overview of the document contents.

Property Definitions - Transaction Extensions

Defines the properties represented in the TransactionExtensions object (JSON) or node (XML). Note that this message artifact is identical for each and every message type.

View Transaction Extension Details

Closing - MC230 - Closing Package

🌐 The following is an example payload to be posted in the body of the HTTP request.

/* Copyright © 2023 Mortgage Connect LP */
{
    "transactionHeader": {
        "transactionIdempotentId": "3B34A671-BB17-400D-90BF-7CBF9C96E8ED",
        "transactionDate": "2022-07-11T02:03:40",
        "clientCode": "1799",
        "clientName": "AcmeInc",
        "vendorCode": "MC",
        "vendorName": "Mortgage Connect"
    },
    "transactionBody": {
        "transactionCode": "Closing-Package",
        "transactionId": "7832143",
        "productTransactionId": "",
        "orderNumber": "2429888",
        "productCode": "CWI",
        "documents": {
            "document": [
                {
                    "documentId": "1388109",
                    "type": "Closing Package",
                    "name": "closing-package.pdf",
                    "fileType": "PDF",
                    "contentMediaType": "application/pdf",
                    "contentUnicodeTextEncodingType": "UTF8",
                    "contentBinaryEncodingType": "Base64",
                    "content": "Base64 String",
                    "description": "Brief overview of the document"
                }
            ]
        }
    },
    "transactionExtensions": {
        "transactionExtension": [
            {
                "key": "Client Specific Key 1",
                "value": "Client Specific Value 1"
            },
            {
                "key": "Client Specific Key 2",
                "value": "Client Specific Value 2"
            }
        ]
    }
}
/* Copyright © 2023 Mortgage Connect LP */

<!-- Copyright © 2023 Mortgage Connect LP -->
<root>
    <transactionHeader>
        <transactionIdempotentId>3B34A671-BB17-400D-90BF-7CBF9C96E8ED</transactionIdempotentId>
        <transactionDate>022-07-11T02:03:40</transactionDate>
        <clientCode>1799</clientCode>
        <clientName>AcmeInc</clientName>
        <vendorCode>MC</vendorCode>
        <vendorName>Mortgage Connect</vendorName>
    </transactionHeader>
    <transactionBody>
        <transactionCode>Closing-Package</transactionCode>
        <transactionId>7832143</transactionId>
        <productTransactionId></productTransactionId>
        <orderNumber>2429888</orderNumber>
        <productCode>CWI</productCode>
        <documents>
            <document>
                <documentId>1388109</documentId>
                <type>Closing Package</type>
                <name>closing-package.pdf</name>
                <fileType>PDF</fileType>
                <contentMediaType>application/pdf</contentMediaType>
                <contentUnicodeTextEncodingType>UTF8</contentUnicodeTextEncodingType>
                <contentBinaryEncodingType>Base64</contentBinaryEncodingType>
                <content>Base64 String</content>
                <description>Brief overview of the document</description>
            </document>
        </documents>
    </transactionBody>
    <transactionExtensions>
        <transactionExtension>
            <key>Client Specific Key 1</key>
            <value>Client Specific Value 1</value>
        </transactionExtension>
        <transactionExtension>
            <key>Client Specific Key 2</key>
            <value>Client Specific Value 1</value>
        </transactionExtension>
    </transactionExtensions>
</root>
<!-- Copyright © 2023 Mortgage Connect LP -->

👍 The request payload can be verified using the following validation schema.

The request payload JSON schema validation is under construction. 🚧

The request payload XML schema validation is under construction. 🚧

✅ The following is an 'Accepted' example payload to be returned in the HTTP response.

Accepted Acknowledgment payloads are typically message type agnostic.

Accepted Acknowledgment payloads are typically message type agnostic.

⛔ The following is a 'Rejected' example payload to be returned in the HTTP response.

Rejected Acknowledgment payloads are typically message type agnostic.

Rejected Acknowledgment payloads are typically message type agnostic.

The Closing Package API method is the mechanism in which Mortgage Connect sends the Client the final closing package.

View Workflow Orchestration

Client URL

POST 🔒 To be determined during onboarding process.

Property Definitions - Transaction Header

Defines the properties represented in the Transaction Header object (JSON) or node (XML). Note that this message artifact is identical for each and every message type.

View Transaction Header Details

Property Definitions - Transaction Body

Defines the properties represented in the Transaction Body object (JSON) or node (XML).

Property	Requirement	Data Type	Min / Max	Description
transactionBody	Required			A parent object (JSON) or node (XML) that contains the transaction metadata.
transactionCode	Required	String	15 / 15	A static value of `Closing-Package`. The transaction code is meant to identify the message type and the context or action that should be taken. In this context the closing package is being sent to the client. Possible Values: Closing-Package
transactionId	Required	String	1 / 50	Represents the Client's unique order number.
productTransactionId	Optional	String	0 / 50	Represents the Client's unique product order number. Note that the `productTransactionId` field is not used in most circumstances. However, when there is a need to further differentiate order numbers at a product level, that share the same `transactionId`, (i.e. the primary order level id), then the `productTransactionId` can be used to ensure uniqueness across the integration transactions. This makes it possible for multiple orders of the same product type to be placed using the same `transactionId`. The use of the `productTransactionId` field and any specific workflow deviations will be vetted during the onboarding process.
orderNumber	Required	Integer		Represents Mortgage Connects unique order number.
productCode	Required	String	3 / 4	Represents Mortgage Connect's product code. Possible Values: LVR `LEGAL & VEString REPORT` PRT `PROPERTY REPORT` PUR `PURCHASE` TTL `TITLE INSURANCE` etc. Traditionally, clients use Mortgage Connects `Product Code` names and thus there is a one to one mapping relationship that is maintained by the client. However, Mortgage Connect is aware that our naming conventions may not resonate and that there are many inconsistencies in product code naming conventions and nomenclatures. It is for this reason that Mortgage Connect is able to map the client's product code to Mortgage Connect's product code to ease the transition. Any required product code mapping exercises will be addressed during the onboarding process. The supported `productCode`(s) are specific per integration and will be determined during the onboarding process. Note that the minimum/maximum length requirement of 3/4 is only applicable if using Mortgage Connect's internal product codes, otherwise when mapping to the client's product codes, the minimum/maximum is 1/50.
documents	Required			A parent object (JSON) or node (XML) that contains a list of document metadata. `(1 to Many)`
document	Required			A parent object (JSON) or node (XML) that contains the metadata associated with a single document.
documentId	Required	Integer		A number or string that uniquely identifies the document within the host system. When an outbound Closing-Package event is sent by Mortgage Connect to the Client, the documentId will be a string in the form of an integer. The integer value represents the Identity Field and Primary Key associated with the corresponding document record. There is no hard requirement to capture this information. However, both parties are encouraged to do so, in order that conversations or any triaging of exceptions around these values can be correlated across systems.
type	Required	String	1 / 255	A name that uniquely identifies the document type. Traditionally, clients use Mortgage Connects `Document Type` names and thus there is a one to one mapping relationship that is maintained by the client. However, Mortgage Connect is aware that our naming conventions may not resonate and that there are many inconsistencies in document type naming conventions and nomenclatures. It is for this reason that Mortgage Connect is able to map the client's document type to Mortgage Connect's document type to ease the transition. Any required document mapping exercises will be addressed during the onboarding process. The supported `types`(s) are specific per integration and will be determined during the onboarding process.
name	Required	String	1 / 100	This is the user friendly name that is associated with the document.
fileType	Required	String	3 / 4	This indicates what type of document it is. This in the context of what the file extension represents. Possible Values: DOC DOCX PDF Future Values: CSV HTML JSON TXT XLS XLSX XML `DOC`, `DOCX`, and `PDF` are currently supported with the vast majority of the documents being delivered as `PDF` documents. The other types are included to support additional documents in the future.
contentMediaType	Required	String	1 / 100	This represents the content media type, i.e. `MIME Type`. Possible Values: application/msword (DOC) application/vnd.openxmlformats-officedocument.wordprocessingml.document (DOCX) application/pdf (PDF) Future Values: text/csv (CSV) text/html (HTML) application/json (JSON) text/plain (TXT) application/vnd.ms-excel (XLS) application/vnd.openxmlformats-officedocument.spreadsheetml.sheet (XLSX) application/xml (XML) At this time `application/msword (DOC)`, `application/vnd.openxmlformats-officedocument.wordprocessingml.document (DOCX)`, and `application/pdf (PDF)` are supported with `application/pdf (PDF)` being used 90+% of the time. The other types are added to support future media types.
contentUnicode TextEncodingType	Required	String	4 / 4	This indicates what unicode text encoding type was used to generate the document. Possible Values: UTF8
contentBinary EncodingType	Required	String	6 / 6	This indicates what binary encoding type was used to generate the document content. Possible Values: Base64
content	Required	String	1 / MAX	This represents the digital representation of the document after it has been encoded using Base64. See: https://en.wikipedia.org/wiki/Base64 for more information regarding Base64 formatting.
description	Optional	String	0 / 255	Provides a brief overview of the document contents.

Property Definitions - Transaction Extensions

Defines the properties represented in the TransactionExtensions object (JSON) or node (XML). Note that this message artifact is identical for each and every message type.

View Transaction Extension Details

Closing - MC240 - Clear To Fund

🌐 The following is an example payload to be posted in the body of the HTTP request.

/* Copyright © 2023 Mortgage Connect LP */
{
    "transactionHeader": {
        "transactionIdempotentId": "3B34A671-BB17-400D-90BF-7CBF9C96E8ED",
        "transactionDate": "2022-07-11T02:03:40",
        "clientCode": "1799",
        "clientName": "AcmeInc",
        "vendorCode": "MC",
        "vendorName": "Mortgage Connect"
    },
    "transactionBody": {
        "transactionCode": "Clear-To-Fund",
        "transactionId": "7832143",
        "productTransactionId": "",
        "orderNumber": "2429888",
        "productCode": "CWI",
        "comment": "Clear to fund",
        "commentDate": "2022-07-11T02:03:40"
    },
    "transactionExtensions": {
        "transactionExtension": [
            {
                "key": "Client Specific Key 1",
                "value": "Client Specific Value 1"
            },
            {
                "key": "Client Specific Key 2",
                "value": "Client Specific Value 2"
            }
        ]
    }
}
/* Copyright © 2023 Mortgage Connect LP */

<!-- Copyright © 2023 Mortgage Connect LP -->
<root>
    <transactionHeader>
        <transactionIdempotentId>3B34A671-BB17-400D-90BF-7CBF9C96E8ED</transactionIdempotentId>
        <transactionDate>022-07-11T02:03:40</transactionDate>
        <clientCode>1799</clientCode>
        <clientName>AcmeInc</clientName>
        <vendorCode>MC</vendorCode>
        <vendorName>Mortgage Connect</vendorName>
    </transactionHeader>
    <transactionBody>
        <transactionCode>Clear-To-Fund</transactionCode>
        <transactionId>7832143</transactionId>
        <productTransactionId></productTransactionId>
        <orderNumber>2429888</orderNumber>
        <productCode>CWI</productCode>
        <comment>Clear to fund</comment>
        <commentDate>2022-07-11T02:03:40</commentDate>
    </transactionBody>
    <transactionExtensions>
        <transactionExtension>
            <key>Client Specific Key 1</key>
            <value>Client Specific Value 1</value>
        </transactionExtension>
        <transactionExtension>
            <key>Client Specific Key 2</key>
            <value>Client Specific Value 1</value>
        </transactionExtension>
    </transactionExtensions>
</root>
<!-- Copyright © 2023 Mortgage Connect LP -->

👍 The request payload can be verified using the following validation schema.

The request payload JSON schema validation is under construction. 🚧

The request payload XML schema validation is under construction. 🚧

✅ The following is an 'Accepted' example payload to be returned in the HTTP response.

Accepted Acknowledgment payloads are typically message type agnostic.

Accepted Acknowledgment payloads are typically message type agnostic.

⛔ The following is a 'Rejected' example payload to be returned in the HTTP response.

Rejected Acknowledgment payloads are typically message type agnostic.

Rejected Acknowledgment payloads are typically message type agnostic.

The Clear To Fund API method is the mechanism in which a Client notifies Mortgage Connect that an order is clear to be funded (i.e. funds to be disbursed).

View Workflow Orchestration

Mortgage Connect URL

POST 🔒 https://{BaseUrl}/Api/V1.0/{ClientCode}/SubmitMessage

Mortgage Connect URL Properties

Property	Requirement	Description
BaseUrl	Required	A unique base Url that represents a specific Mortgage Connect endpoint and targeted environment.
ClientCode	Required	A unique code assigned to all clients that is used for identification, authentication, and customization purposes.

Property Definitions - Transaction Header

Defines the properties represented in the Transaction Header object (JSON) or node (XML). Note that this message artifact is identical for each and every message type.

View Transaction Header Details

Property Definitions - Transaction Body

Defines the properties represented in the Transaction Body object (JSON) or node (XML).

Property	Requirement	Data Type	Min / Max	Description
transactionBody	Required			A parent object (JSON) or node (XML) that contains the transaction metadata.
transactionCode	Required	String	13 / 13	A static value of `Clear-To-Fund`. The transaction code is meant to identify the message type and the context or action that should be taken. In this context it implies that the order is clear to fund, i.e. to be disbursed. Possible Values: Clear-To-Fund
transactionId	Required	String	1 / 50	Represents the Client's unique order number.
productTransactionId	Optional	String	0 / 50	Represents the Client's unique product order number. Note that the `productTransactionId` field is not used in most circumstances. However, when there is a need to further differentiate order numbers at a product level, that share the same `transactionId`, (i.e. the primary order level id), then the `productTransactionId` can be used to ensure uniqueness across the integration transactions. This makes it possible for multiple orders of the same product type to be placed using the same `transactionId`. The use of the `productTransactionId` field and any specific workflow deviations will be vetted during the onboarding process.
orderNumber	Required	Integer		Represents Mortgage Connects unique order number.
productCode	Required	String	3 / 4	Represents Mortgage Connect's product code. Possible Values: LVR `LEGAL & VEString REPORT` PRT `PROPERTY REPORT` PUR `PURCHASE` TTL `TITLE INSURANCE` etc. Traditionally, clients use Mortgage Connects `Product Code` names and thus there is a one to one mapping relationship that is maintained by the client. However, Mortgage Connect is aware that our naming conventions may not resonate and that there are many inconsistencies in product code naming conventions and nomenclatures. It is for this reason that Mortgage Connect is able to map the client's product code to Mortgage Connect's product code to ease the transition. Any required product code mapping exercises will be addressed during the onboarding process. The supported `productCode`(s) are specific per integration and will be determined during the onboarding process. Note that the minimum/maximum length requirement of 3/4 is only applicable if using Mortgage Connect's internal product codes, otherwise when mapping to the client's product codes, the minimum/maximum is 1/50.
comment	Required	String	1 / 1000	A general comment indicating that the order is cleared to fund.
commentDate	Required	DateTime		The date when the order was cleared to fund.

Property Definitions - Transaction Extensions

Defines the properties represented in the TransactionExtensions object (JSON) or node (XML). Note that this message artifact is identical for each and every message type.

View Transaction Extension Details

Closing - MC243 - Not Clear To Fund

🌐 The following is an example payload to be posted in the body of the HTTP request.

/* Copyright © 2023 Mortgage Connect LP */
{
    "transactionHeader": {
        "transactionIdempotentId": "3B34A671-BB17-400D-90BF-7CBF9C96E8ED",
        "transactionDate": "2023-08-03T12:47:11.887Z",
        "clientCode": "1799",
        "clientName": "AcmeInc",
        "vendorCode": "MC",
        "vendorName": "Mortgage Connect"
    },
    "transactionBody": {
        "transactionCode": "Not-Clear-To-Fund",
        "transactionId": "7832143",
        "productTransactionId": "",
        "orderNumber": "2429888",
        "productCode": "CWI",
        "comment": "Unable to clear the funds",
        "commentDate": "2022-08-03T02:50:40"
    },
    "transactionExtensions": {
        "transactionExtension": [
            {
                "key": "Client Specific Key 1",
                "value": "Client Specific Value 1"
            },
            {
                "key": "Client Specific Key 2",
                "value": "Client Specific Value 2"
            }
        ]
    }
}
/* Copyright © 2023 Mortgage Connect LP */

<!-- Copyright © 2023 Mortgage Connect LP -->
<root>
    <transactionHeader>
        <transactionIdempotentId>3B34A671-BB17-400D-90BF-7CBF9C96E8ED</transactionIdempotentId>
        <transactionDate>2023-08-03T12:47:11.887Z</transactionDate>
        <clientCode>1799</clientCode>
        <clientName>AcmeInc</clientName>
        <vendorCode>MC</vendorCode>
        <vendorName>Mortgage Connect</vendorName>
    </transactionHeader>
    <transactionBody>
        <transactionCode>Not-Clear-To-Fund</transactionCode>
        <transactionId>7832143</transactionId>
        <productTransactionId></productTransactionId>
        <orderNumber>2429888</orderNumber>
        <productCode>CWI</productCode>
        <comment>Unable to clear the funds</comment>
        <commentDate>2022-08-03T02:50:40</commentDate>
    </transactionBody>
    <transactionExtensions>
        <transactionExtension>
            <key>Client Specific Key 1</key>
            <value>Client Specific Value 1</value>
        </transactionExtension>
        <transactionExtension>
            <key>Client Specific Key 2</key>
            <value>Client Specific Value 1</value>
        </transactionExtension>
    </transactionExtensions>
</root>
<!-- Copyright © 2023 Mortgage Connect LP -->

👍 The request payload can be verified using the following validation schema.

The request payload JSON schema validation is under construction. 🚧

The request payload XML schema validation is under construction. 🚧

✅ The following is an 'Accepted' example payload to be returned in the HTTP response.

Accepted Acknowledgment payloads are typically message type agnostic.

Accepted Acknowledgment payloads are typically message type agnostic.

⛔ The following is a 'Rejected' example payload to be returned in the HTTP response.

Rejected Acknowledgment payloads are typically message type agnostic.

Rejected Acknowledgment payloads are typically message type agnostic.

The Not Clear To Fund API method is the mechanism in which a Client notifies Mortgage Connect that an order is not clear to be funded (i.e. funds to be disbursed).

View Workflow Orchestration

Mortgage Connect URL

POST 🔒 https://{BaseUrl}/Api/V1.0/{ClientCode}/SubmitMessage

Mortgage Connect URL Properties

Property	Requirement	Description
BaseUrl	Required	A unique base Url that represents a specific Mortgage Connect endpoint and targeted environment.
ClientCode	Required	A unique code assigned to all clients that is used for identification, authentication, and customization purposes.

Property Definitions - Transaction Header

Defines the properties represented in the Transaction Header object (JSON) or node (XML). Note that this message artifact is identical for each and every message type.

View Transaction Header Details

Property Definitions - Transaction Body

Defines the properties represented in the Transaction Body object (JSON) or node (XML).

Property	Requirement	Data Type	Min / Max	Description
transactionBody	Required			A parent object (JSON) or node (XML) that contains the transaction metadata.
transactionCode	Required	String	13 / 13	A static value of `Not Clear-To-Fund`. The transaction code is meant to identify the message type and the context or action that should be taken. In this context it implies that the order is not clear to fund, i.e. to be disbursed. Possible Values: Not-Clear-To-Fund
transactionId	Required	String	1 / 50	Represents the Client's unique order number.
productTransactionId	Optional	String	0 / 50	Represents the Client's unique product order number. Note that the `productTransactionId` field is not used in most circumstances. However, when there is a need to further differentiate order numbers at a product level, that share the same `transactionId`, (i.e. the primary order level id), then the `productTransactionId` can be used to ensure uniqueness across the integration transactions. This makes it possible for multiple orders of the same product type to be placed using the same `transactionId`. The use of the `productTransactionId` field and any specific workflow deviations will be vetted during the onboarding process.
orderNumber	Required	Integer		Represents Mortgage Connects unique order number.
productCode	Required	String	3 / 4	Represents Mortgage Connect's product code. Possible Values: LVR `LEGAL & VEString REPORT` PRT `PROPERTY REPORT` PUR `PURCHASE` TTL `TITLE INSURANCE` etc. Traditionally, clients use Mortgage Connects `Product Code` names and thus there is a one to one mapping relationship that is maintained by the client. However, Mortgage Connect is aware that our naming conventions may not resonate and that there are many inconsistencies in product code naming conventions and nomenclatures. It is for this reason that Mortgage Connect is able to map the client's product code to Mortgage Connect's product code to ease the transition. Any required product code mapping exercises will be addressed during the onboarding process. The supported `productCode`(s) are specific per integration and will be determined during the onboarding process. Note that the minimum/maximum length requirement of 3/4 is only applicable if using Mortgage Connect's internal product codes, otherwise when mapping to the client's product codes, the minimum/maximum is 1/50.
comment	Required	String	1 / 1000	A general comment indicating why the order is not cleared to fund.
commentDate	Required	DateTime		The date when the order was not cleared to fund.

Property Definitions - Transaction Extensions

Defines the properties represented in the TransactionExtensions object (JSON) or node (XML). Note that this message artifact is identical for each and every message type.

View Transaction Extension Details

Closing - MC245 - Funds Sent By Lender

🌐 The following is an example payload to be posted in the body of the HTTP request.

/* Copyright © 2023 Mortgage Connect LP */
{
    "transactionHeader": {
        "transactionIdempotentId": "3B34A671-BB17-400D-90BF-7CBF9C96E8ED",
        "transactionDate": "2022-07-11T02:03:40",
        "clientCode": "1799",
        "clientName": "AcmeInc",
        "vendorCode": "MC",
        "vendorName": "Mortgage Connect"
    },
    "transactionBody": {
        "transactionCode": "Funds-Sent-By-Lender",
        "transactionId": "7832143",
        "productTransactionId": "",
        "orderNumber": "2429888",
        "productCode": "CWI",
        "comment": "Funds sent by Lender",
        "commentDate": "2022-07-11T02:03:40"
    },
    "transactionExtensions": {
        "transactionExtension": [
            {
                "key": "Client Specific Key 1",
                "value": "Client Specific Value 1"
            },
            {
                "key": "Client Specific Key 2",
                "value": "Client Specific Value 2"
            }
        ]
    }
}
/* Copyright © 2023 Mortgage Connect LP */

<!-- Copyright © 2023 Mortgage Connect LP -->
<root>
    <transactionHeader>
        <transactionIdempotentId>3B34A671-BB17-400D-90BF-7CBF9C96E8ED</transactionIdempotentId>
        <transactionDate>022-07-11T02:03:40</transactionDate>
        <clientCode>1799</clientCode>
        <clientName>AcmeInc</clientName>
        <vendorCode>MC</vendorCode>
        <vendorName>Mortgage Connect</vendorName>
    </transactionHeader>
    <transactionBody>
        <transactionCode>Funds-Sent-By-Lender</transactionCode>
        <transactionId>7832143</transactionId>
        <productTransactionId></productTransactionId>
        <orderNumber>2429888</orderNumber>
        <productCode>CWI</productCode>
        <comment>Funds sent by Lender</comment>
        <commentDate>2022-07-11T02:03:40</commentDate>
    </transactionBody>
    <transactionExtensions>
        <transactionExtension>
            <key>Client Specific Key 1</key>
            <value>Client Specific Value 1</value>
        </transactionExtension>
        <transactionExtension>
            <key>Client Specific Key 2</key>
            <value>Client Specific Value 1</value>
        </transactionExtension>
    </transactionExtensions>
</root>
<!-- Copyright © 2023 Mortgage Connect LP -->

👍 The request payload can be verified using the following validation schema.

The request payload JSON schema validation is under construction. 🚧

The request payload XML schema validation is under construction. 🚧

✅ The following is an 'Accepted' example payload to be returned in the HTTP response.

Accepted Acknowledgment payloads are typically message type agnostic.

Accepted Acknowledgment payloads are typically message type agnostic.

⛔ The following is a 'Rejected' example payload to be returned in the HTTP response.

Rejected Acknowledgment payloads are typically message type agnostic.

Rejected Acknowledgment payloads are typically message type agnostic.

The Funds-Sent-By-Lender API method is the mechanism in which a Client notifies Mortgage Connect that funds have been sent by the Lender.

View Workflow Orchestration

Mortgage Connect URL

POST 🔒 https://{BaseUrl}/Api/V1.0/{ClientCode}/SubmitMessage

Mortgage Connect URL Properties

Property	Requirement	Description
BaseUrl	Required	A unique base Url that represents a specific Mortgage Connect endpoint and targeted environment.
ClientCode	Required	A unique code assigned to all clients that is used for identification, authentication, and customization purposes.

Property Definitions - Transaction Header

Defines the properties represented in the Transaction Header object (JSON) or node (XML). Note that this message artifact is identical for each and every message type.

View Transaction Header Details

Property Definitions - Transaction Body

Defines the properties represented in the Transaction Body object (JSON) or node (XML).

Property	Requirement	Data Type	Min / Max	Description
transactionBody	Required			A parent object (JSON) or node (XML) that contains the transaction metadata.
transactionCode	Required	String	13 / 13	A static value of `Funds-Sent-By-Lender`. The transaction code is meant to identify the message type and the context or action that should be taken. In this context it implies that funds have been sent by the lender. Possible Values: Funds-Sent-By-Lender
transactionId	Required	String	1 / 50	Represents the Client's unique order number.
productTransactionId	Optional	String	0 / 50	Represents the Client's unique product order number. Note that the `productTransactionId` field is not used in most circumstances. However, when there is a need to further differentiate order numbers at a product level, that share the same `transactionId`, (i.e. the primary order level id), then the `productTransactionId` can be used to ensure uniqueness across the integration transactions. This makes it possible for multiple orders of the same product type to be placed using the same `transactionId`. The use of the `productTransactionId` field and any specific workflow deviations will be vetted during the onboarding process.
orderNumber	Required	Integer		Represents Mortgage Connects unique order number.
productCode	Required	String	3 / 4	Represents Mortgage Connect's product code. Possible Values: LVR `LEGAL & VEString REPORT` PRT `PROPERTY REPORT` PUR `PURCHASE` TTL `TITLE INSURANCE` etc. Traditionally, clients use Mortgage Connects `Product Code` names and thus there is a one to one mapping relationship that is maintained by the client. However, Mortgage Connect is aware that our naming conventions may not resonate and that there are many inconsistencies in product code naming conventions and nomenclatures. It is for this reason that Mortgage Connect is able to map the client's product code to Mortgage Connect's product code to ease the transition. Any required product code mapping exercises will be addressed during the onboarding process. The supported `productCode`(s) are specific per integration and will be determined during the onboarding process. Note that the minimum/maximum length requirement of 3/4 is only applicable if using Mortgage Connect's internal product codes, otherwise when mapping to the client's product codes, the minimum/maximum is 1/50.
comment	Required	String	1 / 1000	A general comment indicating that the funds have been sent by the lender.
commentDate	Required	DateTime		The date when the funds were sent by the lender.

Property Definitions - Transaction Extensions

Defines the properties represented in the TransactionExtensions object (JSON) or node (XML). Note that this message artifact is identical for each and every message type.

View Transaction Extension Details

Closing - MC247 - Funds Received

🌐 The following is an example payload to be posted in the body of the HTTP request.

/* Copyright © 2023 Mortgage Connect LP */
{
    "transactionHeader": {
        "transactionIdempotentId": "3B34A671-BB17-400D-90BF-7CBF9C96E8ED",
        "transactionDate": "2023-08-25T11:29:29",
        "clientCode": "1799",
        "clientName": "AcmeInc",
        "vendorCode": "MC",
        "vendorName": "Mortgage Connect"
    },
    "transactionBody": {
        "transactionCode": "Funds-Received",
        "transactionId": "7832143",
        "productTransactionId": "",
        "orderNumber": "2429888",
        "productCode": "TTL",
        "comment": "Received funds by vendor - Aug 25 2023 11:29AM",
        "commentDate": "2023-08-25T11:29:23"
    },
    "transactionExtensions": {
        "transactionExtension": [
            {
                "key": "Client Specific Key 1",
                "value": "Client Specific Value 1"
            },
            {
                "key": "Client Specific Key 2",
                "value": "Client Specific Value 2"
            }
        ]
    }
}
/* Copyright © 2023 Mortgage Connect LP */

<!-- Copyright © 2023 Mortgage Connect LP -->
<root>
    <transactionHeader>
        <transactionIdempotentId>3B34A671-BB17-400D-90BF-7CBF9C96E8ED</transactionIdempotentId>
        <transactionDate>2023-08-25T11:29:29</transactionDate>
        <clientCode>1799</clientCode>
        <clientName>AcmeInc</clientName>
        <vendorCode>MC</vendorCode>
        <vendorName>Mortgage Connect</vendorName>
    </transactionHeader>
    <transactionBody>
        <transactionCode>Funds-Received</transactionCode>
        <transactionId>7832143</transactionId>
        <productTransactionId></productTransactionId>
        <orderNumber>2429888</orderNumber>
        <productCode>TTL</productCode>
        <comment>Received funds by vendor - Aug 25 2023 11:29AM</comment>
        <commentDate>2023-08-25T11:29:23</commentDate>
    </transactionBody>
    <transactionExtensions>
        <transactionExtension>
            <key>Client Specific Key 1</key>
            <value>Client Specific Value 1</value>
        </transactionExtension>
        <transactionExtension>
            <key>Client Specific Key 2</key>
            <value>Client Specific Value 1</value>
        </transactionExtension>
    </transactionExtensions>
</root>
<!-- Copyright © 2023 Mortgage Connect LP -->

👍 The request payload can be verified using the following validation schema.

The request payload JSON schema validation is under construction. 🚧

The request payload XML schema validation is under construction. 🚧

✅ The following is an 'Accepted' example payload to be returned in the HTTP response.

Accepted Acknowledgment payloads are typically message type agnostic.

Accepted Acknowledgment payloads are typically message type agnostic.

⛔ The following is a 'Rejected' example payload to be returned in the HTTP response.

Rejected Acknowledgment payloads are typically message type agnostic.

Rejected Acknowledgment payloads are typically message type agnostic.

The Funds Received API method is the mechanism in which Mortgage Connect notifies the Client that an order's funds have been received.

View Workflow Orchestration

Client URL

POST 🔒 To be determined during onboarding process.

Property Definitions - Transaction Header

Defines the properties represented in the Transaction Header object (JSON) or node (XML). Note that this message artifact is identical for each and every message type.

View Transaction Header Details

Property Definitions - Transaction Body

Defines the properties represented in the Transaction Body object (JSON) or node (XML).

Property	Requirement	Data Type	Min / Max	Description
transactionBody	Required			A parent object (JSON) or node (XML) that contains the transaction metadata.
transactionCode	Required	String	15 / 15	A static value of `Funds-Received`. The transaction code is meant to identify the message type and the context or action that should be taken. In this context it implies that funds have been received. Possible Values: Funds-Received
transactionId	Required	String	1 / 50	Represents the Client's unique order number.
productTransactionId	Optional	String	0 / 50	Represents the Client's unique product order number. Note that the `productTransactionId` field is not used in most circumstances. However, when there is a need to further differentiate order numbers at a product level, that share the same `transactionId`, (i.e. the primary order level id), then the `productTransactionId` can be used to ensure uniqueness across the integration transactions. This makes it possible for multiple orders of the same product type to be placed using the same `transactionId`. The use of the `productTransactionId` field and any specific workflow deviations will be vetted during the onboarding process.
orderNumber	Required	Integer		Represents Mortgage Connects unique order number.
productCode	Required	String	3 / 4	Represents Mortgage Connect's product code. Possible Values: LVR `LEGAL & VEString REPORT` PRT `PROPERTY REPORT` PUR `PURCHASE` TTL `TITLE INSURANCE` etc. Traditionally, clients use Mortgage Connects `Product Code` names and thus there is a one to one mapping relationship that is maintained by the client. However, Mortgage Connect is aware that our naming conventions may not resonate and that there are many inconsistencies in product code naming conventions and nomenclatures. It is for this reason that Mortgage Connect is able to map the client's product code to Mortgage Connect's product code to ease the transition. Any required product code mapping exercises will be addressed during the onboarding process. The supported `productCode`(s) are specific per integration and will be determined during the onboarding process. Note that the minimum/maximum length requirement of 3/4 is only applicable if using Mortgage Connect's internal product codes, otherwise when mapping to the client's product codes, the minimum/maximum is 1/50.
comment	Required	String	1 / 1000	A general comment indicating that funds have been received.
commentDate	Required	DateTime		The date when the funds were received.

Property Definitions - Transaction Extensions

Defines the properties represented in the TransactionExtensions object (JSON) or node (XML). Note that this message artifact is identical for each and every message type.

View Transaction Extension Details

Closing - MC250 - Funds Disbursed

🌐 The following is an example payload to be posted in the body of the HTTP request.

/* Copyright © 2023 Mortgage Connect LP */
{
    "transactionHeader": {
        "transactionIdempotentId": "3B34A671-BB17-400D-90BF-7CBF9C96E8ED",
        "transactionDate": "2022-07-11T02:03:40",
        "clientCode": "1799",
        "clientName": "AcmeInc",
        "vendorCode": "MC",
        "vendorName": "Mortgage Connect"
    },
    "transactionBody": {
        "transactionCode": "Funds-Disbursed",
        "transactionId": "7832143",
        "productTransactionId": "",
        "orderNumber": "2429888",
        "productCode": "CWI",
        "comment": "Funds disbursed",
        "commentDate": "2022-07-11T02:03:40"
    },
    "transactionExtensions": {
        "transactionExtension": [
            {
                "key": "Client Specific Key 1",
                "value": "Client Specific Value 1"
            },
            {
                "key": "Client Specific Key 2",
                "value": "Client Specific Value 2"
            }
        ]
    }
}
/* Copyright © 2023 Mortgage Connect LP */

<!-- Copyright © 2023 Mortgage Connect LP -->
<root>
    <transactionHeader>
        <transactionIdempotentId>3B34A671-BB17-400D-90BF-7CBF9C96E8ED</transactionIdempotentId>
        <transactionDate>2022-07-11T02:03:40</transactionDate>
        <clientCode>1799</clientCode>
        <clientName>AcmeInc</clientName>
        <vendorCode>MC</vendorCode>
        <vendorName>Mortgage Connect</vendorName>
    </transactionHeader>
    <transactionBody>
        <transactionCode>Funds-Disbursed</transactionCode>
        <transactionId>7832143</transactionId>
        <productTransactionId></productTransactionId>
        <orderNumber>2429888</orderNumber>
        <productCode>CWI</productCode>
        <comment>Funds disbursed</comment>
        <commentDate>2022-07-11T02:03:40</commentDate>
    </transactionBody>
    <transactionExtensions>
        <transactionExtension>
            <key>Client Specific Key 1</key>
            <value>Client Specific Value 1</value>
        </transactionExtension>
        <transactionExtension>
            <key>Client Specific Key 2</key>
            <value>Client Specific Value 1</value>
        </transactionExtension>
    </transactionExtensions>
</root>
<!-- Copyright © 2023 Mortgage Connect LP -->

👍 The request payload can be verified using the following validation schema.

The request payload JSON schema validation is under construction. 🚧

The request payload XML schema validation is under construction. 🚧

✅ The following is an 'Accepted' example payload to be returned in the HTTP response.

Accepted Acknowledgment payloads are typically message type agnostic.

Accepted Acknowledgment payloads are typically message type agnostic.

⛔ The following is a 'Rejected' example payload to be returned in the HTTP response.

Rejected Acknowledgment payloads are typically message type agnostic.

Rejected Acknowledgment payloads are typically message type agnostic.

The Funds Disbursed API method is the mechanism in which Mortgage Connect notifies the Client that an order has been disbursed.

View Workflow Orchestration

Client URL

POST 🔒 To be determined during onboarding process.

Property Definitions - Transaction Header

Defines the properties represented in the Transaction Header object (JSON) or node (XML). Note that this message artifact is identical for each and every message type.

View Transaction Header Details

Property Definitions - Transaction Body

Defines the properties represented in the Transaction Body object (JSON) or node (XML).

Property	Requirement	Data Type	Min / Max	Description
transactionBody	Required			A parent object (JSON) or node (XML) that contains the transaction metadata.
transactionCode	Required	String	15 / 15	A static value of `Funds-Disbursed`. The transaction code is meant to identify the message type and the context or action that should be taken. In this context it implies that funds have been disbused. Possible Values: Funds-Disbursed
transactionId	Required	String	1 / 50	Represents the Client's unique order number.
productTransactionId	Optional	String	0 / 50	Represents the Client's unique product order number. Note that the `productTransactionId` field is not used in most circumstances. However, when there is a need to further differentiate order numbers at a product level, that share the same `transactionId`, (i.e. the primary order level id), then the `productTransactionId` can be used to ensure uniqueness across the integration transactions. This makes it possible for multiple orders of the same product type to be placed using the same `transactionId`. The use of the `productTransactionId` field and any specific workflow deviations will be vetted during the onboarding process.
orderNumber	Required	Integer		Represents Mortgage Connects unique order number.
productCode	Required	String	3 / 4	Represents Mortgage Connect's product code. Possible Values: LVR `LEGAL & VEString REPORT` PRT `PROPERTY REPORT` PUR `PURCHASE` TTL `TITLE INSURANCE` etc. Traditionally, clients use Mortgage Connects `Product Code` names and thus there is a one to one mapping relationship that is maintained by the client. However, Mortgage Connect is aware that our naming conventions may not resonate and that there are many inconsistencies in product code naming conventions and nomenclatures. It is for this reason that Mortgage Connect is able to map the client's product code to Mortgage Connect's product code to ease the transition. Any required product code mapping exercises will be addressed during the onboarding process. The supported `productCode`(s) are specific per integration and will be determined during the onboarding process. Note that the minimum/maximum length requirement of 3/4 is only applicable if using Mortgage Connect's internal product codes, otherwise when mapping to the client's product codes, the minimum/maximum is 1/50.
comment	Required	String	1 / 1000	A general comment indicating that funds have been disbursed.
commentDate	Required	DateTime		The date when the funds were disbursed.

Property Definitions - Transaction Extensions

Defines the properties represented in the TransactionExtensions object (JSON) or node (XML). Note that this message artifact is identical for each and every message type.

View Transaction Extension Details

Closing - MC260 - Send To Record

🌐 The following is an example payload to be posted in the body of the HTTP request.

/* Copyright © 2023 Mortgage Connect LP */
{
    "transactionHeader": {
        "transactionIdempotentId": "3B34A671-BB17-400D-90BF-7CBF9C96E8ED",
        "transactionDate": "2023-08-16T03:55:00",
        "clientCode": "1799",
        "clientName": "AcmeInc",
        "vendorCode": "MC",
        "vendorName": "Mortgage Connect"
    },
    "transactionBody": {
        "transactionCode": "Send-To-Record",
        "transactionId": "7832143",
        "productTransactionId": "",
        "orderNumber": 2429888,
        "productCode": "CWI",
        "comment": "Your Order has been Send for Recording\nDelivery Method Type: ElectronicDelivery\nDelivery Tracking Identifier: ONLINE",
        "commentDate": "2023-08-08T16:02:40"
    },
    "transactionExtensions": {
        "transactionExtension": [
            {
                "key": "Client Specific Key 1",
                "value": "Client Specific Value 1"
            },
            {
                "key": "Client Specific Key 2",
                "value": "Client Specific Value 2"
            }
        ]
    }
}
/* Copyright © 2023 Mortgage Connect LP */

<!-- Copyright © 2023 Mortgage Connect LP -->
<root>
    <transactionHeader>
        <transactionIdempotentId>3B34A671-BB17-400D-90BF-7CBF9C96E8ED</transactionIdempotentId>
        <transactionDate>2023-08-16T03:55:00/transactionDate>
        <clientCode>1799</clientCode>
        <clientName>AcmeInc</clientName>
        <vendorCode>MC</vendorCode>
        <vendorName>Mortgage Connect</vendorName>
    </transactionHeader>
    <transactionBody>
        <transactionCode>Send-To-Record</transactionCode>
        <transactionId>7832143</transactionId>
        <productTransactionId></productTransactionId>
        <orderNumber>2429888</orderNumber>
        <productCode>CWI</productCode>
        <comment>Your Order has been Send for Recording\nDelivery Method Type: ElectronicDelivery\nDelivery Tracking Identifier: ONLINE</comment>
        <commentDate>2023-08-08T16:02:40</commentDate>
    </transactionBody>
    <transactionExtensions>
        <transactionExtension>
            <key>Client Specific Key 1</key>
            <value>Client Specific Value 1</value>
        </transactionExtension>
        <transactionExtension>
            <key>Client Specific Key 2</key>
            <value>Client Specific Value 1</value>
        </transactionExtension>
    </transactionExtensions>
</root>
<!-- Copyright © 2023 Mortgage Connect LP -->

👍 The request payload can be verified using the following validation schema.

The request payload JSON schema validation is under construction. 🚧

The request payload XML schema validation is under construction. 🚧

✅ The following is an 'Accepted' example payload to be returned in the HTTP response.

Accepted Acknowledgment payloads are typically message type agnostic.

Accepted Acknowledgment payloads are typically message type agnostic.

⛔ The following is a 'Rejected' example payload to be returned in the HTTP response.

Rejected Acknowledgment payloads are typically message type agnostic.

Rejected Acknowledgment payloads are typically message type agnostic.

The Send To Record API method is the mechanism in which Mortgage Connect notifies the Client that the order was sent to be recorded.

View Workflow Orchestration

Client URL

POST 🔒 To be determined during onboarding process.

Property Definitions - Transaction Header

Defines the properties represented in the Transaction Header object (JSON) or node (XML). Note that this message artifact is identical for each and every message type.

View Transaction Header Details

Property Definitions - Transaction Body

Defines the properties represented in the Transaction Body object (JSON) or node (XML).

Property	Requirement	Data Type	Min / Max	Description
transactionBody	Required			A parent object (JSON) or node (XML) that contains the transaction metadata.
transactionCode	Required	String	14 / 14	A static value of `Send-To-Record`. The transaction code is meant to identify the message type and the context or action that should be taken. In this context it implies that the order was sent to be recorded. Possible Values: Send-To-Record
transactionId	Required	String	1 / 50	Represents the Client's unique order number.
productTransactionId	Optional	String	0 / 50	Represents the Client's unique product order number. Note that the `productTransactionId` field is not used in most circumstances. However, when there is a need to further differentiate order numbers at a product level, that share the same `transactionId`, (i.e. the primary order level id), then the `productTransactionId` can be used to ensure uniqueness across the integration transactions. This makes it possible for multiple orders of the same product type to be placed using the same `transactionId`. The use of the `productTransactionId` field and any specific workflow deviations will be vetted during the onboarding process.
orderNumber	Required	Integer		Represents Mortgage Connects unique order number.
productCode	Required	String	3 / 4	Represents Mortgage Connect's product code. Possible Values: LVR `LEGAL & VEString REPORT` PRT `PROPERTY REPORT` PUR `PURCHASE` TTL `TITLE INSURANCE` etc. Traditionally, clients use Mortgage Connects `Product Code` names and thus there is a one to one mapping relationship that is maintained by the client. However, Mortgage Connect is aware that our naming conventions may not resonate and that there are many inconsistencies in product code naming conventions and nomenclatures. It is for this reason that Mortgage Connect is able to map the client's product code to Mortgage Connect's product code to ease the transition. Any required product code mapping exercises will be addressed during the onboarding process. The supported `productCode`(s) are specific per integration and will be determined during the onboarding process. Note that the minimum/maximum length requirement of 3/4 is only applicable if using Mortgage Connect's internal product codes, otherwise when mapping to the client's product codes, the minimum/maximum is 1/50.
comment	Required	String	1 / 1000	A general comment providing details about the order being sent to be recorded.
commentDate	Required	DateTime		The date when the order was sent to be recorded.

Property Definitions - Transaction Extensions

Defines the properties represented in the TransactionExtensions object (JSON) or node (XML). Note that this message artifact is identical for each and every message type.

View Transaction Extension Details

Closing - MC270 - Completed Recording

🌐 The following is an example payload to be posted in the body of the HTTP request.

/* Copyright © 2023 Mortgage Connect LP */
{
    "transactionHeader": {
        "transactionIdempotentId": "3B34A671-BB17-400D-90BF-7CBF9C96E8ED",
        "transactionDate": "2023-08-16T03:55:00",
        "clientCode": "1799",
        "clientName": "AcmeInc",
        "vendorCode": "MC",
        "vendorName": "Mortgage Connect"
    },
    "transactionBody": {
        "transactionCode": "Completed-Recording",
        "transactionId": "7832143",
        "productTransactionId": "",
        "orderNumber": 2429888,
        "productCode": "CWI",
        "recordings": {
            "recording": {
                "recordingFeeAmount": "200000.00",
                "firstPageNumberValue": "0",
                "recordedDatetime": "2023-08-16T00:00:00",
                "recordingType": "CorrectiveEndorsement",
                "volumeIdentifier": "See Inst",
                "volumeType": "Mortgage/Deed of Trust"
            }
         }
    },
    "transactionExtensions": {
        "transactionExtension": [
            {
                "key": "Client Specific Key 1",
                "value": "Client Specific Value 1"
            },
            {
                "key": "Client Specific Key 2",
                "value": "Client Specific Value 2"
            }
        ]
    }
}
/* Copyright © 2023 Mortgage Connect LP */

<!-- Copyright © 2023 Mortgage Connect LP -->
<root>
    <transactionHeader>
        <transactionIdempotentId>3B34A671-BB17-400D-90BF-7CBF9C96E8ED</transactionIdempotentId>
        <transactionDate>2023-08-16T03:55:00/transactionDate>
        <clientCode>1799</clientCode>
        <clientName>AcmeInc</clientName>
        <vendorCode>MC</vendorCode>
        <vendorName>Mortgage Connect</vendorName>
    </transactionHeader>
    <transactionBody>
        <transactionCode>Completed-Recording</transactionCode>
        <transactionId>7832143</transactionId>
        <productTransactionId></productTransactionId>
        <orderNumber>2429888</orderNumber>
        <productCode>CWI</productCode>
        <recordings>
            <recording>
                <recordingFeeAmount>200000.00</recordingFeeAmount>
                <firstPageNumberValue>0</firstPageNumberValue>
                <recordedDatetime>2023-08-16T00:00:00</recordedDatetime>
                <recordingType>CorrectiveEndorsement</recordingType>
                <volumeIdentifier>See Inst</volumeIdentifier>
                <volumeType>Mortgage/Deed of Trust</volumeType>
            </recording>
        </recordings>
    </transactionBody>
    <transactionExtensions>
        <transactionExtension>
            <key>Client Specific Key 1</key>
            <value>Client Specific Value 1</value>
        </transactionExtension>
        <transactionExtension>
            <key>Client Specific Key 2</key>
            <value>Client Specific Value 1</value>
        </transactionExtension>
    </transactionExtensions>
</root>
<!-- Copyright © 2023 Mortgage Connect LP -->

👍 The request payload can be verified using the following validation schema.

The request payload JSON schema validation is under construction. 🚧

The request payload XML schema validation is under construction. 🚧

✅ The following is an 'Accepted' example payload to be returned in the HTTP response.

Accepted Acknowledgment payloads are typically message type agnostic.

Accepted Acknowledgment payloads are typically message type agnostic.

⛔ The following is a 'Rejected' example payload to be returned in the HTTP response.

Rejected Acknowledgment payloads are typically message type agnostic.

Rejected Acknowledgment payloads are typically message type agnostic.

The Completed Recording API method is the mechanism in which Mortgage Connect notifies the Client that the recording has been completed.

View Workflow Orchestration

Client URL

POST 🔒 To be determined during onboarding process.

Property Definitions - Transaction Header

Defines the properties represented in the Transaction Header object (JSON) or node (XML). Note that this message artifact is identical for each and every message type.

View Transaction Header Details

Property Definitions - Transaction Body

Defines the properties represented in the Transaction Body object (JSON) or node (XML).

Property	Requirement	Data Type	Min / Max	Description
transactionBody	Required			A parent object (JSON) or node (XML) that contains the transaction metadata.
transactionCode	Required	String	14 / 14	A static value of `Initial-Closing-Disclosure`. The transaction code is meant to identify the message type and the context or action that should be taken. In this context it implies that the initial Closing Disclosure is completed and that the corresponding document is attached. Possible Values: Initial-Closing-Disclosure
transactionId	Required	String	1 / 50	Represents the Client's unique order number.
productTransactionId	Optional	String	0 / 50	Represents the Client's unique product order number. Note that the `productTransactionId` field is not used in most circumstances. However, when there is a need to further differentiate order numbers at a product level, that share the same `transactionId`, (i.e. the primary order level id), then the `productTransactionId` can be used to ensure uniqueness across the integration transactions. This makes it possible for multiple orders of the same product type to be placed using the same `transactionId`. The use of the `productTransactionId` field and any specific workflow deviations will be vetted during the onboarding process.
orderNumber	Required	Integer		Represents Mortgage Connects unique order number.
productCode	Required	String	3 / 4	Represents Mortgage Connect's product code. Possible Values: LVR `LEGAL & VEString REPORT` PRT `PROPERTY REPORT` PUR `PURCHASE` TTL `TITLE INSURANCE` etc. Traditionally, clients use Mortgage Connects `Product Code` names and thus there is a one to one mapping relationship that is maintained by the client. However, Mortgage Connect is aware that our naming conventions may not resonate and that there are many inconsistencies in product code naming conventions and nomenclatures. It is for this reason that Mortgage Connect is able to map the client's product code to Mortgage Connect's product code to ease the transition. Any required product code mapping exercises will be addressed during the onboarding process. The supported `productCode`(s) are specific per integration and will be determined during the onboarding process. Note that the minimum/maximum length requirement of 3/4 is only applicable if using Mortgage Connect's internal product codes, otherwise when mapping to the client's product codes, the minimum/maximum is 1/50.
recordings	Required			A parent object (JSON) or node (XML) that contains a recording. `(1 to 1)`
recording	Required			A parent object (JSON) or node (XML) that contains the metadata associated with a recording.
recordingFeeAmount	Required	Money		The recording fee amount.
firstPageNumberValue	Required	String	1 / 50	The first page number value of the recording.
recordedDatetime	Required	DateTime		Indicates when the recording was recorded.
recordingType	Required	String	1 / 25	Indicates the recording type. Possible Values: CorrectiveEndorsement
volumeIdentifier	Required	String	1 / 50	Represents the recording volume identifier.
volumeType	Required	String	1 / 60	Indicates the recording volume type.

Property Definitions - Transaction Extensions

Defines the properties represented in the TransactionExtensions object (JSON) or node (XML). Note that this message artifact is identical for each and every message type.

View Transaction Extension Details

Closing - MC180 - Order Complete

🌐 The following is an example payload to be posted in the body of the HTTP request.

/* Copyright © 2023 Mortgage Connect LP */
{
    "transactionHeader": {
        "transactionIdempotentId": "3B34A671-BB17-400D-90BF-7CBF9C96E8ED",
        "transactionDate": "2022-07-11T02:03:40",
        "clientCode": "1799",
        "clientName": "AcmeInc",
        "vendorCode": "MC",
        "vendorName": "Mortgage Connect"
    },
    "transactionBody": {
        "transactionCode": "Order-Complete",
        "transactionId": "7832143",
        "productTransactionId": "",
        "orderNumber": 2429888,
        "productCode": "CWI",
        "comment": "The order is complete.",
        "commentDate": "2022-07-11T02:03:40"
    },
    "transactionExtensions": {
        "transactionExtension": [
            {
                "key": "Client Specific Key 1",
                "value": "Client Specific Value 1"
            },
            {
                "key": "Client Specific Key 2",
                "value": "Client Specific Value 2"
            }
        ]
    }
}
/* Copyright © 2023 Mortgage Connect LP */

<!-- Copyright © 2023 Mortgage Connect LP -->
<root>
    <transactionHeader>
        <transactionIdempotentId>3B34A671-BB17-400D-90BF-7CBF9C96E8ED</transactionIdempotentId>
        <transactionDate>022-07-11T02:03:40</transactionDate>
        <clientCode>1799</clientCode>
        <clientName>AcmeInc</clientName>
        <vendorCode>MC</vendorCode>
        <vendorName>Mortgage Connect</vendorName>
    </transactionHeader>
    <transactionBody>
        <transactionCode>Order-Complete</transactionCode>
        <transactionId>7832143</transactionId>
        <productTransactionId></productTransactionId>
        <orderNumber>2429888</orderNumber>
        <productCode>CWI</productCode>
        <comment>The order is complete.</comment>
        <commentDate>2022-07-11T02:03:40</commentDate>
    </transactionBody>
    <transactionExtensions>
        <transactionExtension>
            <key>Client Specific Key 1</key>
            <value>Client Specific Value 1</value>
        </transactionExtension>
        <transactionExtension>
            <key>Client Specific Key 2</key>
            <value>Client Specific Value 1</value>
        </transactionExtension>
    </transactionExtensions>
</root>
<!-- Copyright © 2023 Mortgage Connect LP -->

👍 The request payload can be verified using the following validation schema.

The request payload JSON schema validation is under construction. 🚧

The request payload XML schema validation is under construction. 🚧

✅ The following is an 'Accepted' example payload to be returned in the HTTP response.

Accepted Acknowledgment payloads are typically message type agnostic.

Accepted Acknowledgment payloads are typically message type agnostic.

⛔ The following is a 'Rejected' example payload to be returned in the HTTP response.

Rejected Acknowledgment payloads are typically message type agnostic.

Rejected Acknowledgment payloads are typically message type agnostic.

The Order Complete API method is the mechanism in which Mortgage Connect can submit a message to the Client to indicate that the Title order is complete.

View Workflow Orchestration

Client URL

POST 🔒 To be determined during onboarding process.

Property Definitions - Transaction Header

Defines the properties represented in the Transaction Header object (JSON) or node (XML). Note that this message artifact is identical for each and every message type.

View Transaction Header Details

Property Definitions - Transaction Body

Defines the properties represented in the Transaction Body object (JSON) or node (XML).

Property	Requirement	Data Type	Min / Max	Description
transactionBody	Required			A parent object (JSON) or node (XML) that contains the transaction metadata.
transactionCode	Required	String	14 / 14	A static value of `Order-Complete`. The transaction code is meant to identify the message type and the context or action that should be taken. In this context it implies that a order has been completed. Possible Values: Order-Complete
transactionId	Required	String	1 / 50	Represents the Client's unique order number.
productTransactionId	Optional	String	0 / 50	Represents the Client's unique product order number. Note that the `productTransactionId` field is not used in most circumstances. However, when there is a need to further differentiate order numbers at a product level, that share the same `transactionId`, (i.e. the primary order level id), then the `productTransactionId` can be used to ensure uniqueness across the integration transactions. This makes it possible for multiple orders of the same product type to be placed using the same `transactionId`. The use of the `productTransactionId` field and any specific workflow deviations will be vetted during the onboarding process.
orderNumber	Required	Integer		Represents Mortgage Connects unique order number.
productCode	Required	String	3 / 4	Represents Mortgage Connect's product code. Possible Values: LVR `LEGAL & VEString REPORT` PRT `PROPERTY REPORT` PUR `PURCHASE` TTL `TITLE INSURANCE` etc. Traditionally, clients use Mortgage Connects `Product Code` names and thus there is a one to one mapping relationship that is maintained by the client. However, Mortgage Connect is aware that our naming conventions may not resonate and that there are many inconsistencies in product code naming conventions and nomenclatures. It is for this reason that Mortgage Connect is able to map the client's product code to Mortgage Connect's product code to ease the transition. Any required product code mapping exercises will be addressed during the onboarding process. The supported `productCode`(s) are specific per integration and will be determined during the onboarding process. Note that the minimum/maximum length requirement of 3/4 is only applicable if using Mortgage Connect's internal product codes, otherwise when mapping to the client's product codes, the minimum/maximum is 1/50.
comment	Required	String	1 / MAX	A general comment indicating that the order is complete.
commentDate	Required	DateTime		The date when the order was completed.

Property Definitions - Transaction Extensions

Defines the properties represented in the TransactionExtensions object (JSON) or node (XML). Note that this message artifact is identical for each and every message type.

View Transaction Extension Details

Default Title API

The following sections detail the Default Title API methods that are specific to Mortgage Connect's Title workflow pipeline.

Default Title - API Event Matrix

The following matrix details the API event matrix supported by the Integration Default Title API. The EventId is an internal Mortgage Connect code that the individual methods are often referenced by.

Client & Mortgage Connect Acknowledgments

The Integration Default Title workflow orchestration currently supports the following acknowledgment events. While technically speaking an Acknowledgment response is not an event, it is being loosely grouped in this category for documentation purposes.

EventId	Event Code	HTTP	Description
MC010 ⇄	Acknowledgment	POST	The `Acknowledgment` response is the mechanism in which the Client and Mortgage Connect can communicate that a message was processed succesfully or failed. In addition, exception information can be returned as well if applicable. These are essentially the response payloads returned in response to a request and are virtually the same for each request with a couple deviations that are outlined in the `MC010 - Acknowledgment` section. All events whether initiated by the Client or Mortgage Connect should return a `MC010 Acknowledgment` message. View Details

Client Initiated Events

The Integration Default Title workflow orchestration currently supports the following events that are to be initiated by the Client LOS and sent to the Mortgage Connect Integration API.

flowchart LR Client(Client LOS) -- POST --> API(MC Integration API)

EventId	Event Code	HTTP	Description
MC100 →	New-Order	POST	The `New Order` API method is the mechanism in which a Client can submit a request to Mortgage Connect to create a new Default Title order. View Details
MC117 →	Cancel-Order	POST	The `Cancel Order` API method is the mechanism in which a Client can submit a request to Mortgage Connect to cancel a Default Title order. View Details
MC120 →	Update-Order	POST	The `Update Order` API method is the mechanism in which a Client can submit a request to Mortgage Connect to update a Default Title order. View Details
MC125 ⇄	Date-Down	POST	The `Date-Down` API method is the mechanism in which a Client can submit a request to Mortgage Connect to add `Special Instructions` to a Default Title order . View Details
MC130 ⇄	Add-Note	POST	The `Add Note` API method is the mechanism in which a Client can submit a request to Mortgage Connect to annotated a Default Title order with notes. View Details
MC140 ⇄	Add-Note-Action	POST	The `Add Note Action` API method is the mechanism in which a Client can submit a request to Mortgage Connect to annotate a Default Title order with notes, with the expectation that Mortgage Connect needs to perform an urgent `Action` such as contacting the borrower. View Details
MC150 ⇄	Add-Attachment	POST	The `Add Attachment` API method is the mechanism in which a Client can submit a request to Mortgage Connect to add documents to a Default Title order. View Details
MC155 →	Revision-Request	POST	The `Revision-Request` API method is the mechanism in which a Client can submit a request to Mortgage Connect to provide a revised Default Title order product. View Details

Mortgage Connect Initiated Events

The Integration Default Title workflow orchestration currently supports the following events that are to be initiated by the Mortgage Connect Integration API and sent to the Client LOS.

flowchart RL API(MC Integration API) -- POST --> Client(Client LOS)

EventId	Event Code	HTTP	Description
MC110 ←	Order-Confirmation	POST	The `Order Confirmation` API method is the mechanism in which Mortgage Connect notifies the Client that a Default Title order has been created. This applies to new orders where `transactionIsAsynchronous` is true. View Details
MC122 ←	Hold-Order	POST	The `Hold Order` API method is the mechanism in which Mortgage Connect notifies the Client that a Default Title order has been placed on hold pending resolution of an issue. View Details
MC123 ←	Hold-Order-Resolved	POST	The `Hold Order-Resolved` API method is the mechanism in which Mortgage Connect notifies the Client that a Default Title order hold has been resolved. View Details
MC125 ⇄	Date-Down	POST	The `Date-Down` API method is the mechanism in which Mortgage Connect notifies the Client that `Special Instructions` were added to a Default Title order. View Details
MC130 ⇄	Add-Note	POST	The `Add Note` API method is the mechanism in which Mortgage Connect can submit a request to the Client containing Date-Down data and documents. View Details
MC140 ⇄	Add-Note-Action	POST	The `Add Note Action` API method is the mechanism in which Mortgage Connect can submit a request to the Client to annotate a Default Title order with notes, with the expectation that the Client needs to Perform an urgent `Action` such as contacting the borrower. View Details
MC150 ⇄	Add-Attachment	POST	The `Add Attachment` API method is the mechanism in which Mortgage Connect can submit a request to the Client to add documents to a Default Title order. View Details
MC158 ←	Servicing-Product-Delivery	POST	The `Servicing Product Delivery` API method is the mechanism in which Mortgage Connect can submit a request to the Client to deliver the `Title Data` and supporting metadata and documents. View Details
MC161 ←	Product-Delivery-Attachment	POST	The `Product Delivery Attachment` API method is the mechanism in which Mortgage Connect can submit a request to the Client to deliver the `Final Title Document` and supporting metadata and documents. View Details
MC162 ←	Mailing-Data	POST	The `Mailing-Data` API method is the mechanism in which Mortgage Connect can submit a request to the Client to deliver the `Mailing Data Response 10 day -30 day, After the product Delivery`. View Details
MC163 ←	Revised-Product-Delivery	POST	The `Revised-Product-Delivery` API method is the mechanism in which Mortgage Connect can submit a request to the Client to deliver the revised `Final Title Document` and supporting metadata and documents. View Details
MC166 ←	Invoice	POST	The `Invoice` API method is the mechanism in which Mortgage Connect can submit a request to the Client to deliver the `Invoice/Fees` and supporting metadata. View Details
MC168 ←	Graded-Title-Data	POST	The `Graded-Title-Data` API method is the mechanism in which Mortgage Connect can submit a request to the Client to deliver the `Graded Title Data` and supporting metadata. View Details
MC170 ←	Clear-Title	POST	The `Clear Title` API method is the mechanism in which Mortgage Connect can submit a request to the Client to deliver the `Title Clearance Status` and supporting metadata. View Details
MC175 ←	Recording-Data	POST	The `Recording-Data` API method is the mechanism in which Mortgage Connect can submit a request to the Client to deliver the `Mortgage Recording Data` and supporting metadata. View Details
MC180 ←	Order-Complete	POST	The `Order Complete` API method is the mechanism in which Mortgage Connect can submit a request to the Client to indicate that the Default Title order is complete. View Details
MC190 ←	Title-Policy	POST	The `Title Policy` API method is the mechanism in which Mortgage Connect can submit a request to the Client to deliver the `Final Title Policy` and supporting metadata. View Details

Default Title - API Message Structure

✅ The following is an example 'Message Envelope'.

/* Copyright © 2023 Mortgage Connect LP */
{
    "transactionHeader": {
        "transactionIdempotentId": "90039F81-73C1-4788-98BC-90553888D301",
        "transactionDate": "2022-07-11T02:03:40",
        "clientCode": "1799",
        "clientName": "AcmeInc",
        "vendorCode": "MC",
        "vendorName": "Mortgage Connect"
    },
    "transactionBody": {
        /* Message Type Specific Metadata Goes Here */
    },
    "transactionExtensions": {
        "transactionExtension": [
            {
                "key": "Client Specific Key 1",
                "value": "Client Specific Value 1"
            },
            {
                "key": "Client Specific Key 2",
                "value": "Client Specific Value 2"
            }
        ]
    }
}
/* Copyright © 2023 Mortgage Connect LP */

<!-- Copyright © 2023 Mortgage Connect LP -->
<root>
    <transactionHeader>
        <transactionIdempotentId>90039F81-73C1-4788-98BC-90553888D301</transactionIdempotentId>
        <transactionDate>022-07-11T02:03:40</transactionDate>
        <clientCode>1799</clientCode>
        <clientName>AcmeInc</clientName>
        <vendorCode>MC</vendorCode>
        <vendorName>Mortgage Connect</vendorName>
    </transactionHeader>
    <transactionBody>
        <!-- Message Type Specific Metadata Goes Here -->
    </transactionBody>
    <transactionExtensions>
        <transactionExtension>
            <key>Client Specific Key 1</key>
            <value>Client Specific Value 1</value>
        </transactionExtension>
        <transactionExtension>
            <key>Client Specific Key 2</key>
            <value>Client Specific Value 1</value>
        </transactionExtension>
    </transactionExtensions>
</root>
<!-- Copyright © 2023 Mortgage Connect LP -->

All of the messages are wrapped in a parent object which serves as the Message Envelope that encompasses all of the message's metadata.

Within the Message Envelope you will find three (3) root level objects.

Transaction Header (transactionHeader)
Transaction Body (transactionBody)
Transaction Extensions (transactionExtensions)

The Transaction Body on the other hand is message type specific and will be documentated separately in a section dedicated to each supported message type.

Property Definitions - Transaction Header

Defines the properties represented in the Transaction Header object (JSON) or node (XML). Note that this message artifact is identical for each and every message type.

Property	Requirement	Data Type	Min / Max	Description
transactionHeader	Required			A parent object (JSON) or node (XML) that contains the transaction header metadata.
transactionIdempotentId	Conditional	GUID		A new globally unique identifier to be generated per every single response. This value is used to ensure transactions are processed idempotently. Idempotent message identification is `NOT` currently implemented. However when a need for this feature bubbles up to the top and it is added to the development pipeline it will work as follows. The API supports idempotency for safely retrying requests without accidentally performing the same operation twice. This is useful when an API call is disrupted in transit and you do not receive a response. For example, if a request to create a new order does not respond due to a network connection error, you can retry the request with the same idempotency Id to guarantee that no more than one order is created. Idempotency works by saving the resulting status code and body of the first request made for any given idempotency Id, regardless of whether it succeeded or failed. Subsequent requests with the same idempotency Id will return the same result, including 500 errors. An idempotency key is a unique value generated by the client which the server uses to recognize subsequent retries of the same request. Idempotent Ids should be GUIDs to ensure uniqueness. Under consideration is also the ability to expire previously processed idempotent Ids, for example ignoring those that are 24 hours old or more. Thus enabling the same transaction to be sent again. Results are only saved if an API endpoint started executing. If incoming parameters failed validation, or the request conflicted with another that was executing concurrently, no idempotent result is saved because no API endpoint began execution. It is safe to retry these requests. All POST requests will accept idempotency keys. Sending idempotent Id in GET and DELETE requests has no effect, as these requests are idempotent by definition. `TransactionIdempotentId` will be required for all `POST` messages once this feature is implemented.
transactionDate	Required	DateTime		The date and time that is associated with the message request.
clientCode	Required	String		This represents Mortgage Connect's client code which uniquely identifies a client. Internally Mortgage Connect often refers to this property as the `ClientId`. A given integration can be associated with one or more `ClientCode`(s). As part of the onboarding process, the Client will need to map their client codes to Mortgage Connects `ClientCode`(s).
clientName	Required	String	1 / 100	This represents the name associated with the client. It is not uncommon for multiple clients, i.e. `ClientCode`(s) to be grouped under the same parent client and thus this field often reflects the parent name instead of individual branch names. This field is not technically of importance from a mapping perspective and is only included to aid in identifying the client when viewing the raw payload, versus memorizing or looking up the `ClientCode`.
vendorCode	Required	String	1 / 100	A code supplied by Mortgage Connect that uniquely identifes the `Integration Platform Instance` or `Tenant` being used to service the integration. Note that typically this value is static per integration.
vendorName	Required	String	1 / 100	A name supplied by Mortgage Connect that uniquely identifes the `Integration Platform Instance` or `Tenant` being used to service the integration. While this value is essentially synonymous to the `VendorCode` it is included for readability, much like the `ClientName` property.

Property Definitions - Transaction Body

Defines the properties represented in the Transaction Body object (JSON) or node (XML).

Property Definitions - Transaction Extensions

Defines the properties represented in the TransactionExtensions object (JSON) or node (XML). Note that this message artifact is identical for each and every message type.

Property	Requirement	Data Type	Min / Max	Description
transactionExtensions	Optional			A parent object (JSON) or node (XML) that contains a list of transaction extensions. `(0 to Many)`.
transactionExtension	Required			A parent object (JSON) or node (XML) that contains the metadata associated with a transaction extension.
key	Required	String	1 / 200	The key (i.e. name) that uniquely identifies the transaction extension.
value	Required	String	1 / MAX	The value that is associated with the transaction extension.

Default Title - API Workflow Orchestration

The following sections provide a graphical overview of the typical Default Title API worflow, from an API sequencing and orchestration perspective.

Default Title - MC010 - Acknowledgment

✅ The following is an 'Accepted' example payload to be returned in the HTTP response.

/* Copyright © 2023 Mortgage Connect LP */
{
    "transactionHeader": {
        "transactionIdempotentId": "D0039F81-73C1-4788-98BC-90553888D301",
        "transactionDate": "2022-07-11T02:03:40",
        "clientCode": "1799",
        "clientName": "AcmeInc",
        "vendorCode": "MC",
        "vendorName": "Mortgage Connect"
    },
    "transactionBody": {
        "transactionCode": "Acknowledgment",
        "transactionId": "7832143",
        "productTransactionId": "",
        "orderNumber": 2429888,
        "ackStatus": true,
        "ackMessage": "Accepted",
        "ackException": ""
    },
    "transactionExtensions": {
        "transactionExtension": [
            {
                "key": "Client Specific Key 1",
                "value": "Client Specific Value 1"
            },
            {
                "key": "Client Specific Key 2",
                "value": "Client Specific Value 2"
            }
        ]
    }
}
/* Copyright © 2023 Mortgage Connect LP */

<!-- Copyright © 2023 Mortgage Connect LP -->
<root>
        <transactionHeader>
                <transactionIdempotentId>D0039F81-73C1-4788-98BC-90553888D301</transactionIdempotentId>
                <transactionDate>022-07-11T02:03:40</transactionDate>
                <clientCode>1799</clientCode>
                <clientName>AcmeInc</clientName>
                <vendorCode>MC</vendorCode>
                <vendorName>Mortgage Connect</vendorName>
        </transactionHeader>
        <transactionBody>
                <transactionCode>Acknowledgment</transactionCode>
                <transactionId>7832143</transactionId>
                <productTransactionId></productTransactionId>
                <orderNumber>2429888</orderNumber>
                <ackStatus>true</ackStatus>
                <ackMessage>Accepted</ackMessage>
        <ackException></ackException>
        </transactionBody>
    <transactionExtensions>
        <transactionExtension>
            <key>Client Specific Key 1</key>
            <value>Client Specific Value 1</value>
        </transactionExtension>
        <transactionExtension>
            <key>Client Specific Key 2</key>
            <value>Client Specific Value 1</value>
        </transactionExtension>
    </transactionExtensions>
</root>
<!-- Copyright © 2023 Mortgage Connect LP -->

⛔ The following is a 'Rejected' example payload to be returned in the HTTP response.

/* Copyright © 2023 Mortgage Connect LP */
{
    "transactionHeader": {
        "transactionIdempotentId": "D0039F81-73C1-4788-98BC-90553888D301",
        "transactionDate": "2022-07-11T02:03:40",
        "clientCode": "1799",
        "clientName": "AcmeInc",
        "vendorCode": "MC",
        "vendorName": "Mortgage Connect"
    },
    "transactionBody": {
        "transactionCode": "Acknowledgment",
        "transactionId": "7832143",
        "orderNumber": 0,
        "ackStatus": false,
        "ackMessage": "Rejected",
        "ackException": "Invalid Credentials"
    },
    "transactionExtensions": {
        "transactionExtension": [
            {
                "key": "Client Specific Key 1",
                "value": "Client Specific Value 1"
            },
            {
                "key": "Client Specific Key 2",
                "value": "Client Specific Value 2"
            }
        ]
    }
}
/* Copyright © 2023 Mortgage Connect LP */

<!-- Copyright © 2023 Mortgage Connect LP -->
<root>
    <transactionHeader>
        <transactionIdempotentId>D0039F81-73C1-4788-98BC-90553888D301</transactionIdempotentId>
        <transactionDate>022-07-11T02:03:40</transactionDate>
        <clientCode>1799</clientCode>
        <clientName>AcmeInc</clientName>
        <vendorCode>MC</vendorCode>
        <vendorName>Mortgage Connect</vendorName>
    </transactionHeader>
    <transactionBody>
        <transactionCode>Acknowledgment</transactionCode>
        <transactionId>7832143</transactionId>
        <orderNumber>0</orderNumber>
        <ackStatus>false</ackStatus>
        <ackMessage>Rejected</ackMessage>
        <ackException>Invalid Credentials</ackException>
    </transactionBody>
    <transactionExtensions>
        <transactionExtension>
            <key>Client Specific Key 1</key>
            <value>Client Specific Value 1</value>
        </transactionExtension>
        <transactionExtension>
            <key>Client Specific Key 2</key>
            <value>Client Specific Value 1</value>
        </transactionExtension>
    </transactionExtensions>
</root>
<!-- Copyright © 2023 Mortgage Connect LP -->

👍 The response payload can be verified using the following validation schema.

/* Copyright © 2023 Mortgage Connect LP */
{
    "$schema": "http://json-schema.org/draft-07/schema#",
    "$id": "root",
    "description": "Copyright @ 2022 Mortgage Connect LP - Title & Tax Schema.",
    "type": "object",
    "additionalProperties": false,
    "properties": {
        "legalHeader": {
            "type": "object",
            "additionalProperties": false,
            "properties": {
                "version": {
                    "examples": [
                        "1.0.8.0"
                    ],
                    "type": "string",
                    "minLength": 1,
                    "maxLength": 20
                },
                "disclosingParty": {
                    "examples": [
                        "Copyright @ 2022 Mortgage Connect LP"
                    ],
                    "type": "string",
                    "minLength": 1,
                    "maxLength": 100
                },
                "proprietaryInformationAndConfidential": {
                    "examples": [
                        "Ownership of Proprietary Information. The Recipient agrees that it shall not receive any right, title or interest, or any license or right to use, the Disclosing Partys Proprietary Information, including, but not limited to, technology, ideas, concepts, drawings, documentation, designs, prototypes, processes, trade secrets, trademarks or other intellectual property rights therein, by implication or otherwise."
                    ],
                    "type": "string",
                    "minLength": 1,
                    "maxLength": 2000
                }
            },
            "required": [
                "version",
                "disclosingParty",
                "proprietaryInformationAndConfidential"
            ],
            "minProperties": 3,
            "maxProperties": 3
        },
        "transactionHeader": {
            "type": "object",
            "additionalProperties": false,
            "properties": {
                "transactionIdempotentId": {
                    "examples": [
                        "3B34A671-BB17-400D-90BF-7CBF9C96E8ED"
                    ],
                    "type": "string",
                    "minLength": 36,
                    "maxLength": 36,
                    "pattern": "^[\\da-fA-F]{8}-[\\da-fA-F]{4}-[\\da-fA-F]{4}-[\\da-fA-F]{4}-[\\da-fA-F]{12}$"
                },
                "transactionDate": {
                    "examples": [
                        "2022-07-11T02:03:40"
                    ],
                    "type": "string",
                    "format": "date-time"
                },
                "clientCode": {
                    "examples": [
                        "1799"
                    ],
                    "type": "string",
                    "minLength": 1,
                    "maxLength": 100,
                    "format": "integer"
                },
                "clientName": {
                    "examples": [
                        "AcmeInc"
                    ],
                    "type": "string",
                    "minLength": 1,
                    "maxLength": 100
                },
                "vendorCode": {
                    "examples": [
                        "MC"
                    ],
                    "type": "string",
                    "minLength": 1,
                    "maxLength": 100
                },
                "vendorName": {
                    "examples": [
                        "Mortgage Connect"
                    ],
                    "type": "string",
                    "minLength": 1,
                    "maxLength": 100
                }
            },
            "required": [
                "transactionIdempotentId",
                "transactionDate",
                "clientCode",
                "clientName",
                "vendorCode",
                "vendorName"
            ],
            "minProperties": 6,
            "maxProperties": 6
        },
        "transactionBody": {
            "if": {
                "properties": {
                    "ackStatus": {
                        "const": false
                    }
                }
            },
            "then": {
                "required": [
                    "transactionCode",
                    "ackStatus",
                    "ackMessage",
                    "ackException"
                ]
            },
            "else": {
                "required": [
                    "transactionCode",
                    "ackStatus",
                    "ackMessage"
                ]
            },
            "type": "object",
            "additionalProperties": false,
            "properties": {
                "transactionCode": {
                    "examples": [
                        "Acknowledgment"
                    ],
                    "type": "string",
                    "const": "Acknowledgment"
                },
                "transactionId": {
                    "examples": [
                        "7832143"
                    ],
                    "type": "string",
                    "minLength": 1,
                    "maxLength": 50
                },
                "productTransactionId": {
                    "examples": [
                        "7832143"
                    ],
                    "type": "string",
                    "minLength": 0,
                    "maxLength": 50
                },
                "orderNumber": {
                    "examples": [
                        "2429888"
                    ],
                    "type": "integer"
                },
                "ackStatus": {
                    "examples": [
                        true,
                        false
                    ],
                    "type": "boolean"
                },
                "ackMessage": {
                    "type": "string"
                },
                "ackException": {
                    "type": "string"
                },
                "responseType": {
                    "type": "string"
                },
                "response": {
                    "type": "object"
                }
            }
        },
        "transactionExtensions": {
            "type": "object",
            "properties": {
                "transactionExtension": {
                    "type": "array",
                    "items": {
                        "type": "object",
                        "additionalProperties": false,
                        "properties": {
                            "key": {
                                "examples": [
                                    "Client Specific Key"
                                ],
                                "type": "string",
                                "minLength": 1,
                                "maxLength": 200
                            },
                            "value": {
                                "examples": [
                                    "Client Specific Value"
                                ],
                                "type": "string",
                                "minLength": 1
                            }
                        },
                        "required": [
                            "key",
                            "value"
                        ],
                        "minProperties": 2,
                        "maxProperties": 2
                    },
                    "minItems": 0
                }
            }
        }
    },
    "required": [
        "transactionHeader",
        "transactionBody"
    ],
    "minProperties": 2,
    "maxProperties": 4
}
/* Copyright © 2023 Mortgage Connect LP */

<?xml version="1.0" encoding="utf-8"?>
<xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema">
    <xs:element name="root">
    <xs:complexType>
        <xs:sequence>
            <xs:element ref="legalHeader" minOccurs="0"/>
            <xs:element ref="transactionHeader"/>
            <xs:element name="transactionBody">
                <xs:complexType>
                    <xs:all>
                        <xs:element name="transactionCode" type="xs:string" fixed="Acknowledgment"/>
                        <xs:element ref="transactionId"/>
                        <xs:element name="productTransactionId" type="transactionId" minOccurs="0"/>
                        <xs:element name="orderNumber" type="orderNo" minOccurs="0"/>
                        <xs:element name="ackStatus" type="xs:boolean"/>
                        <xs:element name="ackMessage" type="xs:string"/>
                        <xs:element name="ackException" type="xs:string" minOccurs="0"/>
                        <xs:element name="responseType" type="xs:string" minOccurs="0"/>
                        <xs:element ref="ackResponse" minOccurs="0"/>
                    </xs:all>
                </xs:complexType>
            </xs:element>
            <xs:element ref="transactionExtensions" minOccurs="0" />
        </xs:sequence>
    </xs:complexType>
    </xs:element>
</xs:schema>

The Acknowledgment event is essentially the payload that is to be returned by all HTTP requests whether it was initialized by the Client or Mortgage Connect.

Property Definitions - Transaction Header

Defines the properties represented in the Transaction Header object (JSON) or node (XML). Note that this message artifact is identical for each and every message type.

View Transaction Header Details

Property Definitions - Transaction Body

Defines the properties represented in the Transaction Body object (JSON) or node (XML).

Property	Requirement	Data Type	Min / Max	Description
transactionBody	Required			A parent object (JSON) or node (XML) that contains the transaction metadata.
transactionCode	Required	String	14 / 14	A static value of `Acknowledgment`. The transaction code is meant to identify the message type and the context or action that should be taken. An `Acknowledgment` transaction code is unique from all other transaction codes in that the context is actually derived from the value of the `AckStatus` property. Possible Values: Acknowledgment
transactionId	Required	String	1 / 50	Represents the Client's unique order number.
productTransactionId	Optional	String	0 / 50	Represents the Client's unique product order number. Note that the `productTransactionId` field is not used in most circumstances. However, when there is a need to further differentiate order numbers at a product level, that share the same `transactionId`, (i.e. the primary order level id), then the `productTransactionId` can be used to ensure uniqueness across the integration transactions. This makes it possible for multiple orders of the same product type to be placed using the same `transactionId`. The use of the `productTransactionId` field and any specific workflow deviations will be vetted during the onboarding process.
orderNumber	Conditional	Integer		Represents Mortgage Connects unique order number. Note this property `Must` be populated in response to a `MC100 - New Order` message that is successfully processed `Synchronously`. For all other messages types, if the `OrderNumber` can be ascertained then it should be included, otherwise it should be set to zero (0) by default.
ackStatus	Required	Boolean		A boolean code indicating whether the request message was successfully processed. This is the property you should interrogate to determine if the message was successful or a failure. Possible Values: true false
ackMessage	Required	String	1 / MAX	A message indicating whether the request message was successfully processed. This property is typically just populated with `Success` or `Failure`. However, it can optionally be populated with additional metadata that provides additional context as to why it was a successful or failed message. It is for this reason you should key off of the `ackStatus` field to determine whether it was a successful or failed message. `Typical` Values: Accepted Rejected
ackException	Conditional	String	0 / MAX	A message that provides additional exception details in the event the message was not sucessfully processed. This property is only ever populated if the message failed to be processed and there are applicable exception details that are appropriate to share, such as `Invalid Credentials` when trying to authenticate the request.
responseType	Conditional	String	0 / MAX	The requested action has returned a response object of the type specified by this property's value. The response type is defined in the `Response Definition` section of the event providing the reponse. Currently applicable to the following events: N/A
response	Conditional	String	0 / MAX	A string containing the JSON or XML representation of the response object. The response object is defined in the `Response Definition` section of the event providing the reponse.

Property Definitions - Transaction Extensions

Defines the properties represented in the TransactionExtensions object (JSON) or node (XML). Note that this message artifact is identical for each and every message type.

View Transaction Extension Details

Default Title - MC100 - New Order

🌐 The following is an example payload to be posted in the body of the HTTP request.

/* Copyright © 2023 Mortgage Connect LP */
{
    "transactionHeader": {
        "transactionIdempotentId": "3B34A671-BB17-400D-90BF-7CBF9C96E8ED",
        "transactionDate": "2022-07-11T02:03:40",
        "clientCode": "1799",
        "clientName": "AcmeInc",
        "vendorCode": "MC",
        "vendorName": "Mortgage Connect"
    },
    "transactionBody": {
        "transactionCode": "New-Order",
        "transactionId": "7832143",
        "productTransactionId": "",
        "transactionIsAsynchronous": false,
        "productCode": "PRLM",
        "loanNumber": "73201-3433",
        "loanAmount": "200000",
        "originalLoanAmount": "59900",
        "unpaidPrincipalAmount": "158698",
        "salePrice": "210000",
        "loanType": "Loan Modification",
        "propertyType": "SingleFamily",
        "amortizationType": "Fixed",
        "expectedClosingDate": "2022-10-19T14:00:00",
        "cema": "CEMA loan option requested",
        "occupancyType": "Primary",
        "propertyAddress": {
            "address1": "1234 Main St",
            "address2": "Apt 1",
            "city": "Shawnee",
            "state": "CA",
            "zipCode": "93950",
            "county": "Monterey"
        },
        "borrowers": {
            "borrower": [
                {
                    "firstName": "Johnny",
                    "middleName": "J",
                    "lastName": "Doe",
                    "suffix": "Sr.",
                    "type": "Borrower",
                    "email": "johnnydoe@gmail.com",
                    "cellPhone": "724-323-4234",
                    "ssn": "111-11-1111",
                    "maritalStatus": "Married",
                    "language": "English",
                    "dateOfBirth": "1965-07-04",
                    "borrowerAddress": {
                        "address1": "1234 Main St",
                        "address2": "Apt1",
                        "city": "Shawnee",
                        "state": "CA",
                        "zipCode": "93950",
                        "county": "Monterey"
                    }
                },
                {
                    "firstName": "Janie",
                    "middleName": "J",
                    "lastName": "Doe",
                    "type": "Borrower",
                    "email": "janiedoe@gmail.com",
                    "cellPhone": "724-123-4545",
                    "ssn": "222-22-2222",
                    "maritalStatus": "Married",
                    "language": "English",
                    "dateOfBirth": "1967-09-22"
                }
            ]
        },
        "parties": {
            "party" : [
                {
                    "firstName": "John",
                    "lastName": "Doe",
                    "phone": "724-420-3341",
                    "email": "johndoe@acmeinc.com",
                    "role": "Processor"
                },
                {
                    "firstName": "Jane",
                    "lastName": "Doe",
                    "phone": "724-420-1833",
                    "email": "janedoe@acmeinc.com",
                    "role": "LoanOfficer"
                }
            ]
        },
        "lender": {
            "name": "Direct",
            "address": "26642 Towne Centre Dr",
            "city": "Lake Forest",
            "state": "CA",
            "zipCode": "92630"
        },
        "specialInstruction": "Conveyance of easement.",
        "investorType": "Fannie"
    },
    "transactionExtensions": {
        "transactionExtension": [
            {
                "key": "Client Specific Key 1",
                "value": "Client Specific Value 1"
            },
            {
                "key": "Client Specific Key 2",
                "value": "Client Specific Value 2"
            }
        ]
    }
}
/* Copyright © 2023 Mortgage Connect LP */

<!-- Copyright © 2023 Mortgage Connect LP -->
<root>
    <transactionHeader>
        <transactionIdempotentId>3B34A671-BB17-400D-90BF-7CBF9C96E8ED</transactionIdempotentId>
        <transactionDate>022-07-11T02:03:40</transactionDate>
        <clientCode>1799</clientCode>
        <clientName>AcmeInc</clientName>
        <vendorCode>MC</vendorCode>
        <vendorName>Mortgage Connect</vendorName>
    </transactionHeader>
    <transactionBody>
        <transactionCode>New-Order</transactionCode>
        <transactionId>7832143</transactionId>
        <productTransactionId></productTransactionId>
        <transactionIsAsynchronous>false</transactionIsAsynchronous>
        <productCode>PRLM</productCode>
        <loanNumber>73201-3433</loanNumber>
        <loanAmount>200000</loanAmount>
        <originalLoanAmount>59900</originalLoanAmount>
        <unpaidPrincipalAmount>158698</unpaidPrincipalAmount>
        <salePrice>210000</salePrice>
        <loanType>Loan Modification</loanType>
        <propertyType>SingleFamily</propertyType>
        <amortizationType>Fixed</amortizationType>
        <expectedClosingDate>2022-10-19T14:00:00</expectedClosingDate>
        <cema>CEMA loan option requested</cema>
        <occupancyType>Primary</occupancyType>
        <propertyAddress>
            <address1>1234 Main St</address1>
            <address2>Apt 1</address2>
            <city>Shawnee</city>
            <state>CA</state>
            <zipCode>93950</zipCode>
            <county>Monterey</county>
        </propertyAddress>
        <borrowers>
            <borrower>
                <firstName>Johnny</firstName>
                <middleName>J</middleName>
                <lastName>Doe</lastName>
                <suffix>Sr.</suffix>
                <type>Borrower</type>
                <email>johnnydoe@gmail.com</email>
                <cellPhone>724-323-4234</cellPhone>
                <ssn>111-11-1111</ssn>
                <maritalStatus>Married</maritalStatus>
                <language>English</language>
                <dateOfBirth>1965-07-04</dateOfBirth>
                <borrowerAddress>
                    <address1>100 Willow St</address1>
                    <address2>Suite 2</address2>
                    <city>Shawnee</city>
                    <state>CA</state>
                    <zipCode>93950</zipCode>
                    <county>Monterey</county>
                </borrowerAddress>
            </borrower>
            <borrower>
                <firstName>Janie</firstName>
                <middleName>J</middleName>
                <lastName>Doe</lastName>
                <type>Borrower</type>
                <email>janiedoe@gmail.com</email>
                <cellPhone>724-123-4545</cellPhone>
                <ssn>222-22-2222</ssn>
                <maritalStatus>Married</maritalStatus>
                <language>English</language>
                <dateOfBirth>1967-09-22</dateOfBirth>
            </borrower>
        </borrowers>
        <parties>
            <party>
                <firstName>John</firstName>
                <lastName>Doe</lastName>
                <phone>724-420-3341</phone>
                <email>johndoe@acmeinc.com</email>
                <role>Processor</role>
            </party>
            <party>
                <firstName>Jane</firstName>
                <lastName>Doe</lastName>
                <phone>724-420-1833</phone>
                <email>janedoe@acmeinc.com</email>
                <role>LoanOfficer</role>
            </party>
        </parties>
        <lender>
            <name>Direct</name>
            <address>26642 Towne Centre Dr</address>
            <city>Lake Forest</city>
            <state>CA</state>
            <zipCode>92630</zipCode>
        </lender>
        <specialInstruction>Conveyance of easement.</specialInstruction>
        <investorType>Fannie</investorType>
    </transactionBody>
    <transactionExtensions>
        <transactionExtension>
            <key>Client Specific Key 1</key>
            <value>Client Specific Value 1</value>
        </transactionExtension>
        <transactionExtension>
            <key>Client Specific Key 2</key>
            <value>Client Specific Value 1</value>
        </transactionExtension>
    </transactionExtensions>
</root>
<!-- Copyright © 2023 Mortgage Connect LP -->

👍 The request payload can be verified using the following validation schema.

/* Copyright © 2023 Mortgage Connect LP */
{
    "$schema": "http://json-schema.org/draft-07/schema#",
    "$id": "root",
    "description": "Copyright @ 2022 Mortgage Connect LP - Title & Tax Schema.",
    "type": "object",
    "additionalProperties": false,
    "properties": {
        "legalHeader": {
            "type": "object",
            "additionalProperties": false,
            "properties": {
                "version": {
                    "examples": [
                        "1.0.8.0"
                    ],
                    "type": "string",
                    "minLength": 1,
                    "maxLength": 20
                },
                "disclosingParty": {
                    "examples": [
                        "Copyright @ 2022 Mortgage Connect LP"
                    ],
                    "type": "string",
                    "minLength": 1,
                    "maxLength": 100
                },
                "proprietaryInformationAndConfidential": {
                    "examples": [
                        "Ownership of Proprietary Information. The Recipient agrees that it shall not receive any right, title or interest, or any license or right to use, the Disclosing Partys Proprietary Information, including, but not limited to, technology, ideas, concepts, drawings, documentation, designs, prototypes, processes, trade secrets, trademarks or other intellectual property rights therein, by implication or otherwise."
                    ],
                    "type": "string",
                    "minLength": 1,
                    "maxLength": 2000
                }
            },
            "required": [
                "version",
                "disclosingParty",
                "proprietaryInformationAndConfidential"
            ],
            "minProperties": 3,
            "maxProperties": 3
        },
        "transactionHeader": {
            "type": "object",
            "additionalProperties": false,
            "properties": {
                "transactionIdempotentId": {
                    "examples": [
                        "3B34A671-BB17-400D-90BF-7CBF9C96E8ED"
                    ],
                    "type": "string",
                    "minLength": 36,
                    "maxLength": 36,
                    "pattern": "^[\\da-fA-F]{8}-[\\da-fA-F]{4}-[\\da-fA-F]{4}-[\\da-fA-F]{4}-[\\da-fA-F]{12}$"
                },
                "transactionDate": {
                    "examples": [
                        "2022-07-11T02:03:40"
                    ],
                    "type": "string",
                    "format": "date-time"
                },
                "clientCode": {
                    "examples": [
                        "1799"
                    ],
                    "type": "string",
                    "minLength": 1,
                    "maxLength": 100,
                    "format": "integer"
                },
                "clientName": {
                    "examples": [
                        "AcmeInc"
                    ],
                    "type": "string",
                    "minLength": 1,
                    "maxLength": 100
                },
                "vendorCode": {
                    "examples": [
                        "MC"
                    ],
                    "type": "string",
                    "minLength": 1,
                    "maxLength": 100
                },
                "vendorName": {
                    "examples": [
                        "Mortgage Connect"
                    ],
                    "type": "string",
                    "minLength": 1,
                    "maxLength": 100
                }
            },
            "required": [
                "transactionIdempotentId",
                "transactionDate",
                "clientCode",
                "clientName",
                "vendorCode",
                "vendorName"
            ],
            "minProperties": 6,
            "maxProperties": 6
        },
        "transactionBody": {
            "title": "TransactionBody",
            "type": "object",
            "additionalProperties": false,
            "properties": {
                "transactionCode": {
                    "examples": [
                        "New-Order"
                    ],
                    "type": "string",
                    "const": "New-Order"
                },
                "transactionId": {
                    "examples": [
                        "7832143"
                    ],
                    "type": "string",
                    "minLength": 1,
                    "maxLength": 50
                },
                "productTransactionId": {
                    "examples": [
                        "7832143"
                    ],
                    "type": "string",
                    "minLength": 0,
                    "maxLength": 50
                },
                "transactionIsAsynchronous": {
                    "examples": [
                        true,
                        false
                    ],
                    "type": "boolean"
                },
                "productCode": {
                    "type": "string",
                    "minLength": 3,
                    "maxLength": 4,
                    "enum": [
                        "PRLM",
                        "PRLP",
                        "TTLP",
                        "TTLN"
                    ]
                },
                "loanNumber": {
                    "examples": [
                        "7313993"
                    ],
                    "type": "string",
                    "minLength": 1,
                    "maxLength": 64
                },
                "loanAmount": {
                    "examples": [
                        "0.00"
                    ],
                    "type": "string",
                    "format": "money"
                },
                "originalLoanAmount": {
                    "$ref": "root#/properties/transactionBody/properties/loanAmount"
                },
                "unpaidPrincipalAmount": {
                    "$ref": "root#/properties/transactionBody/properties/loanAmount"
                },
                "salePrice": {
                    "$ref": "root#/properties/transactionBody/properties/loanAmount"
                },
                "loanType": {
                    "type": "string",
                    "minLength": 1,
                    "maxLength": 24,
                    "enum": [
                        "Deed in Lieu", 
                        "Loan Modification", 
                        "Post-Foreclosure", 
                        "Pre Sale", 
                        "Pre-Foreclosure", 
                        "REO/Foreclosure", 
                        "TSG"
                    ]
                },
                "propertyType": {
                    "type": "string",
                    "maxLength": 64,
                    "enum": [
                        "Condominium",
                        "Cooperative",
                        "Manufactured",
                        "Multi-Family",
                        "Other",
                        "Residential",
                        "SingleFamily"
                    ]
                },
                "amortizationType": {
                    "type": "string",
                    "maxLength": 64,
                    "enum": [
                        "ARM",
                        "Fixed",
                        "Interest Only",
                        "Reverse",
                        ""
                    ]
                },
                "expectedClosingDate": {
                    "type": "string",
                    "format": "date-time"
                },
                "cema": {
                    "type": "string",
                    "maxLength": 100
                },
                "occupancyType": {
                    "type": "string",
                    "maxLength": 64,
                    "enum": [
                        "Primary",
                        "Secondary",
                        "Investment"
                    ]
                },
                "propertyAddress": {
                    "type": "object",
                    "additionalProperties": false,
                    "properties": {
                        "address1": {
                            "examples": [
                                "1204 New York Drive"
                            ],
                            "type": "string",
                            "maxLength": 32
                        },
                        "address2": {
                            "examples": [
                                "1204 New York Drive"
                            ],
                            "type": "string",
                            "maxLength": 32
                        },
                        "city": {
                            "examples": [
                                "Mckees Rocks"
                            ],
                            "type": "string",
                            "maxLength": 32
                        },
                        "state": {
                            "examples": [
                                "PA"
                            ],
                            "type": "string",
                            "enum": [
                                "AK",
                                "AL",
                                "AR",
                                "AS",
                                "AZ",
                                "CA",
                                "CO",
                                "CT",
                                "DC",
                                "DE",
                                "FL",
                                "FM",
                                "GA",
                                "GU",
                                "HI",
                                "IA",
                                "ID",
                                "IL",
                                "IN",
                                "KS",
                                "KY",
                                "LA",
                                "MA",
                                "MD",
                                "ME",
                                "MH",
                                "MI",
                                "MN",
                                "MO",
                                "MP",
                                "MS",
                                "MT",
                                "NC",
                                "ND",
                                "NE",
                                "NH",
                                "NJ",
                                "NM",
                                "NV",
                                "NY",
                                "OH",
                                "OK",
                                "OR",
                                "PA",
                                "PR",
                                "PW",
                                "RI",
                                "SC",
                                "SD",
                                "TN",
                                "TX",
                                "UT",
                                "VA",
                                "VI",
                                "VT",
                                "WA",
                                "WI",
                                "WV",
                                "WY"
                            ]
                        },
                        "zipCode": {
                            "examples": [
                                "15136"
                            ],
                            "type": "string",
                            "minLength": 5,
                            "maxLength": 5,
                            "pattern": "^[0-9]{5}$"
                        },
                        "county": {
                            "examples": [
                                "Allegheny"
                            ],
                            "type": "string",
                            "maxLength": 32
                        }
                    },
                    "required": [
                        "address1",
                        "city",
                        "state",
                        "zipCode"
                    ],
                    "minProperties": 4,
                    "maxProperties": 6
                },
                "borrowers": {
                    "type": "object",
                    "properties": {
                        "borrower": {
                            "type": "array",
                            "items": {
                                "title": "Borrower",
                                "type": "object",
                                "additionalProperties": false,
                                "properties": {
                                    "firstName": {
                                        "examples": [
                                            "John"
                                        ],
                                        "type": "string",
                                        "minLength": 1,
                                        "maxLength": 150
                                    },
                                    "middleName": {
                                        "examples": [
                                            "M"
                                        ],
                                        "type": "string",
                                        "minLength": 0,
                                        "maxLength": 150
                                    },
                                    "lastName": {
                                        "examples": [
                                            "Smith"
                                        ],
                                        "type": "string",
                                        "minLength": 1,
                                        "maxLength": 255
                                    },
                                    "suffix": {
                                        "examples": [
                                            "Sr."
                                        ],
                                        "type": "string",
                                        "minLength": 0,
                                        "maxLength": 4,
                                        "enum": [
                                            "II",
                                            "III",
                                            "Esq.",
                                            "Jr.",
                                            "M.D.",
                                            "P.A.",
                                            "Sr.",
                                            ""
                                        ]
                                    },
                                    "type": {
                                        "type": "string",
                                        "enum": [
                                            "Asset Management Company",
                                            "Asset Manager",
                                            "Assignee",
                                            "Assignor",
                                            "Attorney",
                                            "Bank Attorney",
                                            "Borrower",
                                            "Borrower/Buyer",
                                            "Builder",
                                            "Buyer",
                                            "Buyer Agent",
                                            "Buyer Attorney",
                                            "Buyer Title Company",
                                            "Buyers Broker",
                                            "Condo Association",
                                            "Custodian",
                                            "Foreclosed Party",
                                            "Investor",
                                            "LENDER",
                                            "Lender Loan Officer",
                                            "Listing Agent",
                                            "MC MC Auction Company",
                                            "Mortgage Connect Closer",
                                            "Non-HUD Borrower",
                                            "Non-Vested Signer",
                                            "Other",
                                            "Processor",
                                            "Property Access",
                                            "Real Estate Agent",
                                            "Real Estate Agent - Seller",
                                            "Seller",
                                            "Seller Attorney",
                                            "Sellers Broker",
                                            "Selling Agent",
                                            "Servicer",
                                            "Settlement Agent",
                                            "Title Company",
                                            "Underwriter",
                                            "Vested Signer - Non-Borrower"
                                        ]
                                    },
                                    "email": {
                                        "type": "string",
                                        "maxLength": 255,
                                        "format": "email"
                                    },
                                    "cellPhone": {
                                        "type": "string",
                                        "maxLength": 24
                                    },
                                    "ssn": {
                                        "type": "string",
                                        "maxLength": 128
                                    },
                                    "maritalStatus": {
                                        "type": "string",
                                        "enum": [
                                            "Divorced",
                                            "Married",
                                            "Separated",
                                            "Single",
                                            "Widowed",
                                            ""
                                        ]
                                    },
                                    "language": {
                                        "type": "string",
                                        "enum": [
                                            "English",
                                            "Spanish"
                                        ]
                                    },
                                    "dateOfBirth": {
                                        "type": "string",
                                        "format": "date"
                                    },
                                    "borrowerAddress": {
                                        "$ref": "root#/properties/transactionBody/properties/propertyAddress"
                                    }
                                },
                                "required": [
                                    "firstName",
                                    "lastName",
                                    "type"
                                ]
                            },
                            "minItems": 1
                        }
                    }
                },
                "parties": {
                    "type": "object",
                    "properties": {
                        "party": {
                            "type": "array",
                            "items": {
                                "title": "Party",
                                "type": "object",
                                "additionalProperties": false,
                                "properties": {
                                    "sequenceNo": {
                                        "type": "integer"
                                    },
                                    "firstName": {
                                        "type": "string",
                                        "maxLength": 150
                                    },
                                    "lastName": {
                                        "type": "string",
                                        "maxLength": 150
                                    },
                                    "phone": {
                                        "type": "string",
                                        "maxLength": 24
                                    },
                                    "email": {
                                        "type": "string",
                                        "maxLength": 255,
                                        "format": "email"
                                    },
                                    "role": {
                                        "type": "string",
                                        "enum": [
                                            "Closer",
                                            "LoanOfficer",
                                            "LoanOfficerAssistant",
                                            "Other",
                                            "Processor",
                                            "ProcessorAssistant",
                                            "Underwriter",
                                            "User"
                                        ]
                                    }
                                },
                                "required": [
                                    "firstName",
                                    "lastName",
                                    "role"
                                ]
                            }
                        }
                    }
                },
                "lender": {
                    "title": "Lender",
                    "type": "object",
                    "additionalProperties": false,
                    "properties": {
                        "name": {
                            "type": "string",
                            "maxLength": 255
                        },
                        "address": {
                            "examples": [
                                "1204 New York Drive"
                            ],
                            "type": "string",
                            "maxLength": 255
                        },
                        "city": {
                            "$ref": "root#/properties/transactionBody/properties/propertyAddress/properties/city"
                        },
                        "state": {
                            "$ref": "root#/properties/transactionBody/properties/propertyAddress/properties/state"
                        },
                        "zipCode": {
                            "$ref": "root#/properties/transactionBody/properties/propertyAddress/properties/zipCode"
                        }
                    },
                    "required": [
                        "address",
                        "city",
                        "state",
                        "zipCode"
                    ]
                },
                "specialInstruction": {
                    "type": "string"
                },
                "investorType": {
                    "type": "string"
                }
            },
            "required": [
                "transactionCode",
                "transactionId",
                "transactionIsAsynchronous",
                "productCode",
                "loanNumber",
                "loanType",
                "propertyAddress",
                "borrowers"
            ],
            "allOf": [
                {
                    "if": {
                        "properties": { "propertyType": { "enum": [ "Purchase" ] } }
                    },
                    "then": {
                        "required": [ "salePrice" ]
                    }
                },
                {
                    "if": {
                        "properties": {
                            "loanType": {
                                "enum": [
                                    "Equity",
                                    "Other",
                                    "Purchase",
                                    "Refinance",
                                    "Reverse"
                                ]
                            }
                        }
                    },
                    "then": {
                        "required": [ "propertyType", "occupancyType" ]
                    }
                }
            ]
        },
        "transactionExtensions": {
            "type": "object",
            "properties": {
                "transactionExtension": {
                    "type": "array",
                    "items": {
                        "type": "object",
                        "additionalProperties": false,
                        "properties": {
                            "key": {
                                "examples": [
                                    "Client Specific Key"
                                ],
                                "type": "string",
                                "minLength": 1,
                                "maxLength": 200
                            },
                            "value": {
                                "examples": [
                                    "Client Specific Value"
                                ],
                                "type": "string",
                                "minLength": 1
                            }
                        },
                        "required": [
                            "key",
                            "value"
                        ],
                        "minProperties": 2,
                        "maxProperties": 2
                    },
                    "minItems": 0
                }
            }
        }
    },
    "required": [
        "transactionHeader",
        "transactionBody"
    ],
    "minProperties": 2,
    "maxProperties": 4
}
/* Copyright © 2023 Mortgage Connect LP */

<?xml version="1.0" encoding="utf-8"?>
<xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema">
    <xs:element name="root">
    <xs:complexType>
        <xs:sequence>
            <xs:element ref="legalHeader" minOccurs="0"/>
            <xs:element ref="transactionHeader"/>
            <xs:element name="transactionBody">
                <xs:complexType>
                    <xs:all>
                        <xs:element name="transactionCode" type="xs:string" fixed="New-Order"/>
                        <xs:element ref="transactionId"/>
                        <xs:element name="productTransactionId" type="transactionId" minOccurs="0"/>
                        <xs:element name="transactionIsAsynchronous" type="xs:boolean"/>
                        <xs:element ref="productCode"/>
                        <xs:element ref="loanNumber"/>
                        <xs:element name="loanAmount" type="money" minOccurs="0"/>
                        <xs:element name="originalLoanAmount" type="money" minOccurs="0"/>
                        <xs:element name="unpaidPrincipalAmount" type="money" minOccurs="0"/>
                        <xs:element name="salePrice" type="money" minOccurs="0"/>
                        <xs:element ref="loanType"/>
                        <xs:element name="propertyType" type="propertyType" minOccurs="0"/>
                        <xs:element ref="amortizationType" minOccurs="0"/>
                        <xs:element name="expectedClosingDate" type="xs:dateTime" minOccurs="0"/>
                        <xs:element name="cema" minOccurs="0">
                            <xs:simpleType>
                                <xs:restriction base="xs:string">
                                    <xs:maxLength value="100"/>
                                </xs:restriction>
                            </xs:simpleType>
                        </xs:element>
                        <xs:element ref="occupancyType" minOccurs="0"/>
                        <xs:element name="propertyAddress" type="address"/>
                        <xs:element name="borrowers">
                            <xs:complexType>
                                <xs:sequence>
                                    <xs:element ref="borrower" maxOccurs="unbounded"/>
                                </xs:sequence>
                            </xs:complexType>
                        </xs:element>
                        <xs:element name="parties" minOccurs="0">
                            <xs:complexType>
                                <xs:sequence>
                                    <xs:element ref="party" maxOccurs="unbounded"/>
                                </xs:sequence>
                            </xs:complexType>
                        </xs:element>
                        <xs:element ref="lender" minOccurs="0"/>
                        <xs:element name="specialInstruction" type="xs:string" minOccurs="0"/>
                        <xs:element name="investorType" type="xs:string" minOccurs="0"/>
                    </xs:all>
                </xs:complexType>
            </xs:element>
            <xs:element ref="transactionExtensions" minOccurs="0"/>
        </xs:sequence>
    </xs:complexType>
    </xs:element>
</xs:schema>

✅ The following is an 'Accepted' example payload to be returned in the HTTP response.

Accepted Acknowledgment payloads are typically message type agnostic.

Accepted Acknowledgment payloads are typically message type agnostic.

⛔ The following is a 'Rejected' example payload to be returned in the HTTP response.

Rejected Acknowledgment payloads are typically message type agnostic.

Rejected Acknowledgment payloads are typically message type agnostic.

The New Order API method is the mechanism in which a Client can submit a message to Mortgage Connect to create a new Default Title Order.

View Workflow Orchestration

Mortgage Connect URL

POST 🔒 https://{BaseUrl}/Api/V1.0/{ClientCode}/SubmitMessage

Mortgage Connect URL Properties

Property	Requirement	Description
BaseUrl	Required	A unique base Url that represents a specific Mortgage Connect endpoint and targeted environment.
ClientCode	Required	A unique code assigned to all clients that is used for identification, authentication, and customization purposes.

Property Definitions - Transaction Header

Defines the properties represented in the Transaction Header object (JSON) or node (XML). Note that this message artifact is identical for each and every message type.

View Transaction Header Details

Property Definitions - Transaction Body

Defines the properties represented in the Transaction Body object (JSON) or node (XML).

Property	Requirement	Data Type	Min / Max	Description
transactionBody	Required			A parent object (JSON) or node (XML) that contains the transaction metadata.
transactionCode	Required	String	9 / 9	A static value of `New-Order`. The transaction code is meant to identify the message type and the context or action that should be taken. In this context it implies that a new Default Title Order should be placed. Possible Values: New-Order
transactionId	Required	String	1 / 50	Represents the Client's unique order number.
productTransactionId	Optional	String	0 / 50	Represents the Client's unique product order number. Note that the `productTransactionId` field is not used in most circumstances. However, when there is a need to further differentiate order numbers at a product level, that share the same `transactionId`, (i.e. the primary order level id), then the `productTransactionId` can be used to ensure uniqueness across the integration transactions. This makes it possible for multiple orders of the same product type to be placed using the same `transactionId`. The use of the `productTransactionId` field and any specific workflow deviations will be vetted during the onboarding process.
transactionIsAsynchronous	Required	Boolean		Indicates whether the transaction is processed asynchronously (i.e. `true`) or synchronously (i.e. `false`). The `New-Order` transaction is unique in that it is the only transaction that supports this feature. Synchronous (i.e `false`) processing might be perferred by some clients who's system architecture are dependent on receiving an actual `Order Number` at the time of order submission. If the transaction is processed asynchronous then an `Order-Confirmation` message will be sent to the client once the `New-Order` transaction is actually processed, which will contain the actual `Order Number`. Possible Values: true false
productCode	Required	String	3 / 4	Represents Mortgage Connect's product codes. Note that these are just an example subset of the many products Mortgage Connect supports. Possible Values: PRLM `Property Report Loan Mod` TSG `Trustee Sale Guarantee` PFCF `Pre-Foreclosure Report` PJR `Preliminary Judicial Report` etc. Traditionally, clients use Mortgage Connects `Product Code` names and thus there is a one to one mapping relationship that is maintained by the client. However, Mortgage Connect is aware that our naming conventions may not resonate and that there are many inconsistencies in product code naming conventions and nomenclatures. It is for this reason that Mortgage Connect is able to map the client's product code to Mortgage Connect's product code to ease the transition. Any required product code mapping exercises will be addressed during the onboarding process. The supported `productCode`(s) are specific per integration and will be determined during the onboarding process. Note that the minimum/maximum length requirement of 3/4 is only applicable if using Mortgage Connect's internal product codes, otherwise when mapping to the client's product codes, the minimum/maximum is 1/50. Note that from an ordering perspective, there often is a correlation and synchronization process that occurs between Default Title and Closing orders. Specifically, due to the typical workflow requirements of Mortgage Connect's Title Platform, if a Closing order is placed before a Default Title order, a temporary placeholder Default Title order is automatically created at the same time the Closing order request is received. In this scenario, it is assumed that the Default Title order request will be received shortly afterwards. At which time, the temporary placeholder Default Title order will be updated with the actual Default Title product type requested by the client. For example, assume a client sends a New Order request for a CWO (Closing Without Insurance - Loan Amount < 250K) or CWI (Closing With Insurance - Loan Amount > 250K) product prior to sending a New Order Default Title request. In this scenario, a TPLC (Title Place Holder) order will be placed as a temporary Default Title order and the requested Closing will also be placed. Later, if the client sends a New Order request for a PRT (Property Report) or TTL (Title Insurance) product, then the original TPLC (Title Place Holder) order will be updated with the actual Title product requested by the client. Lastly, it is important to recognize that this an example of one of many workflows (Originations, Default, Loss Mitigation, Originations) supported by Mortgage Connect and will not be applicable to all clients. Subsequently, these specific scenarios will vetted during the onboarding process and can be configured per client integration partner.
loanNumber	Required	String	1 / 64	The clients loan number `alpha-numeric`.
loanAmount	Optional	Money		The loan amount
originalLoanAmount	Optional	Money		The original Loan amount.
unpaidPrincipalAmount	Optional	Money		The unpaid principle amount `if any` in dollars.
salePrice	Conditional	Money		The property sale price. The `salePrice` is optional but is `Required` if the `loanType` is `Purchase`.
loanType	Required	String	1 / 24	The loan type. Possible Values: Deed in Lieu Loan Modification Post-Foreclosure Pre-Foreclosure Pre Sale REO/Foreclosure TSG
propertyType	Optional	String	0 / 64	The property usage type. Possible Values: Condominium Cooperative Manufactured Multi-Family Other PUD SingleFamily
amortizationType	Optional	String	0 / 64	The amortization type, i.e. how the loan will be paid. Possible Values: ARM Fixed Interest Only Reverse
expectedClosingDate	Optional	DateTime		The expected closing data `if known`. Format: `mm/dd/yyyy`
cema	Optional	String	0 / 100	Information regarding a CEMA (Consolidation, Extension and Modification Agreement) mortgage loan.
occupancyType	Optional	String	0 / 64	The occupancy type, i.e. how the property will be used Possible Values: Primary Secondary Investment
propertyAddress	Required	Object		A parent object (JSON) or node (XML) that contains metadata associated with a property address.
address1	Required	String	1 / 255	The property street address.
address2	Optional	String	0 / 255	The property street address 2.
city	Required	String	1 / 32	The property city name.
state	Required	String	2 / 2	The property state abbreviation. Possible Values: AK, AL, AR, AS, AZ, CA, CO, CT, DC, DE, FL, FM, GA, GU, HI, IA, ID, IL, IN, KS, KY, LA, MA, MD, ME, MH, MI, MN, MO, MP, MS, MT, NC, ND, NE, NH, NJ, NM, NV, NY, OH, OK, OR, PA, PR, PW, RI, SC, SD, TN, TX, UT, VA, VI, VT, WA, WI, WV, WY.
zipCode	Required	String	5 / 5	The property zip code.
county	Optional	String	0 / 32	The property county.
borrowers	Required	Array		A parent object (JSON) or node (XML) that contains a list of borrowers. `(1 to Many)` Note that the first borrower is assumed to `always` be the `Primary` borrower.
borrower	Required	Object		A parent object (JSON) or node (XML) that contains the metadata associated with a single borrower.
firstName	Required	String	1 / 150	The borrower’s first name.
middleName	Optional	String	0 / 150	The borrower’s middle name.
lastName	Required	String	1 / 255	The borrower’s last name.
suffix	Optional	String	0 / 4	The borrower's suffix. Possible Values: II III Esq. Jr. Sr.
type	Required	String	1 / 32	The borrower's type. Note that typically this value will be set to `Borrower`. Possible Values: Asset Management Company Asset Manager Assignee Assignor Attorney Bank Attorney Borrower Borrower/Buyer Builder Buyer Buyer Agent Buyer Attorney Buyer Title Company Buyers Broker Condo Association Custodian Foreclosed Party Investor LENDER Lender Loan Officer Listing Agent MC MC Auction Company Mortgage Connect Closer Non-HUD Borrower Non-Vested Signer Other Processor Property Access Real Estate Agent Real Estate Agent - Seller Seller Seller Attorney Sellers Broker Selling Agent Servicer Settlement Agent Title Company Underwriter Vested Signer - Non-Borrower
email	Optional	String	0 / 255	The borrower’s email address.
cellPhone	Optional	String	0 / 24	The borrower's cell phone number.
ssn	Optional	String	0 / 128	The borrower's social security number.
maritalStatus	Optional	String	0 / 128	The borrower’s marital status. Possible Values: Divorced Married Separated Single Widowed
language	Optional	String	0 / 100	The borrower’s natural language. Possible Values: English Spanish
dateOfBirth	Optional	DateTime		The borrower’s date of birth. Format: `mm/dd/yyyy`
borrowerAddress	Optional	Object		A parent object (JSON) or node (XML) that contains metadata associated with a borrower address.
address1	Required	String	1 / 255	The borrower street address.
address2	Optional	String	0 / 255	The borrower street address 2.
city	Required	String	1 / 32	The borrower city name.
state	Required	String	2 / 2	The borrower state abbreviation. Possible Values: AK, AL, AR, AS, AZ, CA, CO, CT, DC, DE, FL, FM, GA, GU, HI, IA, ID, IL, IN, KS, KY, LA, MA, MD, ME, MH, MI, MN, MO, MP, MS, MT, NC, ND, NE, NH, NJ, NM, NV, NY, OH, OK, OR, PA, PR, PW, RI, SC, SD, TN, TX, UT, VA, VI, VT, WA, WI, WV, WY.
zipCode	Required	String	5 / 5	The borrower zip code.
county	Optional	String	0 / 32	The borrower county.
parties	Optional	Array		A parent object (JSON) or node (XML) that contains a list of parties (i.e. those working on the loan). `(0 to Many)`
party	Optional	Object		A parent object (JSON) or node (XML) that contains the metadata associated with a single borrower.
firstName	Required	String	1 / 150	The party first name.
lastName	Required	String	1 / 255	The party last name.
phone	Optional	String	0 / 24	The party's phone number.
email	Optional	String	0 / 255	The party's email address.
role	Required	String	1 / 32	The party's role. Possible Values: Closer LoanOfficer Processor
lender	Optional	Array		A parent object (JSON) or node (XML) that contains the metadata associated with a single lender.
name	Optional	String	0 / 255	The lender's name.
address	Required	String	1 / 255	The lender's address.
city	Required	String	1 / 32	The lender's city.
state	Required	String	2 / 2	The lender's state.
zipCode	Required	String	5 / 5	The lender's zip code.
specialInstruction	Optional	String	0 / MAX	The special instruction associated with the Default Title. `(if applcable)`
investorType	Optional	String	0 / 24	The investor type. Possible Values: Fannie FNMA Freddie FHLMC Other

Property Definitions - Transaction Extensions

Defines the properties represented in the TransactionExtensions object (JSON) or node (XML). Note that this message artifact is identical for each and every message type.

View Transaction Extension Details

Default Title - MC110 - Order Confirmation

🌐 The following is an example payload to be posted in the body of the HTTP request.

/* Copyright © 2023 Mortgage Connect LP */
{
    "transactionHeader": {
        "transactionIdempotentId": "3B34A671-BB17-400D-90BF-7CBF9C96E8ED",
        "transactionDate": "2022-07-11T02:03:40",
        "clientCode": "1799",
        "clientName": "AcmeInc",
        "vendorCode": "MC",
        "vendorName": "Mortgage Connect"
    },
    "transactionBody": {
        "transactionCode": "Order-Confirmation",
        "transactionId": "7832143",
        "productTransactionId": "",
        "orderNumber": 2429888,
        "itemNumber": 1,
        "productCode": "PRLM",
        "loanNumber": "7313993"
    },
    "transactionExtensions": {
        "transactionExtension": [
            {
                "key": "Client Specific Key 1",
                "value": "Client Specific Value 1"
            },
            {
                "key": "Client Specific Key 2",
                "value": "Client Specific Value 2"
            }
        ]
    }
}
/* Copyright © 2023 Mortgage Connect LP */

<!-- Copyright © 2023 Mortgage Connect LP -->
<root>
    <transactionHeader>
        <transactionIdempotentId>3B34A671-Bb17-400D-90Bf-7Cbf9C96E8Ed</transactionIdempotentId>
        <transactionDate>2022-07-11T02:03:40</transactionDate>
        <clientCode>1799</clientCode>
        <clientName>Acmeinc</clientName>
        <vendorCode>MC</vendorCode>
        <vendorName>Mortgage Connect</vendorName>
    </transactionHeader>
    <transactionBody>
        <transactionCode>Order-Confirmation</transactionCode>
        <transactionId>7832143</transactionId>
        <productTransactionId></productTransactionId>
        <orderNumber>2429888</orderNumber>
        <itemNumber>1</itemNumber>
        <productCode>PRLM</productCode>
        <loanNumber>7313993</loanNumber>
    </transactionBody>
    <transactionExtensions>
        <transactionExtension>
            <key>Client Specific Key 1</key>
            <value>Client Specific Value 1</value>
        </transactionExtension>
        <transactionExtension>
            <key>Client Specific Key 2</key>
            <value>Client Specific Value 1</value>
        </transactionExtension>
    </transactionExtensions>
</root>
<!-- Copyright © 2023 Mortgage Connect LP -->

👍 The request payload can be verified using the following validation schema.

/* Copyright © 2023 Mortgage Connect LP */
{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "$id": "root",
  "description": "Copyright @ 2022 Mortgage Connect LP - Title & Tax Schema.",
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "legalHeader": {
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "version": {
          "examples": [
            "1.0.8.0"
          ],
          "type": "string",
          "minLength": 1,
          "maxLength": 20
        },
        "disclosingParty": {
          "examples": [
            "Copyright @ 2022 Mortgage Connect LP"
          ],
          "type": "string",
          "minLength": 1,
          "maxLength": 100
        },
        "proprietaryInformationAndConfidential": {
          "examples": [
            "Ownership of Proprietary Information. The Recipient agrees that it shall not receive any right, title or interest, or any license or right to use, the Disclosing Partys Proprietary Information, including, but not limited to, technology, ideas, concepts, drawings, documentation, designs, prototypes, processes, trade secrets, trademarks or other intellectual property rights therein, by implication or otherwise."
          ],
          "type": "string",
          "minLength": 1,
          "maxLength": 2000
        }
      },
      "required": [
        "version",
        "disclosingParty",
        "proprietaryInformationAndConfidential"
      ],
      "minProperties": 3,
      "maxProperties": 3
    },
    "transactionHeader": {
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "transactionIdempotentId": {
          "examples": [
            "3B34A671-BB17-400D-90BF-7CBF9C96E8ED"
          ],
          "type": "string",
          "minLength": 36,
          "maxLength": 36,
          "pattern": "^[\\da-fA-F]{8}-[\\da-fA-F]{4}-[\\da-fA-F]{4}-[\\da-fA-F]{4}-[\\da-fA-F]{12}$"
        },
        "transactionDate": {
          "examples": [
            "2022-07-11T02:03:40"
          ],
          "type": "string",
          "format": "date-time"
        },
        "clientCode": {
          "examples": [
            "1799"
          ],
          "type": "string",
          "minLength": 1,
          "maxLength": 100,
          "format": "integer"
        },
        "clientName": {
          "examples": [
            "AcmeInc"
          ],
          "type": "string",
          "minLength": 1,
          "maxLength": 100
        },
        "vendorCode": {
          "examples": [
            "MC"
          ],
          "type": "string",
          "minLength": 1,
          "maxLength": 100
        },
        "vendorName": {
          "examples": [
            "Mortgage Connect"
          ],
          "type": "string",
          "minLength": 1,
          "maxLength": 100
        }
      },
      "required": [
        "transactionIdempotentId",
        "transactionDate",
        "clientCode",
        "clientName",
        "vendorCode",
        "vendorName"
      ],
      "minProperties": 6,
      "maxProperties": 6
    },
    "transactionBody": {
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "transactionCode": {
          "examples": [
            "Order-Confirmation"
          ],
          "type": "string",
          "const": "Order-Confirmation"
        },
        "transactionId": {
          "examples": [
            "7832143"
          ],
          "type": "string",
          "minLength": 1,
          "maxLength": 50
        },
        "productTransactionId": {
          "examples": [
            "7832143"
          ],
          "type": "string",
          "minLength": 0,
          "maxLength": 50
        },
        "orderNumber": {
          "examples": [
            "2429888"
          ],
          "type": "integer"
        },
        "itemNumber": {
          "examples": [
            "1"
          ],
          "type": "integer",
          "minimum": 1.0,
          "maximum": 40.0
        },
        "productCode": {
          "type": "string",
          "minLength": 3,
          "maxLength": 4,
          "enum": [
            "PRLM",
            "PRLP",
            "TTLP",
            "TTLN"
          ]
        },
        "loanNumber": {
          "examples": [
            "7313993"
          ],
          "type": "string",
          "minLength": 1,
          "maxLength": 64
        }
      },
      "required": [
        "transactionCode",
        "transactionId",
        "orderNumber",
        "itemNumber",
        "productCode",
        "loanNumber"
      ]
    },
    "transactionExtensions": {
      "type": "object",
      "properties": {
        "transactionExtension": {
          "type": "array",
          "items": {
            "type": "object",
            "additionalProperties": false,
            "properties": {
              "key": {
                "examples": [
                  "Client Specific Key"
                ],
                "type": "string",
                "minLength": 1,
                "maxLength": 200
              },
              "value": {
                "examples": [
                  "Client Specific Value"
                ],
                "type": "string",
                "minLength": 1
              }
            },
            "required": [
              "key",
              "value"
            ],
            "minProperties": 2,
            "maxProperties": 2
          },
          "minItems": 0
        }
      }
    }
  },
  "required": [
    "transactionHeader",
    "transactionBody"
  ],
  "minProperties": 2,
  "maxProperties": 4
}
/* Copyright © 2023 Mortgage Connect LP */

<?xml version="1.0" encoding="utf-8"?>
<xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema">
  <xs:element name="root">
  <xs:complexType>
    <xs:sequence>
      <xs:element ref="legalHeader" minOccurs="0"/>
      <xs:element ref="transactionHeader"/>
      <xs:element name="transactionBody">
        <xs:complexType>
          <xs:all>
            <xs:element name="transactionCode" type="xs:string" fixed="Order-Confirmation"/>
            <xs:element ref="transactionId"/>
            <xs:element name="productTransactionId" type="transactionId" minOccurs="0"/>
            <xs:element name="orderNumber" type="orderNo"/>
            <xs:element name="itemNumber" type="itemNumber"/>
            <xs:element ref="productCode"/>
            <xs:element ref="loanNumber"/>
          </xs:all>
        </xs:complexType>
      </xs:element>
      <xs:element ref="transactionExtensions" minOccurs="0"/>
    </xs:sequence>
  </xs:complexType>
  </xs:element>
</xs:schema>

✅ The following is an 'Accepted' example payload to be returned in the HTTP response.

Accepted Acknowledgment payloads are typically message type agnostic.

Accepted Acknowledgment payloads are typically message type agnostic.

⛔ The following is a 'Rejected' example payload to be returned in the HTTP response.

Rejected Acknowledgment payloads are typically message type agnostic.

Rejected Acknowledgment payloads are typically message type agnostic.

View Workflow Orchestration

Client URL

POST 🔒 To be determined during onboarding process.

Property Definitions - Transaction Header

Defines the properties represented in the Transaction Header object (JSON) or node (XML). Note that this message artifact is identical for each and every message type.

View Transaction Header Details

Property Definitions - Transaction Body

Defines the properties represented in the Transaction Body object (JSON) or node (XML).

Property	Requirement	Data Type	Min / Max	Description
transactionBody	Required			A parent object (JSON) or node (XML) that contains the transaction metadata.
transactionCode	Required	String	14 / 14	A static value of `Order-Confirmation`. The transaction code is meant to identify the message type and the context or action that should be taken. An `Order-Confirmation` transaction code indicates that the previously submitted `New-Order` transaction was successfully processed. As part of the payload, Mortgage Connect's Order and Item Number will be returned. Possible Values: Order-Confirmation
transactionId	Required	String	1 / 50	Represents the Client's unique order number.
productTransactionId	Optional	String	0 / 50	Represents the Client's unique product order number. Note that the `productTransactionId` field is not used in most circumstances. However, when there is a need to further differentiate order numbers at a product level, that share the same `transactionId`, (i.e. the primary order level id), then the `productTransactionId` can be used to ensure uniqueness across the integration transactions. This makes it possible for multiple orders of the same product type to be placed using the same `transactionId`. The use of the `productTransactionId` field and any specific workflow deviations will be vetted during the onboarding process.
orderNumber	Required	Integer		Represents Mortgage Connects unique order number.
itemNumber	Required	Integer	Integer	Represents Mortgage Connects product sequencing number (i.e `1 through 40`) that is associated with each product ordered.
productCode	Required	String	3 / 4	Represents Mortgage Connect's product code. Possible Values: PRLM `Property Report Loan Mod` TSG `Trustee Sale Guarantee` PFCF `Pre-Foreclosure Report` PJR `Preliminary Judicial Report` etc. Traditionally, clients use Mortgage Connects `Product Code` names and thus there is a one to one mapping relationship that is maintained by the client. However, Mortgage Connect is aware that our naming conventions may not resonate and that there are many inconsistencies in product code naming conventions and nomenclatures. It is for this reason that Mortgage Connect is able to map the client's product code to Mortgage Connect's product code to ease the transition. Any required product code mapping exercises will be addressed during the onboarding process. The supported `productCode`(s) are specific per integration and will be determined during the onboarding process. Note that the minimum/maximum length requirement of 3/4 is only applicable if using Mortgage Connect's internal product codes, otherwise when mapping to the client's product codes, the minimum/maximum is 1/50.
loanNumber	Required	String	1 / 64	The client's loan number that is associated with the order.

Property Definitions - Transaction Extensions

Defines the properties represented in the TransactionExtensions object (JSON) or node (XML). Note that this message artifact is identical for each and every message type.

View Transaction Extension Details

Default Title - MC117 - Cancel Order

🌐 The following is an example payload to be posted in the body of the HTTP request.

/* Copyright © 2023 Mortgage Connect LP */
{
  "transactionHeader": {
      "transactionIdempotentId": "3B34A671-BB17-400D-90BF-7CBF9C96E8ED",
      "transactionDate": "2022-07-11T02:03:40",
      "clientCode": "1799",
      "clientName": "AcmeInc",
      "vendorCode": "MC",
      "vendorName": "Mortgage Connect"
  },
  "transactionBody": {
      "transactionCode": "Cancel-Order",
      "transactionId": "7832143",
      "productTransactionId": "",
      "orderNumber": 2429888,
      "productCode": "PRLM"
    },
    "transactionExtensions": {
        "transactionExtension": [
            {
                "key": "Client Specific Key 1",
                "value": "Client Specific Value 1"
            },
            {
                "key": "Client Specific Key 2",
                "value": "Client Specific Value 2"
            }
        ]
    }
}
/* Copyright © 2023 Mortgage Connect LP */

<!-- Copyright © 2023 Mortgage Connect LP -->
<root>
    <transactionHeader>
        <transactionIdempotentId>3B34A671-Bb17-400D-90Bf-7Cbf9C96E8Ed</transactionIdempotentId>
        <transactionDate>2022-07-11T02:03:40</transactionDate>
        <clientCode>1799</clientCode>
        <clientName>Acmeinc</clientName>
        <vendorCode>MC</vendorCode>
        <vendorName>Mortgage Connect</vendorName>
    </transactionHeader>
    <transactionBody>
        <transactionCode>Cancel-Order</transactionCode>
        <transactionId>7832143</transactionId>
        <productTransactionId></productTransactionId>
        <orderNumber>2429888</orderNumber>
        <productCode>PRLM</productCode>
  </transactionBody>
    <transactionExtensions>
        <transactionExtension>
            <key>Client Specific Key 1</key>
            <value>Client Specific Value 1</value>
        </transactionExtension>
        <transactionExtension>
            <key>Client Specific Key 2</key>
            <value>Client Specific Value 1</value>
        </transactionExtension>
    </transactionExtensions>
</root>
<!-- Copyright © 2023 Mortgage Connect LP -->

👍 The request payload can be verified using the following validation schema.

/* Copyright © 2023 Mortgage Connect LP */
{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "$id": "root",
  "description": "Copyright @ 2022 Mortgage Connect LP - Title & Tax Schema.",
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "legalHeader": {
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "version": {
          "examples": [
            "1.0.8.0"
          ],
          "type": "string",
          "minLength": 1,
          "maxLength": 20
        },
        "disclosingParty": {
          "examples": [
            "Copyright @ 2022 Mortgage Connect LP"
          ],
          "type": "string",
          "minLength": 1,
          "maxLength": 100
        },
        "proprietaryInformationAndConfidential": {
          "examples": [
            "Ownership of Proprietary Information. The Recipient agrees that it shall not receive any right, title or interest, or any license or right to use, the Disclosing Partys Proprietary Information, including, but not limited to, technology, ideas, concepts, drawings, documentation, designs, prototypes, processes, trade secrets, trademarks or other intellectual property rights therein, by implication or otherwise."
          ],
          "type": "string",
          "minLength": 1,
          "maxLength": 2000
        }
      },
      "required": [
        "version",
        "disclosingParty",
        "proprietaryInformationAndConfidential"
      ],
      "minProperties": 3,
      "maxProperties": 3
    },
    "transactionHeader": {
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "transactionIdempotentId": {
          "examples": [
            "3B34A671-BB17-400D-90BF-7CBF9C96E8ED"
          ],
          "type": "string",
          "minLength": 36,
          "maxLength": 36,
          "pattern": "^[\\da-fA-F]{8}-[\\da-fA-F]{4}-[\\da-fA-F]{4}-[\\da-fA-F]{4}-[\\da-fA-F]{12}$"
        },
        "transactionDate": {
          "examples": [
            "2022-07-11T02:03:40"
          ],
          "type": "string",
          "format": "date-time"
        },
        "clientCode": {
          "examples": [
            "1799"
          ],
          "type": "string",
          "minLength": 1,
          "maxLength": 100,
          "format": "integer"
        },
        "clientName": {
          "examples": [
            "AcmeInc"
          ],
          "type": "string",
          "minLength": 1,
          "maxLength": 100
        },
        "vendorCode": {
          "examples": [
            "MC"
          ],
          "type": "string",
          "minLength": 1,
          "maxLength": 100
        },
        "vendorName": {
          "examples": [
            "Mortgage Connect"
          ],
          "type": "string",
          "minLength": 1,
          "maxLength": 100
        }
      },
      "required": [
        "transactionIdempotentId",
        "transactionDate",
        "clientCode",
        "clientName",
        "vendorCode",
        "vendorName"
      ],
      "minProperties": 6,
      "maxProperties": 6
    },
    "transactionBody": {
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "transactionCode": {
          "examples": [
            "Cancel-Order"
          ],
          "type": "string",
          "const": "Cancel-Order"
        },
        "transactionId": {
          "examples": [
            "7832143"
          ],
          "type": "string",
          "minLength": 1,
          "maxLength": 50
        },
        "productTransactionId": {
          "examples": [
            "7832143"
          ],
          "type": "string",
          "minLength": 0,
          "maxLength": 50
        },
        "orderNumber": {
          "examples": [
            "2429888"
          ],
          "type": "integer"
        },
        "productCode": {
          "type": "string",
          "minLength": 3,
          "maxLength": 4,
          "enum": [
            "LVR",
            "PRT",
            "PUR",
            "TTL"
          ]
        }
      },
      "required": [
        "transactionCode",
        "transactionId",
        "orderNumber",
        "productCode",
      ]
    },
    "transactionExtensions": {
      "type": "object",
      "properties": {
        "transactionExtension": {
          "type": "array",
          "items": {
            "type": "object",
            "additionalProperties": false,
            "properties": {
              "key": {
                "examples": [
                  "Client Specific Key"
                ],
                "type": "string",
                "minLength": 1,
                "maxLength": 200
              },
              "value": {
                "examples": [
                  "Client Specific Value"
                ],
                "type": "string",
                "minLength": 1
              }
            },
            "required": [
              "key",
              "value"
            ],
            "minProperties": 2,
            "maxProperties": 2
          },
          "minItems": 0
        }
      }
    }
  },
  "required": [
    "transactionHeader",
    "transactionBody"
  ],
  "minProperties": 2,
  "maxProperties": 4
}
/* Copyright © 2023 Mortgage Connect LP */

<?xml version="1.0" encoding="utf-8"?>
<xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema">
  <xs:element name="root">
  <xs:complexType>
    <xs:sequence>
      <xs:element ref="legalHeader" minOccurs="0"/>
      <xs:element ref="transactionHeader"/>
      <xs:element name="transactionBody">
        <xs:complexType>
          <xs:all>
            <xs:element name="transactionCode" type="xs:string" fixed="Cancel-Order"/>
            <xs:element ref="transactionId"/>
            <xs:element name="productTransactionId" type="transactionId" minOccurs="0"/>
            <xs:element name="orderNumber" type="orderNo"/>
            <xs:element ref="productCode"/>
          </xs:all>
        </xs:complexType>
      </xs:element>
      <xs:element ref="transactionExtensions" minOccurs="0"/>
    </xs:sequence>
  </xs:complexType>
  </xs:element>
</xs:schema>

✅ The following is an 'Accepted' example payload to be returned in the HTTP response.

Accepted Acknowledgment payloads are typically message type agnostic.

Accepted Acknowledgment payloads are typically message type agnostic.

⛔ The following is a 'Rejected' example payload to be returned in the HTTP response.

Rejected Acknowledgment payloads are typically message type agnostic.

Rejected Acknowledgment payloads are typically message type agnostic.

The Cancel-Order API method is the mechanism in which a Client can submit a message to Mortgage Connect to cancel a Default Title Order.

The order to cancel is identified by the combination of the OrderNumber and ProductCode.

View Workflow Orchestration

Mortgage Connect URL

POST 🔒 https://{BaseUrl}/Api/V1.0/{ClientCode}/SubmitMessage

Mortgage Connect URL Properties

Property	Requirement	Description
BaseUrl	Required	A unique base Url that represents a specific Mortgage Connect endpoint and targeted environment.
ClientCode	Required	A unique code assigned to all clients that is used for identification, authentication, and customization purposes.

Property Definitions - Transaction Header

Defines the properties represented in the Transaction Header object (JSON) or node (XML). Note that this message artifact is identical for each and every message type.

View Transaction Header Details

Property Definitions - Transaction Body

Defines the properties represented in the Transaction Body object (JSON) or node (XML).

Property	Requirement	Data Type	Min / Max	Description
transactionBody	Required			A parent object (JSON) or node (XML) that contains the transaction metadata.
transactionCode	Required	String	12 / 12	A static value of `Cancel-Order`. The transaction code is meant to identify the message type and the context or action that should be taken. A `Cancel-Order` transaction code indicates that a Default Title Order should be canceled. Possible Values: Cancel-Order
transactionId	Required	String	1 / 50	Represents the Client's unique order number.
productTransactionId	Optional	String	0 / 50	Represents the Client's unique product order number. Note that the `productTransactionId` field is not used in most circumstances. However, when there is a need to further differentiate order numbers at a product level, that share the same `transactionId`, (i.e. the primary order level id), then the `productTransactionId` can be used to ensure uniqueness across the integration transactions. This makes it possible for multiple orders of the same product type to be placed using the same `transactionId`. The use of the `productTransactionId` field and any specific workflow deviations will be vetted during the onboarding process.
orderNumber	Required	Integer		Represents Mortgage Connects unique order number.
productCode	Required	String	3 / 4	Represents Mortgage Connect's product code. Possible Values: PRLM `Property Report Loan Mod` TSG `Trustee Sale Guarantee` PFCF `Pre-Foreclosure Report` PJR `Preliminary Judicial Report` etc. Traditionally, clients use Mortgage Connects `Product Code` names and thus there is a one to one mapping relationship that is maintained by the client. However, Mortgage Connect is aware that our naming conventions may not resonate and that there are many inconsistencies in product code naming conventions and nomenclatures. It is for this reason that Mortgage Connect is able to map the client's product code to Mortgage Connect's product code to ease the transition. Any required product code mapping exercises will be addressed during the onboarding process. The supported `productCode`(s) are specific per integration and will be determined during the onboarding process. Note that the minimum/maximum length requirement of 3/4 is only applicable if using Mortgage Connect's internal product codes, otherwise when mapping to the client's product codes, the minimum/maximum is 1/50.

Property Definitions - Transaction Extensions

Defines the properties represented in the TransactionExtensions object (JSON) or node (XML). Note that this message artifact is identical for each and every message type.

View Transaction Extension Details

Default Title - MC120 - Update Order

🌐 The following is an example payload to be posted in the body of the HTTP request.

/* Copyright © 2023 Mortgage Connect LP */
{
    "transactionHeader": {
        "transactionIdempotentId": "3B34A671-BB17-400D-90BF-7CBF9C96E8ED",
        "transactionDate": "2022-07-11T02:03:40",
        "clientCode": "1799",
        "clientName": "AcmeInc",
        "vendorCode": "MC",
        "vendorName": "Mortgage Connect"
    },
    "transactionBody": {
        "transactionCode": "Update-Order",
        "transactionId": "7832143",
        "productTransactionId": "",
        "orderNumber": 2429888,
        "productCode": "PRLM",
        "loanNumber": "73201-3433",
        "loanAmount": "200000",
        "originalLoanAmount": "59900",
        "unpaidPrincipalAmount": "158698",
        "salePrice": "210000",
        "loanType": "Loan Modification",
        "propertyType": "SingleFamily",
        "amortizationType": "Fixed",
        "expectedClosingDate": "2022-08-31T14:00:00",
        "cema": "CEMA loan option requested",
        "occupancyType": "Primary",
        "propertyAddress": {
            "address1": "1234 Main St",
            "address2": "Apt 1",
            "city": "Shawnee",
            "state": "CA",
            "zipCode": "93950",
            "county": "Monterey"
        },
        "borrowers": {
            "borrower": [
                {
                    "firstName": "Johnny",
                    "middleName": "J",
                    "lastName": "Doe",
                    "suffix": "Sr.",
                    "type": "Borrower",
                    "email": "johnnydoe@gmail.com",
                    "cellPhone": "724-323-4234",
                    "ssn": "111-11-1111",
                    "maritalStatus": "Married",
                    "dateOfBirth": "1965-07-04",
                    "borrowerAddress": {
                        "address1": "1234 Main St",
                        "address2": "",
                        "city": "Shawnee",
                        "state": "CA",
                        "zipCode": "93950",
                        "county": "Monterey"
                    }
                },
                {
                    "firstName": "Janie",
                    "middleName": "J",
                    "lastName": "Doe",
                    "type": "Borrower",
                    "email": "janiedoe@gmail.com",
                    "cellPhone": "724-123-4545",
                    "ssn": "222-22-2222",
                    "maritalStatus": "Married",
                    "dateOfBirth": "1967-09-22"
                }
            ]
        },
        "parties": {
            "party" : [
                {
                    "firstName": "John",
                    "lastName": "Doe",
                    "phone": "724-420-3341",
                    "email": "johndoe@acmeinc.com",
                    "role": "Processor"
                },
                {
                    "firstName": "Jane",
                    "lastName": "Doe",
                    "phone": "724-420-1833",
                    "email": "janedoe@acmeinc.com",
                    "role": "LoanOfficer"
                }
            ]
        },
        "lender": {
            "name": "Direct",
            "address": "26642 Towne Centre Dr",
            "city": "Lake Forest",
            "state": "CA",
            "zipCode": "92630"
        },
        "specialInstruction": "Conveyance of easement.",
    "investorType": "Fannie" 
    },
    "transactionExtensions": {
        "transactionExtension": [
            {
                "key": "Client Specific Key 1",
                "value": "Client Specific Value 1"
            },
            {
                "key": "Client Specific Key 2",
                "value": "Client Specific Value 2"
            }
        ]
    }
}
/* Copyright © 2023 Mortgage Connect LP */

<!-- Copyright © 2023 Mortgage Connect LP -->
<root>
    <transactionHeader>
        <transactionIdempotentId>3B34A671-BB17-400D-90BF-7CBF9C96E8ED</transactionIdempotentId>
        <transactionDate>022-07-11T02:03:40</transactionDate>
        <clientCode>1799</clientCode>
        <clientName>AcmeInc</clientName>
        <vendorCode>MC</vendorCode>
        <vendorName>Mortgage Connect</vendorName>
    </transactionHeader>
    <transactionBody>
        <transactionCode>Update-Order</transactionCode>
        <transactionId>7832143</transactionId>
        <productTransactionId></productTransactionId>
        <orderNumber>2429888</orderNumber>
        <productCode>PRLM</productCode>
        <loanNumber>73201-3433</loanNumber>
        <loanAmount>200000</loanAmount>
        <originalLoanAmount>59900</originalLoanAmount>
        <unpaidPrincipalAmount>158698</unpaidPrincipalAmount>
        <salePrice>210000</salePrice>
        <loanType>Loan Modification</loanType>
        <propertyType>SingleFamily</propertyType>
        <amortizationType>Fixed</amortizationType>
        <expectedClosingDate>2022-08-31T14:00:00</expectedClosingDate>
        <cema>CEMA loan option requested</cema>
        <occupancyType>Primary</occupancyType>
        <propertyAddress>
            <address1>1234 Main St</address1>
            <address2>Suite 2</address2>
            <city>Shawnee</city>
            <state>CA</state>
            <zipCode>93950</zipCode>
            <county>Monterey</county>
        </propertyAddress>
        <borrowers>
            <borrower>
                <firstName>Johnny</firstName>
                <middleName>J</middleName>
                <lastName>Doe</lastName>
                <suffix>Sr.</suffix>
                <type>Borrower</type>
                <email>johnnydoe@gmail.com</email>
                <cellPhone>724-323-4234</cellPhone>
                <ssn>111-11-1111</ssn>
                <maritalStatus>Married</maritalStatus>
                <dateOfBirth>1965-07-04</dateOfBirth>
                <borrowerAddress>
                    <address1>100 Willow St</address1>
                    <address2>Suite 2</address2>
                    <city>Shawnee</city>
                    <state>CA</state>
                    <zipCode>93950</zipCode>
                    <county>Monterey</county>
                </borrowerAddress>
            </borrower>
            <borrower>
                <firstName>Janie</firstName>
                <middleName>J</middleName>
                <lastName>Doe</lastName>
                <type>Borrower</type>
                <email>janiedoe@gmail.com</email>
                <cellPhone>724-123-4545</cellPhone>
                <ssn>222-22-2222</ssn>
                <maritalStatus>Married</maritalStatus>
                <dateOfBirth>1967-09-22</dateOfBirth>
            </borrower>
        </borrowers>
        <parties>
            <party>
                <firstName>John</firstName>
                <lastName>Doe</lastName>
                <phone>724-420-3341</phone>
                <email>johndoe@acmeinc.com</email>
                <role>Processor</role>
            </party>
            <party>
                <firstName>Jane</firstName>
                <lastName>Doe</lastName>
                <phone>724-420-1833</phone>
                <email>janedoe@acmeinc.com</email>
                <role>LoanOfficer</role>
            </party>
        </parties>
        <lender>
            <name>Direct</name>
            <address>26642 Towne Centre Dr</address>
            <city>Lake Forest</city>
            <state>CA</state>
            <zipCode>92630</zipCode>
        </lender>
        <specialInstruction>Conveyance of easement.</specialInstruction>
        <investorType>Fannie</investorType>
    </transactionBody>
    <transactionExtensions>
        <transactionExtension>
            <key>Client Specific Key 1</key>
            <value>Client Specific Value 1</value>
        </transactionExtension>
        <transactionExtension>
            <key>Client Specific Key 2</key>
            <value>Client Specific Value 1</value>
        </transactionExtension>
    </transactionExtensions>
</root>
<!-- Copyright © 2023 Mortgage Connect LP -->

👍 The request payload can be verified using the following validation schema.

/* Copyright © 2023 Mortgage Connect LP */
{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "$id": "root",
  "description": "Copyright @ 2022 Mortgage Connect LP - Title & Tax Schema.",
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "legalHeader": {
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "version": {
          "examples": [
            "1.0.8.0"
          ],
          "type": "string",
          "minLength": 1,
          "maxLength": 20
        },
        "disclosingParty": {
          "examples": [
            "Copyright @ 2022 Mortgage Connect LP"
          ],
          "type": "string",
          "minLength": 1,
          "maxLength": 100
        },
        "proprietaryInformationAndConfidential": {
          "examples": [
            "Ownership of Proprietary Information. The Recipient agrees that it shall not receive any right, title or interest, or any license or right to use, the Disclosing Partys Proprietary Information, including, but not limited to, technology, ideas, concepts, drawings, documentation, designs, prototypes, processes, trade secrets, trademarks or other intellectual property rights therein, by implication or otherwise."
          ],
          "type": "string",
          "minLength": 1,
          "maxLength": 2000
        }
      },
      "required": [
        "version",
        "disclosingParty",
        "proprietaryInformationAndConfidential"
      ],
      "minProperties": 3,
      "maxProperties": 3
    },
    "transactionHeader": {
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "transactionIdempotentId": {
          "examples": [
            "3B34A671-BB17-400D-90BF-7CBF9C96E8ED"
          ],
          "type": "string",
          "minLength": 36,
          "maxLength": 36,
          "pattern": "^[\\da-fA-F]{8}-[\\da-fA-F]{4}-[\\da-fA-F]{4}-[\\da-fA-F]{4}-[\\da-fA-F]{12}$"
        },
        "transactionDate": {
          "examples": [
            "2022-07-11T02:03:40"
          ],
          "type": "string",
          "format": "date-time"
        },
        "clientCode": {
          "examples": [
            "1799"
          ],
          "type": "string",
          "minLength": 1,
          "maxLength": 100,
          "format": "integer"
        },
        "clientName": {
          "examples": [
            "AcmeInc"
          ],
          "type": "string",
          "minLength": 1,
          "maxLength": 100
        },
        "vendorCode": {
          "examples": [
            "MC"
          ],
          "type": "string",
          "minLength": 1,
          "maxLength": 100
        },
        "vendorName": {
          "examples": [
            "Mortgage Connect"
          ],
          "type": "string",
          "minLength": 1,
          "maxLength": 100
        }
      },
      "required": [
        "transactionIdempotentId",
        "transactionDate",
        "clientCode",
        "clientName",
        "vendorCode",
        "vendorName"
      ],
      "minProperties": 6,
      "maxProperties": 6
    },
    "transactionBody": {
      "title": "TransactionBody",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "transactionCode": {
          "examples": [
            "Update-Order"
          ],
          "type": "string",
          "const": "Update-Order"
        },
        "transactionId": {
          "examples": [
            "7832143"
          ],
          "type": "string",
          "minLength": 1,
          "maxLength": 50
        },
        "productTransactionId": {
          "examples": [
            "7832143"
          ],
          "type": "string",
          "minLength": 0,
          "maxLength": 50
        },
        "orderNumber": {
          "examples": [
            "2429888"
          ],
          "type": "integer"
        },
        "productCode": {
          "type": "string",
          "minLength": 3,
          "maxLength": 4,
          "enum": [
            "PRLM",
            "PRLP",
            "TTLP",
            "TTLN"
          ]
        },
        "loanNumber": {
          "examples": [
            "7313993"
          ],
          "type": "string",
          "minLength": 1,
          "maxLength": 64
        },
        "loanAmount": {
          "examples": [
            "0.00"
          ],
          "type": "string",
          "format": "money"
        },
        "originalLoanAmount": {
          "$ref": "root#/properties/transactionBody/properties/loanAmount"
        },
        "unpaidPrincipalAmount": {
          "$ref": "root#/properties/transactionBody/properties/loanAmount"
        },
        "salePrice": {
          "$ref": "root#/properties/transactionBody/properties/loanAmount"
        },
        "loanType": {
          "type": "string",
          "minLength": 1,
          "maxLength": 24,
          "enum": [
            "Deed in Lieu", 
            "Loan Modification", 
            "Post-Foreclosure", 
            "Pre Sale", 
            "Pre-Foreclosure", 
            "REO/Foreclosure", 
            "TSG"
          ]
        },
        "propertyType": {
          "type": "string",
          "maxLength": 64,
          "enum": [
            "Condominium",
            "Cooperative",
            "Manufactured",
            "Multi-Family",
            "Other",
            "Residential",
            "SingleFamily"
          ]
        },
        "amortizationType": {
          "type": "string",
          "maxLength": 64,
          "enum": [
            "ARM",
            "Fixed",
            "Interest Only",
            "Reverse",
            ""
          ]
        },
        "expectedClosingDate": {
          "type": "string",
          "format": "date-time"
        },
        "cema": {
          "type": "string"
        },
        "occupancyType": {
          "type": "string",
          "maxLength": 64,
          "enum": [
            "Primary",
            "Secondary",
            "Investment"
          ]
        },
        "propertyAddress": {
          "type": "object",
          "additionalProperties": false,
          "properties": {
            "address1": {
              "examples": [
                "1204 New York Drive"
              ],
              "type": "string",
              "maxLength": 32
            },
            "address2": {
              "examples": [
                "1204 New York Drive"
              ],
              "type": "string",
              "maxLength": 32
            },
            "city": {
              "examples": [
                "Mckees Rocks"
              ],
              "type": "string",
              "maxLength": 32
            },
            "state": {
              "examples": [
                "PA"
              ],
              "type": "string",
              "enum": [
                "AK",
                "AL",
                "AR",
                "AS",
                "AZ",
                "CA",
                "CO",
                "CT",
                "DC",
                "DE",
                "FL",
                "FM",
                "GA",
                "GU",
                "HI",
                "IA",
                "ID",
                "IL",
                "IN",
                "KS",
                "KY",
                "LA",
                "MA",
                "MD",
                "ME",
                "MH",
                "MI",
                "MN",
                "MO",
                "MP",
                "MS",
                "MT",
                "NC",
                "ND",
                "NE",
                "NH",
                "NJ",
                "NM",
                "NV",
                "NY",
                "OH",
                "OK",
                "OR",
                "PA",
                "PR",
                "PW",
                "RI",
                "SC",
                "SD",
                "TN",
                "TX",
                "UT",
                "VA",
                "VI",
                "VT",
                "WA",
                "WI",
                "WV",
                "WY"
              ]
            },
            "zipCode": {
              "examples": [
                "15136"
              ],
              "type": "string",
              "minLength": 5,
              "maxLength": 5,
              "pattern": "^[0-9]{5}$"
            },
            "county": {
              "examples": [
                "Allegheny"
              ],
              "type": "string",
              "maxLength": 32
            }
          },
          "required": [
            "address1",
            "city",
            "state",
            "zipCode"
          ],
          "minProperties": 4,
          "maxProperties": 6
        },
        "borrowers": {
          "type": "object",
          "properties": {
            "borrower": {
              "type": "array",
              "items": {
                "title": "Borrower",
                "type": "object",
                "additionalProperties": false,
                "properties": {
                  "firstName": {
                    "examples": [
                      "John"
                    ],
                    "type": "string",
                    "minLength": 1,
                    "maxLength": 150
                  },
                  "middleName": {
                    "examples": [
                      "M"
                    ],
                    "type": "string",
                    "minLength": 0,
                    "maxLength": 150
                  },
                  "lastName": {
                    "examples": [
                      "Smith"
                    ],
                    "type": "string",
                    "minLength": 1,
                    "maxLength": 255
                  },
                  "suffix": {
                    "examples": [
                      "Sr."
                    ],
                    "type": "string",
                    "minLength": 0,
                    "maxLength": 4,
                    "enum": [
                      "II",
                      "III",
                      "Esq.",
                      "Jr.",
                      "M.D.",
                      "P.A.",
                      "Sr.",
                      ""
                    ]
                  },
                  "type": {
                    "type": "string",
                    "enum": [
                      "Asset Management Company",
                      "Asset Manager",
                      "Assignee",
                      "Assignor",
                      "Attorney",
                      "Bank Attorney",
                      "Borrower",
                      "Borrower/Buyer",
                      "Builder",
                      "Buyer",
                      "Buyer Agent",
                      "Buyer Attorney",
                      "Buyer Title Company",
                      "Buyers Broker",
                      "Condo Association",
                      "Custodian",
                      "Foreclosed Party",
                      "Investor",
                      "LENDER",
                      "Lender Loan Officer",
                      "Listing Agent",
                      "MC MC Auction Company",
                      "Mortgage Connect Closer",
                      "Non-HUD Borrower",
                      "Non-Vested Signer",
                      "Other",
                      "Processor",
                      "Property Access",
                      "Real Estate Agent",
                      "Real Estate Agent - Seller",
                      "Seller",
                      "Seller Attorney",
                      "Sellers Broker",
                      "Selling Agent",
                      "Servicer",
                      "Settlement Agent",
                      "Title Company",
                      "Underwriter",
                      "Vested Signer - Non-Borrower"
                    ]
                  },
                  "email": {
                    "type": "string",
                    "maxLength": 255,
                    "format": "email"
                  },
                  "cellPhone": {
                    "type": "string",
                    "maxLength": 24
                  },
                  "ssn": {
                    "type": "string",
                    "maxLength": 128
                  },
                  "maritalStatus": {
                    "type": "string",
                    "enum": [
                      "Divorced",
                      "Married",
                      "Separated",
                      "Single",
                      "Widowed",
                      ""
                    ]
                  },
                  "language": {
                    "type": "string",
                    "enum": [
                      "English",
                      "Spanish"
                    ]
                  },
                  "dateOfBirth": {
                    "type": "string",
                    "format": "date"
                  },
                  "borrowerAddress": {
                    "$ref": "root#/properties/transactionBody/properties/propertyAddress"
                  }
                },
                "required": [
                  "firstName",
                  "lastName",
                  "type"
                ]
              },
              "minItems": 1
            }
          }
        },
        "parties": {
          "type": "object",
          "properties": {
            "party": {
              "type": "array",
              "items": {
                "title": "Party",
                "type": "object",
                "additionalProperties": false,
                "properties": {
                  "sequenceNo": {
                    "type": "integer"
                  },
                  "firstName": {
                    "type": "string",
                    "maxLength": 150
                  },
                  "lastName": {
                    "type": "string",
                    "maxLength": 150
                  },
                  "phone": {
                    "type": "string",
                    "maxLength": 24
                  },
                  "email": {
                    "type": "string",
                    "maxLength": 255,
                    "format": "email"
                  },
                  "role": {
                    "type": "string",
                    "enum": [
                      "Closer",
                      "LoanOfficer",
                      "LoanOfficerAssistant",
                      "Other",
                      "Processor",
                      "ProcessorAssistant",
                      "Underwriter",
                      "User"
                    ]
                  }
                },
                "required": [
                  "firstName",
                  "lastName",
                  "role"
                ]
              }
            }
          }
        },
        "lender": {
          "title": "Lender",
          "type": "object",
          "additionalProperties": false,
          "properties": {
            "name": {
              "type": "string",
              "maxLength": 255
            },
            "address": {
              "examples": [
                "1204 New York Drive"
              ],
              "type": "string",
              "maxLength": 255
            },
            "city": {
              "$ref": "root#/properties/transactionBody/properties/propertyAddress/properties/city"
            },
            "state": {
              "$ref": "root#/properties/transactionBody/properties/propertyAddress/properties/state"
            },
            "zipCode": {
              "$ref": "root#/properties/transactionBody/properties/propertyAddress/properties/zipCode"
            }
          },
          "required": [
            "address",
            "city",
            "state",
            "zipCode"
          ]
        },
        "specialInstruction": {
          "type": "string"
        },
        "investorType": {
          "type": "string"
        }
      },
      "required": [
        "transactionCode",
        "transactionId",
        "transactionIsAsynchronous",
        "productCode",
        "loanNumber",
        "loanType",
        "propertyAddress",
        "borrowers"
      ],
      "allOf": [
        {
          "if": {
            "properties": { "propertyType": { "enum": [ "Purchase" ] } }
          },
          "then": {
            "required": [ "salePrice" ]
          }
        },
        {
          "if": {
            "properties": {
              "loanType": {
                "enum": [
                  "Equity",
                  "Other",
                  "Purchase",
                  "Refinance",
                  "Reverse"
                ]
              }
            }
          },
          "then": {
            "required": [ "propertyType", "occupancyType" ]
          }
        }
      ],
    },
    "transactionExtensions": {
      "type": "object",
      "properties": {
        "transactionExtension": {
          "type": "array",
          "items": {
            "type": "object",
            "additionalProperties": false,
            "properties": {
              "key": {
                "examples": [
                  "Client Specific Key"
                ],
                "type": "string",
                "minLength": 1,
                "maxLength": 200
              },
              "value": {
                "examples": [
                  "Client Specific Value"
                ],
                "type": "string",
                "minLength": 1
              }
            },
            "required": [
              "key",
              "value"
            ],
            "minProperties": 2,
            "maxProperties": 2
          },
          "minItems": 0
        }
      }
    }
  },
  "required": [
    "transactionHeader",
    "transactionBody"
  ],
  "minProperties": 2,
  "maxProperties": 4
}
/* Copyright © 2023 Mortgage Connect LP */

<?xml version="1.0" encoding="utf-8"?>
<xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema">
  <xs:element name="root">
  <xs:complexType>
    <xs:sequence>
      <xs:element ref="legalHeader" minOccurs="0"/>
      <xs:element ref="transactionHeader"/>
      <xs:element name="transactionBody">
        <xs:complexType>
          <xs:all>
            <xs:element name="transactionCode" type="xs:string" fixed="Update-Order"/>
            <xs:element ref="transactionId"/>
            <xs:element name="productTransactionId" type="transactionId" minOccurs="0"/>
            <xs:element name="orderNumber" type="orderNo"/>
            <xs:element ref="productCode"/>
            <xs:element ref="loanNumber"/>
            <xs:element name="loanAmount" type="money" minOccurs="0"/>
            <xs:element name="originalLoanAmount" type="money" minOccurs="0"/>
            <xs:element name="unpaidPrincipalAmount" type="money" minOccurs="0"/>
            <xs:element name="salePrice" type="money" minOccurs="0"/>
            <xs:element ref="loanType"/>
            <xs:element name="propertyType" type="propertyType"/>
            <xs:element ref="amortizationType" minOccurs="0"/>
            <xs:element name="expectedClosingDate" type="xs:dateTime" minOccurs="0"/>
            <xs:element name="cema" minOccurs="0">
              <xs:simpleType>
                <xs:restriction base="xs:string">
                  <xs:maxLength value="100"/>
                </xs:restriction>
              </xs:simpleType>
            </xs:element>
            <xs:element ref="occupancyType"/>
            <xs:element name="propertyAddress" type="address"/>
            <xs:element name="borrowers">
              <xs:complexType>
                <xs:sequence>
                  <xs:element ref="borrower" maxOccurs="unbounded"/>
                </xs:sequence>
              </xs:complexType>
            </xs:element>
            <xs:element name="parties" minOccurs="0">
              <xs:complexType>
                <xs:sequence>
                  <xs:element ref="party" maxOccurs="unbounded"/>
                </xs:sequence>
              </xs:complexType>
            </xs:element>
            <xs:element ref="lender" minOccurs="0"/>
            <xs:element name="specialInstruction" type="xs:string" minOccurs="0"/>
          </xs:all>
        </xs:complexType>
      </xs:element>
      <xs:element ref="transactionExtensions" minOccurs="0"/>
    </xs:sequence>
  </xs:complexType>
  </xs:element>
</xs:schema>

✅ The following is an 'Accepted' example payload to be returned in the HTTP response.

Accepted Acknowledgment payloads are typically message type agnostic.

Accepted Acknowledgment payloads are typically message type agnostic.

⛔ The following is a 'Rejected' example payload to be returned in the HTTP response.

Rejected Acknowledgment payloads are typically message type agnostic.

Rejected Acknowledgment payloads are typically message type agnostic.

The Update Order API method is the mechanism in which a Client can submit a message to Mortgage Connect to update a Default Title Order.

The order to update is identified by the combination of the OrderNumber and ProductCode.

View Workflow Orchestration

Mortgage Connect URL

POST 🔒 https://{BaseUrl}/Api/V1.0/{ClientCode}/SubmitMessage

Mortgage Connect URL Properties

Property	Requirement	Description
BaseUrl	Required	A unique base Url that represents a specific Mortgage Connect endpoint and targeted environment.
ClientCode	Required	A unique code assigned to all clients that is used for identification, authentication, and customization purposes.

Property Definitions - Transaction Header

Defines the properties represented in the Transaction Header object (JSON) or node (XML). Note that this message artifact is identical for each and every message type.

View Transaction Header Details

Property Definitions - Transaction Body

Defines the properties represented in the Transaction Body object (JSON) or node (XML).

Property	Requirement	Data Type	Min / Max	Description
transactionBody	Required			A parent object (JSON) or node (XML) that contains the transaction metadata.
transactionCode	Required	String	12 / 12	A static value of `Update-Order`. The transaction code is meant to identify the message type and the context or action that should be taken. In this context it implies that a new Title Order should be updated with additional or changed data. Possible Values: Update-Order
transactionId	Required	String	1 / 50	Represents the Client's unique order number.
productTransactionId	Optional	String	0 / 50	Represents the Client's unique product order number. Note that the `productTransactionId` field is not used in most circumstances. However, when there is a need to further differentiate order numbers at a product level, that share the same `transactionId`, (i.e. the primary order level id), then the `productTransactionId` can be used to ensure uniqueness across the integration transactions. This makes it possible for multiple orders of the same product type to be placed using the same `transactionId`. The use of the `productTransactionId` field and any specific workflow deviations will be vetted during the onboarding process.
orderNumber	Required	Integer		Represents Mortgage Connects unique order number.
productCode	Required	String	3 / 4	Represents Mortgage Connect's product code. Possible Values: PRLM `Property Report Loan Mod` TSG `Trustee Sale Guarantee` PFCF `Pre-Foreclosure Report` PJR `Preliminary Judicial Report` etc. Traditionally, clients use Mortgage Connects `Product Code` names and thus there is a one to one mapping relationship that is maintained by the client. However, Mortgage Connect is aware that our naming conventions may not resonate and that there are many inconsistencies in product code naming conventions and nomenclatures. It is for this reason that Mortgage Connect is able to map the client's product code to Mortgage Connect's product code to ease the transition. Any required product code mapping exercises will be addressed during the onboarding process. The supported `productCode`(s) are specific per integration and will be determined during the onboarding process. Note that the minimum/maximum length requirement of 3/4 is only applicable if using Mortgage Connect's internal product codes, otherwise when mapping to the client's product codes, the minimum/maximum is 1/50.
loanNumber	Required	String	1 / 64	The clients loan number `alpha-numeric`.
loanAmount	Optional	Money		The loan amount
originalLoanAmount	Optional	Money		The original Loan amount.
unpaidPrincipalAmount	Optional	Money		The unpaid principle amount `if any` in dollars.
salePrice	Conditional	Money		The property sale price. The `salePrice` is optional but is `Required` if the `loanType` is `Purchase`.
loanType	Required	String	1 / 24	The loan type. Possible Values: Deed in Lieu Loan Modification Post-Foreclosure Pre-Foreclosure Pre Sale REO/Foreclosure TSG
propertyType	Optional	String	0 / 64	The property usage type. Possible Values: Condominium Cooperative Manufactured Multi-Family Other PUD SingleFamily
amortizationType	Optional	String	0 / 64	The amortization type, i.e. how the loan will be paid. Possible Values: ARM Fixed Interest Only Reverse
expectedClosingDate	Optional	DateTime		The expected closing data `if known`. Format: `mm/dd/yyyy`
cema	Optional	String	0 / 100	Information regarding a CEMA (Consolidation, Extension and Modification Agreement) mortgage loan.
occupancyType	Optional	String	0 / 64	The occupancy type, i.e. how the property will be used Possible Values: Primary Secondary Investment
propertyAddress	Required	Object		A parent object (JSON) or node (XML) that contains metadata associated with a property address.
address1	Required	String	1 / 255	The property street address.
address2	Optional	String	0 / 255	The property street address 2.
city	Required	String	1 / 32	The property city name.
state	Required	String	2 / 2	The property state abbreviation. Possible Values: AK, AL, AR, AS, AZ, CA, CO, CT, DC, DE, FL, FM, GA, GU, HI, IA, ID, IL, IN, KS, KY, LA, MA, MD, ME, MH, MI, MN, MO, MP, MS, MT, NC, ND, NE, NH, NJ, NM, NV, NY, OH, OK, OR, PA, PR, PW, RI, SC, SD, TN, TX, UT, VA, VI, VT, WA, WI, WV, WY.
zipCode	Required	String	5 / 5	The property zip code.
county	Optional	String	0 / 32	The property county.
borrowers	Required	Array		A parent object (JSON) or node (XML) that contains a list of borrowers. `(1 to Many)` Note that the first borrower is assumed to `always` be the `Primary` borrower.
borrower	Required	Object		A parent object (JSON) or node (XML) that contains the metadata associated with a single borrower.
firstName	Required	String	1 / 150	The borrower’s first name.
middleName	Optional	String	0 / 150	The borrower’s middle name.
lastName	Required	String	1 / 255	The borrower’s last name.
suffix	Optional	String	0 / 4	The borrower's suffix. Possible Values: II III Esq. Jr. Sr.
type	Required	String	1 / 32	The borrower's type. Note that typically this value will be set to `Borrower`. Possible Values: Asset Management Company Asset Manager Assignee Assignor Attorney Bank Attorney Borrower Borrower/Buyer Builder Buyer Buyer Agent Buyer Attorney Buyer Title Company Buyers Broker Condo Association Custodian Foreclosed Party Investor LENDER Lender Loan Officer Listing Agent MC MC Auction Company Mortgage Connect Closer Non-HUD Borrower Non-Vested Signer Other Processor Property Access Real Estate Agent Real Estate Agent - Seller Seller Seller Attorney Sellers Broker Selling Agent Servicer Settlement Agent Title Company Underwriter Vested Signer - Non-Borrower
email	Optional	String	0 / 255	The borrower’s email address.
cellPhone	Optional	String	0 / 24	The borrower's cell phone number.
ssn	Optional	String	0 / 128	The borrower's social security number.
maritalStatus	Optional	String	0 / 128	The borrower’s marital status. Possible Values: Divorced Married Separated Single Widowed
language	Optional	String	0 / 100	The borrower’s natural language. Possible Values: English Spanish
dateOfBirth	Optional	DateTime		The borrower’s date of birth. Format: `mm/dd/yyyy`
borrowerAddress	Optional	Object		A parent object (JSON) or node (XML) that contains metadata associated with a borrower address.
address1	Required	String	1 / 255	The borrower street address.
address2	Optional	String	0 / 255	The borrower street address 2.
city	Required	String	1 / 32	The borrower city name.
state	Required	String	2 / 2	The borrower state abbreviation. Possible Values: AK, AL, AR, AS, AZ, CA, CO, CT, DC, DE, FL, FM, GA, GU, HI, IA, ID, IL, IN, KS, KY, LA, MA, MD, ME, MH, MI, MN, MO, MP, MS, MT, NC, ND, NE, NH, NJ, NM, NV, NY, OH, OK, OR, PA, PR, PW, RI, SC, SD, TN, TX, UT, VA, VI, VT, WA, WI, WV, WY.
zipCode	Required	String	5 / 5	The borrower zip code.
county	Optional	String	0 / 32	The borrower county.
parties	Optional	Array		A parent object (JSON) or node (XML) that contains a list of parties (i.e. those working on the loan). `(0 to Many)`
party	Optional	Object		A parent object (JSON) or node (XML) that contains the metadata associated with a single borrower.
firstName	Required	String	1 / 150	The party first name.
lastName	Required	String	1 / 255	The party last name.
phone	Optional	String	0 / 24	The party's phone number.
email	Optional	String	0 / 255	The party's email address.
role	Required	String	1 / 32	The party's role. Possible Values: Closer LoanOfficer Processor
lender	Optional	Array		A parent object (JSON) or node (XML) that contains the metadata associated with a single lender.
name	Optional	String	0 / 255	The lender's name.
address	Required	String	1 / 255	The lender's address.
city	Required	String	1 / 32	The lender's city.
state	Required	String	2 / 2	The lender's state.
zipCode	Required	String	5 / 5	The lender's zip code.
specialInstruction	Optional	String	0 / MAX	The special instruction associated with the Default Title. `(if applcable)`

Property Definitions - Transaction Extensions

Defines the properties represented in the TransactionExtensions object (JSON) or node (XML). Note that this message artifact is identical for each and every message type.

View Transaction Extension Details

Default Title - MC122 - Hold Order

🌐 The following is an example payload to be posted in the body of the HTTP request.

/* Copyright © 2023 Mortgage Connect LP */
{
    "transactionHeader": {
        "transactionIdempotentId": "3B34A671-BB17-400D-90BF-7CBF9C96E8ED",
        "transactionDate": "2022-07-11T02:03:40",
        "clientCode": "1799",
        "clientName": "AcmeInc",
        "vendorCode": "MC",
        "vendorName": "Mortgage Connect"
    },
    "transactionBody": {
        "transactionCode": "Hold-Order",
        "transactionId": "7832143",
        "productTransactionId": "",
        "orderNumber": 2429888,
        "productCode": "PRLM",
        "delayId": 12345,
        "note": "Approval needed - Tax Approval Needed\n\ndelay comment",
        "noteDate": "2022-10-19T14:00:00"
    },
    "transactionExtensions": {
        "transactionExtension": [
            {
                "key": "Client Specific Key 1",
                "value": "Client Specific Value 1"
            },
            {
                "key": "Client Specific Key 2",
                "value": "Client Specific Value 2"
            }
        ]
    }
}
/* Copyright © 2023 Mortgage Connect LP */

<!-- Copyright © 2023 Mortgage Connect LP -->
<root>
    <transactionHeader>
        <transactionIdempotentId>3B34A671-Bb17-400D-90Bf-7Cbf9C96E8Ed</transactionIdempotentId>
        <transactionDate>2022-07-11T02:03:40</transactionDate>
        <clientCode>1799</clientCode>
        <clientName>Acmeinc</clientName>
        <vendorCode>MC</vendorCode>
        <vendorName>Mortgage Connect</vendorName>
    </transactionHeader>
    <transactionBody>
        <transactionCode>Hold-Order</transactionCode>
        <transactionId>7832143</transactionId>
        <productTransactionId></productTransactionId>
        <orderNumber>2429888</orderNumber>
        <productCode>PRLM</productCode>
    <delayId>123456</delayId>
    <note>Approval needed - Tax Approval Needed\n\ndelay note</note>
    <noteDate>2022-10-19T14:00:00</noteDate>
  </transactionBody>
    <transactionExtensions>
        <transactionExtension>
            <key>Client Specific Key 1</key>
            <value>Client Specific Value 1</value>
        </transactionExtension>
        <transactionExtension>
            <key>Client Specific Key 2</key>
            <value>Client Specific Value 1</value>
        </transactionExtension>
    </transactionExtensions>
</root>
<!-- Copyright © 2023 Mortgage Connect LP -->

👍 The request payload can be verified using the following validation schema.

/* Copyright © 2023 Mortgage Connect LP */
{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "$id": "root",
  "description": "Copyright @ 2022 Mortgage Connect LP - Title & Tax Schema.",
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "legalHeader": {
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "version": {
          "examples": [
            "1.0.8.0"
          ],
          "type": "string",
          "minLength": 1,
          "maxLength": 20
        },
        "disclosingParty": {
          "examples": [
            "Copyright @ 2022 Mortgage Connect LP"
          ],
          "type": "string",
          "minLength": 1,
          "maxLength": 100
        },
        "proprietaryInformationAndConfidential": {
          "examples": [
            "Ownership of Proprietary Information. The Recipient agrees that it shall not receive any right, title or interest, or any license or right to use, the Disclosing Partys Proprietary Information, including, but not limited to, technology, ideas, concepts, drawings, documentation, designs, prototypes, processes, trade secrets, trademarks or other intellectual property rights therein, by implication or otherwise."
          ],
          "type": "string",
          "minLength": 1,
          "maxLength": 2000
        }
      },
      "required": [
        "version",
        "disclosingParty",
        "proprietaryInformationAndConfidential"
      ],
      "minProperties": 3,
      "maxProperties": 3
    },
    "transactionHeader": {
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "transactionIdempotentId": {
          "examples": [
            "3B34A671-BB17-400D-90BF-7CBF9C96E8ED"
          ],
          "type": "string",
          "minLength": 36,
          "maxLength": 36,
          "pattern": "^[\\da-fA-F]{8}-[\\da-fA-F]{4}-[\\da-fA-F]{4}-[\\da-fA-F]{4}-[\\da-fA-F]{12}$"
        },
        "transactionDate": {
          "examples": [
            "2022-07-11T02:03:40"
          ],
          "type": "string",
          "format": "date-time"
        },
        "clientCode": {
          "examples": [
            "1799"
          ],
          "type": "string",
          "minLength": 1,
          "maxLength": 100,
          "format": "integer"
        },
        "clientName": {
          "examples": [
            "AcmeInc"
          ],
          "type": "string",
          "minLength": 1,
          "maxLength": 100
        },
        "vendorCode": {
          "examples": [
            "MC"
          ],
          "type": "string",
          "minLength": 1,
          "maxLength": 100
        },
        "vendorName": {
          "examples": [
            "Mortgage Connect"
          ],
          "type": "string",
          "minLength": 1,
          "maxLength": 100
        }
      },
      "required": [
        "transactionIdempotentId",
        "transactionDate",
        "clientCode",
        "clientName",
        "vendorCode",
        "vendorName"
      ],
      "minProperties": 6,
      "maxProperties": 6
    },
    "transactionBody": {
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "transactionCode": {
          "examples": [
            "Hold-Order"
          ],
          "type": "string",
          "const": "Hold-Order"
        },
        "transactionId": {
          "examples": [
            "7832143"
          ],
          "type": "string",
          "minLength": 1,
          "maxLength": 50
        },
        "productTransactionId": {
          "examples": [
            "7832143"
          ],
          "type": "string",
          "minLength": 0,
          "maxLength": 50
        },
        "orderNumber": {
          "examples": [
            "2429888"
          ],
          "type": "integer"
        },
        "productCode": {
          "type": "string",
          "minLength": 3,
          "maxLength": 4,
          "enum": [
            "PRLM",
            "PRLP",
            "TTLP",
            "TTLN"
          ]
        },
        "delayId": {
          "type": "integer"
        }
        "note": {
          "example": [
            "Approval needed - Tax Approval Needed\n\ndelay comment"
          ],
          "type": "string"
        },
        "noteDate": {
          "example": [
            "07-11-2022T14:00:00-4:00"
          ],
          "type": "string",
          "format": "date-time"
        }
      },
      "required": [
        "transactionCode",
        "transactionId",
        "orderNumber",
        "productCode",
        "delayId",
        "note",
        "noteDate"
      ]
    },
    "transactionExtensions": {
      "type": "object",
      "properties": {
        "transactionExtension": {
          "type": "array",
          "items": {
            "type": "object",
            "additionalProperties": false,
            "properties": {
              "key": {
                "examples": [
                  "Client Specific Key"
                ],
                "type": "string",
                "minLength": 1,
                "maxLength": 200
              },
              "value": {
                "examples": [
                  "Client Specific Value"
                ],
                "type": "string",
                "minLength": 1
              }
            },
            "required": [
              "key",
              "value"
            ],
            "minProperties": 2,
            "maxProperties": 2
          },
          "minItems": 0
        }
      }
    }
  },
  "required": [
    "transactionHeader",
    "transactionBody"
  ],
  "minProperties": 2,
  "maxProperties": 4
}
/* Copyright © 2023 Mortgage Connect LP */

<?xml version="1.0" encoding="utf-8"?>
<xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema">
  <xs:element name="root">
  <xs:complexType>
    <xs:sequence>
      <xs:element ref="legalHeader" minOccurs="0"/>
      <xs:element ref="transactionHeader"/>
      <xs:element name="transactionBody">
        <xs:complexType>
          <xs:all>
            <xs:element name="transactionCode" type="xs:string" fixed="Hold-Order"/>
            <xs:element ref="transactionId"/>
            <xs:element name="productTransactionId" type="transactionId" minOccurs="0"/>
            <xs:element name="orderNumber" type="orderNo"/>
            <xs:element ref="productCode"/>
            <xs:element name="note" type="xs:string"/>
            <xs:element name="noteDate" type="xs:dateTime"/>
          </xs:all>
        </xs:complexType>
      </xs:element>
      <xs:element ref="transactionExtensions" minOccurs="0"/>
    </xs:sequence>
  </xs:complexType>
  </xs:element>
</xs:schema>

✅ The following is an 'Accepted' example payload to be returned in the HTTP response.

Accepted Acknowledgment payloads are typically message type agnostic.

Accepted Acknowledgment payloads are typically message type agnostic.

⛔ The following is a 'Rejected' example payload to be returned in the HTTP response.

Rejected Acknowledgment payloads are typically message type agnostic.

Rejected Acknowledgment payloads are typically message type agnostic.

The Hold-Order API method is the mechanism in which a Client is notified that Mortgage Connect has encountered a delay in processing their Default Title Order.

The order on hold is identified by the combination of the OrderNumber and ProductCode.

View Workflow Orchestration

Mortgage Connect URL

POST 🔒 https://{BaseUrl}/Api/V1.0/{ClientCode}/SubmitMessage

Mortgage Connect URL Properties

Property	Requirement	Description
BaseUrl	Required	A unique base Url that represents a specific Mortgage Connect endpoint and targeted environment.
ClientCode	Required	A unique code assigned to all clients that is used for identification, authentication, and customization purposes.

Property Definitions - Transaction Header

Defines the properties represented in the Transaction Header object (JSON) or node (XML). Note that this message artifact is identical for each and every message type.

View Transaction Header Details

Property Definitions - Transaction Body

Defines the properties represented in the Transaction Body object (JSON) or node (XML).

Property	Requirement	Data Type	Min / Max	Description
transactionBody	Required			A parent object (JSON) or node (XML) that contains the transaction metadata.
transactionCode	Required	String	10 / 10	A static value of `Hold-Order`. The transaction code is meant to identify the message type and the context or action that should be taken. A `Hold-Order` transaction code indicates that a Default Title Order had a delay added. Possible Values: Hold-Order
transactionId	Required	String	1 / 50	Represents the Client's unique order number.
productTransactionId	Optional	String	0 / 50	Represents the Client's unique product order number. Note that the `productTransactionId` field is not used in most circumstances. However, when there is a need to further differentiate order numbers at a product level, that share the same `transactionId`, (i.e. the primary order level id), then the `productTransactionId` can be used to ensure uniqueness across the integration transactions. This makes it possible for multiple orders of the same product type to be placed using the same `transactionId`. The use of the `productTransactionId` field and any specific workflow deviations will be vetted during the onboarding process.
orderNumber	Required	Integer		Represents Mortgage Connects unique order number.
productCode	Required	String	3 / 4	Represents Mortgage Connect's product code. Possible Values: PRLM `Property Report Loan Mod` TSG `Trustee Sale Guarantee` PFCF `Pre-Foreclosure Report` PJR `Preliminary Judicial Report` etc. Traditionally, clients use Mortgage Connects `Product Code` names and thus there is a one to one mapping relationship that is maintained by the client. However, Mortgage Connect is aware that our naming conventions may not resonate and that there are many inconsistencies in product code naming conventions and nomenclatures. It is for this reason that Mortgage Connect is able to map the client's product code to Mortgage Connect's product code to ease the transition. Any required product code mapping exercises will be addressed during the onboarding process. The supported `productCode`(s) are specific per integration and will be determined during the onboarding process. Note that the minimum/maximum length requirement of 3/4 is only applicable if using Mortgage Connect's internal product codes, otherwise when mapping to the client's product codes, the minimum/maximum is 1/50.
delayId	Required	Integer		Uniquely identifies the delay. Used to correlate Hold-Order and Hold-Order-Resolved events.
note	Required	String	1 / MAX	The delay reason, delay sub-reason, and delay comments associated with the Order/Product formatted into a note.
noteDate	Required	DateTime		The date when the delay was entered.

Property Definitions - Transaction Extensions

Defines the properties represented in the TransactionExtensions object (JSON) or node (XML). Note that this message artifact is identical for each and every message type.

View Transaction Extension Details

Default Title - MC123 - Hold Order Resolved

🌐 The following is an example payload to be posted in the body of the HTTP request.

/* Copyright © 2023 Mortgage Connect LP */
{
    "transactionHeader": {
        "transactionIdempotentId": "3B34A671-BB17-400D-90BF-7CBF9C96E8ED",
        "transactionDate": "2022-07-11T02:03:40",
        "clientCode": "1799",
        "clientName": "AcmeInc",
        "vendorCode": "MC",
        "vendorName": "Mortgage Connect"
    },
    "transactionBody": {
        "transactionCode": "Hold-Order-Resolved",
        "transactionId": "7832143",
        "productTransactionId": "",
        "orderNumber": 2429888,
        "productCode": "PRLM",
        "delayId": 123456,
        "note": "Approval needed - Tax Approval Needed\n\ndelay comment",
        "noteDate": "2022-10-19T14:00:00"
    },
    "transactionExtensions": {
        "transactionExtension": [
            {
                "key": "Client Specific Key 1",
                "value": "Client Specific Value 1"
            },
            {
                "key": "Client Specific Key 2",
                "value": "Client Specific Value 2"
            }
        ]
    }
}
/* Copyright © 2023 Mortgage Connect LP */

<!-- Copyright © 2023 Mortgage Connect LP -->
<root>
    <transactionHeader>
        <transactionIdempotentId>3B34A671-Bb17-400D-90Bf-7Cbf9C96E8Ed</transactionIdempotentId>
        <transactionDate>2022-07-11T02:03:40</transactionDate>
        <clientCode>1799</clientCode>
        <clientName>Acmeinc</clientName>
        <vendorCode>MC</vendorCode>
        <vendorName>Mortgage Connect</vendorName>
    </transactionHeader>
    <transactionBody>
        <transactionCode>Hold-Order-Resolved</transactionCode>
        <transactionId>7832143</transactionId>
        <productTransactionId></productTransactionId>
        <orderNumber>2429888</orderNumber>
        <productCode>PRLM</productCode>
        <delayId>123456</delayId>
        <note>Approval needed - Tax Approval Needed\n\ndelay note</note>
        <noteDate>2022-10-19T14:00:00</noteDate>
    </transactionBody>
    <transactionExtensions>
        <transactionExtension>
            <key>Client Specific Key 1</key>
            <value>Client Specific Value 1</value>
        </transactionExtension>
        <transactionExtension>
            <key>Client Specific Key 2</key>
            <value>Client Specific Value 1</value>
        </transactionExtension>
    </transactionExtensions>
</root>
<!-- Copyright © 2023 Mortgage Connect LP -->

👍 The request payload can be verified using the following validation schema.

/* Copyright © 2023 Mortgage Connect LP */
{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "$id": "root",
  "description": "Copyright @ 2022 Mortgage Connect LP - Title & Tax Schema.",
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "legalHeader": {
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "version": {
          "examples": [
            "1.0.8.0"
          ],
          "type": "string",
          "minLength": 1,
          "maxLength": 20
        },
        "disclosingParty": {
          "examples": [
            "Copyright @ 2022 Mortgage Connect LP"
          ],
          "type": "string",
          "minLength": 1,
          "maxLength": 100
        },
        "proprietaryInformationAndConfidential": {
          "examples": [
            "Ownership of Proprietary Information. The Recipient agrees that it shall not receive any right, title or interest, or any license or right to use, the Disclosing Partys Proprietary Information, including, but not limited to, technology, ideas, concepts, drawings, documentation, designs, prototypes, processes, trade secrets, trademarks or other intellectual property rights therein, by implication or otherwise."
          ],
          "type": "string",
          "minLength": 1,
          "maxLength": 2000
        }
      },
      "required": [
        "version",
        "disclosingParty",
        "proprietaryInformationAndConfidential"
      ],
      "minProperties": 3,
      "maxProperties": 3
    },
    "transactionHeader": {
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "transactionIdempotentId": {
          "examples": [
            "3B34A671-BB17-400D-90BF-7CBF9C96E8ED"
          ],
          "type": "string",
          "minLength": 36,
          "maxLength": 36,
          "pattern": "^[\\da-fA-F]{8}-[\\da-fA-F]{4}-[\\da-fA-F]{4}-[\\da-fA-F]{4}-[\\da-fA-F]{12}$"
        },
        "transactionDate": {
          "examples": [
            "2022-07-11T02:03:40"
          ],
          "type": "string",
          "format": "date-time"
        },
        "clientCode": {
          "examples": [
            "1799"
          ],
          "type": "string",
          "minLength": 1,
          "maxLength": 100,
          "format": "integer"
        },
        "clientName": {
          "examples": [
            "AcmeInc"
          ],
          "type": "string",
          "minLength": 1,
          "maxLength": 100
        },
        "vendorCode": {
          "examples": [
            "MC"
          ],
          "type": "string",
          "minLength": 1,
          "maxLength": 100
        },
        "vendorName": {
          "examples": [
            "Mortgage Connect"
          ],
          "type": "string",
          "minLength": 1,
          "maxLength": 100
        }
      },
      "required": [
        "transactionIdempotentId",
        "transactionDate",
        "clientCode",
        "clientName",
        "vendorCode",
        "vendorName"
      ],
      "minProperties": 6,
      "maxProperties": 6
    },
    "transactionBody": {
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "transactionCode": {
          "examples": [
            "Hold-Order-Resolved"
          ],
          "type": "string",
          "const": "Hold-Order-Resolved"
        },
        "transactionId": {
          "examples": [
            "7832143"
          ],
          "type": "string",
          "minLength": 1,
          "maxLength": 50
        },
        "productTransactionId": {
          "examples": [
            "7832143"
          ],
          "type": "string",
          "minLength": 0,
          "maxLength": 50
        },
        "orderNumber": {
          "examples": [
            "2429888"
          ],
          "type": "integer"
        },
        "productCode": {
          "type": "string",
          "minLength": 3,
          "maxLength": 4,
          "enum": [
            "PRLM",
            "PRLP",
            "TTLP",
            "TTLN"
          ]
        },
        "delayId": {
          "type": "integer"
        },
        "note": {
          "example": [
            "Approval needed - Tax Approval Needed\n\ndelay comment"
          ],
          "type": "string"
        },
        "noteDate": {
          "example": [
            "07-11-2022T14:00:00-4:00"
          ],
          "type": "string",
          "format": "date-time"
        }
      },
      "required": [
        "transactionCode",
        "transactionId",
        "orderNumber",
        "productCode",
        "delayId",
        "note",
        "noteDate"
      ]
    },
    "transactionExtensions": {
      "type": "object",
      "properties": {
        "transactionExtension": {
          "type": "array",
          "items": {
            "type": "object",
            "additionalProperties": false,
            "properties": {
              "key": {
                "examples": [
                  "Client Specific Key"
                ],
                "type": "string",
                "minLength": 1,
                "maxLength": 200
              },
              "value": {
                "examples": [
                  "Client Specific Value"
                ],
                "type": "string",
                "minLength": 1
              }
            },
            "required": [
              "key",
              "value"
            ],
            "minProperties": 2,
            "maxProperties": 2
          },
          "minItems": 0
        }
      }
    }
  },
  "required": [
    "transactionHeader",
    "transactionBody"
  ],
  "minProperties": 2,
  "maxProperties": 4
}
/* Copyright © 2023 Mortgage Connect LP */

<?xml version="1.0" encoding="utf-8"?>
<xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema">
  <xs:element name="root">
    <xs:complexType>
      <xs:sequence>
        <xs:element ref="legalHeader" minOccurs="0"/>
        <xs:element ref="transactionHeader"/>
        <xs:element name="transactionBody">
          <xs:complexType>
            <xs:all>
              <xs:element name="transactionCode" type="xs:string" fixed="Hold-Order-Resolved"/>
              <xs:element ref="transactionId"/>
              <xs:element name="productTransactionId" type="transactionId" minOccurs="0"/>
              <xs:element name="orderNumber" type="orderNo"/>
              <xs:element ref="productCode"/>
              <xs:element name="noteId" type="xs:integer"/>
              <xs:element name="note" type="xs:string"/>
              <xs:element name="noteDate" type="xs:dateTime"/>
            </xs:all>
          </xs:complexType>
        </xs:element>
        <xs:element ref="transactionExtensions" minOccurs="0"/>
      </xs:sequence>
    </xs:complexType>
  </xs:element>
</xs:schema>

✅ The following is an 'Accepted' example payload to be returned in the HTTP response.

Accepted Acknowledgment payloads are typically message type agnostic.

Accepted Acknowledgment payloads are typically message type agnostic.

⛔ The following is a 'Rejected' example payload to be returned in the HTTP response.

Rejected Acknowledgment payloads are typically message type agnostic.

Rejected Acknowledgment payloads are typically message type agnostic.

The Hold-Order-Resolved API method is the mechanism in which a Client is notified that Mortgage Connect has resolved a delay in processing their Default Title Order.

The order on hold is identified by the combination of the OrderNumber and ProductCode.

View Workflow Orchestration

Mortgage Connect URL

POST 🔒 https://{BaseUrl}/Api/V1.0/{ClientCode}/SubmitMessage

Mortgage Connect URL Properties

Property	Requirement	Description
BaseUrl	Required	A unique base Url that represents a specific Mortgage Connect endpoint and targeted environment.
ClientCode	Required	A unique code assigned to all clients that is used for identification, authentication, and customization purposes.

Property Definitions - Transaction Header

Defines the properties represented in the Transaction Header object (JSON) or node (XML). Note that this message artifact is identical for each and every message type.

View Transaction Header Details

Property Definitions - Transaction Body

Defines the properties represented in the Transaction Body object (JSON) or node (XML).

Property	Requirement	Data Type	Min / Max	Description
transactionBody	Required			A parent object (JSON) or node (XML) that contains the transaction metadata.
transactionCode	Required	String	10 / 10	A static value of `Hold-Order-Resolved`. The transaction code is meant to identify the message type and the context or action that should be taken. A `Hold-Order-Resolved` transaction code indicates that a Default Title Order had a delay resolved. Possible Values: Hold-Order-Resolved
transactionId	Required	String	1 / 50	Represents the Client's unique order number.
productTransactionId	Optional	String	0 / 50	Represents the Client's unique product order number. Note that the `productTransactionId` field is not used in most circumstances. However, when there is a need to further differentiate order numbers at a product level, that share the same `transactionId`, (i.e. the primary order level id), then the `productTransactionId` can be used to ensure uniqueness across the integration transactions. This makes it possible for multiple orders of the same product type to be placed using the same `transactionId`. The use of the `productTransactionId` field and any specific workflow deviations will be vetted during the onboarding process.
orderNumber	Required	Integer		Represents Mortgage Connects unique order number.
productCode	Required	String	3 / 4	Represents Mortgage Connect's product code. Possible Values: PRLM `Property Report Loan Mod` TSG `Trustee Sale Guarantee` PFCF `Pre-Foreclosure Report` PJR `Preliminary Judicial Report` etc. Traditionally, clients use Mortgage Connects `Product Code` names and thus there is a one to one mapping relationship that is maintained by the client. However, Mortgage Connect is aware that our naming conventions may not resonate and that there are many inconsistencies in product code naming conventions and nomenclatures. It is for this reason that Mortgage Connect is able to map the client's product code to Mortgage Connect's product code to ease the transition. Any required product code mapping exercises will be addressed during the onboarding process. The supported `productCode`(s) are specific per integration and will be determined during the onboarding process. Note that the minimum/maximum length requirement of 3/4 is only applicable if using Mortgage Connect's internal product codes, otherwise when mapping to the client's product codes, the minimum/maximum is 1/50.
delayId	Required	Integer		Uniquely identifies the delay. Used to correlate Hold-Order and Hold-Order-Resolved events.
note	Required	String	1 / MAX	The resolution, resolution date, delay reason, delay sub-reason, delay comments, and delay date associated with the Order/Product formatted into a note.
noteDate	Required	DateTime		The date when the delay was resolved.

Property Definitions - Transaction Extensions

Defines the properties represented in the TransactionExtensions object (JSON) or node (XML). Note that this message artifact is identical for each and every message type.

View Transaction Extension Details

Default Title - MC125 - Date Down

🌐 The following is an example payload to be posted in the body of the HTTP request.

/* Copyright © 2023 Mortgage Connect LP */
{
  "transactionHeader": {
    "transactionIdempotentId": "3B34A671-BB17-400D-90BF-7CBF9C96E8ED",
    "transactionDate": "2022-07-11T02:03:40",
    "clientCode": "1799",
    "clientName": "AcmeInc",
    "vendorCode": "MC",
    "vendorName": "Mortgage Connect"
  },
  "transactionBody": {
    "transactionCode": "Date-Down",
    "transactionId": "7832143",
    "productTransactionId": "",
    "orderNumber": 2429888,
    "productCode": "TSG",
    "specialInstructions": "Proceed with property sale as originally planned.",
    "note": "We have scheduled a trustees sale of the property.",
    "noteDate": "2022-10-19T14:00:00",
    "dateDownType": "FIRUpdate",
    "effectiveDate": "2022-06-30",
    "newMatters": true,
    "clear": true,
    "documents": {
      "document": [
        {
          "documentId": "72033395",
          "type": "Datedown",
          "name": "Datedown.pdf",
          "fileType": "PDF",
          "contentMediaType": "application/pdf",
          "contentUnicodeTextEncodingType": "UTF8",
          "contentBinaryEncodingType": "Base64",
          "content": "Base64 String",
          "description": "Brief overview of the document"
        }
      ]
    }
  },
  "transactionExtensions": {
    "transactionExtension": [
      {
        "key": "Client Specific Key 1",
        "value": "Client Specific Value 1"
      },
      {
        "key": "Client Specific Key 2",
        "value": "Client Specific Value 2"
      }
    ]
  }
}
/* Copyright © 2023 Mortgage Connect LP */

<!-- Copyright © 2023 Mortgage Connect LP -->
<root>
    <transactionHeader>
        <transactionIdempotentId>3B34A671-BB17-400D-90BF-7CBF9C96E8ED</transactionIdempotentId>
        <transactionDate>022-07-11T02:03:40</transactionDate>
        <clientCode>1799</clientCode>
        <clientName>AcmeInc</clientName>
        <vendorCode>MC</vendorCode>
        <vendorName>Mortgage Connect</vendorName>
    </transactionHeader>
    <transactionBody>
        <transactionCode>Date-Down</transactionCode>
        <transactionId>7832143</transactionId>
        <productTransactionId></productTransactionId>
        <orderNumber>2429888</orderNumber>
        <productCode>TSG</productCode>
        <specialInstruction>Proceed with property sale as originally planned.</specialInstruction>
        <note>We have scheduled a trustees sale of the property.</note>
        <noteDate>2022-10-19T14:00:00</noteDate>
        <dateDownType>FIRUpdate</dateDownType>
        <effectiveDate>2022-06-30</effectiveDate>
        <newMatters>true</newMatters>
        <clear>true</clear>
        <documents>
            <document>
                <documentId>1243992</documentId>
                <type>Datedown</type>
                <name>Datedown.pdf</name>
                <fileType>PDF</fileType>
                <contentMediaType>application/pdf</contentMediaType>
                <contentUnicodeTextEncodingType>UTF8</contentUnicodeTextEncodingType>
                <contentBinaryEncodingType>Base64</contentBinaryEncodingType>
                <content>Base64 String</content>
                <description>Brief overview of the document</description>
            </document>
        </documents>
    </transactionBody>
    <transactionExtensions>
        <transactionExtension>
            <key>Client Specific Key 1</key>
            <value>Client Specific Value 1</value>
        </transactionExtension>
        <transactionExtension>
            <key>Client Specific Key 2</key>
            <value>Client Specific Value 1</value>
        </transactionExtension>
    </transactionExtensions>
</root>
<!-- Copyright © 2023 Mortgage Connect LP -->

👍 The request payload can be verified using the following validation schema.

/* Copyright © 2023 Mortgage Connect LP */
{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "$id": "root",
  "description": "Copyright @ 2022 Mortgage Connect LP - Title & Tax Schema.",
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "legalHeader": {
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "version": {
          "examples": [
            "1.0.8.0"
          ],
          "type": "string",
          "minLength": 1,
          "maxLength": 20
        },
        "disclosingParty": {
          "examples": [
            "Copyright @ 2022 Mortgage Connect LP"
          ],
          "type": "string",
          "minLength": 1,
          "maxLength": 100
        },
        "proprietaryInformationAndConfidential": {
          "examples": [
            "Ownership of Proprietary Information. The Recipient agrees that it shall not receive any right, title or interest, or any license or right to use, the Disclosing Partys Proprietary Information, including, but not limited to, technology, ideas, concepts, drawings, documentation, designs, prototypes, processes, trade secrets, trademarks or other intellectual property rights therein, by implication or otherwise."
          ],
          "type": "string",
          "minLength": 1,
          "maxLength": 2000
        }
      },
      "required": [
        "version",
        "disclosingParty",
        "proprietaryInformationAndConfidential"
      ],
      "minProperties": 3,
      "maxProperties": 3
    },
    "transactionHeader": {
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "transactionIdempotentId": {
          "examples": [
            "3B34A671-BB17-400D-90BF-7CBF9C96E8ED"
          ],
          "type": "string",
          "minLength": 36,
          "maxLength": 36,
          "pattern": "^[\\da-fA-F]{8}-[\\da-fA-F]{4}-[\\da-fA-F]{4}-[\\da-fA-F]{4}-[\\da-fA-F]{12}$"
        },
        "transactionDate": {
          "examples": [
            "2022-07-11T02:03:40"
          ],
          "type": "string",
          "format": "date-time"
        },
        "clientCode": {
          "examples": [
            "1799"
          ],
          "type": "string",
          "minLength": 1,
          "maxLength": 100,
          "format": "integer"
        },
        "clientName": {
          "examples": [
            "AcmeInc"
          ],
          "type": "string",
          "minLength": 1,
          "maxLength": 100
        },
        "vendorCode": {
          "examples": [
            "MC"
          ],
          "type": "string",
          "minLength": 1,
          "maxLength": 100
        },
        "vendorName": {
          "examples": [
            "Mortgage Connect"
          ],
          "type": "string",
          "minLength": 1,
          "maxLength": 100
        }
      },
      "required": [
        "transactionIdempotentId",
        "transactionDate",
        "clientCode",
        "clientName",
        "vendorCode",
        "vendorName"
      ],
      "minProperties": 6,
      "maxProperties": 6
    },
    "transactionBody": {
      "title": "TransactionBody",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "transactionCode": {
          "examples": [
            "Date-Down"
          ],
          "type": "string",
          "const": "Date-Down"
        },
        "transactionId": {
          "examples": [
            "7832143"
          ],
          "type": "string",
          "minLength": 1,
          "maxLength": 50
        },
        "productTransactionId": {
          "examples": [
            "7832143"
          ],
          "type": "string",
          "minLength": 0,
          "maxLength": 50
        },
        "orderNumber": {
          "examples": [
            "2429888"
          ],
          "type": "integer"
        },
        "productCode": {
          "type": "string",
          "minLength": 3,
          "maxLength": 4,
          "enum": [
            "PRLM",
            "TSG",
            "PFCF",
            "PJR"
          ]
        },
        "dateDownType": {
          "type": "string",
          "enum": [
            "_10Day",
            "_5Day",
            "AfterSale",
            "BACEND",
            "Courtesy",
            "Deed In Lieu",
            "DeedInLieu",
            "Elimination",
            "FCPolicyUpdate",
            "FIRUpdate",
            "General",
            "IRS",
            "Judicial Sale",
            "LITUpdate",
            "MiscDateDown",
            "MiscEndorsement",
            "MiscTsgEndorsement",
            "PubDateDown",
            "Publication",
            "REO Update",
            "Sale",
            "SaleDateDown",
            "Start-Over",
            "Startover",
            "StartOverDateDown",
            "StartoverEndorsement",
            "TSG",
            "TSGDateDown"
          ]
        },
        "effectiveDate": {
          "type": "string",
          "format": "date"
        },
        "newMatters": {
          "example": [
            true
          ],
          "type": "boolean"
        },
        "clear": {
          "example": [
            true
          ],
          "type": "boolean"
        },
        "documents": {
          "type": "object",
          "properties": {
            "document": {
              "type": "array",
              "items": {
                "type": "object",
                "properties": {
                  "documentId": {
                    "examples": [
                      1243992
                    ],
                    "type": "string",
                    "maxLength": 36
                  },
                  "type": {
                    "type": "string",
                    "minLength": 0,
                    "maxLength": 0,
                    "enum": [
                      "Other"
                    ]
                  },
                  "name": {
                    "examples": [
                      "patriot-search.pdf"
                    ],
                    "type": "string",
                    "maxLength": 100
                  },
                  "fileType": {
                    "type": "string",
                    "enum": [
                      "DOC",
                      "DOCX",
                      "PDF",
                      "doc",
                      "docx",
                      "pdf"
                    ]
                  },
                  "contentMediaType": {
                    "type": "string",
                    "enum": [
                      "application/msword",
                      "application/vnd.openxmlformats-officedocument.wordprocessingml.document",
                      "application/pdf"
                    ]
                  },
                  "contentUnicodeTextEncodingType": {
                    "type": "string",
                    "enum": [
                      "UTF8"
                    ]
                  },
                  "contentBinaryEncodingType": {
                    "type": "string",
                    "enum": [
                      "Base64"
                    ]
                  },
                  "content": {
                    "contentEncoding": "base64",
                    "type": "string"
                  },
                  "description": {
                    "type": "string",
                    "maxLength": 255
                  }
                },
                "required": [
                  "documentId",
                  "type",
                  "name",
                  "fileType",
                  "contentMediaType",
                  "contentUnicodeTextEncodingType",
                  "contentBinaryEncodingType",
                  "content"
                ],
                "allOf": [
                  {
                    "if": {
                      "properties": {
                        "fileType": {
                          "enum": [
                            "DOC",
                            "doc"
                          ]
                        }
                      }
                    },
                    "then": {
                      "properties": {
                        "contentMediaType": {
                          "enum": [
                            "application/msword"
                          ]
                        }
                      }
                    }
                  },
                  {
                    "if": {
                      "properties": {
                        "fileType": {
                          "enum": [
                            "DOCX",
                            "docx"
                          ]
                        }
                      }
                    },
                    "then": {
                      "properties": {
                        "contentMediaType": {
                          "enum": [
                            "application/vnd.openxmlformats-officedocument.wordprocessingml.document"
                          ]
                        }
                      }
                    }
                  },
                  {
                    "if": {
                      "properties": {
                        "fileType": {
                          "enum": [
                            "PDF",
                            "pdf"
                          ]
                        }
                      }
                    },
                    "then": {
                      "properties": {
                        "contentMediaType": {
                          "enum": [
                            "application/pdf"
                          ]
                        }
                      }
                    }
                  }
                ]
              },
              "minItems": 1
            }
          }
        }
      }
    },
    "transactionExtensions": {
      "type": "object",
      "properties": {
        "transactionExtension": {
          "type": "array",
          "items": {
            "type": "object",
            "additionalProperties": false,
            "properties": {
              "key": {
                "examples": [
                  "Client Specific Key"
                ],
                "type": "string",
                "minLength": 1,
                "maxLength": 200
              },
              "value": {
                "examples": [
                  "Client Specific Value"
                ],
                "type": "string",
                "minLength": 1
              }
            },
            "required": [
              "key",
              "value"
            ],
            "minProperties": 2,
            "maxProperties": 2
          },
          "minItems": 0
        }
      }
    }
  },
  "required": [
    "transactionHeader",
    "transactionBody"
  ],
  "minProperties": 2,
  "maxProperties": 4
}
/* Copyright © 2023 Mortgage Connect LP */

<?xml version="1.0" encoding="utf-8"?>
<xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema">
  <xs:element name="root">
  <xs:complexType>
    <xs:sequence>
      <xs:element ref="legalHeader" minOccurs="0"/>
      <xs:element ref="transactionHeader"/>
      <xs:element name="transactionBody">
        <xs:complexType>
          <xs:all>
            <xs:element name="transactionCode" type="xs:string" fixed="Add-Note"/>
            <xs:element ref="transactionId"/>
            <xs:element name="productTransactionId" type="transactionId" minOccurs="0"/>
            <xs:element name="orderNumber" type="orderNo"/>
            <xs:element ref="productCode"/>
            <xs:element name="specialInstructions" type="xs:string"/>
            <xs:element name="note" type="xs:string" minOccurs="0"/>
            <xs:element name="noteDate" type="xs:dateTime" minOccurs="0"/>
          </xs:all>
        </xs:complexType>
      </xs:element>
      <xs:element ref="transactionExtensions" minOccurs="0"/>
    </xs:sequence>
  </xs:complexType>
  </xs:element>
</xs:schema>

✅ The following is an 'Accepted' example payload to be returned in the HTTP response.

Accepted Acknowledgment payloads are typically message type agnostic.

Accepted Acknowledgment payloads are typically message type agnostic.

⛔ The following is a 'Rejected' example payload to be returned in the HTTP response.

Rejected Acknowledgment payloads are typically message type agnostic.

Rejected Acknowledgment payloads are typically message type agnostic.

The Date Down API method is the mechanism in which a Client or Mortgage Connect can submit a message, notifying the other party that Special Instructions were added to a Default Title order.

The order to update is identified by the combination of the OrderNumber and ProductCode.

View Workflow Orchestration

Mortgage Connect URL

POST 🔒 https://{BaseUrl}/Api/V1.0/{ClientCode}/SubmitMessage

Mortgage Connect URL Properties

Property	Requirement	Description
BaseUrl	Required	A unique base Url that represents a specific Mortgage Connect endpoint and targeted environment.
ClientCode	Required	A unique code assigned to all clients that is used for identification, authentication, and customization purposes.

Property Definitions - Transaction Header

Defines the properties represented in the Transaction Header object (JSON) or node (XML). Note that this message artifact is identical for each and every message type.

View Transaction Header Details

Property Definitions - Transaction Body

Defines the properties represented in the Transaction Body object (JSON) or node (XML).

Property	Requirement	Data Type	Min / Max	Description
transactionBody	Required			A parent object (JSON) or node (XML) that contains the transaction metadata.
transactionCode	Required	String	9 / 9	A static value of `Date-Down`. The transaction code is meant to identify the message type and the context or action that should be taken. In this context it implies that a new Title Order should be updated with additional or changed data. Possible Values: Date-Down
transactionId	Required	String	1 / 50	Represents the Client's unique order number.
productTransactionId	Optional	String	0 / 50	Represents the Client's unique product order number. Note that the `productTransactionId` field is not used in most circumstances. However, when there is a need to further differentiate order numbers at a product level, that share the same `transactionId`, (i.e. the primary order level id), then the `productTransactionId` can be used to ensure uniqueness across the integration transactions. This makes it possible for multiple orders of the same product type to be placed using the same `transactionId`. The use of the `productTransactionId` field and any specific workflow deviations will be vetted during the onboarding process.
orderNumber	Required	Integer		Represents Mortgage Connects unique order number.
productCode	Required	String	3 / 4	Represents Mortgage Connect's product code. Possible Values: PRLM `Property Report Loan Mod` TSG `Trustee Sale Guarantee` PFCF `Pre-Foreclosure Report` PJR `Preliminary Judicial Report` etc. Traditionally, clients use Mortgage Connects `Product Code` names and thus there is a one to one mapping relationship that is maintained by the client. However, Mortgage Connect is aware that our naming conventions may not resonate and that there are many inconsistencies in product code naming conventions and nomenclatures. It is for this reason that Mortgage Connect is able to map the client's product code to Mortgage Connect's product code to ease the transition. Any required product code mapping exercises will be addressed during the onboarding process. The supported `productCode`(s) are specific per integration and will be determined during the onboarding process. Note that the minimum/maximum length requirement of 3/4 is only applicable if using Mortgage Connect's internal product codes, otherwise when mapping to the client's product codes, the minimum/maximum is 1/50.
specialInstructions	Required	String	1 / MAX	Special instructions for processing the order.
note	Optional	String	1 / MAX	The actual note text to be associated with the Order/Product.
noteDate	Optional	DateTime		The date when the note was entered.
dateDownType	Optional	String	1 / 50	Indicates the type of `Date Down` data being provided. Possible Values: _10Day _5Day AfterSale BACEND Courtesy Deed In Lieu DeedInLieu Elimination FCPolicyUpdate FIRUpdate General IRS Judicial Sale LITUpdate MiscDateDown MiscEndorsement MiscTsgEndorsement PubDateDown Publication REO Update Sale SaleDateDown Start-Over Startover StartOverDateDown StartoverEndorsement TSG TSGDateDown
effectiveDate	Optional	Date		The date at which the `Date Down` is/was effective.
newMatters	Optional	Boolean		Indicates whether the Date Down is a new issue (true) or a previously known issue (false).
clear	Optional	Boolean		Indicates whether the Date Down has been addressed (true) or is currently open (false).
documents	Optional			A parent object (JSON) or node (XML) that contains a list of title documents. `(0 to Many)`
document	Optional			A parent object (JSON) or node (XML) that contains metadata associated with title documents.
documentId	Required	Integer		A number or string that uniquely identifies the document within the host system. When an outbound Date-Down event is sent by Mortgage Connect to the Client, the documentId will be a string in the form of an integer. The integer value represents the Identity Field and Primary Key associated with the corresponding document record. There is no hard requirement to capture this information. However, both parties are encouraged to do so, in order that conversations or any triaging of exceptions around these values can be correlated across systems.
type	Required	String	1 / 255	A name that uniquely identifies the document type. Traditionally, clients use Mortgage Connects `Document Type` names and thus there is a one to one mapping relationship that is maintained by the client. However, Mortgage Connect is aware that our naming conventions may not resonate and that there are many inconsistencies in document type naming conventions and nomenclatures. It is for this reason that Mortgage Connect is able to map the client's document type to Mortgage Connect's document type to ease the transition. Any required document mapping exercises will be addressed during the onboarding process. The supported `types`(s) are specific per integration and will be determined during the onboarding process.
name	Required	String	1 / 100	This is the user friendly name that is associated with the document.
fileType	Required	String	3 / 4	This indicates what type of document it is. This in the context of what the file extension represents. Possible Values: DOC DOCX PDF Future Values: CSV HTML JSON TXT XLS XLSX XML `DOC`, `DOCX`, and `PDF` are currently supported with the vast majority of the documents being delivered as `PDF` documents. The other types are included to support additional documents in the future.
contentMediaType	Required	String	1 / 100	This represents the content media type, i.e. `MIME Type`. Possible Values: application/msword (DOC) application/vnd.openxmlformats-officedocument.wordprocessingml.document (DOCX) application/pdf (PDF) Future Values: text/csv (CSV) text/html (HTML) application/json (JSON) text/plain (TXT) application/vnd.ms-excel (XLS) application/vnd.openxmlformats-officedocument.spreadsheetml.sheet (XLSX) application/xml (XML) At this time `application/msword (DOC)`, `application/vnd.openxmlformats-officedocument.wordprocessingml.document (DOCX)`, and `application/pdf (PDF)` are supported with `application/pdf (PDF)` being used 90+% of the time. The other types are added to support future media types.
contentUnicode TextEncodingType	Required	String	4 / 4	This indicates what unicode text encoding type was used to generate the document. Possible Values: UTF8
contentBinary EncodingType	Required	String	6 / 6	This indicates what binary encoding type was used to generate the document content. Possible Values: Base64
content	Required	String	1 / MAX	This represents the digital representation of the document after it has been encoded using Base64. See: https://en.wikipedia.org/wiki/Base64 for more information regarding Base64 formatting.
description	Optional	String	0 / 255	Provides a brief overview of the document contents.

Property Definitions - Transaction Extensions

Defines the properties represented in the TransactionExtensions object (JSON) or node (XML). Note that this message artifact is identical for each and every message type.

View Transaction Extension Details

Default Title - MC130 - Add Note

🌐 The following is an example payload to be posted in the body of the HTTP request.

/* Copyright © 2023 Mortgage Connect LP */
{
    "transactionHeader": {
        "transactionIdempotentId": "3B34A671-BB17-400D-90BF-7CBF9C96E8ED",
        "transactionDate": "2022-07-11T02:03:40",
        "clientCode": "1799",
        "clientName": "AcmeInc",
        "vendorCode": "MC",
        "vendorName": "Mortgage Connect"
    },
    "transactionBody": {
        "transactionCode": "Add-Note",
        "transactionId": "7832143",
        "productTransactionId": "",
        "orderNumber": 2429888,
        "productCode": "PRLM",
        "note": "We have scheduled a trustees sale of the property.",
        "noteDate": "2022-10-19T14:00:00"
    },
    "transactionExtensions": {
        "transactionExtension": [
            {
                "key": "Client Specific Key 1",
                "value": "Client Specific Value 1"
            },
            {
                "key": "Client Specific Key 2",
                "value": "Client Specific Value 2"
            }
        ]
    }
}
/* Copyright © 2023 Mortgage Connect LP */

<!-- Copyright © 2023 Mortgage Connect LP -->
<root>
    <transactionHeader>
        <transactionIdempotentId>3B34A671-BB17-400D-90BF-7CBF9C96E8ED</transactionIdempotentId>
        <transactionDate>022-07-11T02:03:40</transactionDate>
        <clientCode>1799</clientCode>
        <clientName>AcmeInc</clientName>
        <vendorCode>MC</vendorCode>
        <vendorName>Mortgage Connect</vendorName>
    </transactionHeader>
    <transactionBody>
        <transactionCode>Add-Note</transactionCode>
        <transactionId>7832143</transactionId>
        <productTransactionId></productTransactionId>
        <orderNumber>2429888</orderNumber>
        <productCode>PRLM</productCode>
        <note>We have scheduled a trustees sale of the property.</note>
        <noteDate>2022-10-19T14:00:00</noteDate>
    </transactionBody>
    <transactionExtensions>
        <transactionExtension>
            <key>Client Specific Key 1</key>
            <value>Client Specific Value 1</value>
        </transactionExtension>
        <transactionExtension>
            <key>Client Specific Key 2</key>
            <value>Client Specific Value 1</value>
        </transactionExtension>
    </transactionExtensions>
</root>
<!-- Copyright © 2023 Mortgage Connect LP -->

👍 The request payload can be verified using the following validation schema.

/* Copyright © 2023 Mortgage Connect LP */
{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "$id": "root",
  "description": "Copyright @ 2022 Mortgage Connect LP - Title & Tax Schema.",
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "legalHeader": {
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "version": {
          "examples": [
            "1.0.8.0"
          ],
          "type": "string",
          "minLength": 1,
          "maxLength": 20
        },
        "disclosingParty": {
          "examples": [
            "Copyright @ 2022 Mortgage Connect LP"
          ],
          "type": "string",
          "minLength": 1,
          "maxLength": 100
        },
        "proprietaryInformationAndConfidential": {
          "examples": [
            "Ownership of Proprietary Information. The Recipient agrees that it shall not receive any right, title or interest, or any license or right to use, the Disclosing Partys Proprietary Information, including, but not limited to, technology, ideas, concepts, drawings, documentation, designs, prototypes, processes, trade secrets, trademarks or other intellectual property rights therein, by implication or otherwise."
          ],
          "type": "string",
          "minLength": 1,
          "maxLength": 2000
        }
      },
      "required": [
        "version",
        "disclosingParty",
        "proprietaryInformationAndConfidential"
      ],
      "minProperties": 3,
      "maxProperties": 3
    },
    "transactionHeader": {
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "transactionIdempotentId": {
          "examples": [
            "3B34A671-BB17-400D-90BF-7CBF9C96E8ED"
          ],
          "type": "string",
          "minLength": 36,
          "maxLength": 36,
          "pattern": "^[\\da-fA-F]{8}-[\\da-fA-F]{4}-[\\da-fA-F]{4}-[\\da-fA-F]{4}-[\\da-fA-F]{12}$"
        },
        "transactionDate": {
          "examples": [
            "2022-07-11T02:03:40"
          ],
          "type": "string",
          "format": "date-time"
        },
        "clientCode": {
          "examples": [
            "1799"
          ],
          "type": "string",
          "minLength": 1,
          "maxLength": 100,
          "format": "integer"
        },
        "clientName": {
          "examples": [
            "AcmeInc"
          ],
          "type": "string",
          "minLength": 1,
          "maxLength": 100
        },
        "vendorCode": {
          "examples": [
            "MC"
          ],
          "type": "string",
          "minLength": 1,
          "maxLength": 100
        },
        "vendorName": {
          "examples": [
            "Mortgage Connect"
          ],
          "type": "string",
          "minLength": 1,
          "maxLength": 100
        }
      },
      "required": [
        "transactionIdempotentId",
        "transactionDate",
        "clientCode",
        "clientName",
        "vendorCode",
        "vendorName"
      ],
      "minProperties": 6,
      "maxProperties": 6
    },
    "transactionBody": {
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "transactionCode": {
          "examples": [
            "Add-Note"
          ],
          "type": "string",
          "const": "Add-Note"
        },
        "transactionId": {
          "examples": [
            "7832143"
          ],
          "type": "string",
          "minLength": 1,
          "maxLength": 50
        },
        "productTransactionId": {
          "examples": [
            "7832143"
          ],
          "type": "string",
          "minLength": 0,
          "maxLength": 50
        },
        "orderNumber": {
          "examples": [
            "2429888"
          ],
          "type": "integer"
        },
        "productCode": {
          "type": "string",
          "minLength": 3,
          "maxLength": 4,
          "enum": [
            "PRLM",
            "PRLP",
            "TTLP",
            "TTLN"
          ]
        },
        "note": {
          "example": [
            "We have scheduled a trustees sale of the property."
          ],
          "type": "string"
        },
        "noteDate": {
          "example": [
            "07-11-2022T14:00:00-4:00"
          ],
          "type": "string",
          "format": "date-time"
        }
      },
      "required": [
        "transactionCode",
        "transactionId",
        "orderNumber",
        "productCode",
        "note",
        "noteDate"
      ]
    },
    "transactionExtensions": {
      "type": "object",
      "properties": {
        "transactionExtension": {
          "type": "array",
          "items": {
            "type": "object",
            "additionalProperties": false,
            "properties": {
              "key": {
                "examples": [
                  "Client Specific Key"
                ],
                "type": "string",
                "minLength": 1,
                "maxLength": 200
              },
              "value": {
                "examples": [
                  "Client Specific Value"
                ],
                "type": "string",
                "minLength": 1
              }
            },
            "required": [
              "key",
              "value"
            ],
            "minProperties": 2,
            "maxProperties": 2
          },
          "minItems": 0
        }
      }
    }
  },
  "required": [
    "transactionHeader",
    "transactionBody"
  ],
  "minProperties": 2,
  "maxProperties": 4
}
/* Copyright © 2023 Mortgage Connect LP */

<?xml version="1.0" encoding="utf-8"?>
<xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema">
  <xs:element name="root">
  <xs:complexType>
    <xs:sequence>
      <xs:element ref="legalHeader" minOccurs="0"/>
      <xs:element ref="transactionHeader"/>
      <xs:element name="transactionBody">
        <xs:complexType>
          <xs:all>
            <xs:element name="transactionCode" type="xs:string" fixed="Add-Note"/>
            <xs:element ref="transactionId"/>
            <xs:element name="productTransactionId" type="transactionId" minOccurs="0"/>
            <xs:element name="orderNumber" type="orderNo"/>
            <xs:element ref="productCode"/>
            <xs:element name="note" type="xs:string"/>
            <xs:element name="noteDate" type="xs:dateTime"/>
          </xs:all>
        </xs:complexType>
      </xs:element>
      <xs:element ref="transactionExtensions" minOccurs="0"/>
    </xs:sequence>
  </xs:complexType>
  </xs:element>
</xs:schema>

✅ The following is an 'Accepted' example payload to be returned in the HTTP response.

Accepted Acknowledgment payloads are typically message type agnostic.

Accepted Acknowledgment payloads are typically message type agnostic.

⛔ The following is a 'Rejected' example payload to be returned in the HTTP response.

Rejected Acknowledgment payloads are typically message type agnostic.

Rejected Acknowledgment payloads are typically message type agnostic.

The Add Note API method is the mechanism in which a Client or Mortgage Connect can submit a message to add a note to the Default Title Order.

View Workflow Orchestration

Client URL

POST 🔒 To be determined during onboarding process.

Mortgage Connect URL

POST 🔒 https://{BaseUrl}/Api/V1.0/{ClientCode}/SubmitMessage

Mortgage Connect URL Properties

Property	Requirement	Description
BaseUrl	Required	A unique base Url that represents a specific Mortgage Connect endpoint and targeted environment.
ClientCode	Required	A unique code assigned to all clients that is used for identification, authentication, and customization purposes.

Property Definitions - Transaction Header

Defines the properties represented in the Transaction Header object (JSON) or node (XML). Note that this message artifact is identical for each and every message type.

View Transaction Header Details

Property Definitions - Transaction Body

Defines the properties represented in the Transaction Body object (JSON) or node (XML).

Property	Requirement	Data Type	Min / Max	Description
transactionBody	Required			A parent object (JSON) or node (XML) that contains the transaction metadata.
**transactionCode	Required	String	8 / 8	A static value of `Add-Note`. The transaction code is meant to identify the message type and the context or action that should be taken. In this context it implies that a note should be added to the Default Title Order. Possible Values: Add-Note
transactionId	Required	String	1 / 50	Represents the Client's unique order number.
productTransactionId	Optional	String	0 / 50	Represents the Client's unique product order number. Note that the `productTransactionId` field is not used in most circumstances. However, when there is a need to further differentiate order numbers at a product level, that share the same `transactionId`, (i.e. the primary order level id), then the `productTransactionId` can be used to ensure uniqueness across the integration transactions. This makes it possible for multiple orders of the same product type to be placed using the same `transactionId`. The use of the `productTransactionId` field and any specific workflow deviations will be vetted during the onboarding process.
orderNumber	Required	Integer		Represents Mortgage Connects unique order number.
productCode	Required	String	3 / 4	Represents Mortgage Connect's product code. Possible Values: PRLM `Property Report Loan Mod` TSG `Trustee Sale Guarantee` PFCF `Pre-Foreclosure Report` PJR `Preliminary Judicial Report` etc. Traditionally, clients use Mortgage Connects `Product Code` names and thus there is a one to one mapping relationship that is maintained by the client. However, Mortgage Connect is aware that our naming conventions may not resonate and that there are many inconsistencies in product code naming conventions and nomenclatures. It is for this reason that Mortgage Connect is able to map the client's product code to Mortgage Connect's product code to ease the transition. Any required product code mapping exercises will be addressed during the onboarding process. The supported `productCode`(s) are specific per integration and will be determined during the onboarding process. Note that the minimum/maximum length requirement of 3/4 is only applicable if using Mortgage Connect's internal product codes, otherwise when mapping to the client's product codes, the minimum/maximum is 1/50.
note	Required	String	1 / MAX	The actual note text to be associated with the Order/Product.
noteDate	Required	DateTime		The date when the note was entered.

Property Definitions - Transaction Extensions

Defines the properties represented in the TransactionExtensions object (JSON) or node (XML). Note that this message artifact is identical for each and every message type.

View Transaction Extension Details

Default Title - MC140 - Add Note Action

🌐 The following is an example payload to be posted in the body of the HTTP request.

/* Copyright © 2023 Mortgage Connect LP */
{
    "transactionHeader": {
        "transactionIdempotentId": "3B34A671-BB17-400D-90BF-7CBF9C96E8ED",
        "transactionDate": "2022-07-11T02:03:40",
        "clientCode": "1799",
        "clientName": "AcmeInc",
        "vendorCode": "MC",
        "vendorName": "Mortgage Connect"
    },
    "transactionBody": {
        "transactionCode": "Add-Note-Action",
        "transactionId": "7832143",
        "productTransactionId": "",
        "orderNumber": 2429888,
        "productCode": "PRLM",
        "note": "Please call borrower immediately to confirm martial status.",
        "noteDate": "2022-10-19T14:00:00"
    },
    "transactionExtensions": {
        "transactionExtension": [
            {
                "key": "Client Specific Key 1",
                "value": "Client Specific Value 1"
            },
            {
                "key": "Client Specific Key 2",
                "value": "Client Specific Value 2"
            }
        ]
    }
}
/* Copyright © 2023 Mortgage Connect LP */

<!-- Copyright © 2023 Mortgage Connect LP -->
<root>
    <transactionHeader>
        <transactionIdempotentId>3B34A671-BB17-400D-90BF-7CBF9C96E8ED</transactionIdempotentId>
        <transactionDate>022-07-11T02:03:40</transactionDate>
        <clientCode>1799</clientCode>
        <clientName>AcmeInc</clientName>
        <vendorCode>MC</vendorCode>
        <vendorName>Mortgage Connect</vendorName>
    </transactionHeader>
    <transactionBody>
        <transactionCode>Add-Note-Action</transactionCode>
        <transactionId>7832143</transactionId>
        <productTransactionId></productTransactionId>
        <orderNumber>2429888</orderNumber>
        <productCode>PRLM</productCode>
        <note>Please call borrower immediately to confirm martial status.</note>
        <noteDate>2022-10-19T14:00:00</noteDate>
    </transactionBody>
    <transactionExtensions>
        <transactionExtension>
            <key>Client Specific Key 1</key>
            <value>Client Specific Value 1</value>
        </transactionExtension>
        <transactionExtension>
            <key>Client Specific Key 2</key>
            <value>Client Specific Value 1</value>
        </transactionExtension>
    </transactionExtensions>
</root>
<!-- Copyright © 2023 Mortgage Connect LP -->

👍 The request payload can be verified using the following validation schema.

/* Copyright © 2023 Mortgage Connect LP */
{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "$id": "root",
  "description": "Copyright @ 2022 Mortgage Connect LP - Title & Tax Schema.",
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "legalHeader": {
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "version": {
          "examples": [
            "1.0.8.0"
          ],
          "type": "string",
          "minLength": 1,
          "maxLength": 20
        },
        "disclosingParty": {
          "examples": [
            "Copyright @ 2022 Mortgage Connect LP"
          ],
          "type": "string",
          "minLength": 1,
          "maxLength": 100
        },
        "proprietaryInformationAndConfidential": {
          "examples": [
            "Ownership of Proprietary Information. The Recipient agrees that it shall not receive any right, title or interest, or any license or right to use, the Disclosing Partys Proprietary Information, including, but not limited to, technology, ideas, concepts, drawings, documentation, designs, prototypes, processes, trade secrets, trademarks or other intellectual property rights therein, by implication or otherwise."
          ],
          "type": "string",
          "minLength": 1,
          "maxLength": 2000
        }
      },
      "required": [
        "version",
        "disclosingParty",
        "proprietaryInformationAndConfidential"
      ],
      "minProperties": 3,
      "maxProperties": 3
    },
    "transactionHeader": {
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "transactionIdempotentId": {
          "examples": [
            "3B34A671-BB17-400D-90BF-7CBF9C96E8ED"
          ],
          "type": "string",
          "minLength": 36,
          "maxLength": 36,
          "pattern": "^[\\da-fA-F]{8}-[\\da-fA-F]{4}-[\\da-fA-F]{4}-[\\da-fA-F]{4}-[\\da-fA-F]{12}$"
        },
        "transactionDate": {
          "examples": [
            "2022-07-11T02:03:40"
          ],
          "type": "string",
          "format": "date-time"
        },
        "clientCode": {
          "examples": [
            "1799"
          ],
          "type": "string",
          "minLength": 1,
          "maxLength": 100,
          "format": "integer"
        },
        "clientName": {
          "examples": [
            "AcmeInc"
          ],
          "type": "string",
          "minLength": 1,
          "maxLength": 100
        },
        "vendorCode": {
          "examples": [
            "MC"
          ],
          "type": "string",
          "minLength": 1,
          "maxLength": 100
        },
        "vendorName": {
          "examples": [
            "Mortgage Connect"
          ],
          "type": "string",
          "minLength": 1,
          "maxLength": 100
        }
      },
      "required": [
        "transactionIdempotentId",
        "transactionDate",
        "clientCode",
        "clientName",
        "vendorCode",
        "vendorName"
      ],
      "minProperties": 6,
      "maxProperties": 6
    },
    "transactionBody": {
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "transactionCode": {
          "examples": [
            "Add-Note-Action"
          ],
          "type": "string",
          "const": "Add-Note-Action"
        },
        "transactionId": {
          "examples": [
            "7832143"
          ],
          "type": "string",
          "minLength": 1,
          "maxLength": 50
        },
        "productTransactionId": {
          "examples": [
            "7832143"
          ],
          "type": "string",
          "minLength": 0,
          "maxLength": 50
        },
        "orderNumber": {
          "examples": [
            "2429888"
          ],
          "type": "integer"
        },
        "productCode": {
          "type": "string",
          "minLength": 3,
          "maxLength": 4,
          "enum": [
            "PRLM",
            "PRLP",
            "TTLP",
            "TTLN"
          ]
        },
        "note": {
          "example": [
            "We have scheduled a trustees sale of the property."
          ],
          "type": "string"
        },
        "noteDate": {
          "example": [
            "07-11-2022T14:00:00-4:00"
          ],
          "type": "string",
          "format": "date-time"
        }
      },
      "required": [
        "transactionCode",
        "transactionId",
        "orderNumber",
        "productCode",
        "note",
        "noteDate"
      ]
    },
    "transactionExtensions": {
      "type": "object",
      "properties": {
        "transactionExtension": {
          "type": "array",
          "items": {
            "type": "object",
            "additionalProperties": false,
            "properties": {
              "key": {
                "examples": [
                  "Client Specific Key"
                ],
                "type": "string",
                "minLength": 1,
                "maxLength": 200
              },
              "value": {
                "examples": [
                  "Client Specific Value"
                ],
                "type": "string",
                "minLength": 1
              }
            },
            "required": [
              "key",
              "value"
            ],
            "minProperties": 2,
            "maxProperties": 2
          },
          "minItems": 0
        }
      }
    }
  },
  "required": [
    "transactionHeader",
    "transactionBody"
  ],
  "minProperties": 2,
  "maxProperties": 4
}
/* Copyright © 2023 Mortgage Connect LP */

<?xml version="1.0" encoding="utf-8"?>
<xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema">
  <xs:element name="root">
  <xs:complexType>
    <xs:sequence>
      <xs:element ref="legalHeader" minOccurs="0"/>
      <xs:element ref="transactionHeader"/>
      <xs:element name="transactionBody">
        <xs:complexType>
          <xs:all>
            <xs:element name="transactionCode" type="xs:string" fixed="Add-Note-Action"/>
            <xs:element ref="transactionId"/>
            <xs:element name="productTransactionId" type="transactionId" minOccurs="0"/>
            <xs:element name="orderNumber" type="orderNo"/>
            <xs:element ref="productCode"/>
            <xs:element name="note" type="xs:string"/>
            <xs:element name="noteDate" type="xs:dateTime"/>
          </xs:all>
        </xs:complexType>
      </xs:element>
      <xs:element ref="transactionExtensions" minOccurs="0"/>
    </xs:sequence>
  </xs:complexType>
  </xs:element>
</xs:schema>

✅ The following is an 'Accepted' example payload to be returned in the HTTP response.

Accepted Acknowledgment payloads are typically message type agnostic.

Accepted Acknowledgment payloads are typically message type agnostic.

⛔ The following is a 'Rejected' example payload to be returned in the HTTP response.

Rejected Acknowledgment payloads are typically message type agnostic.

Rejected Acknowledgment payloads are typically message type agnostic.

The Add Note Action API method is the mechanism in which a Client or Mortgage Connect can submit a message to add a note to the Default Title Order with escalation.

View Workflow Orchestration

Client URL

POST 🔒 To be determined during onboarding process.

Mortgage Connect URL

POST 🔒 https://{BaseUrl}/Api/V1.0/{ClientCode}/SubmitMessage

Mortgage Connect URL Properties

Property	Requirement	Description
BaseUrl	Required	A unique base Url that represents a specific Mortgage Connect endpoint and targeted environment.
ClientCode	Required	A unique code assigned to all clients that is used for identification, authentication, and customization purposes.

Property Definitions - Transaction Header

Defines the properties represented in the Transaction Header object (JSON) or node (XML). Note that this message artifact is identical for each and every message type.

View Transaction Header Details

Property Definitions - Transaction Body

Defines the properties represented in the Transaction Body object (JSON) or node (XML).

Property	Requirement	Data Type	Min / Max	Description
transactionBody	Required			A parent object (JSON) or node (XML) that contains the transaction metadata.
transactionCode	Required	String	15 / 15	A static value of `Add-Note-Action`. The transaction code is meant to identify the message type and the context or action that should be taken. In this context it implies that a note should be added to the Default Title Order and it should be escalated to the proper personnel. Possible Values: Add-Note-Action
transactionId	Required	String	1 / 50	Represents the Client's unique order number.
productTransactionId	Optional	String	0 / 50	Represents the Client's unique product order number. Note that the `productTransactionId` field is not used in most circumstances. However, when there is a need to further differentiate order numbers at a product level, that share the same `transactionId`, (i.e. the primary order level id), then the `productTransactionId` can be used to ensure uniqueness across the integration transactions. This makes it possible for multiple orders of the same product type to be placed using the same `transactionId`. The use of the `productTransactionId` field and any specific workflow deviations will be vetted during the onboarding process.
orderNumber	Required	Integer		Represents Mortgage Connects unique order number.
productCode	Required	String	3 / 4	Represents Mortgage Connect's product code. Possible Values: PRLM `Property Report Loan Mod` TSG `Trustee Sale Guarantee` PFCF `Pre-Foreclosure Report` PJR `Preliminary Judicial Report` etc. Traditionally, clients use Mortgage Connects `Product Code` names and thus there is a one to one mapping relationship that is maintained by the client. However, Mortgage Connect is aware that our naming conventions may not resonate and that there are many inconsistencies in product code naming conventions and nomenclatures. It is for this reason that Mortgage Connect is able to map the client's product code to Mortgage Connect's product code to ease the transition. Any required product code mapping exercises will be addressed during the onboarding process. The supported `productCode`(s) are specific per integration and will be determined during the onboarding process. Note that the minimum/maximum length requirement of 3/4 is only applicable if using Mortgage Connect's internal product codes, otherwise when mapping to the client's product codes, the minimum/maximum is 1/50.
note	Required	String	1 / MAX	The actual text to be associated with the Order/Product.
noteDate	Required	DateTime		The date when the note was entered.

Property Definitions - Transaction Extensions

Defines the properties represented in the TransactionExtensions object (JSON) or node (XML). Note that this message artifact is identical for each and every message type.

View Transaction Extension Details

Default Title - MC150 - Add Attachment

🌐 The following is an example payload to be posted in the body of the HTTP request.

/* Copyright © 2023 Mortgage Connect LP */
{
    "transactionHeader": {
        "transactionIdempotentId": "3B34A671-BB17-400D-90BF-7CBF9C96E8ED",
        "transactionDate": "2022-07-11T02:03:40",
        "clientCode": "1799",
        "clientName": "AcmeInc",
        "vendorCode": "MC",
        "vendorName": "Mortgage Connect"
    },
    "transactionBody": {
        "transactionCode": "Add-Attachment",
        "transactionId": "7832143",
        "productTransactionId": "",
        "orderNumber": 2429888,
        "productCode": "PRLM",
        "documents": {
            "document": [
                {
                    "documentId": "1243992",
                    "type": "Patriot Search",
                    "name": "Patriot-Search.pdf",
                    "fileType": "PDF",
                    "contentMediaType": "application/pdf",
                    "contentUnicodeTextEncodingType": "UTF8",
                    "contentBinaryEncodingType": "Base64",
                    "content": "Base64 String",
                    "description": "Brief overview of the document"
                }
            ]
        }
    },
    "transactionExtensions": {
        "transactionExtension": [
            {
                "key": "Client Specific Key 1",
                "value": "Client Specific Value 1"
            },
            {
                "key": "Client Specific Key 2",
                "value": "Client Specific Value 2"
            }
        ]
    }
}
/* Copyright © 2023 Mortgage Connect LP */

<!-- Copyright © 2023 Mortgage Connect LP -->
<root>
    <transactionHeader>
        <transactionIdempotentId>3B34A671-BB17-400D-90BF-7CBF9C96E8ED</transactionIdempotentId>
        <transactionDate>2022-07-11T02:03:40</transactionDate>
        <clientCode>1799</clientCode>
        <clientName>AcmeInc</clientName>
        <vendorCode>MC</vendorCode>
        <vendorName>Mortgage Connect</vendorName>
    </transactionHeader>
    <transactionBody>
        <transactionCode>Add-Attachment</transactionCode>
        <transactionId>7832143</transactionId>
        <productTransactionId></productTransactionId>
        <orderNumber>2429888</orderNumber>
        <productCode>PRLM</productCode>
        <documents>
            <document>
                <documentId>1243992</documentId>
                <type>Patriot Search</type>
                <name>Patriot-Search.pdf</name>
                <fileType>PDF</fileType>
                <contentMediaType>application/pdf</contentMediaType>
                <contentUnicodeTextEncodingType>UTF8</contentUnicodeTextEncodingType>
                <contentBinaryEncodingType>Base64</contentBinaryEncodingType>
                <content>Base64 String</content>
                <description>Brief overview of the document</description>
            </document>
        </documents>
    </transactionBody>
    <transactionExtensions>
        <transactionExtension>
            <key>Client Specific Key 1</key>
            <value>Client Specific Value 1</value>
        </transactionExtension>
        <transactionExtension>
            <key>Client Specific Key 2</key>
            <value>Client Specific Value 1</value>
        </transactionExtension>
    </transactionExtensions>
</root>
<!-- Copyright © 2023 Mortgage Connect LP -->

👍 The request payload can be verified using the following validation schema.

/* Copyright © 2023 Mortgage Connect LP */
{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "$id": "root",
  "description": "Copyright @ 2022 Mortgage Connect LP",
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "legalHeader": {
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "version": {
          "examples": [
            "1.0.8.0"
          ],
          "type": "string",
          "minLength": 1,
          "maxLength": 20
        },
        "disclosingParty": {
          "examples": [
            "Copyright @ 2022 Mortgage Connect LP"
          ],
          "type": "string",
          "minLength": 1,
          "maxLength": 100
        },
        "proprietaryInformationAndConfidential": {
          "examples": [
            "Ownership of Proprietary Information. The Recipient agrees that it shall not receive any right, title or interest, or any license or right to use, the Disclosing Partys Proprietary Information, including, but not limited to, technology, ideas, concepts, drawings, documentation, designs, prototypes, processes, trade secrets, trademarks or other intellectual property rights therein, by implication or otherwise."
          ],
          "type": "string",
          "minLength": 1,
          "maxLength": 2000
        }
      },
      "required": [
        "version",
        "disclosingParty",
        "proprietaryInformationAndConfidential"
      ],
      "minProperties": 3,
      "maxProperties": 3
    },
    "transactionHeader": {
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "transactionIdempotentId": {
          "examples": [
            "3B34A671-BB17-400D-90BF-7CBF9C96E8ED"
          ],
          "type": "string",
          "minLength": 36,
          "maxLength": 36,
          "pattern": "^[\\da-fA-F]{8}-[\\da-fA-F]{4}-[\\da-fA-F]{4}-[\\da-fA-F]{4}-[\\da-fA-F]{12}$"
        },
        "transactionDate": {
          "examples": [
            "2022-07-11T02:03:40"
          ],
          "type": "string",
          "format": "date-time"
        },
        "clientCode": {
          "examples": [
            "1799"
          ],
          "type": "string",
          "minLength": 1,
          "maxLength": 100,
          "format": "integer"
        },
        "clientName": {
          "examples": [
            "AcmeInc"
          ],
          "type": "string",
          "minLength": 1,
          "maxLength": 100
        },
        "vendorCode": {
          "examples": [
            "MC"
          ],
          "type": "string",
          "minLength": 1,
          "maxLength": 100
        },
        "vendorName": {
          "examples": [
            "Mortgage Connect"
          ],
          "type": "string",
          "minLength": 1,
          "maxLength": 100
        }
      },
      "required": [
        "transactionIdempotentId",
        "transactionDate",
        "clientCode",
        "clientName",
        "vendorCode",
        "vendorName"
      ],
      "minProperties": 6,
      "maxProperties": 6
    },
    "transactionBody": {
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "transactionCode": {
          "examples": [
            "Add-Attachment"
          ],
          "type": "string",
          "const": "Add-Attachment"
        },
        "transactionId": {
          "examples": [
            "7832143"
          ],
          "type": "string",
          "minLength": 1,
          "maxLength": 50
        },
        "productTransactionId": {
          "examples": [
            "7832143"
          ],
          "type": "string",
          "minLength": 0,
          "maxLength": 50
        },
        "orderNumber": {
          "examples": [
            "2429888"
          ],
          "type": "integer"
        },
        "productCode": {
          "type": "string",
          "minLength": 3,
          "maxLength": 4,
          "enum": [
            "PRLM",
            "PRLP",
            "TTLP",
            "TTLN"
          ]
        },
        "documents": {
          "type": "object",
          "properties": {
            "document": {
              "type": "array",
              "items": {
                "type": "object",
                "properties": {
                  "documentId": {
                    "examples": [
                      "1243992"
                    ],
                    "type": "string"
                  },
                  "type": {
                    "type": "string",
                    "minLength": 0,
                    "maxLength": 0,
                    "enum": [
                      "Other"
                    ]
                  },
                  "name": {
                    "examples": [
                      "patriot-search.pdf"
                    ],
                    "type": "string",
                    "maxLength": 100
                  },
                  "fileType": {
                    "type": "string",
                    "enum": [
                      "DOC",
                      "DOCX",
                      "PDF",
                      "doc",
                      "docx",
                      "pdf"
                    ]
                  },
                  "contentMediaType": {
                    "type": "string",
                    "enum": [
                      "application/msword",
                      "application/vnd.openxmlformats-officedocument.wordprocessingml.document",
                      "application/pdf"
                    ]
                  },
                  "contentUnicodeTextEncodingType": {
                    "type": "string",
                    "enum": [
                      "UTF8"
                    ]
                  },
                  "contentBinaryEncodingType": {
                    "type": "string",
                    "enum": [
                      "Base64"
                    ]
                  },
                  "content": {
                    "contentEncoding": "base64",
                    "type": "string"
                  },
                  "description": {
                    "type": "string",
                    "maxLength": 255
                  }
                },
                "allOf": [
                  {
                    "if": {
                      "properties": { "fileType": { "enum": [ "DOC", "doc" ] } }
                    },
                    "then": {
                      "properties": { "contentMediaType": { "enum": [ "application/msword" ] } }
                    }
                  },
                  {
                    "if": {
                      "properties": { "fileType": { "enum": [ "DOCX", "docx" ] } }
                    },
                    "then": {
                      "properties": { "contentMediaType": { "enum": [ "application/vnd.openxmlformats-officedocument.wordprocessingml.document" ] } }
                    }
                  },
                  {
                    "if": {
                      "properties": { "fileType": { "enum": [ "PDF", "pdf" ] } }
                    },
                    "then": {
                      "properties": { "contentMediaType": { "enum": [ "application/pdf" ] } }
                    }
                  }
                ],
                "required": [
                  "documentId",
                  "type",
                  "name",
                  "fileType",
                  "contentMediaType",
                  "contentUnicodeTextEncodingType",
                  "contentBinaryEncodingType",
                  "content"
                ]
              },
              "minItems": 1
            }
          }
        }
      },
      "required": [
        "transactionCode",
        "transactionId",
        "orderNumber",
        "productCode",
        "documents"
      ]
    },
    "transactionExtensions": {
      "type": "object",
      "properties": {
        "transactionExtension": {
          "type": "array",
          "items": {
            "type": "object",
            "additionalProperties": false,
            "properties": {
              "key": {
                "examples": [
                  "Client Specific Key"
                ],
                "type": "string",
                "minLength": 1,
                "maxLength": 200
              },
              "value": {
                "examples": [
                  "Client Specific Value"
                ],
                "type": "string",
                "minLength": 1
              }
            },
            "required": [
              "key",
              "value"
            ],
            "minProperties": 2,
            "maxProperties": 2
          },
          "minItems": 0
        }
      }
    }
  },
  "required": [
    "transactionHeader",
    "transactionBody"
  ],
  "minProperties": 2,
  "maxProperties": 4
}
/* Copyright © 2023 Mortgage Connect LP */

<?xml version="1.0" encoding="utf-8"?>
<xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema">
  <xs:element name="root">
  <xs:complexType>
    <xs:sequence>
      <xs:element ref="legalHeader" minOccurs="0"/>
      <xs:element ref="transactionHeader"/>
      <xs:element name="transactionBody">
        <xs:complexType>
          <xs:all>
            <xs:element name="transactionCode" type="xs:string" fixed="Add-Attachment"/>
            <xs:element ref="transactionId"/>
            <xs:element name="productTransactionId" type="transactionId" minOccurs="0"/>
            <xs:element name="orderNumber" type="orderNo"/>
            <xs:element ref="productCode"/>
            <xs:element name="documents">
              <xs:complexType>
                <xs:sequence>
                  <xs:element ref="document" minOccurs="1" maxOccurs="unbounded"/>
                </xs:sequence>
              </xs:complexType>
            </xs:element>  
          </xs:all>
        </xs:complexType>
      </xs:element>
      <xs:element ref="transactionExtensions" minOccurs="0"/>
    </xs:sequence>
  </xs:complexType>
  </xs:element>
</xs:schema>

✅ The following is an 'Accepted' example payload to be returned in the HTTP response.

Accepted Acknowledgment payloads are typically message type agnostic.

Accepted Acknowledgment payloads are typically message type agnostic.

⛔ The following is a 'Rejected' example payload to be returned in the HTTP response.

Rejected Acknowledgment payloads are typically message type agnostic.

Rejected Acknowledgment payloads are typically message type agnostic.

The Add Attachment API method is the mechanism in which a Client or Mortgage Connect can submit a message to add a document to a Default Title Order.

View Workflow Orchestration

Client URL

POST 🔒 To be determined during onboarding process.

Mortgage Connect URL

POST 🔒 https://{BaseUrl}/Api/V1.0/{ClientCode}/SubmitMessage

Mortgage Connect URL Properties

Property	Requirement	Description
BaseUrl	Required	A unique base Url that represents a specific Mortgage Connect endpoint and targeted environment.
ClientCode	Required	A unique code assigned to all clients that is used for identification, authentication, and customization purposes.

Property Definitions - Transaction Header

Defines the properties represented in the Transaction Header object (JSON) or node (XML). Note that this message artifact is identical for each and every message type.

View Transaction Header Details

Property Definitions - Transaction Body

Defines the properties represented in the Transaction Body object (JSON) or node (XML).

Property	Requirement	Data Type	Min / Max	Description
transactionBody	Required			A parent object (JSON) or node (XML) that contains the transaction metadata.
transactionCode	Required	String	14 / 14	A static value of `Add-Attachment`. The transaction code is meant to identify the message type and the context or action that should be taken. In this context it implies that an attachment should be added to the Default Title Order. Possible Values: Add-Attachment
transactionId	Required	String	1 / 50	Represents the Client's unique order number.
productTransactionId	Optional	String	0 / 50	Represents the Client's unique product order number. Note that the `productTransactionId` field is not used in most circumstances. However, when there is a need to further differentiate order numbers at a product level, that share the same `transactionId`, (i.e. the primary order level id), then the `productTransactionId` can be used to ensure uniqueness across the integration transactions. This makes it possible for multiple orders of the same product type to be placed using the same `transactionId`. The use of the `productTransactionId` field and any specific workflow deviations will be vetted during the onboarding process.
orderNumber	Required	Integer		Represents Mortgage Connects unique order number.
productCode	Required	String	3 / 4	Represents Mortgage Connect's product code. Possible Values: PRLM `Property Report Loan Mod` TSG `Trustee Sale Guarantee` PFCF `Pre-Foreclosure Report` PJR `Preliminary Judicial Report` etc. Traditionally, clients use Mortgage Connects `Product Code` names and thus there is a one to one mapping relationship that is maintained by the client. However, Mortgage Connect is aware that our naming conventions may not resonate and that there are many inconsistencies in product code naming conventions and nomenclatures. It is for this reason that Mortgage Connect is able to map the client's product code to Mortgage Connect's product code to ease the transition. Any required product code mapping exercises will be addressed during the onboarding process. The supported `productCode`(s) are specific per integration and will be determined during the onboarding process. Note that the minimum/maximum length requirement of 3/4 is only applicable if using Mortgage Connect's internal product codes, otherwise when mapping to the client's product codes, the minimum/maximum is 1/50.
documents	Require			A parent object (JSON) or node (XML) that contains a list of document metadata. `(1 to Many)`
document	Required			A parent object (JSON) or node (XML) that contains the metadata associated with a single document.
documentId	Required	String	1/36	A number or string that uniquely identifies the document within the host system. When an outbound Add-Attachment event is sent by Mortgage Connect to the Client, the documentId will be a string in the form of an integer. The integer value represents the Identity Field and Primary Key associated with the corresponding document record. Likewise, when the Client sends Mortgage Connect an Add-Attachment event, the documentId could also represent an Integer, however, there is no reason why the value could not be a unique string like a GUID. No matter what value is passed, the value needs to represent a unique value that uniquely identifies the attached document. There is no hard requirement to capture this information. However, both parties are encouraged to do so, in order that conversations or any triaging of exceptions around these values can be correlated across systems.
type	Required	String	1 / 255	A name that uniquely identifies the document type. Traditionally, clients use Mortgage Connects `Document Type` names and thus there is a one to one mapping relationship that is maintained by the client. However, Mortgage Connect is aware that our naming conventions may not resonate and that there are many inconsistencies in document type naming conventions and nomenclatures. It is for this reason that Mortgage Connect is able to map the client's document type to Mortgage Connect's document type to ease the transition. Any required document mapping exercises will be addressed during the onboarding process. The supported `types`(s) are specific per integration and will be determined during the onboarding process.
name	Required	String	1 / 100	This is the user friendly name that is associated with the document.
fileType	Required	String	3 / 4	This indicates what type of document it is. This in the context of what the file extension represents. Possible Values: DOC DOCX PDF Future Values: CSV HTML JSON TXT XLS XLSX XML `DOC`, `DOCX`, and `PDF` are currently supported with the vast majority of the documents being delivered as `PDF` documents. The other types are included to support additional documents in the future.
contentMediaType	Required	String	1 / 100	This represents the content media type, i.e. `MIME Type`. Possible Values: application/msword (DOC) application/vnd.openxmlformats-officedocument.wordprocessingml.document (DOCX) application/pdf (PDF) Future Values: text/csv (CSV) text/html (HTML) application/json (JSON) text/plain (TXT) application/vnd.ms-excel (XLS) application/vnd.openxmlformats-officedocument.spreadsheetml.sheet (XLSX) application/xml (XML) At this time `application/msword (DOC)`, `application/vnd.openxmlformats-officedocument.wordprocessingml.document (DOCX)`, and `application/pdf (PDF)` are supported with `application/pdf (PDF)` being used 90+% of the time. The other types are added to support future media types.
contentUnicode TextEncodingType	Required	String	4 / 4	This indicates what unicode text encoding type was used to generate the document. Possible Values: UTF8
contentBinary EncodingType	Required	String	6 / 6	This indicates what binary encoding type was used to generate the document content. Possible Values: Base64
content	Required	String	1 / MAX	This represents the digital representation of the document after it has been encoded using Base64. See: https://en.wikipedia.org/wiki/Base64 for more information regarding Base64 formatting.
description	Optional	String	0 / 255	Provides a brief overview of the document contents.

Property Definitions - Transaction Extensions

Defines the properties represented in the TransactionExtensions object (JSON) or node (XML). Note that this message artifact is identical for each and every message type.

View Transaction Extension Details

Default Title - MC155 - Revision Request

🌐 The following is an example payload to be posted in the body of the HTTP request.

/* Copyright © 2023 Mortgage Connect LP */
{
    "transactionHeader": {
        "transactionIdempotentId": "3B34A671-BB17-400D-90BF-7CBF9C96E8ED",
        "transactionDate": "2022-07-11T02:03:40",
        "clientCode": "1799",
        "clientName": "AcmeInc",
        "vendorCode": "MC",
        "vendorName": "Mortgage Connect"
    },
    "transactionBody": {
        "transactionCode": "Revision-Request",
        "transactionId": "7832143",
        "productTransactionId": "",
        "orderNumber": 2429888,
        "productCode": "PRLM",
        "note": "We have scheduled a trustees sale of the property.",
        "noteDate": "2022-10-19T14:00:00"
    },
    "transactionExtensions": {
        "transactionExtension": [
            {
                "key": "Client Specific Key 1",
                "value": "Client Specific Value 1"
            },
            {
                "key": "Client Specific Key 2",
                "value": "Client Specific Value 2"
            }
        ]
    }
}
/* Copyright © 2023 Mortgage Connect LP */

<!-- Copyright © 2023 Mortgage Connect LP -->
<root>
    <transactionHeader>
        <transactionIdempotentId>3B34A671-BB17-400D-90BF-7CBF9C96E8ED</transactionIdempotentId>
        <transactionDate>022-07-11T02:03:40</transactionDate>
        <clientCode>1799</clientCode>
        <clientName>AcmeInc</clientName>
        <vendorCode>MC</vendorCode>
        <vendorName>Mortgage Connect</vendorName>
    </transactionHeader>
    <transactionBody>
        <transactionCode>Revision-Request</transactionCode>
        <transactionId>7832143</transactionId>
        <productTransactionId></productTransactionId>
        <orderNumber>2429888</orderNumber>
        <productCode>PRLM</productCode>
        <note>We have scheduled a trustees sale of the property.</note>
        <noteDate>2022-10-19T14:00:00</noteDate>
    </transactionBody>
    <transactionExtensions>
        <transactionExtension>
            <key>Client Specific Key 1</key>
            <value>Client Specific Value 1</value>
        </transactionExtension>
        <transactionExtension>
            <key>Client Specific Key 2</key>
            <value>Client Specific Value 1</value>
        </transactionExtension>
    </transactionExtensions>
</root>
<!-- Copyright © 2023 Mortgage Connect LP -->

👍 The request payload can be verified using the following validation schema.

/* Copyright © 2023 Mortgage Connect LP */
{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "$id": "root",
  "description": "Copyright @ 2022 Mortgage Connect LP - Title & Tax Schema.",
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "legalHeader": {
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "version": {
          "examples": [
            "1.0.8.0"
          ],
          "type": "string",
          "minLength": 1,
          "maxLength": 20
        },
        "disclosingParty": {
          "examples": [
            "Copyright @ 2022 Mortgage Connect LP"
          ],
          "type": "string",
          "minLength": 1,
          "maxLength": 100
        },
        "proprietaryInformationAndConfidential": {
          "examples": [
            "Ownership of Proprietary Information. The Recipient agrees that it shall not receive any right, title or interest, or any license or right to use, the Disclosing Partys Proprietary Information, including, but not limited to, technology, ideas, concepts, drawings, documentation, designs, prototypes, processes, trade secrets, trademarks or other intellectual property rights therein, by implication or otherwise."
          ],
          "type": "string",
          "minLength": 1,
          "maxLength": 2000
        }
      },
      "required": [
        "version",
        "disclosingParty",
        "proprietaryInformationAndConfidential"
      ],
      "minProperties": 3,
      "maxProperties": 3
    },
    "transactionHeader": {
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "transactionIdempotentId": {
          "examples": [
            "3B34A671-BB17-400D-90BF-7CBF9C96E8ED"
          ],
          "type": "string",
          "minLength": 36,
          "maxLength": 36,
          "pattern": "^[\\da-fA-F]{8}-[\\da-fA-F]{4}-[\\da-fA-F]{4}-[\\da-fA-F]{4}-[\\da-fA-F]{12}$"
        },
        "transactionDate": {
          "examples": [
            "2022-07-11T02:03:40"
          ],
          "type": "string",
          "format": "date-time"
        },
        "clientCode": {
          "examples": [
            "1799"
          ],
          "type": "string",
          "minLength": 1,
          "maxLength": 100,
          "format": "integer"
        },
        "clientName": {
          "examples": [
            "AcmeInc"
          ],
          "type": "string",
          "minLength": 1,
          "maxLength": 100
        },
        "vendorCode": {
          "examples": [
            "MC"
          ],
          "type": "string",
          "minLength": 1,
          "maxLength": 100
        },
        "vendorName": {
          "examples": [
            "Mortgage Connect"
          ],
          "type": "string",
          "minLength": 1,
          "maxLength": 100
        }
      },
      "required": [
        "transactionIdempotentId",
        "transactionDate",
        "clientCode",
        "clientName",
        "vendorCode",
        "vendorName"
      ],
      "minProperties": 6,
      "maxProperties": 6
    },
    "transactionBody": {
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "transactionCode": {
          "examples": [
            "Revision-Request"
          ],
          "type": "string",
          "const": "Revision-Request"
        },
        "transactionId": {
          "examples": [
            "7832143"
          ],
          "type": "string",
          "minLength": 1,
          "maxLength": 50
        },
        "productTransactionId": {
          "examples": [
            "7832143"
          ],
          "type": "string",
          "minLength": 0,
          "maxLength": 50
        },
        "orderNumber": {
          "examples": [
            "2429888"
          ],
          "type": "integer"
        },
        "productCode": {
          "type": "string",
          "minLength": 3,
          "maxLength": 4,
          "enum": [
            "PRLM",
            "PRLP",
            "TTLP",
            "TTLN"
          ]
        },
        "note": {
          "example": [
            "We have scheduled a trustees sale of the property."
          ],
          "type": "string"
        },
        "noteDate": {
          "example": [
            "07-11-2022T14:00:00-4:00"
          ],
          "type": "string",
          "format": "date-time"
        }
      },
      "required": [
        "transactionCode",
        "transactionId",
        "orderNumber",
        "productCode",
        "note",
        "noteDate"
      ]
    },
    "transactionExtensions": {
      "type": "object",
      "properties": {
        "transactionExtension": {
          "type": "array",
          "items": {
            "type": "object",
            "additionalProperties": false,
            "properties": {
              "key": {
                "examples": [
                  "Client Specific Key"
                ],
                "type": "string",
                "minLength": 1,
                "maxLength": 200
              },
              "value": {
                "examples": [
                  "Client Specific Value"
                ],
                "type": "string",
                "minLength": 1
              }
            },
            "required": [
              "key",
              "value"
            ],
            "minProperties": 2,
            "maxProperties": 2
          },
          "minItems": 0
        }
      }
    }
  },
  "required": [
    "transactionHeader",
    "transactionBody"
  ],
  "minProperties": 2,
  "maxProperties": 4
}
/* Copyright © 2023 Mortgage Connect LP */

<?xml version="1.0" encoding="utf-8"?>
<xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema">
  <xs:element name="root">
  <xs:complexType>
    <xs:sequence>
      <xs:element ref="legalHeader" minOccurs="0"/>
      <xs:element ref="transactionHeader"/>
      <xs:element name="transactionBody">
        <xs:complexType>
          <xs:all>
            <xs:element name="transactionCode" type="xs:string" fixed="Revision-Request"/>
            <xs:element ref="transactionId"/>
            <xs:element name="productTransactionId" type="transactionId" minOccurs="0"/>
            <xs:element name="orderNumber" type="orderNo"/>
            <xs:element ref="productCode"/>
            <xs:element name="note" type="xs:string"/>
            <xs:element name="noteDate" type="xs:dateTime"/>
          </xs:all>
        </xs:complexType>
      </xs:element>
      <xs:element ref="transactionExtensions" minOccurs="0"/>
    </xs:sequence>
  </xs:complexType>
  </xs:element>
</xs:schema>

✅ The following is an 'Accepted' example payload to be returned in the HTTP response.

Accepted Acknowledgment payloads are typically message type agnostic.

Accepted Acknowledgment payloads are typically message type agnostic.

⛔ The following is a 'Rejected' example payload to be returned in the HTTP response.

Rejected Acknowledgment payloads are typically message type agnostic.

Rejected Acknowledgment payloads are typically message type agnostic.

The Revision Request API method is the mechanism in which a Client can submit a request for a revised Default Title Order Product.

View Workflow Orchestration

Client URL

POST 🔒 To be determined during onboarding process.

Mortgage Connect URL

POST 🔒 https://{BaseUrl}/Api/V1.0/{ClientCode}/SubmitMessage

Mortgage Connect URL Properties

Property	Requirement	Description
BaseUrl	Required	A unique base Url that represents a specific Mortgage Connect endpoint and targeted environment.
ClientCode	Required	A unique code assigned to all clients that is used for identification, authentication, and customization purposes.

Property Definitions - Transaction Header

Defines the properties represented in the Transaction Header object (JSON) or node (XML). Note that this message artifact is identical for each and every message type.

View Transaction Header Details

Property Definitions - Transaction Body

Defines the properties represented in the Transaction Body object (JSON) or node (XML).

Property	Requirement	Data Type	Min / Max	Description
transactionBody	Required			A parent object (JSON) or node (XML) that contains the transaction metadata.
**transactionCode	Required	String	16 / 16	A static value of `Revision-Request`. The transaction code is meant to identify the message type and the context or action that should be taken. In this context it implies that a note should be added to the Default Title Order. Possible Values: Revision-Request
transactionId	Required	String	1 / 50	Represents the Client's unique order number.
productTransactionId	Optional	String	0 / 50	Represents the Client's unique product order number. Note that the `productTransactionId` field is not used in most circumstances. However, when there is a need to further differentiate order numbers at a product level, that share the same `transactionId`, (i.e. the primary order level id), then the `productTransactionId` can be used to ensure uniqueness across the integration transactions. This makes it possible for multiple orders of the same product type to be placed using the same `transactionId`. The use of the `productTransactionId` field and any specific workflow deviations will be vetted during the onboarding process.
orderNumber	Required	Integer		Represents Mortgage Connects unique order number.
productCode	Required	String	3 / 4	Represents Mortgage Connect's product code. Possible Values: PRLM `Property Report Loan Mod` TSG `Trustee Sale Guarantee` PFCF `Pre-Foreclosure Report` PJR `Preliminary Judicial Report` etc. Traditionally, clients use Mortgage Connects `Product Code` names and thus there is a one to one mapping relationship that is maintained by the client. However, Mortgage Connect is aware that our naming conventions may not resonate and that there are many inconsistencies in product code naming conventions and nomenclatures. It is for this reason that Mortgage Connect is able to map the client's product code to Mortgage Connect's product code to ease the transition. Any required product code mapping exercises will be addressed during the onboarding process. The supported `productCode`(s) are specific per integration and will be determined during the onboarding process. Note that the minimum/maximum length requirement of 3/4 is only applicable if using Mortgage Connect's internal product codes, otherwise when mapping to the client's product codes, the minimum/maximum is 1/50.
note	Required	String	1 / MAX	The actual note text to be associated with the Order/Product.
noteDate	Required	DateTime		The date when the note was entered.

Property Definitions - Transaction Extensions

Defines the properties represented in the TransactionExtensions object (JSON) or node (XML). Note that this message artifact is identical for each and every message type.

View Transaction Extension Details

Default Title - MC158 - Servicing Product Delivery

🌐 The following is an example payload to be posted in the body of the HTTP request.

/* Copyright © 2023 Mortgage Connect LP */
{
  "transactionHeader": {
    "transactionIdempotentId": "0689E5CC-EA1D-4362-975E-90D49358D3CC",
    "transactionDate": "2024-10-17T10:37:09",
    "clientCode": "1799",
    "clientName": "AcmeInc",
    "vendorCode": "MC",
    "vendorName": "Mortgage Connect"
  },
  "transactionBody": {
    "transactionCode": "Servicing-Product-Delivery",
    "transactionId": "20241015-01",
    "productTransactionId": "",
    "orderNumber": 3240137,
    "itemNumber": 1,
    "productCode": "TSG",
    "loanNumber": "20241015-01",
    "clientOrderNumber": "20241015-01",
    "propertyType": "Single Family",
    "estateType": "Fee Simple",
    "openDate": "2024-10-15T03:10:11",
    "legalDescription": "Test Legal Description from BENE",
    "shortLegalDescription": "Short Legal Description",
    "landRecordsType": "Waterfront - River, Stream, etc.",
    "lot": "",
    "block": "",
    "censusTract": "",
    "acreage": "",
    "titleEffectiveDate": "2024-10-16",
    "liabilityAmount": "789600.00",
    "apnNumber": "896317999",
    "propertyInfo": {
      "address1": "1234 Main St ",
      "address2": "",
      "city": "Sebring",
      "state": "FL",
      "zipCode": "33870",
      "county": "HIGHLANDS"
    },
    "title": {
      "benecheck": {
        "vestingName": "Test Trustors ",
        "originalBeneficiary": "Original Beneficiary",
        "currentTrustee": "Current Trustee"
      },
      "deeds": {
        "deed": [
          {
            "deedType": "Deed",
            "grantee": "John Doe",
            "grantor": "Jane Smith",
            "trustee": "",
            "deedDate": "10-20-2022",
            "recordedDate": "05-10-2022",
            "instrument": "",
            "book": "10",
            "page": "234",
            "currentDeed": true
          }
        ]
      },
      "securityInstruments": {
        "securityInstrument": [
          {
            "instrumentType": "DeedOfTrust",
            "originalPrincipalAmount": 59900.00,
            "unpaidPrincipalBalance": 22000.00,
            "trustor": "Test Trustors",
            "beneficiary": "Current Beneficiary",
            "trustee": "Original Trustee",
            "mortagor": "",
            "mortagee": "",
            "noteDate": "",
            "maturityDate": "",
            "datedDate": "2017-12-05",
            "recordedDate": "2017-11-07",
            "instrument": "123-456",
            "book": "1111",
            "page": "222",
            "mersNumber": "",
            "isSubject": true,
            "lienPosition": 1,
            "assignments": {
              "assignment": [
                {
                  "assignor": "Test Assignment From",
                  "assignee": "Test Assigment To",
                  "datedDate": "2024-10-02",
                  "book": "44",
                  "page": "44",
                  "instrument": "",
                  "recordedDate": "2024-10-02"
                }
              ]
            },
            "modifications": {
              "modification": [
                {
                  "datedDate": "2024-10-15",
                  "book": "",
                  "page": "",
                  "instrument": "112223",
                  "recordedDate": "2024-10-15"
                }
              ]
            }
          }
        ]
      },
      "borrowers": {
        "borrower": [
            {
              "firstName": "Johnny",
              "middleName": "J",
              "lastName": "Doe",
              "suffix": "Sr.",
              "type": "Borrower",
              "email": "johnnydoe@gmail.com",
              "cellPhone": "724-323-4234",
              "ssn": "111-11-1111",
              "maritalStatus": "Married",
              "dateOfBirth": "7/4/1965",
              "borrowerAddress": {
                "address1": "100 Willow St",
                "address2": "",
                "city": "Shawnee",
                "state": "CA",
                "zipCode": "93950",
                "county": "Monterey"
              }
            },
            {
              "firstName": "Janie",
              "middleName": "J",
              "lastName": "Doe",
              "type": "Borrower",
              "email": "janiedoe@gmail.com",
              "cellPhone": "724-123-4545",
              "ssn": "222-22-2222",
              "maritalStatus": "Married",
              "dateOfBirth": "9/22/1967",
              "borrowerAddress": {
                "address1": "100 Willow St",
                "address2": "",
                "city": "Shawnee",
                "state": "CA",
                "zipCode": "93950",
                "county": "Monterey"
              }
            }
        ]
      },
      "parties": {
        "party": [
          {
            "sequenceNo": 1,
            "firstName": "John",
            "lastName": "Doe",
            "phone": "724-420-3341",
            "email": "johndoe@acmeinc.com",
            "role": "Processor"
          },
          {
            "sequenceNo": 2,
            "firstName": "Jane",
            "lastName": "Doe",
            "phone": "724-420-1833",
            "email": "janedoe@acmeinc.com",
            "role": "LoanOfficer"
          }
        ]
      },
      "documents": {
        "document": [
          {
            "documentId": "72033395",
            "type": "Tsg",
            "name": "TSG.1.pdf",
            "fileType": "PDF",
            "contentMediaType": "application/pdf",
            "contentUnicodeTextEncodingType": "UTF8",
            "contentBinaryEncodingType": "Base64",
            "content": "Base64 String",
            "description": "Brief overview of the document"
          }
        ]
      }
    },
    "taxes": {
      "taxItem": [
        {
          "taxAmount": 1233.00,
          "taxYear": 2023,
          "firstInstallment": 2500.00,
          "firstInstallmentPenalty": 500.00,
          "firstInstallmentStatus": "Paid",
          "secondInstallment": 12345.00,
          "secondInstallmentPenalty": 750.00,
          "secondInstallmentStatus": "Delinquent",
          "codeArea": "CODE",
          "exemption": 22.00,
          "land": 122.00,
          "improvement": 242.00,
          "sequenceNumber": 1
        }
      ]
    }
  },
  "transactionExtensions": {
    "transactionExtension": [
      {
        "key": "Client Specific Key 1",
        "value": "Client Specific Value 1"
      },
      {
        "key": "Client Specific Key 2",
        "value": "Client Specific Value 2"
      }
    ]
  }
}

/* Copyright © 2023 Mortgage Connect LP */

<!-- Copyright © 2024 Mortgage Connect LP -->
<root>
    <transactionHeader>
        <transactionIdempotentId>0689E5CC-EA1D-4362-975E-90D49358D3CC</transactionIdempotentId>
        <transactionDate>2024-10-17T10:37:09</transactionDate>
        <clientCode>1799</clientCode>
        <clientName>AcmeInc</clientName>
        <vendorCode>MC</vendorCode>
        <vendorName>Mortgage Connect</vendorName>
    </transactionHeader>
    <transactionBody>
        <transactionCode>Servicing-Product-Delivery</transactionCode>
        <transactionId>20241015-01</transactionId>
        <productTransactionId></productTransactionId>
        <orderNumber>3240137</orderNumber>
        <itemNumber>1</itemNumber>
        <productCode>TSG</productCode>
        <loanNumber>20241015-01</loanNumber>
        <clientOrderNumber>20241015-01</clientOrderNumber>
        <propertyType>Single Family</propertyType>
        <estateType>Fee Simple</estateType>
        <openDate>2024-10-15T03:10:11</openDate>
        <legalDescription>Test Legal Description from BENE</legalDescription>
        <shortLegalDescription>Short Legal Description</shortLegalDescription>
        <landRecordsType>Waterfront - River, Stream, etc.</landRecordsType>
        <lot></lot>
        <block></block>
        <censusTract></censusTract>
        <acreage></acreage>
        <titleEffectiveDate>2024-10-16</titleEffectiveDate>
        <liabilityAmount>789600.00</liabilityAmount>
        <apnNumber>896317999</apnNumber>
        <propertyInfo>
            <address1>1234 Main St </address1>
            <address2></address2>
            <city>Sebring</city>
            <state>FL</state>
            <zipCode>33870</zipCode>
            <county>HIGHLANDS</county>
        </propertyInfo>
        <title>
            <benecheck>
                <vestingName>Test Trustors</vestingName>
                <originalBeneficiary>Original Beneficiary</originalBeneficiary>
                <currentTrustee>Current Trustee</currentTrustee>
            </benecheck>
            <deeds>
                <deed>
                    <deedType>Deed</deedType>
                    <grantee>John Doe</grantee>
                    <grantor>Jane Smith</grantor>
                    <trustee></trustee>
                    <deedDate>10-20-2022</deedDate>
                    <recordedDate>05-10-2022</recordedDate>
                    <instrument></instrument>
                    <book>10</book>
                    <page>234</page>
                    <currentDeed>true</currentDeed>
                </deed>
            </deeds>
            <securityInstruments>
                <securityInstrument>
                    <instrumentType>DeedOfTrust</instrumentType>
                    <originalPrincipalAmount>59900</originalPrincipalAmount>
                    <unpaidPrincipalBalance>22000</unpaidPrincipalBalance>
                    <trustor>Test Trustors</trustor>
                    <beneficiary>Current Beneficiary</beneficiary>
                    <trustee>Original Trustee</trustee>
                    <mortagor></mortagor>
                    <mortagee></mortagee>
                    <noteDate></noteDate>
                    <maturityDate></maturityDate>
                    <datedDate>2017-12-05</datedDate>
                    <recordedDate>2017-11-07</recordedDate>
                    <instrument>123-456</instrument>
                    <book>1111</book>
                    <page>222</page>
                    <mersNumber></mersNumber>
                    <isSubject>true</isSubject>
                    <lienPosition>1</lienPosition>
                    <assignments>
                        <assignment>
                            <assignor>Test Assignment From</assignor>
                            <assignee>Test Assigment To</assignee>
                            <datedDate>2024-10-02</datedDate>
                            <book>44</book>
                            <page>44</page>
                            <instrument></instrument>
                            <recordedDate>2024-10-02</recordedDate>
                        </assignment>
                    </assignments>
                    <modifications>
                        <modification>
                            <datedDate>2024-10-15</datedDate>
                            <book></book>
                            <page></page>
                            <instrument>112223</instrument>
                            <recordedDate>2024-10-15</recordedDate>
                        </modification>
                    </modifications>
                </securityInstrument>
            </securityInstruments>
            <borrowers>
                <borrower>
                    <firstName>Johnny</firstName>
                    <middleName>J</middleName>
                    <lastName>Doe</lastName>
                    <suffix>Sr.</suffix>
                    <type>Borrower</type>
                    <email>johnnydoe@gmail.com</email>
                    <cellPhone>724-323-4234</cellPhone>
                    <ssn>111-11-1111</ssn>
                    <maritalStatus>Married</maritalStatus>
                    <dateOfBirth>7/4/1965</dateOfBirth>
                    <borrowerAddress>
                        <address1>100 Willow St</address1>
                        <address2></address2>
                        <city>Shawnee</city>
                        <state>CA</state>
                        <zipCode>93950</zipCode>
                        <county>Monterey</county>
                    </borrowerAddress>
                </borrower>
                <borrower>
                    <firstName>Janie</firstName>
                    <middleName>J</middleName>
                    <lastName>Doe</lastName>
                    <type>Borrower</type>
                    <email>janiedoe@gmail.com</email>
                    <cellPhone>724-123-4545</cellPhone>
                    <ssn>222-22-2222</ssn>
                    <maritalStatus>Married</maritalStatus>
                    <dateOfBirth>9/22/1967</dateOfBirth>
                    <borrowerAddress>
                        <address1>100 Willow St</address1>
                        <address2></address2>
                        <city>Shawnee</city>
                        <state>CA</state>
                        <zipCode>93950</zipCode>
                        <county>Monterey</county>
                    </borrowerAddress>
                </borrower>
            </borrowers>
            <parties>
                <party>
                    <sequenceNo>1</sequenceNo>
                    <firstName>John</firstName>
                    <lastName>Doe</lastName>
                    <phone>724-420-3341</phone>
                    <email>johndoe@acmeinc.com</email>
                    <role>Processor</role>
                </party>
                <party>
                    <sequenceNo>2</sequenceNo>
                    <firstName>Jane</firstName>
                    <lastName>Doe</lastName>
                    <phone>724-420-1833</phone>
                    <email>janedoe@acmeinc.com</email>
                    <role>LoanOfficer</role>
                </party>
            </parties>
            <documents>
                <document>
                    <documentId>72033395</documentId>
                    <type>Tsg</type>
                    <name>TSG.1.pdf</name>
                    <fileType>PDF</fileType>
                    <contentMediaType>application/pdf</contentMediaType>
                    <contentUnicodeTextEncodingType>UTF8</contentUnicodeTextEncodingType>
                    <contentBinaryEncodingType>Base64</contentBinaryEncodingType>
                    <content>Base64 String</content>
                    <description>Brief overview of the document</description>
                </document>
            </documents>
        </title>
        <taxes>
            <taxItem>
                <taxAmount>1233.00</taxAmount>
                <taxYear>2023</taxYear>
                <firstInstallment>2500.00</firstInstallment>
                <firstInstallmentPenalty>500.00</firstInstallmentPenalty>
                <firstInstallmentStatus>Paid</firstInstallmentStatus>
                <secondInstallment>12345.00</secondInstallment>
                <secondInstallmentPenalty>750.00</secondInstallmentPenalty>
                <secondInstallmentStatus>Delinquent</secondInstallmentStatus>
                <codeArea>CODE</codeArea>
                <exemption>22.00</exemption>
                <land>122.00</land>
                <improvement>242.00</improvement>
                <sequenceNumber>1</sequenceNumber>
            </taxItem>
        </taxes>
    </transactionBody>
    <transactionExtensions>
        <transactionExtension>
            <key>Client Specific Key 1</key>
            <value>Client Specific Value 1</value>
        </transactionExtension>
        <transactionExtension>
            <key>Client Specific Key 2</key>
            <value>Client Specific Value 2</value>
        </transactionExtension>
    </transactionExtensions>
</root>
<!-- Copyright © 2024 Mortgage Connect LP -->

👍 The request payload can be verified using the following validation schema.

/* Copyright © 2024 Mortgage Connect LP */
{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "$id": "root",
  "description": "Copyright @ 2024 Mortgage Connect LP - Title & Tax Schema.",
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "legalHeader": {
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "version": {
          "examples": [
            "0.8 Beta"
          ],
          "type": "string",
          "minLength": 1,
          "maxLength": 20
        },
        "disclosingParty": {
          "examples": [
            "Copyright @ 2024 Mortgage Connect LP"
          ],
          "type": "string",
          "minLength": 1,
          "maxLength": 100
        },
        "proprietaryInformationAndConfidential": {
          "examples": [
            "Ownership of Proprietary Information. The Recipient agrees that it shall not receive any right, title or interest, or any license or right to use, the Disclosing Party�s Proprietary Information, including, but not limited to, technology, ideas, concepts, drawings, documentation, designs, prototypes, processes, trade secrets, trademarks or other intellectual property rights therein, by implication or otherwise."
          ],
          "type": "string",
          "minLength": 1,
          "maxLength": 2000
        }
      },
      "required": [
        "version",
        "disclosingParty",
        "proprietaryInformationAndConfidential"
      ],
      "minProperties": 3,
      "maxProperties": 3
    },
    "transactionHeader": {
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "transactionIdempotentId": {
          "examples": [
            "3B34A671-BB17-400D-90BF-7CBF9C96E8ED"
          ],
          "type": "string",
          "minLength": 36,
          "maxLength": 36,
          "pattern": "^[\\da-fA-F]{8}-[\\da-fA-F]{4}-[\\da-fA-F]{4}-[\\da-fA-F]{4}-[\\da-fA-F]{12}$"
        },
        "transactionDate": {
          "examples": [
            "2022-07-11T02:03:40"
          ],
          "type": "string",
          "format": "date-time"
        },
        "clientCode": {
          "examples": [
            "1799"
          ],
          "type": "string",
          "minLength": 1,
          "maxLength": 100,
          "format": "integer"
        },
        "clientName": {
          "examples": [
            "AcmeInc"
          ],
          "type": "string",
          "minLength": 1,
          "maxLength": 100
        },
        "vendorCode": {
          "type": "string",
          "minLength": 1,
          "maxLength": 100
        },
        "vendorName": {
          "type": "string",
          "minLength": 1,
          "maxLength": 100
        }
      },
      "required": [
        "transactionIdempotentId",
        "transactionDate",
        "clientCode",
        "clientName",
        "vendorCode",
        "vendorName"
      ],
      "minProperties": 6,
      "maxProperties": 6
    },
    "transactionBody": {
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "transactionCode": {
          "type": "string",
          "const": "Servicing-Product-Delivery"
        },
        "transactionId": {
          "examples": [
            "7832143"
          ],
          "type": "string",
          "minLength": 1,
          "maxLength": 50
        },
        "productTransactionId": {
          "examples": [
            "7832143"
          ],
          "type": "string",
          "minLength": 0,
          "maxLength": 50
        },
        "orderNumber": {
          "examples": [
            "2429888"
          ],
          "type": "integer"
        },
        "itemNumber": {
          "examples": [
            "1"
          ],
          "type": "integer",
          "minimum": 1.0,
          "maximum": 40.0
        },
        "productCode": {
          "type": "string",
          "minLength": 3,
          "maxLength": 4,
          "enum": [
            "REC",
            "BENE",
            "TSG"
          ]
        },
        "loanNumber": {
          "examples": [
            "7313993"
          ],
          "type": "string",
          "minLength": 1,
          "maxLength": 64
        },
        "clientOrderNumber": {
          "type": "string",
          "maxLength": 64
        },
        "propertyType": {
          "type": "string",
          "maxLength": 64
        },
        "estateType": {
          "type": "string",
          "maxLength": 255
        },
        "openDate": {
          "examples": [
            "yyyy-MM-ddThh:mm:ss"
          ],
          "type": "string",
          "format": "date-time"
        },
        "legalDescription": {
          "examples": [
            "Being the same property as conveyed from Katie to John as set forth in Deed Instrument #18 dated 06/02/2022, recorded 06/02/2022, Allegheny County, PENNSYLVANIA."
          ],
          "type": "string"
        },
        "shortLegalDescription": {
          "examples": [
            "Being the same property as conveyed from Katie to John as set forth in Deed Instrument #18 dated 06/02/2022, recorded 06/02/2022, Allegheny County, PENNSYLVANIA."
          ],
          "type": "string"
        },
        "landRecordsType": {
          "type": "string",
          "enum": [
            "Condo",
            "PUD",
            "Waterfront - Bay, Ocean, etc.",
            "Waterfront - River, Stream, etc.",
            "Mobile Home",
            ""
          ]
        },
        "lot": {
          "examples": [
            "127"
          ],
          "type": "string",
          "maxLength": 100
        },
        "block": {
          "examples": [
            "1100"
          ],
          "type": "string",
          "maxLength": 100
        },
        "censusTract": {
          "examples": [
            "6032.02"
          ],
          "type": "string",
          "maxLength": 250
        },
        "acreage": {
          "examples": [
            "55.7 acres"
          ],
          "type": "string",
          "maxLength": 100
        },
        "titleEffectiveDate": {
          "examples": [
            "05-10-2022"
          ],
          "type": "string",
          "format": "date"
        },
        "liabilityAmount": {
          "examples": [
            "0.00"
          ],
          "type": "string",
          "format": "money"
        },
        "apnNumber": {
          "type": "string",
          "maxLength": 50
        },
        "propertyInfo": {
          "type": "object",
          "additionalProperties": false,
          "properties": {
            "address1": {
              "examples": [
                "1204 New York Drive"
              ],
              "type": "string",
              "maxLength": 255
            },
            "address2": {
              "examples": [
                "1204 New York Drive"
              ],
              "type": "string",
              "maxLength": 255
            },
            "city": {
              "examples": [
                "Mckees Rocks"
              ],
              "type": "string",
              "maxLength": 32
            },
            "state": {
              "examples": [
                "PA"
              ],
              "type": "string",
              "enum": [
                "AK",
                "AL",
                "AR",
                "AS",
                "AZ",
                "CA",
                "CO",
                "CT",
                "DC",
                "DE",
                "FL",
                "FM",
                "GA",
                "GU",
                "HI",
                "IA",
                "ID",
                "IL",
                "IN",
                "KS",
                "KY",
                "LA",
                "MA",
                "MD",
                "ME",
                "MH",
                "MI",
                "MN",
                "MO",
                "MP",
                "MS",
                "MT",
                "NC",
                "ND",
                "NE",
                "NH",
                "NJ",
                "NM",
                "NV",
                "NY",
                "OH",
                "OK",
                "OR",
                "PA",
                "PR",
                "PW",
                "RI",
                "SC",
                "SD",
                "TN",
                "TX",
                "UT",
                "VA",
                "VI",
                "VT",
                "WA",
                "WI",
                "WV",
                "WY"
              ]
            },
            "zipCode": {
              "examples": [
                "15136"
              ],
              "type": "string",
              "minLength": 5,
              "maxLength": 5,
              "pattern": "^[0-9]{5}$"
            },
            "county": {
              "examples": [
                "Allegheny"
              ],
              "type": "string",
              "maxLength": 32
            }
          },
          "required": [
            "address1",
            "city",
            "state",
            "zipCode"
          ],
          "minProperties": 4,
          "maxProperties": 6
        },
        "title": {
          "type": "object",
          "properties": {
            "benecheck": {
              "type": "object",
              "properties": {
                "vestingName": {
                  "type": "string",
                  "maxLength": 200
                },
                "originalBeneficiary": {
                  "type": "string",
                  "maxLength": 255
                },
                "currentTrustee": {
                  "type": "string",
                  "maxLength": 255
                }
              }
            },
            "deeds": {
              "type": "object",
              "properties": {
                "deed": {
                  "type": "array",
                  "items": {
                    "type": "object",
                    "properties": {
                      "deedType": {
                        "examples": [
                          "Deed"
                        ],
                        "type": "string",
                        "maxLength": 50
                      },
                      "grantee": {
                        "type": "string"
                      },
                      "grantor": {
                        "type": "string"
                      },
                      "trustee": {
                        "type": "string",
                        "maxLength": 255
                      },
                      "deedDate": {
                        "examples": [
                          "2022-10-20"
                        ],
                        "type": "string",
                        "format": "date"
                      },
                      "recordedDate": {
                        "examples": [
                          "05-10-2022"
                        ],
                        "type": "string",
                        "format": "date"
                      },
                      "instrument": {
                        "examples": [
                          "234"
                        ],
                        "type": "string",
                        "maxLength": 32
                      },
                      "book": {
                        "examples": [
                          "11"
                        ],
                        "type": "string",
                        "maxLength": 32
                      },
                      "page": {
                        "examples": [
                          "12"
                        ],
                        "type": "string",
                        "maxLength": 32
                      },
                      "currentDeed": {
                        "examples": [
                          "true"
                        ],
                        "type": "boolean"
                      }
                    }
                  }
                }
              }
            },
            "securityInstruments": {
              "type": "object",
              "properties": {
                "securityInstrument": {
                  "type": "array",
                  "items": {
                    "type": "object",
                    "properties": {
                      "instrumentType": {
                        "type": "string",
                        "maxLength": 100
                      },
                      "originalPrincipalAmount": {
                        "$ref": "root#/properties/transactionBody/properties/liabilityAmount"
                      },
                      "unpaidPrincipalBalance": {
                        "$ref": "root#/properties/transactionBody/properties/liabilityAmount"
                      },
                      "trustor": {
                        "type": "string"
                      },
                      "beneficiary": {
                        "type": "string"
                      },
                      "trustee": {
                        "type": "string",
                        "maxLength": 255
                      },
                      "mortagor": {
                        "type": "string"
                      },
                      "mortagee": {
                        "type": "string"
                      },
                      "noteDate": {
                        "type": "string",
                        "format": "date"
                      },
                      "maturityDate": {
                        "type": "string",
                        "format": "date"
                      },
                      "datedDate": {
                        "$ref": "root#/properties/transactionBody/properties/title/properties/deeds/properties/deed/items/properties/recordedDate"
                      },
                      "recordedDate": {
                        "$ref": "root#/properties/transactionBody/properties/title/properties/deeds/properties/deed/items/properties/recordedDate"
                      },
                      "instrument": {
                        "$ref": "root#/properties/transactionBody/properties/title/properties/deeds/properties/deed/items/properties/instrument"
                      },
                      "book": {
                        "$ref": "root#/properties/transactionBody/properties/title/properties/deeds/properties/deed/items/properties/book"
                      },
                      "page": {
                        "$ref": "root#/properties/transactionBody/properties/title/properties/deeds/properties/deed/items/properties/page"
                      },
                      "mersNumber": {
                        "type": "string",
                        "maxLength": 100
                      },
                      "isSubject": {
                        "examples": [
                          "true"
                        ],
                        "type": "boolean"
                      },
                      "lienPosition": {
                        "type": "integer"
                      },
                      "assignments": {
                        "type": "object",
                        "properties": {
                          "assignment": {
                            "type": "array",
                            "items": {
                              "type": "object",
                              "properties": {
                                "assignor": {
                                  "type": "string",
                                  "maxLength": 300
                                },
                                "assignee": {
                                  "type": "string",
                                  "maxLength": 128
                                },
                                "datedDate": {
                                  "examples": [
                                    "05-10-2022"
                                  ],
                                  "type": "string",
                                  "format": "date"
                                },
                                "book": {
                                  "$ref": "root#/properties/transactionBody/properties/title/properties/deeds/properties/deed/items/properties/book"
                                },
                                "page": {
                                  "$ref": "root#/properties/transactionBody/properties/title/properties/deeds/properties/deed/items/properties/page"
                                },
                                "instrument": {
                                  "$ref": "root#/properties/transactionBody/properties/title/properties/deeds/properties/deed/items/properties/instrument"
                                },
                                "recordedDate": {
                                  "$ref": "root#/properties/transactionBody/properties/title/properties/deeds/properties/deed/items/properties/recordedDate"
                                }
                              }
                            }
                          }
                        }
                      },
                      "modifications": {
                        "type": "object",
                        "properties": {
                          "modification": {
                            "type": "array",
                            "items": {
                              "type": "object",
                              "properties": {
                                "datedDate": {
                                  "$ref": "root#/properties/transactionBody/properties/title/properties/securityInstruments/properties/securityInstrument/items/properties/assignments/properties/assignment/items/properties/datedDate"
                                },
                                "book": {
                                  "$ref": "root#/properties/transactionBody/properties/title/properties/deeds/properties/deed/items/properties/book"
                                },
                                "page": {
                                  "$ref": "root#/properties/transactionBody/properties/title/properties/deeds/properties/deed/items/properties/page"
                                },
                                "instrument": {
                                  "$ref": "root#/properties/transactionBody/properties/title/properties/deeds/properties/deed/items/properties/instrument"
                                },
                                "recordedDate": {
                                  "$ref": "root#/properties/transactionBody/properties/title/properties/deeds/properties/deed/items/properties/recordedDate"
                                }
                              }
                            }
                          }
                        }
                      }
                    }
                  }
                }
              }
            },
            "borrowers": {
              "type": "object",
              "properties": {
                "borrower": {
                  "type": "array",
                  "items": {
                    "title": "Borrower",
                    "type": "object",
                    "additionalProperties": false,
                    "properties": {
                      "firstName": {
                        "examples": [
                          "John"
                        ],
                        "type": "string",
                        "minLength": 1,
                        "maxLength": 150
                      },
                      "middleName": {
                        "examples": [
                          "M"
                        ],
                        "type": "string",
                        "minLength": 0,
                        "maxLength": 150
                      },
                      "lastName": {
                        "examples": [
                          "Smith"
                        ],
                        "type": "string",
                        "minLength": 1,
                        "maxLength": 255
                      },
                      "suffix": {
                        "examples": [
                          "Sr."
                        ],
                        "type": "string",
                        "minLength": 0,
                        "maxLength": 4,
                        "enum": [
                          "II",
                          "III",
                          "Esq.",
                          "Jr.",
                          "M.D.",
                          "P.A.",
                          "Sr.",
                          ""
                        ]
                      },
                      "type": {
                        "type": "string",
                        "enum": [
                          "Asset Management Company",
                          "Asset Manager",
                          "Assignee",
                          "Assignor",
                          "Attorney",
                          "Bank Attorney",
                          "Borrower",
                          "Borrower/Buyer",
                          "Builder",
                          "Buyer",
                          "Buyer Agent",
                          "Buyer Attorney",
                          "Buyer Title Company",
                          "Buyers Broker",
                          "Condo Association",
                          "Custodian",
                          "Foreclosed Party",
                          "Investor",
                          "LENDER",
                          "Lender Loan Officer",
                          "Listing Agent",
                          "MC MC Auction Company",
                          "Mortgage Connect Closer",
                          "Non-HUD Borrower",
                          "Non-Vested Signer",
                          "Other",
                          "Processor",
                          "Property Access",
                          "Real Estate Agent",
                          "Real Estate Agent - Seller",
                          "Seller",
                          "Seller Attorney",
                          "Sellers Broker",
                          "Selling Agent",
                          "Servicer",
                          "Settlement Agent",
                          "Title Company",
                          "Underwriter",
                          "Vested Signer - Non-Borrower"
                        ]
                      },
                      "email": {
                        "type": "string",
                        "maxLength": 255
                      },
                      "cellPhone": {
                        "type": "string",
                        "maxLength": 24
                      },
                      "ssn": {
                        "type": "string",
                        "maxLength": 128
                      },
                      "maritalStatus": {
                        "type": "string",
                        "enum": [
                          "Divorced",
                          "Married",
                          "Separated",
                          "Single",
                          "Widowed",
                          ""
                        ]
                      },
                      "language": {
                        "type": "string",
                        "enum": [
                          "English",
                          "Spanish"
                        ]
                      },
                      "dateOfBirth": {
                        "type": "string",
                        "format": "date"
                      },
                      "borrowerAddress": {
                        "$ref": "root#/properties/transactionBody/properties/propertyInfo"
                      }
                    },
                    "required": [
                      "firstName",
                      "lastName",
                      "type"
                    ]
                  }
                }
              }
            },
            "parties": {
              "type": "object",
              "properties": {
                "party": {
                  "type": "array",
                  "items": {
                    "title": "Party",
                    "type": "object",
                    "additionalProperties": false,
                    "properties": {
                      "sequenceNo": {
                        "type": "integer"
                      },
                      "firstName": {
                        "type": "string",
                        "maxLength": 150
                      },
                      "lastName": {
                        "type": "string",
                        "maxLength": 150
                      },
                      "phone": {
                        "type": "string",
                        "maxLength": 24
                      },
                      "email": {
                        "type": "string",
                        "maxLength": 255,
                        "format": "email"
                      },
                      "role": {
                        "type": "string",
                        "enum": [
                          "Closer",
                          "LoanOfficer",
                          "LoanOfficerAssistant",
                          "Other",
                          "Processor",
                          "ProcessorAssistant",
                          "Underwriter",
                          "User"
                        ]
                      }
                    },
                    "required": [
                      "firstName",
                      "lastName",
                      "role"
                    ]
                  }
                }
              }
            },
            "documents": {
              "type": "object",
              "properties": {
                "document": {
                  "type": "array",
                  "items": {
                    "type": "object",
                    "properties": {
                      "documentId": {
                        "examples": [
                          1243992
                        ],
                        "type": "string",
                        "maxLength": 36
                      },
                      "type": {
                        "type": "string",
                        "minLength": 0,
                        "maxLength": 0,
                        "enum": [
                          "Other"
                        ]
                      },
                      "name": {
                        "examples": [
                          "patriot-search.pdf"
                        ],
                        "type": "string",
                        "maxLength": 100
                      },
                      "fileType": {
                        "type": "string",
                        "enum": [
                          "DOC",
                          "DOCX",
                          "PDF",
                          "doc",
                          "docx",
                          "pdf"
                        ]
                      },
                      "contentMediaType": {
                        "type": "string",
                        "enum": [
                          "application/msword",
                          "application/vnd.openxmlformats-officedocument.wordprocessingml.document",
                          "application/pdf"
                        ]
                      },
                      "contentUnicodeTextEncodingType": {
                        "type": "string",
                        "enum": [
                          "UTF8"
                        ]
                      },
                      "contentBinaryEncodingType": {
                        "type": "string",
                        "enum": [
                          "Base64"
                        ]
                      },
                      "content": {
                        "contentEncoding": "base64",
                        "type": "string"
                      }
                    },
                    "required": [
                      "documentId",
                      "type",
                      "name",
                      "fileType",
                      "contentMediaType",
                      "contentUnicodeTextEncodingType",
                      "contentBinaryEncodingType",
                      "content"
                    ],
                    "allOf": [
                      {
                        "if": {
                          "properties": {
                            "fileType": {
                              "enum": [
                                "DOC",
                                "doc"
                              ]
                            }
                          }
                        },
                        "then": {
                          "properties": {
                            "contentMediaType": {
                              "enum": [
                                "application/msword"
                              ]
                            }
                          }
                        }
                      },
                      {
                        "if": {
                          "properties": {
                            "fileType": {
                              "enum": [
                                "DOCX",
                                "docx"
                              ]
                            }
                          }
                        },
                        "then": {
                          "properties": {
                            "contentMediaType": {
                              "enum": [
                                "application/vnd.openxmlformats-officedocument.wordprocessingml.document"
                              ]
                            }
                          }
                        }
                      },
                      {
                        "if": {
                          "properties": {
                            "fileType": {
                              "enum": [
                                "PDF",
                                "pdf"
                              ]
                            }
                          }
                        },
                        "then": {
                          "properties": {
                            "contentMediaType": {
                              "enum": [
                                "application/pdf"
                              ]
                            }
                          }
                        }
                      }
                    ]
                  }
                }
              }
            }
          }
        },
        "taxes": {
          "type": "object",
          "properties": {
            "taxItem": {
              "type": "array",
              "properties": {
                "items": {
                  "type": "object",
                  "properties": {
                    "taxAmount": {
                      "$ref": "root#/properties/transactionBody/properties/liabilityAmount"
                    },
                    "taxYear": {
                      "type": "integer"
                    },
                    "firstInstallment": {
                      "$ref": "root#/properties/transactionBody/properties/liabilityAmount"
                    },
                    "firstInstallmentPenalty": {
                      "$ref": "root#/properties/transactionBody/properties/liabilityAmount"
                    },
                    "firstInstallmentStatus": {
                      "type": "string"
                    },
                    "secondInstallment": {
                      "$ref": "root#/properties/transactionBody/properties/liabilityAmount"
                    },
                    "secondInstallmentPenalty": {
                      "$ref": "root#/properties/transactionBody/properties/liabilityAmount"
                    },
                    "secondInstallmentStatus": {
                      "type": "string"
                    },
                    "codeArea": {
                      "type": "string",
                      "maxLength": 32
                    },
                    "exemption": {
                      "$ref": "root#/properties/transactionBody/properties/liabilityAmount"
                    },
                    "land": {
                      "$ref": "root#/properties/transactionBody/properties/liabilityAmount"
                    },
                    "improvement": {
                      "$ref": "root#/properties/transactionBody/properties/liabilityAmount"
                    },
                    "sequenceNumber": {
                      "type": "integer"
                    }
                  }
                }
              }
            }
          }
        }
      },
      "required": [
        "transactionCode",
        "transactionId",
        "orderNumber",
        "itemNumber",
        "productCode",
        "loanNumber"
      ]
    },
    "transactionExtensions": {
      "type": "object",
      "properties": {
        "transactionExtension": {
          "type": "array",
          "items": {
            "type": "object",
            "additionalProperties": false,
            "properties": {
              "key": {
                "examples": [
                  "Client Specific Key"
                ],
                "type": "string",
                "minLength": 1,
                "maxLength": 200
              },
              "value": {
                "examples": [
                  "Client Specific Value"
                ],
                "type": "string",
                "minLength": 1
              }
            },
            "required": [
              "key",
              "value"
            ],
            "minProperties": 2,
            "maxProperties": 2
          },
          "minItems": 0
        }
      }
    }
  },
  "required": [
    "transactionHeader",
    "transactionBody"
  ],
  "minProperties": 2,
  "maxProperties": 4
}/* Copyright © 2023 Mortgage Connect LP */

<?xml version="1.0" encoding="utf-8"?>
<xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema">
  <xs:element name="root">
    <xs:complexType>
      <xs:sequence>
        <xs:element ref="legalHeader" minOccurs="0"/>
        <xs:element ref="transactionHeader"/>
        <xs:element name="transactionBody">
          <xs:complexType>
            <xs:all>
              <xs:element name="transactionCode" type="xs:string" fixed="Servicing-Product-Delivery"/>
              <xs:element ref="transactionId"/>
              <xs:element name="productTransactionId" type="transactionId" minOccurs="0"/>
              <xs:element name="orderNumber" type="orderNo"/>
              <xs:element name="itemNumber" type="itemNumber"/>
              <xs:element ref="productCode"/>
              <xs:element ref="loanNumber"/>
              <xs:element name="clientOrderNumber" minOccurs="0">
                <xs:simpleType>
                  <xs:restriction base="xs:string">
                    <xs:maxLength value="64"/>
                  </xs:restriction>
                </xs:simpleType>
              </xs:element>
              <xs:element name="propertyType" minOccurs="0">
                <xs:simpleType>
                  <xs:restriction base="xs:string">
                    <xs:maxLength value="64"/>
                  </xs:restriction>
                </xs:simpleType>
              </xs:element>
              <xs:element name="estateType" minOccurs="0">
                <xs:simpleType>
                  <xs:restriction base="xs:string">
                    <xs:maxLength value="255"/>
                  </xs:restriction>
                </xs:simpleType>
              </xs:element>
              <xs:element name="openDate" type="xs:dateTime"/>
              <xs:element name="legalDescription" type="xs:string"/>
              <xs:element name="shortLegalDescription" type="xs:string" minOccurs="0"/>
              <xs:element name="landRecordsType" minOccurs="0">
                <xs:simpleType>
                  <xs:restriction base="xs:string">
                    <xs:enumeration value="Condo"/>
                    <xs:enumeration value="PUD"/>
                    <xs:enumeration value="Waterfront - Bay, Ocean, etc."/>
                    <xs:enumeration value="Waterfront - River, Stream, etc."/>
                    <xs:enumeration value="Mobile Home"/>
                    <xs:enumeration value=""/>
                  </xs:restriction>
                </xs:simpleType>
              </xs:element>
              <xs:element name="lot" minOccurs="0">
                <xs:simpleType>
                  <xs:restriction base="xs:string">
                    <xs:maxLength value="100"/>
                  </xs:restriction>
                </xs:simpleType>
              </xs:element>
              <xs:element name="block" minOccurs="0">
                <xs:simpleType>
                  <xs:restriction base="xs:string">
                    <xs:maxLength value="100"/>
                  </xs:restriction>
                </xs:simpleType>
              </xs:element>
              <xs:element name="censustract" minOccurs="0">
                <xs:simpleType>
                  <xs:restriction base="xs:string">
                    <xs:maxLength value="250"/>
                  </xs:restriction>
                </xs:simpleType>
              </xs:element>
              <xs:element name="acreage" minOccurs="0">
                <xs:simpleType>
                  <xs:restriction base="xs:string">
                    <xs:maxLength value="100"/>
                  </xs:restriction>
                </xs:simpleType>
              </xs:element>
              <xs:element name="titleEffectiveDate" type="xs:dateTime" minOccurs="0"/>
              <xs:element name="liabilityAmount" type="money" minOccurs="0"/>
              <xs:element name="apnNumber" minOccurs="0">
                <xs:simpleType>
                  <xs:restriction base="xs:string">
                    <xs:maxLength value="50"/>
                  </xs:restriction>
                </xs:simpleType>
              </xs:element>
              <xs:element name="propertyInfo" type="address"/>
              <xs:element name="title">
                <xs:complexType>
                  <xs:all>
                    <xs:element name="benecheck" minOccurs="0">
                      <xs:complexType>
                        <xs:all>
                          <xs:element name="vestingName" minOccurs="0">
                            <xs:simpleType>
                              <xs:restriction base="xs:string">
                                <xs:maxLength value="200"/>
                              </xs:restriction>
                            </xs:simpleType>
                          </xs:element>
                          <xs:element name="originalBeneficiary" minOccurs="0">
                            <xs:simpleType>
                              <xs:restriction base="xs:string">
                                <xs:maxLength value="255"/>
                              </xs:restriction>
                            </xs:simpleType>
                          </xs:element>
                          <xs:element name="currentTrustee" minOccurs="0">
                            <xs:simpleType>
                              <xs:restriction base="xs:string">
                                <xs:maxLength value="255"/>
                              </xs:restriction>
                            </xs:simpleType>
                          </xs:element>

                        </xs:all>
                      </xs:complexType>
                    </xs:element>
                    <xs:element name="deeds">
                      <xs:complexType>
                        <xs:sequence>
                          <xs:element name="deed" maxOccurs="unbounded">
                            <xs:complexType>
                              <xs:all>
                                <xs:element name="deedType" type="deedType" minOccurs="0"/>
                                <xs:element name="grantee" type="xs:string"/>
                                <xs:element name="grantor" type="xs:string"/>
                                <xs:element name="trustee" minOccurs="0">
                                  <xs:simpleType>
                                    <xs:restriction base="xs:string">
                                      <xs:maxLength value="255"/>
                                    </xs:restriction>
                                  </xs:simpleType>
                                </xs:element>
                                <xs:element name="deedDate" type="xs:date"/>
                                <xs:element name="recordedDate" type="xs:date"/>
                                <xs:element name="instrument" type="instrument" minOccurs="0"/>
                                <xs:element name="book" type="book" minOccurs="0"/>
                                <xs:element name="page" type="page" minOccurs="0"/>
                                <xs:element name="currentDeed" type="xs:boolean"/>
                              </xs:all>
                            </xs:complexType>
                          </xs:element>
                        </xs:sequence>
                      </xs:complexType>
                    </xs:element>
                    <xs:element name="securityInstruments">
                      <xs:complexType>
                        <xs:sequence>
                          <xs:element name="securityInstrument" maxOccurs="unbounded">
                            <xs:complexType>
                              <xs:all>
                                <xs:element name="instrumentType" minOccurs="0">
                                  <xs:simpleType>
                                    <xs:restriction base="xs:string">
                                      <xs:maxLength value="100"/>
                                    </xs:restriction>
                                  </xs:simpleType>
                                </xs:element>
                                <xs:element name="originalPrincipalAmount" type="money" minOccurs="0"/>
                                <xs:element name="unpaidPrincipalBalance" type="money" minOccurs="0"/>
                                <xs:element name="trustor" type="xs:string"/>
                                <xs:element name="beneficiary" type="xs:string"/>
                                <xs:element name="trustee" minOccurs="0">
                                  <xs:simpleType>
                                    <xs:restriction base="xs:string">
                                      <xs:maxLength value="255"/>
                                    </xs:restriction>
                                  </xs:simpleType>
                                </xs:element>
                                <xs:element name="mortagor" type="xs:string"/>
                                <xs:element name="mortagee" type="xs:string"/>
                                <xs:element name="noteDate" type="xs:date"/>
                                <xs:element name="maturityDate" type="xs:date"/>
                                <xs:element name="recordedDate" type="xs:date"/>
                                <xs:element name="instrument" type="instrument" minOccurs="0"/>
                                <xs:element name="book" type="book" minOccurs="0"/>
                                <xs:element name="page" type="page" minOccurs="0"/>
                                <xs:element name="mersNumber" minOccurs="0">
                                  <xs:simpleType>
                                    <xs:restriction base="xs:string">
                                      <xs:maxLength value="100"/>
                                    </xs:restriction>
                                  </xs:simpleType>
                                </xs:element>
                                <xs:element name="isSubject" type="xs:boolean"/>
                                <xs:element name="lienPosition" type="xs:integer"/>
                                <xs:element name="assignments" minOccurs="0">
                                  <xs:complexType>
                                    <xs:sequence>
                                      <xs:element name="assignment" maxOccurs="unbounded">
                                        <xs:complexType>
                                          <xs:sequence>
                                            <xs:element name="assignor" minOccurs="0">
                                              <xs:simpleType>
                                                <xs:restriction base="xs:string">
                                                  <xs:maxLength value="300"/>
                                                </xs:restriction>
                                              </xs:simpleType>
                                            </xs:element>
                                            <xs:element name="assignee">
                                              <xs:simpleType>
                                                <xs:restriction base="xs:string">
                                                  <xs:maxLength value="128"/>
                                                </xs:restriction>
                                              </xs:simpleType>
                                            </xs:element>
                                            <xs:element name="datedDate" type="xs:date"/>
                                            <xs:element name="book" type="book" minOccurs="0"/>
                                            <xs:element name="page" type="page" minOccurs="0"/>
                                            <xs:element name="instrument" type="instrument" minOccurs="0"/>
                                            <xs:element name="recordedDate" type="xs:date"/>
                                          </xs:sequence>
                                        </xs:complexType>
                                      </xs:element>
                                    </xs:sequence>
                                  </xs:complexType>
                                </xs:element>
                                <xs:element name="modifications" minOccurs="0">
                                  <xs:complexType>
                                    <xs:sequence>
                                      <xs:element name="modification" maxOccurs="unbounded">
                                        <xs:complexType>
                                          <xs:sequence>
                                            <xs:element name="datedDate" type="xs:date"/>
                                            <xs:element name="book" type="book" minOccurs="0"/>
                                            <xs:element name="page" type="page" minOccurs="0"/>
                                            <xs:element name="instrument" type="instrument" minOccurs="0"/>
                                            <xs:element name="recordedDate" type="xs:date"/>
                                          </xs:sequence>
                                        </xs:complexType>
                                      </xs:element>
                                    </xs:sequence>
                                  </xs:complexType>
                                </xs:element>
                              </xs:all>
                            </xs:complexType>
                          </xs:element>
                        </xs:sequence>
                      </xs:complexType>
                    </xs:element>
                    <xs:element name="borrowers">
                      <xs:complexType>
                        <xs:sequence>
                          <xs:element ref="borrower" maxOccurs="unbounded"/>
                        </xs:sequence>
                      </xs:complexType>
                    </xs:element>
                    <xs:element name="parties" minOccurs="0">
                      <xs:complexType>
                        <xs:sequence>
                          <xs:element ref="party" maxOccurs="unbounded"/>
                        </xs:sequence>
                      </xs:complexType>
                    </xs:element>
                    <xs:element name="documents" minOccurs="0">
                      <xs:complexType>
                        <xs:sequence>
                          <xs:element ref="document" minOccurs="1" maxOccurs="unbounded"/>
                        </xs:sequence>
                      </xs:complexType>
                    </xs:element>
                  </xs:all>
                </xs:complexType>
              </xs:element>
              <xs:element name="taxes" minOccurs="0">
                <xs:complexType>
                  <xs:sequence>
                    <xs:element name="taxItem" minOccurs="0">
                      <xs:complexType>
                        <xs:sequence>
                          <xs:element name="taxItem" minOccurs="1" maxOccurs="unbounded">
                            <xs:complexType>
                              <xs:sequence>
                                <xs:element name="taxAmount" type="money" minOccurs="0"/>
                                <xs:element name="taxYear" type="xs:integer" minOccurs="0"/>
                                <xs:element name="firstInstallment" type="money" minOccurs="0"/>
                                <xs:element name="firstInstallmentPenalty" type="money" minOccurs="0"/>
                                <xs:element name="firstInstallmentStatus" type="xs:string" minOccurs="0"/>
                                <xs:element name="secondInstallment" type="money" minOccurs="0"/>
                                <xs:element name="secondInstallmentPenalty" type="money" minOccurs="0"/>
                                <xs:element name="secondInstallmentStatus" type="xs:string" minOccurs="0"/>
                                <xs:element name="codeArea" minOccurs="0">
                                  <xs:simpleType>
                                    <xs:restriction base="xs:string">
                                      <xs:maxLength value="32"/>
                                    </xs:restriction>
                                  </xs:simpleType>
                                </xs:element>
                                <xs:element name="exemption" type="money" minOccurs="0"/>
                                <xs:element name="land" type="money" minOccurs="0"/>
                                <xs:element name="improvement" type="money" minOccurs="0"/>
                                <xs:element name="sequenceNumber" type="xs:integer" minOccurs="0"/>
                              </xs:sequence>
                            </xs:complexType>
                          </xs:element>
                        </xs:sequence>
                      </xs:complexType>
                    </xs:element>
                  </xs:sequence>
                </xs:complexType>
              </xs:element>
            </xs:all>
          </xs:complexType>
        </xs:element>
        <xs:element ref="transactionExtensions" minOccurs="0"/>
      </xs:sequence>
    </xs:complexType>
  </xs:element>
</xs:schema>

✅ The following is an 'Accepted' example payload to be returned in the HTTP response.

Accepted Acknowledgment payloads are typically message type agnostic.

Accepted Acknowledgment payloads are typically message type agnostic.

⛔ The following is a 'Rejected' example payload to be returned in the HTTP response.

Rejected Acknowledgment payloads are typically message type agnostic.

Rejected Acknowledgment payloads are typically message type agnostic.

The Servicing Product Delivery API method is the mechanism in which Mortgage Connect can submit a message to the Client to deliver the Final Graded Title Documents and supporting metadata.

View Workflow Orchestration

Client URL

POST 🔒 To be determined during onboarding process.

Property Definitions - Transaction Header

Defines the properties represented in the Transaction Header object (JSON) or node (XML). Note that this message artifact is identical for each and every message type.

View Transaction Header Details

Property Definitions - Transaction Body

Defines the properties represented in the Transaction Body object (JSON) or node (XML).

Property	Requirement	Data Type	Min / Max	Description
transactionBody	Required			A parent object (JSON) or node (XML) that contains the transaction metadata.
transactionCode	Required	String	26 / 26	A static value of `Servicing-Product-Delivery`. The transaction code is meant to identify the message type and the context or action that should be taken. In this context it implies that the product and all supporting metadata are to be delivered to the client. Possible Values: Servicing-Product-Delivery
transactionId	Required	String	1 / 50	Represents the Client's unique order number.
productTransactionId	Optional	String	0 / 50	Represents the Client's unique product order number. Note that the `productTransactionId` field is not used in most circumstances. However, when there is a need to further differentiate order numbers at a product level, that share the same `transactionId`, (i.e. the primary order level id), then the `productTransactionId` can be used to ensure uniqueness across the integration transactions. This makes it possible for multiple orders of the same product type to be placed using the same `transactionId`. The use of the `productTransactionId` field and any specific workflow deviations will be vetted during the onboarding process.
orderNumber	Required	Integer		Represents Mortgage Connects unique order number.
itemNumber	Required	Integer	Integer	Represents Mortgage Connects product sequencing number (i.e `1 through 40`) that is associated with each product ordered.
productCode	Required	String	3 / 4	Represents Mortgage Connect's product code. Possible Values: PRLM `Property Report Loan Mod` TSG `Trustee Sale Guarantee` PFCF `Pre-Foreclosure Report` PJR `Preliminary Judicial Report` etc. Traditionally, clients use Mortgage Connects `Product Code` names and thus there is a one to one mapping relationship that is maintained by the client. However, Mortgage Connect is aware that our naming conventions may not resonate and that there are many inconsistencies in product code naming conventions and nomenclatures. It is for this reason that Mortgage Connect is able to map the client's product code to Mortgage Connect's product code to ease the transition. Any required product code mapping exercises will be addressed during the onboarding process. The supported `productCode`(s) are specific per integration and will be determined during the onboarding process. Note that the minimum/maximum length requirement of 3/4 is only applicable if using Mortgage Connect's internal product codes, otherwise when mapping to the client's product codes, the minimum/maximum is 1/50.
loanNumber	Required	String	1 / 64	The client's loan number that is associated with the order.
clientOrderNumber	Optional	String	0 / 64	The client's order number that is associated with the order.
propertyType	Optional	String	1 / 64	The type of property, i.e., Single Family, PUD, etc. Possible Values: Condominium Cooperative Manufactured Other PUD Single Family Two to Four Family
estateType	Optional	String	1 / 16	The estate type. Possible Values: Fee Simple Lease Hold
openDate	Required	DateTime		The date when the product was added to Mortgage Connect.
legalDescription	Required	String	1 / max	The legal description associated with the Title. (if applicable)
shortLegalDescription	Optional	String	0 / max	The short legal description associated with the Title. (if applicable)
landRecordsType	Optional	String	0 / 100	The land record type. Possible Values: Condo PUD Waterfront - Bay, Ocean, etc. Waterfront - River, Stream, etc. Mobile Home
lot	Optional	String	0 / 100	The property lot number, which identifies the specific parcel of land within a block.
block	Optional	String	0 / 100	The property block number, which identifies the group of lots within a subdivision or a development project.
censusTract	Optional	String	0 / 250	The property census tract, which is a statistical subdivisions of a county that aims to have roughly 4,000 inhabitants. Tract boundaries are usually visible features, such as roads or rivers, but they can also follow the boundaries of national parks, military reservations, or American Indian reservations.
acreage	Optional	String	0 / 100	The property acreage, which identifies the size of the property land in acres.
titleEffectiveDate	Optional	DateTime		The effective date of the recordation of the deed or mortgage.
liabilityAmount	Optional	Money		The portion of the `Purchase Price` that was not paid in cash by the purchaser.
apnNumber	Optional	String	0 / 50	The assessor parcel number (APN) is the unique number assigned to each land parcel by the local county tax assessor.
propertyInfo	Required			A parent object (JSON) or node (XML) that contains metadata associated with a property address.
address1	Required	String	1 / 78	The property street address line 1.
address2	Required	String	1 / 78	The property street address line 2.
city	Required	String	1 / 32	The property city.
state	Required	String	2 / 2	The property state abbreviation. Possible Values: AK, AL, AR, AS, AZ, CA, CO, CT, DC, DE, FL, FM, GA, GU, HI, IA, ID, IL, IN, KS, KY, LA, MA, MD, ME, MH, MI, MN, MO, MP, MS, MT, NC, ND, NE, NH, NJ, NM, NV, NY, OH, OK, OR, PA, PR, PW, RI, SC, SD, TN, TX, UT, VA, VI, VT, WA, WI, WV, WY.
zipCode	Required	String	5 / 5	The property zip code.
county	Required	String	1 / 32	The property county.
title	Optional			A parent object (JSON) or node (XML) that contains metadata associated with the title.
taxes	Optional			A parent object (JSON) or node (XML) that contains metadata associated with the taxes.

Property Definitions - Transaction Body - Title

Defines the properties represented in the Transaction/Title object (JSON) or node (XML).

Property	Requirement	Data Type	Min / Max	Description
title	Optional			A parent object (JSON) or node (XML) that contains metadata associated with the title.
benecheck	Optional	Object		A parent object (JSON) or node (XML) that contains metadata associated with benecheck.
vestingName	Optional	String	1 / 200	Borrower’s Vesting on the Subject Deed of Trust.
originalBeneficiary	Optional	String	1 / 255	Original Lender on Subject Deed of Trust.
currentTrustee	Optional	String	1 / 255	Current Trustee found on Recorded Documents.
deeds	Optional	Array		A parent object (JSON) or node (XML) that contains a list of deed objects. `(0 to Many)`
deed	Optional	Object		A parent object (JSON) or node (XML) that contains metadata associated with deeds.
deedType	Optional	String	1 / 50	Indicates the type of deed.
grantee	Optional	String	1 / max	The deed grantee.
grantor	Optional	String	1 / max	The deed grantor.
trustee	Optional	String	0 / 255	The deed comments.
deedDate	Optional	DateTime		The deed date.
recordedDate	Optional	DateTime		The deed recorded date.
instrument	Optional	String	0 / 32	The deed instrument number.
book	Optional	String	0 / 32	The deed book.
page	Optional	String	0 / 32	The deed page.
currentDeed	Optional	Boolean		Indicates whether it is the current deed. Possible Values: true false
securityInstruments	Optional	Array		A parent object (JSON) or node (XML) that contains a list of securityInstrument objects. `(0 to Many)`
borrowers	Optional	Array		A parent object (JSON) or node (XML) that contains a list of borrower objects. `(0 to Many)` Note that the first borrower is assumed to `always` be the `Primary` borrower.
parties	Optional	Array		A parent object (JSON) or node (XML) that contains a list of mortgage party objects. `(0 to Many)`
documents	Optional	Array		A parent object (JSON) or node (XML) that contains a list of title document objects. `(0 to Many)`

Property Definitions - Transaction Body - Title - SecurityInstruments

Defines the properties represented in the Transaction/Title/SecurityInstruments object (JSON) or node (XML).

Property	Requirement	Data Type	Min / Max	Description
securityInstruments	Optional	Array		A parent object (JSON) or node (XML) that contains a list of securityInstruments. `(1 to Many)`
securityInstrument	Optional	Object		A parent object (JSON) or node (XML) that contains metadata associated with securityInstrument.
instrumentType	Optional	String	0 / MAX	Instrument type i.e. Deed of Trust.
originalPrincipalAmount	Optional	Money		The original amount of the Loan.
unpaidPrincipalBalance	Optional	Money		The portion of the loan amount still owed.
trustor	Optional	String	0 / MAX	Borrower on Subject Deed of Trust.
beneficiary	Optional	String	0 / MAX	Lender on Subject Deed of Trust.
trustee	Optional	String	0 / 255	The mortgage trustee name.
mortgagor	Optional	String	0 / MAX	The mortgagor.
mortgagee	Optional	String	0 / MAX	The mortgagee.
noteDate	Optional	DateTime		The date the note went into effect.
maturityDate	Optional	DateTime		The date the borrower is expected to make their final payment.
datedDate	Optional	DateTime		The deed dated date.
recordedDate	Optional	DateTime		The deed recorded date.
instrument	Optional	String	0 / 32	The deed instrument number.
book	Optional	String	0 / 32	The deed book.
page	Optional	String	0 / 32	The deed page.
mersNumber	Optional	String	0 / 100	The Mortgage Electronic Registration System (MERS) number
isSubject	Optional	Boolean		Indicates the borrower assumed the mortgage. Possible Values: true false
lienPosition	Optional	Integer		Indicates the mortgage lien position.
assignments	Optional	Array		A parent object (JSON) or node (XML) that contains a list of mortgage assignments. `(0 to Many)`
assignment	Optional	Object		A parent object (JSON) or node (XML) that contains metadata associated with mortgage assignments.
assignor	Optional	String	1 / 300	The mortgage assignment assignor.
assignee	Optional	String	1 / 128	The mortgage assignment assignee.
datedDate	Optional	DateTime		The mortgage assignment dated date.
book	Optional	String	0 / 32	The mortgage assignment book.
page	Optional	String	0 / 32	The mortgagr assignment page.
instrument	Optional	String	0 / 32	The mortgage assignment instrument number.
recordedDate	Optional	DateTime		The mortgage assignment recorded date.
modifications	Optional	Array		A parent object (JSON) or node (XML) that contains a list of mortgage modifications. `(0 to Many)`
modification	Optional	Object		A parent object (JSON) or node (XML) that contains metadata associated with mortgage modifications.
datedDate	Optional	DateTime		The mortgage modification dated date.
book	Optional	String	0 / 32	The mortgage modification book.
page	Optional	String	0 / 32	The mortgagr modification page.
instrument	Optional	String	0 / 32	The mortgage modification instrument number.
recordedDate	Optional	DateTime		The mortgage modification recorded date.

Property Definitions - Transaction Body - Title - Borrowers

Defines the properties represented in the Transaction/Title/Borrowers object (JSON) or node (XML).

Property	Requirement	Data Type	Min / Max	Description
borrowers	Optional	Array		A parent object (JSON) or node (XML) that contains a list of borrowers. `(1 to Many)` Note that the first borrower is assumed to `always` be the `Primary` borrower.
borrower	Optional	Object		A parent object (JSON) or node (XML) that contains the metadata associated with a single borrower.
firstName	Optional	String	1 / 150	The borrower’s first name.
middleName	Optional	String	0 / 150	The borrower’s middle name.
lastName	Optional	String	1 / 255	The borrower’s last name.
suffix	Optional	String	0 / 4	The borrower's suffix. Possible Values: II III Esq. Jr. Sr.
type	Optional	String	1 / 32	The borrower's type. Note that typically this value will be set to `Borrower`. Possible Values: Asset Management Company Asset Manager Assignee Assignor Attorney Bank Attorney Borrower Borrower/Buyer Builder Buyer Buyer Agent Buyer Attorney Buyer Title Company Buyers Broker Condo Association Custodian Foreclosed Party Investor LENDER Lender Loan Officer Listing Agent MC MC Auction Company Mortgage Connect Closer Non-HUD Borrower Non-Vested Signer Other Processor Property Access Real Estate Agent Real Estate Agent - Seller Seller Seller Attorney Sellers Broker Selling Agent Servicer Settlement Agent Title Company Underwriter Vested Signer - Non-Borrower
email	Optional	String	0 / 255	The borrower’s email address.
cellPhone	Optional	String	0 / 24	The borrower's cell phone number.
ssn	Optional	String	0 / 128	The borrower's social security number.
maritalStatus	Optional	String	0 / 128	The borrower’s marital status. Possible Values: Divorced Married Separated Single Widowed
dateOfBirth	Optional	DateTime		The borrower’s date of birth. Format: `mm/dd/yyyy`
borrowerAddress	Optional	Object		A parent object (JSON) or node (XML) that contains metadata associated with a borrower address.
address1	Required	String	1 / 255	The borrower street address.
address2	Optional	String	0 / 255	The borrower street address 2.
city	Optional	String	1 / 32	The borrower city name.
state	Optional	String	2 / 2	The borrower state abbreviation. Possible Values: AK, AL, AR, AS, AZ, CA, CO, CT, DC, DE, FL, FM, GA, GU, HI, IA, ID, IL, IN, KS, KY, LA, MA, MD, ME, MH, MI, MN, MO, MP, MS, MT, NC, ND, NE, NH, NJ, NM, NV, NY, OH, OK, OR, PA, PR, PW, RI, SC, SD, TN, TX, UT, VA, VI, VT, WA, WI, WV, WY.
zipCode	Optional	String	5 / 5	The borrower zip code.
county	Optional	String	0 / 32	The borrower county.

Property Definitions - Transaction Body - Title - Parties

Defines the properties represented in the Transaction/Title/Parties object (JSON) or node (XML).

Property	Requirement	Data Type	Min / Max	Description
parties	Optional	Array		A parent object (JSON) or node (XML) that contains a list of mortgage parties. `(1 to Many)`
party	Optional	Object		A parent object (JSON) or node (XML) that contains metadata associated with mortgage parties.
sequenceNo	Optional	Integer		The party sequence number.
firstName	Optional	String	1 / 150	The party first name.
lastName	Optional	String	1 / 255	The party last name.
phone	Optional	String	0 / 24	The party's phone number.
email	Optional	String	0 / 255	The party's email address.
role	Optional	String	1 / 32	The party's role. Possible Values: Closer LoanOfficer Processor

Property Definitions - Transaction Body - Title - Documents

Defines the properties represented in the Transaction/Title/Documents object (JSON) or node (XML).

Property	Requirement	Data Type	Min / Max	Description
documents	Optional	Array		A parent object (JSON) or node (XML) that contains a list of title documents. `(0 to Many)`
document	Optional	Object		A parent object (JSON) or node (XML) that contains metadata associated with title documents.
documentId	Required	String		A number or string that uniquely identifies the document within the host system. When an outbound Servicing-Product-Delivery event is sent by Mortgage Connect to the Client, the documentId will be a string in the form of an integer. The integer value represents the Identity Field and Primary Key associated with the corresponding document record. There is no hard requirement to capture this information. However, both parties are encouraged to do so, in order that conversations or any triaging of exceptions around these values can be correlated across systems.
type	Required	String	1 / 255	A name that uniquely identifies the document type. Traditionally, clients use Mortgage Connects `Document Type` names and thus there is a one to one mapping relationship that is maintained by the client. However, Mortgage Connect is aware that our naming conventions may not resonate and that there are many inconsistencies in document type naming conventions and nomenclatures. It is for this reason that Mortgage Connect is able to map the client's document type to Mortgage Connect's document type to ease the transition. Any required document mapping exercises will be addressed during the onboarding process. The supported `types`(s) are specific per integration and will be determined during the onboarding process.
name	Required	String	1 / 100	This is the user friendly name that is associated with the document.
fileType	Required	String	3 / 4	This indicates what type of document it is. This in the context of what the file extension represents. Possible Values: DOC DOCX PDF Future Values: CSV HTML JSON TXT XLS XLSX XML `DOC`, `DOCX`, and `PDF` are currently supported with the vast majority of the documents being delivered as `PDF` documents. The other types are included to support additional documents in the future.
contentMediaType	Required	String	1 / 100	This represents the content media type, i.e. `MIME Type`. Possible Values: application/msword (DOC) application/vnd.openxmlformats-officedocument.wordprocessingml.document (DOCX) application/pdf (PDF) Future Values: text/csv (CSV) text/html (HTML) application/json (JSON) text/plain (TXT) application/vnd.ms-excel (XLS) application/vnd.openxmlformats-officedocument.spreadsheetml.sheet (XLSX) application/xml (XML) At this time `application/msword (DOC)`, `application/vnd.openxmlformats-officedocument.wordprocessingml.document (DOCX)`, and `application/pdf (PDF)` are supported with `application/pdf (PDF)` being used 90+% of the time. The other types are added to support future media types.
contentUnicodeTextEncodingType	Required	String	4 / 4	This indicates what unicode text encoding type was used to generate the document. Possible Values: UTF8
contentBinaryEncodingType	Required	String	6 / 6	This indicates what binary encoding type was used to generate the document content. Possible Values: Base64
content	Required	String	1 / MAX	This represents the digital representation of the document after it has been encoded using Base64. See: https://en.wikipedia.org/wiki/Base64 for more information regarding Base64 formatting.
description	Optional	String	0 / 255	Provides a brief overview of the document contents.

Property Definitions - Transaction Body - Tax

Defines the properties represented in the Transaction/Tax object (JSON) or node (XML).

Property	Requirement	Data Type	Min / Max	Description
taxes	Optional	Array		A parent object (JSON) or node (XML) that contains metadata associated with the taxes.
taxItem	Optional	Object		A parent object (JSON) or node (XML) that contains metadata associated with the parsed tax address.
taxAmount	Optional	Money		Tax Amount Due.
taxYear	Optional	Integer		Current Fiscal Year.
firstInstallment	Optional	Money		First Installment Due for the Year (Depends on State Specific Rule).
firstInstallmentPenalty	Optional	Money		Penalty amount if there is any penalty for First Installment due.
firstInstallmentStatus	Optional	String	0 / MAX	First Installment Status like Paid, Delinquent.
secondInstallment	Optional	Money		Second Installment Due for the Year (Depends on State Specific Rule).
secondInstallmentPenalty	Optional	Money		Penalty amount if there is any penalty for Second Installment due.
secondInstallmentStatus	Optional	String	0 / MAX	Second Installment Status like Paid, Delinquent.
codeArea	Optional	String	0 / 32	Tax Code Area as Defined by the State.
exemption	Optional	Money		Any Tax Exemption that Borrow is eligible for.
land	Optional	Money		Land Value assessed by the County.
improvement	Optional	Money		Improvement assessed value by the County.
sequenceNumber	Optional	Integer		A system assigned value for identifying and sorting the record.

Property Definitions - Transaction Extensions

Defines the properties represented in the TransactionExtensions object (JSON) or node (XML). Note that this message artifact is identical for each and every message type.

View Transaction Extension Details

Default Title - MC161 - Product Delivery Attachment

🌐 The following is an example payload to be posted in the body of the HTTP request.

/* Copyright © 2023 Mortgage Connect LP */
{
    "transactionHeader": {
        "transactionIdempotentId": "3B34A671-BB17-400D-90BF-7CBF9C96E8ED",
        "transactionDate": "2022-07-11T02:03:40",
        "clientCode": "1799",
        "clientName": "AcmeInc",
        "vendorCode": "MC",
        "vendorName": "Mortgage Connect"
    },
    "transactionBody": {
        "transactionCode": "Product-Delivery-Attachment",
        "transactionId": "7832143",
        "productTransactionId": "",
        "orderNumber": 2429888,
        "itemNumber": 1,
        "productCode": "PRLM",
        "loanNumber": "7313993",
        "titleGrade": "B",
        "isInsurable": false,
        "clearanceItems": {
          "clearanceItem": [
            {
              "rowId": 9717052,
              "clearingType": "Requirement",
              "name": "Subject mortgage not found in first lien position",
              "followUpDate": "2024-02-23",
              "dueDate": "2024-02-25",
              "status": "Overdue",
              "team": "05/10/2022",
              "requestTypes": "0.00",
              "tcMethod": false
            }
          ]
        },
        "documents": {
          "document": [
            {
              "documentId": "1734433",
              "type": "REVISED_GRADED_PROPERTY_REPORT",
              "name": "property-report.pdf",
              "fileType": "PDF",
              "contentMediaType": "application/pdf",
              "contentUnicodeTextEncodingType": "UTF8",
              "contentBinaryEncodingType": "Base64",
              "content": "Base64 String",
              "description": "Brief overview of the document"
            }
          ]
        }
    },
    "transactionExtensions": {
        "transactionExtension": [
            {
                "key": "Client Specific Key 1",
                "value": "Client Specific Value 1"
            },
            {
                "key": "Client Specific Key 2",
                "value": "Client Specific Value 2"
            }
        ]
    }
}
/* Copyright © 2023 Mortgage Connect LP */

<!-- Copyright © 2023 Mortgage Connect LP -->
<root>
    <transactionHeader>
        <transactionIdempotentId>3B34A671-Bb17-400D-90Bf-7Cbf9C96E8Ed</transactionIdempotentId>
        <transactionDate>2022-07-11T02:03:40</transactionDate>
        <clientCode>1799</clientCode>
        <clientName>Acmeinc</clientName>
        <vendorCode>MC</vendorCode>
        <vendorName>Mortgage Connect</vendorName>
    </transactionHeader>
    <transactionBody>
        <transactionCode>Product-Delivery-Attachment</transactionCode>
        <transactionId>7832143</transactionId>
        <productTransactionId></productTransactionId>
        <orderNumber>2429888</orderNumber>
        <itemNumber>1</itemNumber>
        <productCode>PRLM</productCode>
        <loanNumber>7313993</loanNumber>
        <titleGrade>B</titleGrade>
        <isInsurable>false</isInsurable>
        <clearanceItems>
            <clearanceItem>
                <rowId>9717052</rowId>
                <clearingType>Requirement</clearingType>
                <name>Subject mortgage not found in first lien position</name>
                <followUpDate>2024-02-23</followUpDate>
                <dueDate>2024-02-25</dueDate>
                <status>Overdue</status>
                <team>05/10/2022</team>
                <requestTypes>0.00</requestTypes>
                <tcMethod>false</tcMethod>
            </clearanceItem>
        </clearanceItems>
        <documents>
            <document>
                <documentId>1734433</documentId>
                <type>REVISED_GRADED_PROPERTY_REPORT</type>
                <name>property-report.pdf</name>
                <fileType>Pdf</fileType>
                <contentMediaType>application/pdf</contentMediaType>
                <contentUnicodeTextEncodingType>UTF8</contentUnicodeTextEncodingType>
                <contentBinaryEncodingType>Base64</contentBinaryEncodingType>
                <content>Base64 String</content>
                <description>Brief overview of the document</description>			
            </document>
        </documents>
    </transactionBody>
    <transactionExtensions>
        <transactionExtension>
            <key>Client Specific Key 1</key>
            <value>Client Specific Value 1</value>
        </transactionExtension>
        <transactionExtension>
            <key>Client Specific Key 2</key>
            <value>Client Specific Value 1</value>
        </transactionExtension>
    </transactionExtensions>
</root>
<!-- Copyright © 2023 Mortgage Connect LP -->

👍 The request payload can be verified using the following validation schema.

/* Copyright © 2023 Mortgage Connect LP */
{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "$id": "root",
  "description": "Copyright @ 2022 Mortgage Connect LP - Title & Tax Schema.",
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "legalHeader": {
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "version": {
          "examples": [
            "1.0.8.0"
          ],
          "type": "string",
          "minLength": 1,
          "maxLength": 20
        },
        "disclosingParty": {
          "examples": [
            "Copyright @ 2022 Mortgage Connect LP"
          ],
          "type": "string",
          "minLength": 1,
          "maxLength": 100
        },
        "proprietaryInformationAndConfidential": {
          "examples": [
            "Ownership of Proprietary Information. The Recipient agrees that it shall not receive any right, title or interest, or any license or right to use, the Disclosing Partys Proprietary Information, including, but not limited to, technology, ideas, concepts, drawings, documentation, designs, prototypes, processes, trade secrets, trademarks or other intellectual property rights therein, by implication or otherwise."
          ],
          "type": "string",
          "minLength": 1,
          "maxLength": 2000
        }
      },
      "required": [
        "version",
        "disclosingParty",
        "proprietaryInformationAndConfidential"
      ],
      "minProperties": 3,
      "maxProperties": 3
    },
    "transactionHeader": {
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "transactionIdempotentId": {
          "examples": [
            "3B34A671-BB17-400D-90BF-7CBF9C96E8ED"
          ],
          "type": "string",
          "minLength": 36,
          "maxLength": 36,
          "pattern": "^[\\da-fA-F]{8}-[\\da-fA-F]{4}-[\\da-fA-F]{4}-[\\da-fA-F]{4}-[\\da-fA-F]{12}$"
        },
        "transactionDate": {
          "examples": [
            "2022-07-11T02:03:40"
          ],
          "type": "string",
          "format": "date-time"
        },
        "clientCode": {
          "examples": [
            "1799"
          ],
          "type": "string",
          "minLength": 1,
          "maxLength": 100,
          "format": "integer"
        },
        "clientName": {
          "examples": [
            "AcmeInc"
          ],
          "type": "string",
          "minLength": 1,
          "maxLength": 100
        },
        "vendorCode": {
          "examples": [
            "MC"
          ],
          "type": "string",
          "minLength": 1,
          "maxLength": 100
        },
        "vendorName": {
          "examples": [
            "Mortgage Connect"
          ],
          "type": "string",
          "minLength": 1,
          "maxLength": 100
        }
      },
      "required": [
        "transactionIdempotentId",
        "transactionDate",
        "clientCode",
        "clientName",
        "vendorCode",
        "vendorName"
      ],
      "minProperties": 6,
      "maxProperties": 6
    },
    "transactionBody": {
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "transactionCode": {
          "examples": [
            "Product-Delivery-Attachment"
          ],
          "type": "string",
          "const": "Product-Delivery-Attachment"
        },
        "transactionId": {
          "examples": [
            "7832143"
          ],
          "type": "string",
          "minLength": 1,
          "maxLength": 50
        },
        "productTransactionId": {
          "examples": [
            "7832143"
          ],
          "type": "string",
          "minLength": 0,
          "maxLength": 50
        },
        "orderNumber": {
          "examples": [
            "2429888"
          ],
          "type": "integer"
        },
        "itemNumber": {
          "examples": [
            "1"
          ],
          "type": "integer",
          "minimum": 1.0,
          "maximum": 40.0
        },
        "productCode": {
          "type": "string",
          "minLength": 3,
          "maxLength": 4,
          "enum": [
            "PRLM",
            "PRLP",
            "TTLP",
            "TTLN"
          ]
        },
        "loanNumber": {
          "examples": [
            "7313993"
          ],
          "type": "string",
          "minLength": 1,
          "maxLength": 64
        },
        "titleGrade": {
          "type": "string",
          "maxLength": 30
        },
        "isInsurable": {
          "example": [
            true
          ],
          "type": "boolean"
        },
        "clearanceItems": {
          "type": "object",
          "properties": {
            "clearanceItem": {
              "type": "array",
              "items": {
                "type": "object",
                "properties": {
                  "rowId": {
                    "examples": [
                      "1"
                    ],
                    "type": "integer",
                    "minimum": 1.0
                  },
                  "clearingType": {
                    "type": "string",
                    "maxLength": 80
                  },
                  "name": {
                    "type": "string"
                  },
                  "followUpDate": {
                    "examples": [
                      "05-10-2022"
                    ],
                    "type": "string",
                    "format": "date"
                  },
                  "dueDate": {
                    "examples": [
                      "05-10-2022"
                    ],
                    "type": "string",
                    "format": "date"
                  },
                  "status": {
                    "type": "string",
                    "enum": [
                      "Awaiting Approval",
                      "Cleared",
                      "Open",
                      "Overdue"
                    ]
                  },
                  "team": {
                    "type": "string",
                    "maxLength": 60
                  },
                  "requestTypes": {
                    "type": "string",
                    "maxLength": 64
                  },
                  "tcMethod": {
                    "type": "string",
                    "maxLength": 300
                  }
                }
              }
            }
          }
        },
        "documents": {
          "type": "object",
          "properties": {
            "document": {
              "type": "array",
              "items": {
                "type": "object",
                "properties": {
                  "documentId": {
                    "examples": [
                      1243992
                    ],
                    "type": "string",
                    "maxLength": 36
                  },
                  "type": {
                    "type": "string",
                    "minLength": 0,
                    "maxLength": 0,
                    "enum": [
                      "Other"
                    ]
                  },
                  "name": {
                    "examples": [
                      "patriot-search.pdf"
                    ],
                    "type": "string",
                    "maxLength": 100
                  },
                  "fileType": {
                    "type": "string",
                    "enum": [
                      "DOC",
                      "DOCX",
                      "PDF",
                      "doc",
                      "docx",
                      "pdf"
                    ]
                  },
                  "contentMediaType": {
                    "type": "string",
                    "enum": [
                      "application/msword",
                      "application/vnd.openxmlformats-officedocument.wordprocessingml.document",
                      "application/pdf"
                    ]
                  },
                  "contentUnicodeTextEncodingType": {
                    "type": "string",
                    "enum": [
                      "UTF8"
                    ]
                  },
                  "contentBinaryEncodingType": {
                    "type": "string",
                    "enum": [
                      "Base64"
                    ]
                  },
                  "content": {
                    "contentEncoding": "base64",
                    "type": "string"
                  },
                  "description": {
                    "type": "string",
                    "maxLength": 255
                  }
                },
                "required": [
                  "documentId",
                  "type",
                  "name",
                  "fileType",
                  "contentMediaType",
                  "contentUnicodeTextEncodingType",
                  "contentBinaryEncodingType",
                  "content"
                ],
                "allOf": [
                  {
                    "if": {
                      "properties": {
                        "fileType": {
                          "enum": [
                            "DOC",
                            "doc"
                          ]
                        }
                      }
                    },
                    "then": {
                      "properties": {
                        "contentMediaType": "application/msword"
                      }
                    }
                  },
                  {
                    "if": {
                      "properties": {
                        "fileType": {
                          "enum": [
                            "DOCX",
                            "docx"
                          ]
                        }
                      }
                    },
                    "then": {
                      "properties": {
                        "contentMediaType": "application/vnd.openxmlformats-officedocument.wordprocessingml.document"
                      }
                    }
                  },
                  {
                    "if": {
                      "properties": {
                        "fileType": {
                          "enum": [
                            "PDF",
                            "pdf"
                          ]
                        }
                      }
                    },
                    "then": {
                      "properties": {
                        "contentMediaType": "application/pdf"
                      }
                    }
                  }
                ]
              }
            }
          }
        }
      },
      "required": [
        "transactionCode",
        "transactionId",
        "orderNumber",
        "itemNumber",
        "productCode",
        "loanNumber"
      ]
    },
    "transactionExtensions": {
      "type": "object",
      "properties": {
        "transactionExtension": {
          "type": "array",
          "items": {
            "type": "object",
            "additionalProperties": false,
            "properties": {
              "key": {
                "examples": [
                  "Client Specific Key"
                ],
                "type": "string",
                "minLength": 1,
                "maxLength": 200
              },
              "value": {
                "examples": [
                  "Client Specific Value"
                ],
                "type": "string",
                "minLength": 1
              }
            },
            "required": [
              "key",
              "value"
            ],
            "minProperties": 2,
            "maxProperties": 2
          },
          "minItems": 0
        }
      }
    }
  },
  "required": [
    "transactionHeader",
    "transactionBody"
  ],
  "minProperties": 2,
  "maxProperties": 4
}
/* Copyright © 2023 Mortgage Connect LP */

<?xml version="1.0" encoding="utf-8"?>
<xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema">
  <xs:element name="root">
  <xs:complexType>
    <xs:sequence>
      <xs:element ref="legalHeader" minOccurs="0"/>
      <xs:element ref="transactionHeader"/>
      <xs:element name="transactionBody">
        <xs:complexType>
          <xs:all>
            <xs:element name="transactionCode" type="xs:string" fixed="Product-Delivery-Attachment"/>
            <xs:element ref="transactionId"/>
            <xs:element name="productTransactionId" type="transactionId" minOccurs="0"/>
            <xs:element name="orderNumber" type="orderNo"/>
            <xs:element name="itemNumber" type="itemNumber"/>
            <xs:element ref="productCode"/>
            <xs:element ref="loanNumber"/>
            <xs:element name="titleGrade" type="xs:string"/>
            <xs:element name="isInsurable" type="xs:boolean"/>
            <xs:element name="clearanceItems" minOccurs="0">
              <xs:complexType>
                <xs:sequence>
                  <xs:element ref="clearanceItem" minOccurs="0" maxOccurs="unbounded"/>
                </xs:sequence>
              </xs:complexType>
            </xs:element>
            <xs:element name="documents" minOccurs="0">
              <xs:complexType>
                <xs:sequence>
                  <xs:element ref="document" minOccurs="1" maxOccurs="unbounded"/>
                </xs:sequence>
              </xs:complexType>
            </xs:element>
          </xs:all>
        </xs:complexType>
      </xs:element>
      <xs:element ref="transactionExtensions" minOccurs="0"/>
    </xs:sequence>
  </xs:complexType>
  </xs:element>
</xs:schema>

✅ The following is an 'Accepted' example payload to be returned in the HTTP response.

Accepted Acknowledgment payloads are typically message type agnostic.

Accepted Acknowledgment payloads are typically message type agnostic.

⛔ The following is a 'Rejected' example payload to be returned in the HTTP response.

Rejected Acknowledgment payloads are typically message type agnostic.

Rejected Acknowledgment payloads are typically message type agnostic.

The Product Delivery Attachment API method is the mechanism in which Mortgage Connect can submit a message to the Client to deliver the Final Graded Title Documents and supporting metadata.

View Workflow Orchestration

Client URL

POST 🔒 To be determined during onboarding process.

Property Definitions - Transaction Header

Defines the properties represented in the Transaction Header object (JSON) or node (XML). Note that this message artifact is identical for each and every message type.

View Transaction Header Details

Property Definitions - Transaction Body

Defines the properties represented in the Transaction Body object (JSON) or node (XML).

Property	Requirement	Data Type	Min / Max	Description
transactionBody	Required			A parent object (JSON) or node (XML) that contains the transaction metadata.
transactionCode	Required	String	27 / 27	A static value of `Product-Delivery-Attachment`. The transaction code is meant to identify the message type and the context or action that should be taken. In this context it implies that the product and all supporting metadata are to be delivered to the client. Possible Values: Product-Delivery-Attachment
transactionId	Required	String	1 / 50	Represents the Client's unique order number.
productTransactionId	Optional	String	0 / 50	Represents the Client's unique product order number. Note that the `productTransactionId` field is not used in most circumstances. However, when there is a need to further differentiate order numbers at a product level, that share the same `transactionId`, (i.e. the primary order level id), then the `productTransactionId` can be used to ensure uniqueness across the integration transactions. This makes it possible for multiple orders of the same product type to be placed using the same `transactionId`. The use of the `productTransactionId` field and any specific workflow deviations will be vetted during the onboarding process.
orderNumber	Required	Integer		Represents Mortgage Connects unique order number.
itemNumber	Required	Integer	Integer	Represents Mortgage Connects product sequencing number (i.e `1 through 40`) that is associated with each product ordered.
productCode	Required	String	3 / 4	Represents Mortgage Connect's product code. Possible Values: PRLM `Property Report Loan Mod` TSG `Trustee Sale Guarantee` PFCF `Pre-Foreclosure Report` PJR `Preliminary Judicial Report` etc. Traditionally, clients use Mortgage Connects `Product Code` names and thus there is a one to one mapping relationship that is maintained by the client. However, Mortgage Connect is aware that our naming conventions may not resonate and that there are many inconsistencies in product code naming conventions and nomenclatures. It is for this reason that Mortgage Connect is able to map the client's product code to Mortgage Connect's product code to ease the transition. Any required product code mapping exercises will be addressed during the onboarding process. The supported `productCode`(s) are specific per integration and will be determined during the onboarding process. Note that the minimum/maximum length requirement of 3/4 is only applicable if using Mortgage Connect's internal product codes, otherwise when mapping to the client's product codes, the minimum/maximum is 1/50.
loanNumber	Required	String	1 / 64	The client's loan number that is associated with the order.
titleGrade	Optional	String	0 / 30	The grade for the Title.
isInsurable	Required	Boolean		Indicates whether or not the Title is insurable.
clearanceItems	Optional	Array		A parent object (JSON) or node (XML) that contains an array of title clearance items.
clearanceItem	Optional	Object		A parent object (JSON) or node (XML) that contains metadata associated with title clearance item.
rowId	Optional	integer		A number that uniquely identifies the clearance item.
clearingType	Optional	String	0 / 80	A general category for the item. Typically set to 'Requirement`.
name	Optional	String	0 / 12	A string that provides a brief description of the clearance item.
followUpDate	Optional	Date		The date that follow up activities are scheduled.
dueDate	Optional	Date		The date that follow up activities are expected to be completed.
status	Optional	String	0 / 25	The current status of the clearance item. Possible Values: Awaiting Approval Cleared Open Overdue
team	Optional	String	0 / 60	The team assigned to clear the item.
requestTypes	Optional	String	0 / 64	A list of requests made in support of clearing the item.
tcMethod	Optional	String	0 / 300	A description of what is being done to clear the item.
documents	Optional			A parent object (JSON) or node (XML) that contains a list of title documents. `(0 to Many)`
document	Optional			A parent object (JSON) or node (XML) that contains metadata associated with title documents.
documentId	Required	Integer		A number or string that uniquely identifies the document within the host system. When an outbound Product-Delivery event is sent by Mortgage Connect to the Client, the documentId will be a string in the form of an integer. The integer value represents the Identity Field and Primary Key associated with the corresponding document record. There is no hard requirement to capture this information. However, both parties are encouraged to do so, in order that conversations or any triaging of exceptions around these values can be correlated across systems.
type	Required	String	1 / 255	A name that uniquely identifies the document type. Traditionally, clients use Mortgage Connects `Document Type` names and thus there is a one to one mapping relationship that is maintained by the client. However, Mortgage Connect is aware that our naming conventions may not resonate and that there are many inconsistencies in document type naming conventions and nomenclatures. It is for this reason that Mortgage Connect is able to map the client's document type to Mortgage Connect's document type to ease the transition. Any required document mapping exercises will be addressed during the onboarding process. The supported `types`(s) are specific per integration and will be determined during the onboarding process.
name	Required	String	1 / 100	This is the user friendly name that is associated with the document.
fileType	Required	String	3 / 4	This indicates what type of document it is. This in the context of what the file extension represents. Possible Values: DOC DOCX PDF Future Values: CSV HTML JSON TXT XLS XLSX XML `DOC`, `DOCX`, and `PDF` are currently supported with the vast majority of the documents being delivered as `PDF` documents. The other types are included to support additional documents in the future.
contentMediaType	Required	String	1 / 100	This represents the content media type, i.e. `MIME Type`. Possible Values: application/msword (DOC) application/vnd.openxmlformats-officedocument.wordprocessingml.document (DOCX) application/pdf (PDF) Future Values: text/csv (CSV) text/html (HTML) application/json (JSON) text/plain (TXT) application/vnd.ms-excel (XLS) application/vnd.openxmlformats-officedocument.spreadsheetml.sheet (XLSX) application/xml (XML) At this time `application/msword (DOC)`, `application/vnd.openxmlformats-officedocument.wordprocessingml.document (DOCX)`, and `application/pdf (PDF)` are supported with `application/pdf (PDF)` being used 90+% of the time. The other types are added to support future media types.
contentUnicode TextEncodingType	Required	String	4 / 4	This indicates what unicode text encoding type was used to generate the document. Possible Values: UTF8
contentBinary EncodingType	Required	String	6 / 6	This indicates what binary encoding type was used to generate the document content. Possible Values: Base64
content	Required	String	1 / MAX	This represents the digital representation of the document after it has been encoded using Base64. See: https://en.wikipedia.org/wiki/Base64 for more information regarding Base64 formatting.
description	Optional	String	0 / 255	Provides a brief overview of the document contents.

Property Definitions - Transaction Extensions

Defines the properties represented in the TransactionExtensions object (JSON) or node (XML). Note that this message artifact is identical for each and every message type.

View Transaction Extension Details

Default Title - MC162 - Mailing Data

🌐 The following is an example payload to be posted in the body of the HTTP request.

/* Copyright © 2023 Mortgage Connect LP */
{
    "transactionHeader": {
    "transactionIdempotentId": "3B34A671-BB17-400D-90BF-7CBF9C96E8ED",
    "transactionDate": "2022-07-11T02:03:40",
    "clientCode": "1799",
    "clientName": "AcmeInc",
    "vendorCode": "MC",
    "vendorName": "Mortgage Connect"
  },
    "transactionBody": {
    "transactionCode": "Mailing-Data",
    "transactionId": "7832143",
    "productTransactionId": "",
    "orderNumber": 2429888,
    "productCode": "PRLM",
    "mailings": {
      "mailingData": [
        {
          "mailingId": 97148,
          "masterId": 977020,
          "orderNo": 3005060,
          "name": "John Smith",
          "address": "1234 Main St",
          "city": "Shawnee",
          "state": "CA",
          "zipCode": "93950",
          "description": "TEN DAY"
        },
        {
          "mailingId": 97149,
          "masterId": 977020,
          "orderNo": 3005060,
          "name": "Occupant",
          "address": "1234 Main St",
          "city": "Shawnee",
          "state": "CA",
          "zipCode": "93950",
          "description": "TEN DAY"
        }
      ]
    }
  },
  "transactionExtensions": {
    "transactionExtension": [
      {
        "key": "Client Specific Key 1",
        "value": "Client Specific Value 1"
      },
      {
        "key": "Client Specific Key 2",
        "value": "Client Specific Value 2"
      }
    ]
  }
}
/* Copyright © 2023 Mortgage Connect LP */

<!-- Copyright © 2023 Mortgage Connect LP -->
<root>
    <transactionHeader>
        <transactionIdempotentId>3B34A671-BB17-400D-90BF-7CBF9C96E8ED</transactionIdempotentId>
        <transactionDate>022-07-11T02:03:40</transactionDate>
        <clientCode>1799</clientCode>
        <clientName>AcmeInc</clientName>
        <vendorCode>MC</vendorCode>
        <vendorName>Mortgage Connect</vendorName>
    </transactionHeader>
    <transactionBody>
        <transactionCode>Mailing-Data</transactionCode>
        <transactionId>7832143</transactionId>
        <productTransactionId></productTransactionId>
        <orderNumber>2429888</orderNumber>
        <productCode>PRLM</productCode>
        <mailings>
            <mailData>
                <mailingId>97148<mailingId>
                <masterId>977020</masterId>
                <orderNo>3005060</orderNo>
                <name>John Smith</name>
                <address>1234 Main St</address>
                <city>Shawnee</city>
                <state>CA</state>
                <zipCode>93950</zipCode>
                <description>TEN DAY</description>
            </mailData>
            <mailData>
                <mailingId>97148<mailingId>
                <masterId>977020</masterId>
                <orderNo>3005060</orderNo>
                <name>Occupant</name>
                <address>1234 Main St</address>
                <city>Shawnee</city>
                <state>CA</state>
                <zipCode>93950</zipCode>
                <description>TEN DAY</description>
            </mailData>
        </mailings>
    </transactionBody>
    <transactionExtensions>
        <transactionExtension>
            <key>Client Specific Key 1</key>
            <value>Client Specific Value 1</value>
        </transactionExtension>
        <transactionExtension>
            <key>Client Specific Key 2</key>
            <value>Client Specific Value 1</value>
        </transactionExtension>
    </transactionExtensions>
</root>
<!-- Copyright © 2023 Mortgage Connect LP -->

👍 The request payload can be verified using the following validation schema.

/* Copyright © 2023 Mortgage Connect LP */
{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "$id": "root",
  "description": "Copyright @ 2022 Mortgage Connect LP - Title & Tax Schema.",
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "legalHeader": {
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "version": {
          "examples": [
            "1.0.8.0"
          ],
          "type": "string",
          "minLength": 1,
          "maxLength": 20
        },
        "disclosingParty": {
          "examples": [
            "Copyright @ 2022 Mortgage Connect LP"
          ],
          "type": "string",
          "minLength": 1,
          "maxLength": 100
        },
        "proprietaryInformationAndConfidential": {
          "examples": [
            "Ownership of Proprietary Information. The Recipient agrees that it shall not receive any right, title or interest, or any license or right to use, the Disclosing Partys Proprietary Information, including, but not limited to, technology, ideas, concepts, drawings, documentation, designs, prototypes, processes, trade secrets, trademarks or other intellectual property rights therein, by implication or otherwise."
          ],
          "type": "string",
          "minLength": 1,
          "maxLength": 2000
        }
      },
      "required": [
        "version",
        "disclosingParty",
        "proprietaryInformationAndConfidential"
      ],
      "minProperties": 3,
      "maxProperties": 3
    },
    "transactionHeader": {
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "transactionIdempotentId": {
          "examples": [
            "3B34A671-BB17-400D-90BF-7CBF9C96E8ED"
          ],
          "type": "string",
          "minLength": 36,
          "maxLength": 36,
          "pattern": "^[\\da-fA-F]{8}-[\\da-fA-F]{4}-[\\da-fA-F]{4}-[\\da-fA-F]{4}-[\\da-fA-F]{12}$"
        },
        "transactionDate": {
          "examples": [
            "2022-07-11T02:03:40"
          ],
          "type": "string",
          "format": "date-time"
        },
        "clientCode": {
          "examples": [
            "1799"
          ],
          "type": "string",
          "minLength": 1,
          "maxLength": 100,
          "format": "integer"
        },
        "clientName": {
          "examples": [
            "AcmeInc"
          ],
          "type": "string",
          "minLength": 1,
          "maxLength": 100
        },
        "vendorCode": {
          "examples": [
            "MC"
          ],
          "type": "string",
          "minLength": 1,
          "maxLength": 100
        },
        "vendorName": {
          "examples": [
            "Mortgage Connect"
          ],
          "type": "string",
          "minLength": 1,
          "maxLength": 100
        }
      },
      "required": [
        "transactionIdempotentId",
        "transactionDate",
        "clientCode",
        "clientName",
        "vendorCode",
        "vendorName"
      ],
      "minProperties": 6,
      "maxProperties": 6
    },
    "transactionBody": {
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "transactionCode": {
          "examples": [
            "Mailing-Data"
          ],
          "type": "string",
          "const": "Mailing-Data"
        },
        "transactionId": {
          "examples": [
            "7832143"
          ],
          "type": "string",
          "minLength": 1,
          "maxLength": 50
        },
        "productTransactionId": {
          "examples": [
            "7832143"
          ],
          "type": "string",
          "minLength": 0,
          "maxLength": 50
        },
        "orderNumber": {
          "examples": [
            "2429888"
          ],
          "type": "integer"
        },
        "productCode": {
          "type": "string",
          "minLength": 3,
          "maxLength": 4,
          "enum": [
            "PRLM",
            "PRLP",
            "TTLP",
            "TTLN"
          ]
        },
        "mailings": {
          "type": "object",
          "properties": {
            "mailingData": {
              "type": "array",
              "items": {
                "mailingData": {
                  "type": "object",
                  "properties": {
                    "mailingId": {
                      "type": "integer",
                      "examples": ["97148"]
                    },
                    "masterId": {
                      "type": "integer",
                      "examples": [ "977020" ]
                    },
                    "orderNo": {
                      "type": "integer",
                      "examples": [ "3005060" ]
                    },
                    "name": {
                      "type": "string",
                      "examples": [ "John Smith" ],
                      "minLength": 1,
                      "maxLength": 255
                    },
                    "address": {
                      "$ref": "#/$defs/address/properties/address1"
                    },
                    "city": {
                      "$ref": "#/$defs/address/properties/city"
                    },
                    "state": {
                      "$ref": "#/$defs/address/properties/state"
                    },
                    "zipCode": {
                      "$ref": "#/$defs/address/properties/zipCode"
                    },
                    "description": {
                      "type": "string",
                      "minLength": 1
                    }
                  },
                  "required": [
                    "mailingId",
                    "masterId",
                    "orderNo",
                    "name",
                    "address",
                    "city",
                    "state",
                    "zipCode",
                    "description"
                  ]
                }
              },
              "minItems": 1
            }
          }
        }
      },
      "required": [
        "transactionCode",
        "transactionId",
        "orderNumber",
        "productCode",
        "mailings"
      ]
    },
    "transactionExtensions": {
      "type": "object",
      "properties": {
        "transactionExtension": {
          "type": "array",
          "items": {
            "type": "object",
            "additionalProperties": false,
            "properties": {
              "key": {
                "examples": [
                  "Client Specific Key"
                ],
                "type": "string",
                "minLength": 1,
                "maxLength": 200
              },
              "value": {
                "examples": [
                  "Client Specific Value"
                ],
                "type": "string",
                "minLength": 1
              }
            },
            "required": [
              "key",
              "value"
            ],
            "minProperties": 2,
            "maxProperties": 2
          },
          "minItems": 0
        }
      }
    }
  },
  "required": [
    "transactionHeader",
    "transactionBody"
  ],
  "minProperties": 2,
  "maxProperties": 4
}
/* Copyright © 2023 Mortgage Connect LP */

<?xml version="1.0" encoding="utf-8"?>
<xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema">
  <xs:element name="root">
    <xs:complexType>
      <xs:sequence>
        <xs:element ref="legalHeader" minOccurs="0"/>
        <xs:element ref="transactionHeader"/>
        <xs:element name="transactionBody">
          <xs:complexType>
            <xs:all>
              <xs:element name="transactionCode" type="xs:string" fixed="Mailing-Data"/>
              <xs:element ref="transactionId"/>
              <xs:element name="productTransactionId" type="transactionId" minOccurs="0"/>
              <xs:element name="orderNumber" type="orderNo"/>
              <xs:element ref="productCode"/>
              <xs:element name="mailings" minOccurs="0">
                <xs:complexType>
                  <xs:sequence>
                    <xs:element name="mailingData" minOccurs="1" maxOccurs="unbounded">
                      <xs:complexType>
                        <xs:all>
                          <xs:element name="mailingId" type="xs:integer" minOccurs="0"/>
                          <xs:element name="masterId" type="xs:integer" minOccurs="0"/>
                          <xs:element name="orderNo" type="xs:integer" minOccurs="0"/>
                          <xs:element name="name" minOccurs="0">
                            <xs:simpleType>
                              <xs:restriction base="xs:string">
                                <xs:maxLength value="255"/>
                              </xs:restriction>
                            </xs:simpleType>
                          </xs:element>
                          <xs:element name="address" type="addressLine"/>
                          <xs:element name="city" type="city"/>
                          <xs:element name="state" type="state"/>
                          <xs:element name="zipCode" type="zipCode"/>
                          <xs:element name="description" type="xs:string"/>
                        </xs:all>
                      </xs:complexType>
                    </xs:element>
                  </xs:sequence>
                </xs:complexType>
              </xs:element>
            </xs:all>
          </xs:complexType>
        </xs:element>
        <xs:element ref="transactionExtensions" minOccurs="0"/>
      </xs:sequence>
    </xs:complexType>
  </xs:element>
</xs:schema>

✅ The following is an 'Accepted' example payload to be returned in the HTTP response.

Accepted Acknowledgment payloads are typically message type agnostic.

Accepted Acknowledgment payloads are typically message type agnostic.

⛔ The following is a 'Rejected' example payload to be returned in the HTTP response.

Rejected Acknowledgment payloads are typically message type agnostic.

Rejected Acknowledgment payloads are typically message type agnostic.

The Mailing Data API method is the mechanism in which Mortgage Connect can provide to the client, a list of mailing data for the Default Title Order.

View Workflow Orchestration

Client URL

POST 🔒 To be determined during onboarding process.

Mortgage Connect URL

POST 🔒 https://{BaseUrl}/Api/V1.0/{ClientCode}/SubmitMessage

Mortgage Connect URL Properties

Property	Requirement	Description
BaseUrl	Required	A unique base Url that represents a specific Mortgage Connect endpoint and targeted environment.
ClientCode	Required	A unique code assigned to all clients that is used for identification, authentication, and customization purposes.

Property Definitions - Transaction Header

Defines the properties represented in the Transaction Header object (JSON) or node (XML). Note that this message artifact is identical for each and every message type.

View Transaction Header Details

Property Definitions - Transaction Body

Defines the properties represented in the Transaction Body object (JSON) or node (XML).

Property	Requirement	Data Type	Min / Max	Description
transactionBody	Required			A parent object (JSON) or node (XML) that contains the transaction metadata.
transactionCode	Required	String	12 / 12	A static value of `Mailing-Data`. The transaction code is meant to identify the message type and the context or action that should be taken. In this context it implies that a list of mailing data and all supporting metadata are to be delivered to the client. Possible Values: Mailing-Data
transactionId	Required	String	1 / 50	Represents the Client's unique order number.
productTransactionId	Optional	String	0 / 50	Represents the Client's unique product order number. Note that the `productTransactionId` field is not used in most circumstances. However, when there is a need to further differentiate order numbers at a product level, that share the same `transactionId`, (i.e. the primary order level id), then the `productTransactionId` can be used to ensure uniqueness across the integration transactions. This makes it possible for multiple orders of the same product type to be placed using the same `transactionId`. The use of the `productTransactionId` field and any specific workflow deviations will be vetted during the onboarding process.
orderNumber	Required	Integer		Represents Mortgage Connects unique order number.
productCode	Required	String	3 / 4	Represents Mortgage Connect's product code. Possible Values: PRLM `Property Report Loan Mod` TSG `Trustee Sale Guarantee` PFCF `Pre-Foreclosure Report` PJR `Preliminary Judicial Report` etc. Traditionally, clients use Mortgage Connects `Product Code` names and thus there is a one to one mapping relationship that is maintained by the client. However, Mortgage Connect is aware that our naming conventions may not resonate and that there are many inconsistencies in product code naming conventions and nomenclatures. It is for this reason that Mortgage Connect is able to map the client's product code to Mortgage Connect's product code to ease the transition. Any required product code mapping exercises will be addressed during the onboarding process. The supported `productCode`(s) are specific per integration and will be determined during the onboarding process. Note that the minimum/maximum length requirement of 3/4 is only applicable if using Mortgage Connect's internal product codes, otherwise when mapping to the client's product codes, the minimum/maximum is 1/50.
mailings	Required	Array	1 / MAX	An array of mailing data items.
mailingData	Required			A parent object (JSON) or node (XML) that contains metadata associated with mailing data.
mailingId	Required	Integer		A value that uniquely identifies the mailing item within the Mortgage Connect system.
masterId	Required	Integer		A parent level value used to group mailings across multiple products.
orderNo	Required	Integer		Identifies the Mortgage Connect order number that originated the mailing item.
address	Required	String	1 / 255	The mailing street address.
city	Required	String	1 / 32	The mailing city name.
state	Required	String	2 / 2	The mailing state abbreviation. Possible Values: AK, AL, AR, AS, AZ, CA, CO, CT, DC, DE, FL, FM, GA, GU, HI, IA, ID, IL, IN, KS, KY, LA, MA, MD, ME, MH, MI, MN, MO, MP, MS, MT, NC, ND, NE, NH, NJ, NM, NV, NY, OH, OK, OR, PA, PR, PW, RI, SC, SD, TN, TX, UT, VA, VI, VT, WA, WI, WV, WY.
zipCode	Required	String	5 / 5	The mailing zip code.
description	Required	String	1 / MAX	The type and/or content of the mailing.

Property Definitions - Transaction Extensions

Defines the properties represented in the TransactionExtensions object (JSON) or node (XML). Note that this message artifact is identical for each and every message type.

View Transaction Extension Details

Default Title - MC163 - Revised Product Delivery

🌐 The following is an example payload to be posted in the body of the HTTP request.

/* Copyright © 2023 Mortgage Connect LP */
{
        "transactionHeader": {
                "transactionIdempotentId": "3B34A671-BB17-400D-90BF-7CBF9C96E8ED",
                "transactionDate": "2022-07-11T02:03:40",
                "clientCode": "1799",
                "clientName": "AcmeInc",
                "vendorCode": "MC",
                "vendorName": "Mortgage Connect"
        },
        "transactionBody": {
                "transactionCode": "Revised-Product-Delivery",
                "transactionId": "7832143",
                "productTransactionId": "",
                "orderNumber": 2429888,
                "itemNumber": 1,
                "productCode": "PRLM",
                "loanNumber": "7313993",
                "titleGrade": "B",
                "isInsurable": false,
                "clearanceItems": {
                        "clearanceItem": [
                            {
                                    "rowId": 9717052,
                                    "clearingType": "Requirement",
                                    "name": "Subject mortgage not found in first lien position",
                                    "followUpDate": "2024-02-23",
                                    "dueDate": "2024-02-25",
                                    "status": "Overdue",
                                    "team": "05/10/2022",
                                    "requestTypes": "0.00",
                                    "tcMethod": false
                            }
                        ]
                },
                "documents": {
                        "document": [
                            {
                                    "documentId": "1734433",
                                    "type": "REVISED_GRADED_PROPERTY_REPORT",
                                    "name": "property-report.pdf",
                                    "fileType": "PDF",
                                    "contentMediaType": "application/pdf",
                                    "contentUnicodeTextEncodingType": "UTF8",
                                    "contentBinaryEncodingType": "Base64",
                                    "content": "Base64 String",
                                    "description": "Brief overview of the document"
                            }
                        ]
                }
        },
        "transactionExtensions": {
                "transactionExtension": [
                        {
                                "key": "Client Specific Key 1",
                                "value": "Client Specific Value 1"
                        },
                        {
                                "key": "Client Specific Key 2",
                                "value": "Client Specific Value 2"
                        }
                ]
        }
}
/* Copyright © 2023 Mortgage Connect LP */

<!-- Copyright © 2023 Mortgage Connect LP -->
<root>
    <transactionHeader>
        <transactionIdempotentId>3B34A671-Bb17-400D-90Bf-7Cbf9C96E8Ed</transactionIdempotentId>
        <transactionDate>2022-07-11T02:03:40</transactionDate>
        <clientCode>1799</clientCode>
        <clientName>Acmeinc</clientName>
        <vendorCode>MC</vendorCode>
        <vendorName>Mortgage Connect</vendorName>
    </transactionHeader>
    <transactionBody>
        <transactionCode>Revised-Product-Delivery</transactionCode>
        <transactionId>7832143</transactionId>
        <productTransactionId></productTransactionId>
        <orderNumber>2429888</orderNumber>
        <itemNumber>1</itemNumber>
        <productCode>PRLM</productCode>
        <loanNumber>7313993</loanNumber>
        <titleGrade>B</titleGrade>
        <isInsurable>false</isInsurable>
        <clearanceItems>
            <clearanceItem>
                <rowId>9717052</rowId>
                <clearingType>Requirement</clearingType>
                <name>Subject mortgage not found in first lien position</name>
                <followUpDate>2024-02-23</followUpDate>
                <dueDate>2024-02-25</dueDate>
                <status>Overdue</status>
                <team>05/10/2022</team>
                <requestTypes>0.00</requestTypes>
                <tcMethod>false</tcMethod>
            </clearanceItem>
        </clearanceItems>
        <documents>
            <document>
                <documentId>1734433</documentId>
                <type>REVISED_GRADED_PROPERTY_REPORT</type>
                <name>property-report.pdf</name>
                <fileType>Pdf</fileType>
                <contentMediaType>application/pdf</contentMediaType>
                <contentUnicodeTextEncodingType>UTF8</contentUnicodeTextEncodingType>
                <contentBinaryEncodingType>Base64</contentBinaryEncodingType>
                <content>Base64 String</content>
                <description>Brief overview of the document</description>		
            </document>
        </documents>
    </transactionBody>
    <transactionExtensions>
        <transactionExtension>
            <key>Client Specific Key 1</key>
            <value>Client Specific Value 1</value>
        </transactionExtension>
        <transactionExtension>
            <key>Client Specific Key 2</key>
            <value>Client Specific Value 1</value>
        </transactionExtension>
    </transactionExtensions>
</root>
<!-- Copyright © 2023 Mortgage Connect LP -->

👍 The request payload can be verified using the following validation schema.

/* Copyright © 2023 Mortgage Connect LP */
{
    "$schema": "http://json-schema.org/draft-07/schema#",
    "$id": "root",
    "description": "Copyright @ 2022 Mortgage Connect LP - Title & Tax Schema.",
    "type": "object",
    "additionalProperties": false,
    "properties": {
        "legalHeader": {
            "type": "object",
            "additionalProperties": false,
            "properties": {
                "version": {
                    "examples": [
                        "1.0.8.0"
                    ],
                    "type": "string",
                    "minLength": 1,
                    "maxLength": 20
                },
                "disclosingParty": {
                    "examples": [
                        "Copyright @ 2022 Mortgage Connect LP"
                    ],
                    "type": "string",
                    "minLength": 1,
                    "maxLength": 100
                },
                "proprietaryInformationAndConfidential": {
                    "examples": [
                        "Ownership of Proprietary Information. The Recipient agrees that it shall not receive any right, title or interest, or any license or right to use, the Disclosing Partys Proprietary Information, including, but not limited to, technology, ideas, concepts, drawings, documentation, designs, prototypes, processes, trade secrets, trademarks or other intellectual property rights therein, by implication or otherwise."
                    ],
                    "type": "string",
                    "minLength": 1,
                    "maxLength": 2000
                }
            },
            "required": [
                "version",
                "disclosingParty",
                "proprietaryInformationAndConfidential"
            ],
            "minProperties": 3,
            "maxProperties": 3
        },
        "transactionHeader": {
            "type": "object",
            "additionalProperties": false,
            "properties": {
                "transactionIdempotentId": {
                    "examples": [
                        "3B34A671-BB17-400D-90BF-7CBF9C96E8ED"
                    ],
                    "type": "string",
                    "minLength": 36,
                    "maxLength": 36,
                    "pattern": "^[\\da-fA-F]{8}-[\\da-fA-F]{4}-[\\da-fA-F]{4}-[\\da-fA-F]{4}-[\\da-fA-F]{12}$"
                },
                "transactionDate": {
                    "examples": [
                        "2022-07-11T02:03:40"
                    ],
                    "type": "string",
                    "format": "date-time"
                },
                "clientCode": {
                    "examples": [
                        "1799"
                    ],
                    "type": "string",
                    "minLength": 1,
                    "maxLength": 100,
                    "format": "integer"
                },
                "clientName": {
                    "examples": [
                        "AcmeInc"
                    ],
                    "type": "string",
                    "minLength": 1,
                    "maxLength": 100
                },
                "vendorCode": {
                    "examples": [
                        "MC"
                    ],
                    "type": "string",
                    "minLength": 1,
                    "maxLength": 100
                },
                "vendorName": {
                    "examples": [
                        "Mortgage Connect"
                    ],
                    "type": "string",
                    "minLength": 1,
                    "maxLength": 100
                }
            },
            "required": [
                "transactionIdempotentId",
                "transactionDate",
                "clientCode",
                "clientName",
                "vendorCode",
                "vendorName"
            ],
            "minProperties": 6,
            "maxProperties": 6
        },
        "transactionBody": {
            "type": "object",
            "additionalProperties": false,
            "properties": {
                "transactionCode": {
                    "examples": [
                        "Revised-Product-Delivery"
                    ],
                    "type": "string",
                    "const": "Revised-Product-Delivery"
                },
                "transactionId": {
                    "examples": [
                        "7832143"
                    ],
                    "type": "string",
                    "minLength": 1,
                    "maxLength": 50
                },
                "productTransactionId": {
                    "examples": [
                        "7832143"
                    ],
                    "type": "string",
                    "minLength": 0,
                    "maxLength": 50
                },
                "orderNumber": {
                    "examples": [
                        "2429888"
                    ],
                    "type": "integer"
                },
                "itemNumber": {
                    "examples": [
                        "1"
                    ],
                    "type": "integer",
                    "minimum": 1.0,
                    "maximum": 40.0
                },
                "productCode": {
                    "type": "string",
                    "minLength": 3,
                    "maxLength": 4,
                    "enum": [
                        "PRLM",
                        "PRLP",
                        "TTLP",
                        "TTLN"
                    ]
                },
                "loanNumber": {
                    "examples": [
                        "7313993"
                    ],
                    "type": "string",
                    "minLength": 1,
                    "maxLength": 64
                },
                "titleGrade": {
                    "type": "string",
                    "maxLength": 30
                },
                "isInsurable": {
                    "example": [
                        true
                    ],
                    "type": "boolean"
                },
                "clearanceItems": {
                    "type": "object",
                    "properties": {
                        "clearanceItem": {
                            "type": "array",
                            "items": {
                                "type": "object",
                                "properties": {
                                    "rowId": {
                                        "examples": [
                                            "1"
                                        ],
                                        "type": "integer",
                                        "minimum": 1.0
                                    },
                                    "clearingType": {
                                        "type": "string",
                                        "maxLength": 80
                                    },
                                    "name": {
                                        "type": "string"
                                    },
                                    "followUpDate": {
                                        "examples": [
                                            "05-10-2022"
                                        ],
                                        "type": "string",
                                        "format": "date"
                                    },
                                    "dueDate": {
                                        "examples": [
                                            "05-10-2022"
                                        ],
                                        "type": "string",
                                        "format": "date"
                                    },
                                    "status": {
                                        "type": "string",
                                        "enum": [
                                            "Awaiting Approval",
                                            "Cleared",
                                            "Open",
                                            "Overdue"
                                        ]
                                    },
                                    "team": {
                                        "type": "string",
                                        "maxLength": 60
                                    },
                                    "requestTypes": {
                                        "type": "string",
                                        "maxLength": 64
                                    },
                                    "tcMethod": {
                                        "type": "string",
                                        "maxLength": 300
                                    }
                                }
                            }
                        }
                    }
                },
                "documents": {
                    "type": "object",
                    "properties": {
                        "document": {
                            "type": "array",
                            "items": {
                                "type": "object",
                                "properties": {
                                    "documentId": {
                                        "examples": [
                                            1243992
                                        ],
                                        "type": "string",
                                        "maxLength": 36
                                    },
                                    "type": {
                                        "type": "string",
                                        "minLength": 0,
                                        "maxLength": 0,
                                        "enum": [
                                            "Other"
                                        ]
                                    },
                                    "name": {
                                        "examples": [
                                            "patriot-search.pdf"
                                        ],
                                        "type": "string",
                                        "maxLength": 100
                                    },
                                    "fileType": {
                                        "type": "string",
                                        "enum": [
                                            "DOC",
                                            "DOCX",
                                            "PDF",
                                            "doc",
                                            "docx",
                                            "pdf"
                                        ]
                                    },
                                    "contentMediaType": {
                                        "type": "string",
                                        "enum": [
                                            "application/msword",
                                            "application/vnd.openxmlformats-officedocument.wordprocessingml.document",
                                            "application/pdf"
                                        ]
                                    },
                                    "contentUnicodeTextEncodingType": {
                                        "type": "string",
                                        "enum": [
                                            "UTF8"
                                        ]
                                    },
                                    "contentBinaryEncodingType": {
                                        "type": "string",
                                        "enum": [
                                            "Base64"
                                        ]
                                    },
                                    "content": {
                                        "contentEncoding": "base64",
                                        "type": "string"
                                    }
                                },
                                "required": [
                                    "documentId",
                                    "type",
                                    "name",
                                    "fileType",
                                    "contentMediaType",
                                    "contentUnicodeTextEncodingType",
                                    "contentBinaryEncodingType",
                                    "content"
                                ],
                                "allOf": [
                                    {
                                        "if": {
                                            "properties": {
                                                "fileType": {
                                                    "enum": [
                                                        "DOC",
                                                        "doc"
                                                    ]
                                                }
                                            }
                                        },
                                        "then": {
                                            "properties": {
                                                "contentMediaType": "application/msword"
                                            }
                                        }
                                    },
                                    {
                                        "if": {
                                            "properties": {
                                                "fileType": {
                                                    "enum": [
                                                        "DOCX",
                                                        "docx"
                                                    ]
                                                }
                                            }
                                        },
                                        "then": {
                                            "properties": {
                                                "contentMediaType": "application/vnd.openxmlformats-officedocument.wordprocessingml.document"
                                            }
                                        }
                                    },
                                    {
                                        "if": {
                                            "properties": {
                                                "fileType": {
                                                    "enum": [
                                                        "PDF",
                                                        "pdf"
                                                    ]
                                                }
                                            }
                                        },
                                        "then": {
                                            "properties": {
                                                "contentMediaType": "application/pdf"
                                            }
                                        }
                                    }
                                ]
                            }
                        }
                    }
                }
            },
            "required": [
                "transactionCode",
                "transactionId",
                "orderNumber",
                "itemNumber",
                "productCode",
                "loanNumber"
            ]
        },
        "transactionExtensions": {
            "type": "object",
            "properties": {
                "transactionExtension": {
                    "type": "array",
                    "items": {
                        "type": "object",
                        "additionalProperties": false,
                        "properties": {
                            "key": {
                                "examples": [
                                    "Client Specific Key"
                                ],
                                "type": "string",
                                "minLength": 1,
                                "maxLength": 200
                            },
                            "value": {
                                "examples": [
                                    "Client Specific Value"
                                ],
                                "type": "string",
                                "minLength": 1
                            }
                        },
                        "required": [
                            "key",
                            "value"
                        ],
                        "minProperties": 2,
                        "maxProperties": 2
                    },
                    "minItems": 0
                }
            }
        }
    },
    "required": [
        "transactionHeader",
        "transactionBody"
    ],
    "minProperties": 2,
    "maxProperties": 4
}
/* Copyright © 2023 Mortgage Connect LP */

<?xml version="1.0" encoding="utf-8"?>
<xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema">
    <xs:element name="root">
    <xs:complexType>
        <xs:sequence>
            <xs:element ref="legalHeader" minOccurs="0"/>
            <xs:element ref="transactionHeader"/>
            <xs:element name="transactionBody">
                <xs:complexType>
                    <xs:all>
                        <xs:element name="transactionCode" type="xs:string" fixed="Revised-Product-Delivery"/>
                        <xs:element ref="transactionId"/>
                        <xs:element name="productTransactionId" type="transactionId" minOccurs="0"/>
                        <xs:element name="orderNumber" type="orderNo"/>
                        <xs:element name="itemNumber" type="itemNumber"/>
                        <xs:element ref="productCode"/>
                        <xs:element ref="loanNumber"/>
                        <xs:element name="titleGrade" type="xs:string"/>
                        <xs:element name="isInsurable" type="xs:boolean"/>
                        <xs:element name="clearanceItems" minOccurs="0">
                            <xs:complexType>
                                <xs:sequence>
                                    <xs:element ref="clearanceItem" minOccurs="0" maxOccurs="unbounded"/>
                                </xs:sequence>
                            </xs:complexType>
                        </xs:element>
                        <xs:element name="documents" minOccurs="0">
                            <xs:complexType>
                                <xs:sequence>
                                    <xs:element ref="document" minOccurs="1" maxOccurs="unbounded"/>
                                </xs:sequence>
                            </xs:complexType>
                        </xs:element>
                    </xs:all>
                </xs:complexType>
            </xs:element>
            <xs:element ref="transactionExtensions" minOccurs="0"/>
        </xs:sequence>
    </xs:complexType>
    </xs:element>
</xs:schema>

✅ The following is an 'Accepted' example payload to be returned in the HTTP response.

Accepted Acknowledgment payloads are typically message type agnostic.

Accepted Acknowledgment payloads are typically message type agnostic.

⛔ The following is a 'Rejected' example payload to be returned in the HTTP response.

Rejected Acknowledgment payloads are typically message type agnostic.

Rejected Acknowledgment payloads are typically message type agnostic.

The Revised Product Delivery API method is the mechanism in which Mortgage Connect can submit a message to the Client to deliver Graded Title Documents and supporting metadata in response to the client submitting a Revision Request.

View Workflow Orchestration

Client URL

POST 🔒 To be determined during onboarding process.

Property Definitions - Transaction Header

Defines the properties represented in the Transaction Header object (JSON) or node (XML). Note that this message artifact is identical for each and every message type.

View Transaction Header Details

Property Definitions - Transaction Body

Defines the properties represented in the Transaction Body object (JSON) or node (XML).

Property	Requirement	Data Type	Min / Max	Description
transactionBody	Required			A parent object (JSON) or node (XML) that contains the transaction metadata.
transactionCode	Required	String	24 / 24	A static value of `Revised-Product-Delivery`. The transaction code is meant to identify the message type and the context or action that should be taken. In this context it implies that the product and all supporting metadata are to be delivered to the client. Possible Values: Revised-Product-Delivery
transactionId	Required	String	1 / 50	Represents the Client's unique order number.
productTransactionId	Optional	String	0 / 50	Represents the Client's unique product order number. Note that the `productTransactionId` field is not used in most circumstances. However, when there is a need to further differentiate order numbers at a product level, that share the same `transactionId`, (i.e. the primary order level id), then the `productTransactionId` can be used to ensure uniqueness across the integration transactions. This makes it possible for multiple orders of the same product type to be placed using the same `transactionId`. The use of the `productTransactionId` field and any specific workflow deviations will be vetted during the onboarding process.
orderNumber	Required	Integer		Represents Mortgage Connects unique order number.
itemNumber	Required	Integer	Integer	Represents Mortgage Connects product sequencing number (i.e `1 through 40`) that is associated with each product ordered.
productCode	Required	String	3 / 4	Represents Mortgage Connect's product code. Possible Values: PRLM `Property Report Loan Mod` TSG `Trustee Sale Guarantee` PFCF `Pre-Foreclosure Report` PJR `Preliminary Judicial Report` etc. Traditionally, clients use Mortgage Connects `Product Code` names and thus there is a one to one mapping relationship that is maintained by the client. However, Mortgage Connect is aware that our naming conventions may not resonate and that there are many inconsistencies in product code naming conventions and nomenclatures. It is for this reason that Mortgage Connect is able to map the client's product code to Mortgage Connect's product code to ease the transition. Any required product code mapping exercises will be addressed during the onboarding process. The supported `productCode`(s) are specific per integration and will be determined during the onboarding process. Note that the minimum/maximum length requirement of 3/4 is only applicable if using Mortgage Connect's internal product codes, otherwise when mapping to the client's product codes, the minimum/maximum is 1/50.
loanNumber	Required	String	1 / 64	The client's loan number that is associated with the order.
titleGrade	Optional	String	0 / 30	The grade for the Title.
isInsurable	Required	Boolean		Indicates whether or not the Title is insurable.
clearanceItems	Optional	Array		A parent object (JSON) or node (XML) that contains an array of title clearance items.
clearanceItem	Optional	Object		A parent object (JSON) or node (XML) that contains metadata associated with title clearance item.
rowId	Optional	integer		A number that uniquely identifies the clearance item.
clearingType	Optional	String	0 / 80	A general category for the item. Typically set to 'Requirement`.
name	Optional	String	0 / 12	A string that provides a brief description of the clearance item.
followUpDate	Optional	Date		The date that follow up activities are scheduled.
dueDate	Optional	Date		The date that follow up activities are expected to be completed.
status	Optional	String	0 / 25	The current status of the clearance item. Possible Values: Awaiting Approval Cleared Open Overdue
team	Optional	String	0 / 60	The team assigned to clear the item.
requestTypes	Optional	String	0 / 64	A list of requests made in support of clearing the item.
tcMethod	Optional	String	0 / 300	A description of what is being done to clear the item.
documents	Optional			A parent object (JSON) or node (XML) that contains a list of title documents. `(0 to Many)`
document	Optional			A parent object (JSON) or node (XML) that contains metadata associated with title documents.
documentId	Required	Integer		A number or string that uniquely identifies the document within the host system. When an outbound Product-Delivery event is sent by Mortgage Connect to the Client, the documentId will be a string in the form of an integer. The integer value represents the Identity Field and Primary Key associated with the corresponding document record. There is no hard requirement to capture this information. However, both parties are encouraged to do so, in order that conversations or any triaging of exceptions around these values can be correlated across systems.
type	Required	String	1 / 255	A name that uniquely identifies the document type. Traditionally, clients use Mortgage Connects `Document Type` names and thus there is a one to one mapping relationship that is maintained by the client. However, Mortgage Connect is aware that our naming conventions may not resonate and that there are many inconsistencies in document type naming conventions and nomenclatures. It is for this reason that Mortgage Connect is able to map the client's document type to Mortgage Connect's document type to ease the transition. Any required document mapping exercises will be addressed during the onboarding process. The supported `types`(s) are specific per integration and will be determined during the onboarding process.
name	Required	String	1 / 100	This is the user friendly name that is associated with the document.
fileType	Required	String	3 / 4	This indicates what type of document it is. This in the context of what the file extension represents. Possible Values: DOC DOCX PDF Future Values: CSV HTML JSON TXT XLS XLSX XML `DOC`, `DOCX`, and `PDF` are currently supported with the vast majority of the documents being delivered as `PDF` documents. The other types are included to support additional documents in the future.
contentMediaType	Required	String	1 / 100	This represents the content media type, i.e. `MIME Type`. Possible Values: application/msword (DOC) application/vnd.openxmlformats-officedocument.wordprocessingml.document (DOCX) application/pdf (PDF) Future Values: text/csv (CSV) text/html (HTML) application/json (JSON) text/plain (TXT) application/vnd.ms-excel (XLS) application/vnd.openxmlformats-officedocument.spreadsheetml.sheet (XLSX) application/xml (XML) At this time `application/msword (DOC)`, `application/vnd.openxmlformats-officedocument.wordprocessingml.document (DOCX)`, and `application/pdf (PDF)` are supported with `application/pdf (PDF)` being used 90+% of the time. The other types are added to support future media types.
contentUnicode TextEncodingType	Required	String	4 / 4	This indicates what unicode text encoding type was used to generate the document. Possible Values: UTF8
contentBinary EncodingType	Required	String	6 / 6	This indicates what binary encoding type was used to generate the document content. Possible Values: Base64
content	Required	String	1 / MAX	This represents the digital representation of the document after it has been encoded using Base64. See: https://en.wikipedia.org/wiki/Base64 for more information regarding Base64 formatting.
description	Optional	String	0 / 255	Provides a brief overview of the document contents.

Property Definitions - Transaction Extensions

Defines the properties represented in the TransactionExtensions object (JSON) or node (XML). Note that this message artifact is identical for each and every message type.

View Transaction Extension Details

Default Title - MC166 - Invoice

🌐 The following is an example payload to be posted in the body of the HTTP request.

/* Copyright © 2024 Mortgage Connect LP */
{
    "transactionHeader": {
      "transactionIdempotentId": "3B34A671-BB17-400D-90BF-7CBF9C96E8ED",
      "transactionDate": "2022-07-11T02:03:40",
      "clientCode": "1799",
      "clientName": "AcmeInc",
      "vendorCode": "MC",
      "vendorName": "Mortgage Connect"
    },
    "transactionBody": {
      "transactionCode": "Invoice",
      "transactionId": "7832143",
      "productTransactionId": "",
      "orderNumber": 2429888,
      "fees": {
          "fee": [
            {
              "feeType": "Non-Remittance",
              "feeName": "TSG Fee",
              "feeAmount": "250.0000",
              "productCode": "TSG"
            },
            {
              "feeType": "Non-Remittance",
              "feeName": "UPT Fee",
              "feeAmount": "0.0000",
              "productCode": "UPT"
            },
            {
              "feeType": "Non-Remittance",
              "feeName": "REC Fee",
              "feeAmount": "0.0000",
              "productCode": "REC"
            }
          ]
      },
      "documents": {
        "document": [
          {
            "documentId": "73340225",
            "type": "Invoice To Client",
            "name": "Invoice.pdf",
            "fileType": "PDF",
            "contentMediaType": "application/pdf",
            "contentUnicodeTextEncodingType": "UTF8",
            "contentBinaryEncodingType": "Base64",
            "content": "Base64 String",
            "description": "Brief overview of the document"
          }
        ]
      }
    },
    "transactionExtensions": {
      "transactionExtension": [
          {
              "key": "Client Specific Key 1",
              "value": "Client Specific Value 1"
          },
          {
              "key": "Client Specific Key 2",
              "value": "Client Specific Value 2"
          }
      ]
    }
}
/* Copyright © 2024 Mortgage Connect LP */

<!-- Copyright © 2024 Mortgage Connect LP -->
<root>
    <transactionHeader>
        <transactionIdempotentId>3B34A671-BB17-400D-90BF-7CBF9C96E8ED</transactionIdempotentId>
        <transactionDate>022-07-11T02:03:40</transactionDate>
        <clientCode>1799</clientCode>
        <clientName>AcmeInc</clientName>
        <vendorCode>MC</vendorCode>
        <vendorName>Mortgage Connect</vendorName>
    </transactionHeader>
    <transactionBody>
        <transactionCode>Invoice</transactionCode>
        <transactionId>7832143</transactionId>
        <productTransactionId></productTransactionId>
        <orderNumber>2429888</orderNumber>
        <fees>
            <fee>
                <feeType>Non-Remittance</feeType>
                <feeName>TSG Fee</feeName>
                <feeAmount>250.0000</feeAmount>
                <productCode>TSG</productCode>
            </fee>
            <fee>
                <feeType>Non-Remittance</feeType>
                <feeName>UPT Fee</feeName>
                <feeAmount>0.0000</feeAmount>
                <productCode>UPT</productCode>
            </fee>
            <fee>
                <feeType>Non-Remittance</feeType>
                <feeName>REC Fee</feeName>
                <feeAmount>0.0000</feeAmount>
                <productCode>REC</productCode>
            </fee>
        </fees>
        <documents>
            <document>
                <documentId>73340225</documentId>
                <type>Invoice To Client</type>
                <name>Invoice.pdf</name>
                <fileType>PDF</fileType>
                <contentMediaType>application/pdf</contentMediaType>
                <contentUnicodeTextEncodingType>UTF8</contentUnicodeTextEncodingType>
                <contentBinaryEncodingType>Base64</contentBinaryEncodingType>
                <content>Base64 String</content>
                <description>Brief overview of the document</description>
            </document>
        </documents>
    </transactionBody>
    <transactionExtensions>
        <transactionExtension>
            <key>Client Specific Key 1</key>
            <value>Client Specific Value 1</value>
        </transactionExtension>
        <transactionExtension>
            <key>Client Specific Key 2</key>
            <value>Client Specific Value 1</value>
        </transactionExtension>
    </transactionExtensions>
</root>
<!-- Copyright © 2024 Mortgage Connect LP -->

👍 The request payload can be verified using the following validation schema.

/* Copyright © 2024 Mortgage Connect LP */
{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "$id": "root",
  "description": "Copyright @ 2022 Mortgage Connect LP",
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "legalHeader": {
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "version": {
          "examples": [
            "1.0.8.0"
          ],
          "type": "string",
          "minLength": 1,
          "maxLength": 20
        },
        "disclosingParty": {
          "examples": [
            "Copyright @ 2022 Mortgage Connect LP"
          ],
          "type": "string",
          "minLength": 1,
          "maxLength": 100
        },
        "proprietaryInformationAndConfidential": {
          "examples": [
            "Ownership of Proprietary Information. The Recipient agrees that it shall not receive any right, title or interest, or any license or right to use, the Disclosing Partys Proprietary Information, including, but not limited to, technology, ideas, concepts, drawings, documentation, designs, prototypes, processes, trade secrets, trademarks or other intellectual property rights therein, by implication or otherwise."
          ],
          "type": "string",
          "minLength": 1,
          "maxLength": 2000
        }
      },
      "required": [
        "version",
        "disclosingParty",
        "proprietaryInformationAndConfidential"
      ],
      "minProperties": 3,
      "maxProperties": 3
    },
    "transactionHeader": {
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "transactionIdempotentId": {
          "examples": [
            "3B34A671-BB17-400D-90BF-7CBF9C96E8ED"
          ],
          "type": "string",
          "minLength": 36,
          "maxLength": 36,
          "pattern": "^[\\da-fA-F]{8}-[\\da-fA-F]{4}-[\\da-fA-F]{4}-[\\da-fA-F]{4}-[\\da-fA-F]{12}$"
        },
        "transactionDate": {
          "examples": [
            "2022-07-11T02:03:40"
          ],
          "type": "string",
          "format": "date-time"
        },
        "clientCode": {
          "examples": [
            "1799"
          ],
          "type": "string",
          "minLength": 1,
          "maxLength": 100,
          "format": "integer"
        },
        "clientName": {
          "examples": [
            "AcmeInc"
          ],
          "type": "string",
          "minLength": 1,
          "maxLength": 100
        },
        "vendorCode": {
          "examples": [
            "MC"
          ],
          "type": "string",
          "minLength": 1,
          "maxLength": 100
        },
        "vendorName": {
          "examples": [
            "Mortgage Connect"
          ],
          "type": "string",
          "minLength": 1,
          "maxLength": 100
        }
      },
      "required": [
        "transactionIdempotentId",
        "transactionDate",
        "clientCode",
        "clientName",
        "vendorCode",
        "vendorName"
      ],
      "minProperties": 6,
      "maxProperties": 6
    },
    "transactionBody": {
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "transactionCode": {
          "type": "string",
          "const": "Invoice"
        },
        "transactionId": {
          "examples": [
            "7832143"
          ],
          "type": "string",
          "minLength": 1,
          "maxLength": 50
        },
        "productTransactionId": {
          "examples": [
            "7832143"
          ],
          "type": "string",
          "minLength": 0,
          "maxLength": 50
        },     
        "orderNumber": {
          "examples": [
            "2429888"
          ],
          "type": "integer"
        },
        "fees": {
          "type": "object",
          "properties": {
            "fee": {
              "type": "array",
              "items": {
                "feeType": {
                  "type": "string",
                  "maxLength": 32
                },
                "feeName": {
                  "type": "string",
                  "maxLength": 100
                },
                "feeAmount": {
                  "$ref": "CommonTypes#/$defs/money"
                },
                "productCode": {
                  "type": "string",
                  "maxLength": 4
                }
              }
            }
          }
        },
        "documents": {
          "type": "object",
          "properties": {
            "document": {
              "type": "array",
              "items": {
                "$ref": "CommonTypes#/$defs/document"
              },
              "minItems": 1
            }
          }
        }
      },
      "required": [
        "transactionCode",
        "transactionId",
        "orderNumber",
        "issuedBy",
        "issuedTo",
        "propertyAddress"
      ]
    },
    "transactionExtensions": {
      "type": "object",
      "properties": {
        "transactionExtension": {
          "type": "array",
          "items": {
            "type": "object",
            "additionalProperties": false,
            "properties": {
              "key": {
                "examples": [
                  "Client Specific Key"
                ],
                "type": "string",
                "minLength": 1,
                "maxLength": 200
              },
              "value": {
                "examples": [
                  "Client Specific Value"
                ],
                "type": "string",
                "minLength": 1
              }
            },
            "required": [
              "key",
              "value"
            ],
            "minProperties": 2,
            "maxProperties": 2
          },
          "minItems": 0
        }
      }
    }
  },
  "required": [
    "transactionHeader",
    "transactionBody"
  ],
  "minProperties": 2,
  "maxProperties": 4
}
/* Copyright © 2024 Mortgage Connect LP */

<!-- Copyright © 2024 Mortgage Connect LP -->
<?xml version="1.0" encoding="utf-8"?>
<xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema">
  <xs:element name="root">
    <xs:complexType>
      <xs:sequence>
        <xs:element ref="legalHeader" minOccurs="0"/>
        <xs:element ref="transactionHeader"/>
        <xs:element name="transactionBody">
          <xs:complexType>
            <xs:all>
              <xs:element name="transactionCode" type="xs:string" fixed="Invoice"/>
              <xs:element ref="transactionId"/>
              <xs:element name="productTransactionId" type="transactionId" minOccurs="0"/>
              <xs:element name="orderNumber" type="orderNo"/>
              <xs:element name="fees" minOccurs="0">
                <xs:complexType>
                  <xs:sequence>
                    <xs:element name="fee" minOccurs="1" maxOccurs="unbounded">
                      <xs:complexType>
                        <xs:all>
                          <xs:element name="feeType" minOccurs="0">
                            <xs:simpleType>
                              <xs:restriction base="xs:string">
                                <xs:maxLength value="32"/>
                              </xs:restriction>
                            </xs:simpleType>
                          </xs:element>
                          <xs:element name="feeName" minOccurs="0">
                            <xs:simpleType>
                              <xs:restriction base="xs:string">
                                <xs:maxLength value="100"/>
                              </xs:restriction>
                            </xs:simpleType>
                          </xs:element>
                          <xs:element name="feeAmount" type="money" minOccurs="0"/>
                          <xs:element name="productCode" minOccurs="0">
                            <xs:simpleType>
                              <xs:restriction base="xs:string">
                                <xs:maxLength value="4"/>
                              </xs:restriction>
                            </xs:simpleType>
                          </xs:element>
                        </xs:all>
                      </xs:complexType>
                    </xs:element>
                  </xs:sequence>
                </xs:complexType>
              </xs:element>
              <xs:element name="documents" minOccurs="0">
                <xs:complexType>
                  <xs:sequence>
                    <xs:element ref="document" minOccurs="1" maxOccurs="unbounded"/>
                  </xs:sequence>
                </xs:complexType>
              </xs:element>
            </xs:all>
          </xs:complexType>
        </xs:element>
        <xs:element ref="transactionExtensions" minOccurs="0"/>
      </xs:sequence>
    </xs:complexType>
  </xs:element>
</xs:schema>
<!-- Copyright © 2024 Mortgage Connect LP -->

✅ The following is an 'Accepted' example payload to be returned in the HTTP response.

Accepted Acknowledgment payloads are typically message type agnostic.

Accepted Acknowledgment payloads are typically message type agnostic.

⛔ The following is a 'Rejected' example payload to be returned in the HTTP response.

Rejected Acknowledgment payloads are typically message type agnostic.

Rejected Acknowledgment payloads are typically message type agnostic.

The Invoice API method is the mechanism in which Mortgage Connect can submit a message to the Client that contains Fee Data and supporting metadata.

View Workflow Orchestration

Client URL

POST 🔒 To be determined during onboarding process.

Property Definitions - Transaction Header

Defines the properties represented in the Transaction Header object (JSON) or node (XML). Note that this message artifact is identical for each and every message type.

View Transaction Header Details

Property Definitions - Transaction Body

Defines the properties represented in the Transaction Body object (JSON) or node (XML).

Property	Requirement	Data Type	Min / Max	Description
transactionBody	Required			A parent object (JSON) or node (XML) that contains the transaction metadata.
transactionCode	Required	String	7 / 7	A static value of `Invoice`. The transaction code is meant to identify the message type and the context or action that should be taken. In this context it implies that Fee Data should be delivered to the client. Possible Values: Invoice
transactionId	Required	String	1 / 50	Represents the Client's unique order number.
productTransactionId	Optional	String	0 / 50	Represents the Client's unique product order number. Note that the `productTransactionId` field is not used in most circumstances. However, when there is a need to further differentiate order numbers at a product level, that share the same `transactionId`, (i.e. the primary order level id), then the `productTransactionId` can be used to ensure uniqueness across the integration transactions. This makes it possible for multiple orders of the same product type to be placed using the same `transactionId`. The use of the `productTransactionId` field and any specific workflow deviations will be vetted during the onboarding process.
orderNumber	Required	Integer		Represents Mortgage Connects unique order number.
fees	Required			A parent object (JSON) or node (XML) that contains fees metadata. (1 to Many)
fee	Required			A parent object (JSON) or node (XML) that contains fee metadata.
feeType	Optional	String	0 / 32	The type of fee. Normally this will be `Non-Remittance`.
feeName	Optional	String	1 / 100	The name of a fee.
feeAmount	Optional	Money	1 / 100	The amount associated with a fee.
productCode	Optional	String	3 / 4	Represents Mortgage Connect's product code. Possible Values: PRLM `Property Report Loan Mod` TSG `Trustee Sale Guarantee` PFCF `Pre-Foreclosure Report` PJR `Preliminary Judicial Report` etc. Traditionally, clients use Mortgage Connects `Product Code` names and thus there is a one to one mapping relationship that is maintained by the client. However, Mortgage Connect is aware that our naming conventions may not resonate and that there are many inconsistencies in product code naming conventions and nomenclatures. It is for this reason that Mortgage Connect is able to map the client's product code to Mortgage Connect's product code to ease the transition. Any required product code mapping exercises will be addressed during the onboarding process. The supported `productCode`(s) are specific per integration and will be determined during the onboarding process. Note that the minimum/maximum length requirement of 3/4 is only applicable if using Mortgage Connect's internal product codes, otherwise when mapping to the client's product codes, the minimum/maximum is 1/50.
documents	Optional			A parent object (JSON) or node (XML) that contains a list of invoice documents. `(0 to Many)`
document	Optional			A parent object (JSON) or node (XML) that contains metadata associated with each invoice document.
documentId	Required	Integer		A number or string that uniquely identifies the document within the host system. When an outbound Invoice event is sent by Mortgage Connect to the Client, the documentId will be a string in the form of an integer. The integer value represents the Identity Field and Primary Key associated with the corresponding document record. There is no hard requirement to capture this information. However, both parties are encouraged to do so, in order that conversations or any triaging of exceptions around these values can be correlated across systems.
type	Required	String	1 / 255	A name that uniquely identifies the document type. Traditionally, clients use Mortgage Connects `Document Type` names and thus there is a one to one mapping relationship that is maintained by the client. However, Mortgage Connect is aware that our naming conventions may not resonate and that there are many inconsistencies in document type naming conventions and nomenclatures. It is for this reason that Mortgage Connect is able to map the client's document type to Mortgage Connect's document type to ease the transition. Any required document mapping exercises will be addressed during the onboarding process. The supported `types`(s) are specific per integration and will be determined during the onboarding process.
name	Required	String	1 / 100	This is the user friendly name that is associated with the document.
fileType	Required	String	3 / 4	This indicates what type of document it is. This in the context of what the file extension represents. Possible Values: DOC DOCX PDF Future Values: CSV HTML JSON TXT XLS XLSX XML `DOC`, `DOCX`, and `PDF` are currently supported with the vast majority of the documents being delivered as `PDF` documents. The other types are included to support additional documents in the future.
contentMediaType	Required	String	1 / 100	This represents the content media type, i.e. `MIME Type`. Possible Values: application/msword (DOC) application/vnd.openxmlformats-officedocument.wordprocessingml.document (DOCX) application/pdf (PDF) Future Values: text/csv (CSV) text/html (HTML) application/json (JSON) text/plain (TXT) application/vnd.ms-excel (XLS) application/vnd.openxmlformats-officedocument.spreadsheetml.sheet (XLSX) application/xml (XML) At this time `application/msword (DOC)`, `application/vnd.openxmlformats-officedocument.wordprocessingml.document (DOCX)`, and `application/pdf (PDF)` are supported with `application/pdf (PDF)` being used 90+% of the time. The other types are added to support future media types.
contentUnicode TextEncodingType	Required	String	4 / 4	This indicates what unicode text encoding type was used to generate the document. Possible Values: UTF8
contentBinary EncodingType	Required	String	6 / 6	This indicates what binary encoding type was used to generate the document content. Possible Values: Base64
content	Required	String	1 / MAX	This represents the digital representation of the document after it has been encoded using Base64. See: https://en.wikipedia.org/wiki/Base64 for more information regarding Base64 formatting.
description	Optional	String	0 / 255	Provides a brief overview of the document contents.

Property Definitions - Transaction Extensions

Defines the properties represented in the TransactionExtensions object (JSON) or node (XML). Note that this message artifact is identical for each and every message type.

View Transaction Extension Details

Default Title - MC168 - Graded Title Data

🌐 The following is an example payload to be posted in the body of the HTTP request.

/* Copyright © 2023 Mortgage Connect LP */
{
    "transactionHeader": {
        "transactionIdempotentId": "3B34A671-BB17-400D-90BF-7CBF9C96E8ED",
        "transactionDate": "2022-07-11T02:03:40",
        "clientCode": "1799",
        "clientName": "AcmeInc",
        "vendorCode": "MC",
        "vendorName": "Mortgage Connect"
    },
    "transactionBody": {
        "transactionCode": "Graded-Title-Data",
        "transactionId": "7832143",
        "productTransactionId": "",
        "orderNumber": 2429888,
        "itemNumber": 1,
        "productCode": "TSG",
        "loanNumber": "20241015-01",
        "titleGrade": "A",
        "isInsurable": false,
        "clearanceItems": {
            "clearanceItem": [
            {
                "rowId": 9717052,
                "description": "Unrecorded Mortgage",
                "clearingType": "Requirement",
                "name": "Subject mortgage not found in first lien position",
                "followUpDate": "2024-02-23",
                "dueDate": "2024-02-25",
                "status": "Overdue",
                "team": "airons [CITI 1]",
                "requestTypes": "Subordination (Req. - 10/17/2024); ",
                "tcMethod": "External Subordination"
            }
            ]
        },
        "documents": {
            "document": [
            {
                "documentId": "72033395",
                "type": "Tsg",
                "name": "TSG.1.pdf",
                "fileType": "PDF",
                "contentMediaType": "application/pdf",
                "contentUnicodeTextEncodingType": "UTF8",
                "contentBinaryEncodingType": "Base64",
                "content": "Base64 String",
                "description": "Brief overview of the document"
            }
            ]
        }
    },
    "transactionExtensions": {
        "transactionExtension": [
            {
                "key": "Client Specific Key 1",
                "value": "Client Specific Value 1"
            },
            {
                "key": "Client Specific Key 2",
                "value": "Client Specific Value 2"
            }
        ]
    }
}
/* Copyright © 2023 Mortgage Connect LP */

<!-- Copyright © 2023 Mortgage Connect LP -->
<root>
    <transactionHeader>
        <transactionIdempotentId>3B34A671-Bb17-400D-90Bf-7Cbf9C96E8Ed</transactionIdempotentId>
        <transactionDate>2022-07-11T02:03:40</transactionDate>
        <clientCode>1799</clientCode>
        <clientName>Acmeinc</clientName>
        <vendorCode>MC</vendorCode>
        <vendorName>Mortgage Connect</vendorName>
    </transactionHeader>
    <transactionBody>
        <transactionCode>Graded-Title-Data</transactionCode>
        <transactionId>7832143</transactionId>
        <productTransactionId></productTransactionId>
        <orderNumber>2429888</orderNumber>
        <itemNumber>1</itemNumber>
        <productCode>TSG</productCode>
        <loanNumber>7313993</loanNumber>
        <titleGrade>A</titleGrade>
        <isInsurable>false</isInsurable>
        <clearanceItems>
            <clearanceItem>
                <rowId>9717052</rowId>
                <description>Unrecorded Mortgage</description>
                <clearingType>Requirement</clearingType>
                <name>Subject mortgage not found in first lien position</name>
                <followUpDate>2024-02-23</followUpDate>
                <dueDate>2024-02-25</dueDate>
                <status>Overdue</status>
                <team>airons [CITI 1]</team>
                <requestTypes>Subordination (Req. - 10/17/2024); </requestTypes>
                <tcMethod>External Subordination</tcMethod>
            </clearanceItem>
        </clearanceItems>
        <documents>
            <document>
                <documentId>72033395</documentId>
                <type>Tsg</type>
                <name>TSG.1.pdf</name>
                <fileType>PDF</fileType>
                <contentMediaType>application/pdf</contentMediaType>
                <contentUnicodeTextEncodingType>UTF8</contentUnicodeTextEncodingType>
                <contentBinaryEncodingType>Base64</contentBinaryEncodingType>
                <content>Base64 String</content>
                <description>Brief overview of the document</description>
            </document>
        </documents>
    </transactionBody>
    <transactionExtensions>
        <transactionExtension>
            <key>Client Specific Key 1</key>
            <value>Client Specific Value 1</value>
        </transactionExtension>
        <transactionExtension>
            <key>Client Specific Key 2</key>
            <value>Client Specific Value 1</value>
        </transactionExtension>
    </transactionExtensions>
</root>
<!-- Copyright © 2023 Mortgage Connect LP -->

👍 The request payload can be verified using the following validation schema.

/* Copyright © 2023 Mortgage Connect LP */
{
    "$schema": "http://json-schema.org/draft-07/schema#",
    "$id": "root",
    "description": "Copyright @ 2022 Mortgage Connect LP - Title & Tax Schema.",
    "type": "object",
    "additionalProperties": false,
    "properties": {
        "legalHeader": {
            "type": "object",
            "additionalProperties": false,
            "properties": {
                "version": {
                    "examples": [
                        "0.8 Beta"
                    ],
                    "type": "string",
                    "minLength": 1,
                    "maxLength": 20
                },
                "disclosingParty": {
                    "examples": [
                        "Copyright @ 2022 Mortgage Connect LP"
                    ],
                    "type": "string",
                    "minLength": 1,
                    "maxLength": 100
                },
                "proprietaryInformationAndConfidential": {
                    "examples": [
                        "Ownership of Proprietary Information. The Recipient agrees that it shall not receive any right, title or interest, or any license or right to use, the Disclosing Party�s Proprietary Information, including, but not limited to, technology, ideas, concepts, drawings, documentation, designs, prototypes, processes, trade secrets, trademarks or other intellectual property rights therein, by implication or otherwise."
                    ],
                    "type": "string",
                    "minLength": 1,
                    "maxLength": 2000
                }
            },
            "required": [
                "version",
                "disclosingParty",
                "proprietaryInformationAndConfidential"
            ],
            "minProperties": 3,
            "maxProperties": 3
        },
        "transactionHeader": {
            "type": "object",
            "additionalProperties": false,
            "properties": {
                "transactionIdempotentId": {
                    "examples": [
                        "3B34A671-BB17-400D-90BF-7CBF9C96E8ED"
                    ],
                    "type": "string",
                    "minLength": 36,
                    "maxLength": 36,
                    "pattern": "^[\\da-fA-F]{8}-[\\da-fA-F]{4}-[\\da-fA-F]{4}-[\\da-fA-F]{4}-[\\da-fA-F]{12}$"
                },
                "transactionDate": {
                    "examples": [
                        "2022-07-11T02:03:40"
                    ],
                    "type": "string",
                    "format": "date-time"
                },
                "clientCode": {
                    "examples": [
                        "1799"
                    ],
                    "type": "string",
                    "minLength": 1,
                    "maxLength": 100,
                    "format": "integer"
                },
                "clientName": {
                    "examples": [
                        "AcmeInc"
                    ],
                    "type": "string",
                    "minLength": 1,
                    "maxLength": 100
                },
                "vendorCode": {
                    "examples": [
                        "MC"
                    ],
                    "type": "string",
                    "minLength": 1,
                    "maxLength": 100
                },
                "vendorName": {
                    "examples": [
                        "Mortgage Connect"
                    ],
                    "type": "string",
                    "minLength": 1,
                    "maxLength": 100
                }
            },
            "required": [
                "transactionIdempotentId",
                "transactionDate",
                "clientCode",
                "clientName",
                "vendorCode",
                "vendorName"
            ],
            "minProperties": 6,
            "maxProperties": 6
        },
        "transactionBody": {
            "type": "object",
            "additionalProperties": false,
            "properties": {
                "transactionCode": {
                    "type": "string",
                    "const": "Graded-Title-Data"
                },
                "transactionId": {
                    "examples": [
                        "7832143"
                    ],
                    "type": "string",
                    "minLength": 1,
                    "maxLength": 50
                },
                "productTransactionId": {
                    "examples": [
                        "7832143"
                    ],
                    "type": "string",
                    "minLength": 0,
                    "maxLength": 50
                },
                "orderNumber": {
                    "examples": [
                        "2429888"
                    ],
                    "type": "integer"
                },
                "itemNumber": {
                    "examples": [
                        "1"
                    ],
                    "type": "integer",
                    "minimum": 1.0,
                    "maximum": 40.0
                },
                "productCode": {
                    "type": "string",
                    "minLength": 3,
                    "maxLength": 4,
                    "enum": [
                        "REC",
                        "BENE",
                        "TSG"
                    ]
                },
                "loanNumber": {
                    "examples": [
                        "7313993"
                    ],
                    "type": "string",
                    "minLength": 1,
                    "maxLength": 64
                },
                "titleGrade": {
                    "example": [
                        "A"
                    ],
                    "type": "string"
                },
                "isInsurable": {
                    "example": [
                        true
                    ],
                    "type": "boolean"
                },
                "clearanceItems": {
                    "type": "object",
                    "properties": {
                        "clearanceItem": {
                            "type": "array",
                            "items": {
                                "type": "object",
                                "properties": {
                                    "rowId": {
                                        "examples": [
                                            "1"
                                        ],
                                        "type": "integer",
                                        "minimum": 1.0
                                    },
                                    "description": {
                                        "type": "string"
                                    },
                                    "clearingType": {
                                        "type": "string",
                                        "maxLength": 80
                                    },
                                    "name": {
                                        "type": "string"
                                    },
                                    "followUpDate": {
                                        "examples": [
                                            "05-10-2022"
                                        ],
                                        "type": "string",
                                        "format": "date"
                                    },
                                    "dueDate": {
                                        "examples": [
                                            "05-10-2022"
                                        ],
                                        "type": "string",
                                        "format": "date"
                                    },
                                    "status": {
                                        "type": "string",
                                        "enum": [
                                            "Awaiting Approval",
                                            "Cleared",
                                            "Open",
                                            "Overdue"
                                        ]
                                    },
                                    "team": {
                                        "type": "string",
                                        "maxLength": 60
                                    },
                                    "requestTypes": {
                                        "type": "string",
                                        "maxLength": 64
                                    },
                                    "tcMethod": {
                                        "type": "string",
                                        "maxLength": 300
                                    }
                                }
                            }
                        }
                    }
                },
                "documents": {
                    "type": "object",
                    "properties": {
                        "document": {
                            "type": "array",
                            "items": {
                                "type": "object",
                                "properties": {
                                    "documentId": {
                                        "examples": [
                                            1243992
                                        ],
                                        "type": "string",
                                        "maxLength": 36
                                    },
                                    "type": {
                                        "type": "string",
                                        "minLength": 0,
                                        "maxLength": 0,
                                        "enum": [
                                            "Other"
                                        ]
                                    },
                                    "name": {
                                        "examples": [
                                            "patriot-search.pdf"
                                        ],
                                        "type": "string",
                                        "maxLength": 100
                                    },
                                    "fileType": {
                                        "type": "string",
                                        "enum": [
                                            "DOC",
                                            "DOCX",
                                            "PDF",
                                            "doc",
                                            "docx",
                                            "pdf"
                                        ]
                                    },
                                    "contentMediaType": {
                                        "type": "string",
                                        "enum": [
                                            "application/msword",
                                            "application/vnd.openxmlformats-officedocument.wordprocessingml.document",
                                            "application/pdf"
                                        ]
                                    },
                                    "contentUnicodeTextEncodingType": {
                                        "type": "string",
                                        "enum": [
                                            "UTF8"
                                        ]
                                    },
                                    "contentBinaryEncodingType": {
                                        "type": "string",
                                        "enum": [
                                            "Base64"
                                        ]
                                    },
                                    "content": {
                                        "contentEncoding": "base64",
                                        "type": "string"
                                    }
                                },
                                "required": [
                                    "documentId",
                                    "type",
                                    "name",
                                    "fileType",
                                    "contentMediaType",
                                    "contentUnicodeTextEncodingType",
                                    "contentBinaryEncodingType",
                                    "content"
                                ],
                                "allOf": [
                                    {
                                        "if": {
                                            "properties": {
                                                "fileType": {
                                                    "enum": [
                                                        "DOC",
                                                        "doc"
                                                    ]
                                                }
                                            }
                                        },
                                        "then": {
                                            "properties": {
                                                "contentMediaType": {
                                                    "enum": [
                                                        "application/msword"
                                                    ]
                                                }
                                            }
                                        }
                                    },
                                    {
                                        "if": {
                                            "properties": {
                                                "fileType": {
                                                    "enum": [
                                                        "DOCX",
                                                        "docx"
                                                    ]
                                                }
                                            }
                                        },
                                        "then": {
                                            "properties": {
                                                "contentMediaType": {
                                                    "enum": [
                                                        "application/vnd.openxmlformats-officedocument.wordprocessingml.document"
                                                    ]
                                                }
                                            }
                                        }
                                    },
                                    {
                                        "if": {
                                            "properties": {
                                                "fileType": {
                                                    "enum": [
                                                        "PDF",
                                                        "pdf"
                                                    ]
                                                }
                                            }
                                        },
                                        "then": {
                                            "properties": {
                                                "contentMediaType": {
                                                    "enum": [
                                                        "application/pdf"
                                                    ]
                                                }
                                            }
                                        }
                                    }
                                ]
                            }
                        }
                    }
                }
            },
            "required": [
                "transactionCode",
                "transactionId",
                "orderNumber",
                "itemNumber",
                "productCode",
                "loanNumber"
            ]
        },
        "transactionExtensions": {
            "type": "object",
            "properties": {
                "transactionExtension": {
                    "type": "array",
                    "items": {
                        "type": "object",
                        "additionalProperties": false,
                        "properties": {
                            "key": {
                                "examples": [
                                    "Client Specific Key"
                                ],
                                "type": "string",
                                "minLength": 1,
                                "maxLength": 200
                            },
                            "value": {
                                "examples": [
                                    "Client Specific Value"
                                ],
                                "type": "string",
                                "minLength": 1
                            }
                        },
                        "required": [
                            "key",
                            "value"
                        ],
                        "minProperties": 2,
                        "maxProperties": 2
                    },
                    "minItems": 0
                }
            }
        }
    },
    "required": [
        "transactionHeader",
        "transactionBody"
    ],
    "minProperties": 2,
    "maxProperties": 4
}
/* Copyright © 2023 Mortgage Connect LP */

<?xml version="1.0" encoding="utf-8"?>
<xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema">
    <xs:element name="root">
        <xs:complexType>
            <xs:sequence>
                <xs:element ref="legalHeader" minOccurs="0"/>
                <xs:element ref="transactionHeader"/>
                <xs:element name="transactionBody">
                    <xs:complexType>
                        <xs:all>
                            <xs:element name="transactionCode" type="xs:string" fixed="Graded-Title-Data"/>
                            <xs:element ref="transactionId"/>
                            <xs:element name="productTransactionId" type="transactionId" minOccurs="0"/>
                            <xs:element name="orderNumber" type="orderNo"/>
                            <xs:element name="itemNumber" type="itemNo"/>
                            <xs:element ref="productCode"/>
                            <xs:element ref="loanNumber"/>
                            <xs:element name="titleGrade" type="xs:string" minOccurs="0"/>
                            <xs:element name="isInsurable" type="xs:boolean" minOccurs="0"/>
                            <xs:element name="clearanceItems" minOccurs="0">
                                <xs:complexType>
                                    <xs:sequence>
                                        <xs:element name="clearanceItem" minOccurs="1" maxOccurs="unbounded">
                                            <xs:complexType>
                                                <xs:all>
                                                    <xs:element name="rowId" type="xs:integer" minOccurs="0"/>
                                                    <xs:element name="description" type="xs:string" minOccurs="0"/>
                                                    <xs:element name="clearingType" minOccurs="0">
                                                        <xs:simpleType>
                                                            <xs:restriction base="xs:string">
                                                                <xs:maxLength value="80"/>
                                                            </xs:restriction>
                                                        </xs:simpleType>
                                                    </xs:element>
                                                    <xs:element name="name" type="xs:string" minOccurs="0" />
                                                    <xs:element name="followUpDate" type="xs:date" minOccurs="0"/>
                                                    <xs:element name="dueDate" type="xs:date" minOccurs="0"/>
                                                    <xs:element name="status">
                                                        <xs:simpleType>
                                                            <xs:restriction base="xs:string">
                                                                <xs:enumeration value="Awaiting Approval"/>
                                                                <xs:enumeration value="Cleared"/>
                                                                <xs:enumeration value="Open"/>
                                                                <xs:enumeration value="Overdue"/>
                                                            </xs:restriction>
                                                        </xs:simpleType>
                                                    </xs:element>
                                                    <xs:element name="team" minOccurs="0">
                                                        <xs:simpleType>
                                                            <xs:restriction base="xs:string">
                                                                <xs:maxLength value="60"/>
                                                            </xs:restriction>
                                                        </xs:simpleType>
                                                    </xs:element>
                                                    <xs:element name="requestTypes" minOccurs="0">
                                                        <xs:simpleType>
                                                            <xs:restriction base="xs:string">
                                                                <xs:maxLength value="64"/>
                                                            </xs:restriction>
                                                        </xs:simpleType>
                                                    </xs:element>
                                                    <xs:element name="tcMethod" minOccurs="0">
                                                        <xs:simpleType>
                                                            <xs:restriction base="xs:string">
                                                                <xs:maxLength value="300"/>
                                                            </xs:restriction>
                                                        </xs:simpleType>
                                                    </xs:element>
                                                </xs:all>
                                            </xs:complexType>
                                        </xs:element>
                                    </xs:sequence>
                                </xs:complexType>
                            </xs:element>
                            <xs:element name="documents" minOccurs="0">
                                <xs:complexType>
                                    <xs:sequence>
                                        <xs:element ref="document" minOccurs="1" maxOccurs="unbounded"/>
                                    </xs:sequence>
                                </xs:complexType>
                            </xs:element>
                        </xs:all>
                    </xs:complexType>
                </xs:element>
                <xs:element ref="transactionExtensions" minOccurs="0" />
            </xs:sequence>
        </xs:complexType>
    </xs:element>
</xs:schema>

✅ The following is an 'Accepted' example payload to be returned in the HTTP response.

Accepted Acknowledgment payloads are typically message type agnostic.

Accepted Acknowledgment payloads are typically message type agnostic.

⛔ The following is a 'Rejected' example payload to be returned in the HTTP response.

Rejected Acknowledgment payloads are typically message type agnostic.

Rejected Acknowledgment payloads are typically message type agnostic.

The Graded Title Data API method is the mechanism in which Mortgage Connect can submit a message to the Client to deliver the Graded Title Data and supporting metadata.

View Workflow Orchestration

Client URL

POST 🔒 To be determined during onboarding process.

Property Definitions - Transaction Header

Defines the properties represented in the Transaction Header object (JSON) or node (XML). Note that this message artifact is identical for each and every message type.

View Transaction Header Details

Property Definitions - Transaction Body

Defines the properties represented in the Transaction Body object (JSON) or node (XML).

Property	Requirement	Data Type	Min / Max	Description
transactionBody	Required			A parent object (JSON) or node (XML) that contains the transaction metadata.
transactionCode	Required	String	17 / 17	A static value of `Graded-Title-Data`. The transaction code is meant to identify the message type and the context or action that should be taken. In this context it implies that the title grade and all supporting metadata are to be delivered to the client. Possible Values: Graded-Title-Data
transactionId	Required	String	1 / 50	Represents the Client's unique order number.
productTransactionId	Optional	String	0 / 50	Represents the Client's unique product order number. Note that the `productTransactionId` field is not used in most circumstances. However, when there is a need to further differentiate order numbers at a product level, that share the same `transactionId`, (i.e. the primary order level id), then the `productTransactionId` can be used to ensure uniqueness across the integration transactions. This makes it possible for multiple orders of the same product type to be placed using the same `transactionId`. The use of the `productTransactionId` field and any specific workflow deviations will be vetted during the onboarding process.
orderNumber	Required	Integer		Represents Mortgage Connects unique order number.
itemNumber	Required	Integer	Integer	Represents Mortgage Connects product sequencing number (i.e `1 through 40`) that is associated with each product ordered.
productCode	Required	String	3 / 4	Represents Mortgage Connect's product code. Possible Values: PRLM `Property Report Loan Mod` TSG `Trustee Sale Guarantee` PFCF `Pre-Foreclosure Report` PJR `Preliminary Judicial Report` etc. Traditionally, clients use Mortgage Connects `Product Code` names and thus there is a one to one mapping relationship that is maintained by the client. However, Mortgage Connect is aware that our naming conventions may not resonate and that there are many inconsistencies in product code naming conventions and nomenclatures. It is for this reason that Mortgage Connect is able to map the client's product code to Mortgage Connect's product code to ease the transition. Any required product code mapping exercises will be addressed during the onboarding process. The supported `productCode`(s) are specific per integration and will be determined during the onboarding process. Note that the minimum/maximum length requirement of 3/4 is only applicable if using Mortgage Connect's internal product codes, otherwise when mapping to the client's product codes, the minimum/maximum is 1/50.
loanNumber	Required	String	1 / 64	The client's loan number that is associated with the order.
titleGrade	Optional	String	0 / 30	The grade for the Title.
isInsurable	Required	Boolean		Indicates whether or not the Title is insurable.
clearanceItems	Optional	Array		A parent object (JSON) or node (XML) that contains an array of title clearance items.
clearanceItem	Optional	Object		A parent object (JSON) or node (XML) that contains metadata associated with title clearance item.
rowId	Optional	integer		A number that uniquely identifies the clearance item.
description	Optional	String	0 / MAX	A string that provides additional information about the clearance item.
clearingType	Optional	String	0 / 80	A general category for the item. Typically set to 'Requirement`.
name	Optional	String	0 / 12	A string that provides a brief description of the clearance item.
followUpDate	Optional	Date		The date that follow up activities are scheduled.
dueDate	Optional	Date		The date that follow up activities are expected to be completed.
status	Optional	String	0 / 25	The current status of the clearance item. Possible Values: Awaiting Approval Cleared Open Overdue
team	Optional	String	0 / 60	The team assigned to clear the item.
requestTypes	Optional	String	0 / 64	A list of requests made in support of clearing the item.
tcMethod	Optional	String	0 / 300	A description of what is being done to clear the item.
documents	Optional			A parent object (JSON) or node (XML) that contains a list of title documents. `(0 to Many)`
document	Optional			A parent object (JSON) or node (XML) that contains metadata associated with title documents.
documentId	Required	Integer		A number or string that uniquely identifies the document within the host system. When an outbound Product-Delivery event is sent by Mortgage Connect to the Client, the documentId will be a string in the form of an integer. The integer value represents the Identity Field and Primary Key associated with the corresponding document record. There is no hard requirement to capture this information. However, both parties are encouraged to do so, in order that conversations or any triaging of exceptions around these values can be correlated across systems.
type	Required	String	1 / 255	A name that uniquely identifies the document type. Traditionally, clients use Mortgage Connects `Document Type` names and thus there is a one to one mapping relationship that is maintained by the client. However, Mortgage Connect is aware that our naming conventions may not resonate and that there are many inconsistencies in document type naming conventions and nomenclatures. It is for this reason that Mortgage Connect is able to map the client's document type to Mortgage Connect's document type to ease the transition. Any required document mapping exercises will be addressed during the onboarding process. The supported `types`(s) are specific per integration and will be determined during the onboarding process.
name	Required	String	1 / 100	This is the user friendly name that is associated with the document.
fileType	Required	String	3 / 4	This indicates what type of document it is. This in the context of what the file extension represents. Possible Values: DOC DOCX PDF Future Values: CSV HTML JSON TXT XLS XLSX XML `DOC`, `DOCX`, and `PDF` are currently supported with the vast majority of the documents being delivered as `PDF` documents. The other types are included to support additional documents in the future.
contentMediaType	Required	String	1 / 100	This represents the content media type, i.e. `MIME Type`. Possible Values: application/msword (DOC) application/vnd.openxmlformats-officedocument.wordprocessingml.document (DOCX) application/pdf (PDF) Future Values: text/csv (CSV) text/html (HTML) application/json (JSON) text/plain (TXT) application/vnd.ms-excel (XLS) application/vnd.openxmlformats-officedocument.spreadsheetml.sheet (XLSX) application/xml (XML) At this time `application/msword (DOC)`, `application/vnd.openxmlformats-officedocument.wordprocessingml.document (DOCX)`, and `application/pdf (PDF)` are supported with `application/pdf (PDF)` being used 90+% of the time. The other types are added to support future media types.
contentUnicode TextEncodingType	Required	String	4 / 4	This indicates what unicode text encoding type was used to generate the document. Possible Values: UTF8
contentBinary EncodingType	Required	String	6 / 6	This indicates what binary encoding type was used to generate the document content. Possible Values: Base64
content	Required	String	1 / MAX	This represents the digital representation of the document after it has been encoded using Base64. See: https://en.wikipedia.org/wiki/Base64 for more information regarding Base64 formatting.
description	Optional	String	0 / 255	Provides a brief overview of the document contents.

Property Definitions - Transaction Extensions

Defines the properties represented in the TransactionExtensions object (JSON) or node (XML). Note that this message artifact is identical for each and every message type.

View Transaction Extension Details

Default Title - MC170 - Clear Title

🌐 The following is an example payload to be posted in the body of the HTTP request.

/* Copyright © 2023 Mortgage Connect LP */
{
    "transactionHeader": {
        "transactionIdempotentId": "3B34A671-BB17-400D-90BF-7CBF9C96E8ED",
        "transactionDate": "2022-07-11T02:03:40",
        "clientCode": "1799",
        "clientName": "AcmeInc",
        "vendorCode": "MC",
        "vendorName": "Mortgage Connect"
    },
    "transactionBody": {
        "transactionCode": "Clear-Title",
        "transactionId": "7832143",
        "productTransactionId": "",
        "orderNumber": 2429888,
        "productCode": "PRLM",
        "comment": "Clear to close.",
        "commentDate": "2022-07-11T02:03:40",
        "titleGrade": "A"
    },
    "transactionExtensions": {
        "transactionExtension": [
            {
                "key": "Client Specific Key 1",
                "value": "Client Specific Value 1"
            },
            {
                "key": "Client Specific Key 2",
                "value": "Client Specific Value 2"
            }
        ]
    }
}
/* Copyright © 2023 Mortgage Connect LP */

<!-- Copyright © 2023 Mortgage Connect LP -->
<root>
    <transactionHeader>
        <transactionIdempotentId>3B34A671-BB17-400D-90BF-7CBF9C96E8ED</transactionIdempotentId>
        <transactionDate>022-07-11T02:03:40</transactionDate>
        <clientCode>1799</clientCode>
        <clientName>AcmeInc</clientName>
        <vendorCode>MC</vendorCode>
        <vendorName>Mortgage Connect</vendorName>
    </transactionHeader>
    <transactionBody>
        <transactionCode>Clear-Title</transactionCode>
        <transactionId>7832143</transactionId>
        <productTransactionId></productTransactionId>
        <orderNumber>2429888</orderNumber>
        <productCode>PRLM</productCode>
        <comment>Clear to close.</comment>
        <commentDate>2022-07-11T02:03:40</commentDate>
        <titleGrade>A</titleGrade>
    </transactionBody>
    <transactionExtensions>
        <transactionExtension>
            <key>Client Specific Key 1</key>
            <value>Client Specific Value 1</value>
        </transactionExtension>
        <transactionExtension>
            <key>Client Specific Key 2</key>
            <value>Client Specific Value 1</value>
        </transactionExtension>
    </transactionExtensions>
</root>
<!-- Copyright © 2023 Mortgage Connect LP -->

👍 The request payload can be verified using the following validation schema.

/* Copyright © 2023 Mortgage Connect LP */
{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "$id": "root",
  "description": "Copyright @ 2023 Mortgage Connect LP - Title & Tax Schema.",
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "legalHeader": {
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "version": {
          "examples": [
            "1.0.8.0"
          ],
          "type": "string",
          "minLength": 1,
          "maxLength": 20
        },
        "disclosingParty": {
          "examples": [
            "Copyright @ 2023 Mortgage Connect LP"
          ],
          "type": "string",
          "minLength": 1,
          "maxLength": 100
        },
        "proprietaryInformationAndConfidential": {
          "examples": [
            "Ownership of Proprietary Information. The Recipient agrees that it shall not receive any right, title or interest, or any license or right to use, the Disclosing Partys Proprietary Information, including, but not limited to, technology, ideas, concepts, drawings, documentation, designs, prototypes, processes, trade secrets, trademarks or other intellectual property rights therein, by implication or otherwise."
          ],
          "type": "string",
          "minLength": 1,
          "maxLength": 2000
        }
      },
      "required": [
        "version",
        "disclosingParty",
        "proprietaryInformationAndConfidential"
      ],
      "minProperties": 3,
      "maxProperties": 3
    },
    "transactionHeader": {
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "transactionIdempotentId": {
          "examples": [
            "3B34A671-BB17-400D-90BF-7CBF9C96E8ED"
          ],
          "type": "string",
          "minLength": 36,
          "maxLength": 36,
          "pattern": "^[\\da-fA-F]{8}-[\\da-fA-F]{4}-[\\da-fA-F]{4}-[\\da-fA-F]{4}-[\\da-fA-F]{12}$"
        },
        "transactionDate": {
          "examples": [
            "2022-07-11T02:03:40"
          ],
          "type": "string",
          "format": "date-time"
        },
        "clientCode": {
          "examples": [
            "1799"
          ],
          "type": "string",
          "minLength": 1,
          "maxLength": 100,
          "format": "integer"
        },
        "clientName": {
          "examples": [
            "AcmeInc"
          ],
          "type": "string",
          "minLength": 1,
          "maxLength": 100
        },
        "vendorCode": {
          "examples": [
            "MC"
          ],
          "type": "string",
          "minLength": 1,
          "maxLength": 100
        },
        "vendorName": {
          "examples": [
            "Mortgage Connect"
          ],
          "type": "string",
          "minLength": 1,
          "maxLength": 100
        }
      },
      "required": [
        "transactionIdempotentId",
        "transactionDate",
        "clientCode",
        "clientName",
        "vendorCode",
        "vendorName"
      ],
      "minProperties": 6,
      "maxProperties": 6
    },
    "transactionBody": {
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "transactionCode": {
          "examples": [
            "Clear-Title"
          ],
          "type": "string",
          "const": "Clear-Title"
        },
        "transactionId": {
          "examples": [
            "7832143"
          ],
          "type": "string",
          "minLength": 1,
          "maxLength": 50
        },
        "productTransactionId": {
          "$ref": "root#/properties/transactionBody/properties/transactionId"
        },
        "orderNumber": {
          "examples": [
            "2429888"
          ],
          "type": "integer"
        },
        "productCode": {
          "type": "string",
          "minLength": 3,
          "maxLength": 4,
          "enum": [
            "PRLM",
            "PRLP",
            "TTLP",
            "TTLN"
          ]
        },
        "comment": {
          "example": [
            "Clear to close."
          ],
          "type": "string"
        },
        "commentDate": {
          "example": [
            "07-11-2022T14:00:00-4:00"
          ],
          "type": "string",
          "format": "date-time"
        },
        "titleGrade": {
          "example": [
            "A"
          ],
          "type": "string"
        }
      },
      "required": [
        "transactionCode",
        "transactionId",
        "orderNumber",
        "productCode",
        "comment",
        "commentDate"
      ]
    },
    "transactionExtensions": {
      "type": "object",
      "properties": {
        "transactionExtension": {
          "type": "array",
          "items": {
            "type": "object",
            "additionalProperties": false,
            "properties": {
              "key": {
                "examples": [
                  "Client Specific Key"
                ],
                "type": "string",
                "minLength": 1,
                "maxLength": 200
              },
              "value": {
                "examples": [
                  "Client Specific Value"
                ],
                "type": "string",
                "minLength": 1
              }
            },
            "required": [
              "key",
              "value"
            ],
            "minProperties": 2,
            "maxProperties": 2
          },
          "minItems": 0
        }
      }
    }
  },
  "required": [
    "transactionHeader",
    "transactionBody"
  ],
  "minProperties": 2,
  "maxProperties": 4
}
/* Copyright © 2023 Mortgage Connect LP */

<?xml version="1.0" encoding="utf-8"?>
<xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema">
  <xs:element name="root">
  <xs:complexType>
    <xs:sequence>
      <xs:element ref="legalHeader" minOccurs="0"/>
      <xs:element ref="transactionHeader"/>
      <xs:element name="transactionBody">
        <xs:complexType>
          <xs:all>
            <xs:element name="transactionCode" type="xs:string" fixed="Clear-Title"/>
            <xs:element ref="transactionId"/>
            <xs:element name="productTransactionId" type="transactionId" minOccurs="0"/>
            <xs:element name="orderNumber" type="orderNo"/>
            <xs:element ref="productCode"/>
            <xs:element name="comment" type="xs:string"/>
            <xs:element name="commentDate" type="xs:dateTime"/>
            <xs:element name="titleGrade" type="xs:string" minOccurs="0"/>
          </xs:all>
        </xs:complexType>
      </xs:element>
      <xs:element ref="transactionExtensions" minOccurs="0"/>
    </xs:sequence>
  </xs:complexType>
  </xs:element>
</xs:schema>

✅ The following is an 'Accepted' example payload to be returned in the HTTP response.

Accepted Acknowledgment payloads are typically message type agnostic.

Accepted Acknowledgment payloads are typically message type agnostic.

⛔ The following is a 'Rejected' example payload to be returned in the HTTP response.

Rejected Acknowledgment payloads are typically message type agnostic.

Rejected Acknowledgment payloads are typically message type agnostic.

The Clear Title API method is the mechanism in which Mortgage Connect can submit a message to the Client to deliver the Default Title Clearance Status and supporting metadata.

View Workflow Orchestration

Client URL

POST 🔒 To be determined during onboarding process.

Property Definitions - Transaction Header

Defines the properties represented in the Transaction Header object (JSON) or node (XML). Note that this message artifact is identical for each and every message type.

View Transaction Header Details

Property Definitions - Transaction Body

Defines the properties represented in the Transaction Body object (JSON) or node (XML).

Property	Requirement	Data Type	Min / Max	Description
transactionBody	Required			A parent object (JSON) or node (XML) that contains the transaction metadata.
transactionCode	Required	String	11 / 11	A static value of `Clear-Title`. The transaction code is meant to identify the message type and the context or action that should be taken. In this context it implies that the default title is cleared and you can proceed to close. Possible Values: Clear-Title
transactionId	Required	String	1 / 50	Represents the Client's unique order number.
productTransactionId	Optional	String	0 / 50	Represents the Client's unique product order number. Note that the `productTransactionId` field is not used in most circumstances. However, when there is a need to further differentiate order numbers at a product level, that share the same `transactionId`, (i.e. the primary order level id), then the `productTransactionId` can be used to ensure uniqueness across the integration transactions. This makes it possible for multiple orders of the same product type to be placed using the same `transactionId`. The use of the `productTransactionId` field and any specific workflow deviations will be vetted during the onboarding process.
orderNumber	Required	Integer		Represents Mortgage Connects unique order number.
productCode	Required	String	3 / 4	Represents Mortgage Connect's product code. Possible Values: PRLM `Property Report Loan Mod` TSG `Trustee Sale Guarantee` PFCF `Pre-Foreclosure Report` PJR `Preliminary Judicial Report` etc. Traditionally, clients use Mortgage Connects `Product Code` names and thus there is a one to one mapping relationship that is maintained by the client. However, Mortgage Connect is aware that our naming conventions may not resonate and that there are many inconsistencies in product code naming conventions and nomenclatures. It is for this reason that Mortgage Connect is able to map the client's product code to Mortgage Connect's product code to ease the transition. Any required product code mapping exercises will be addressed during the onboarding process. The supported `productCode`(s) are specific per integration and will be determined during the onboarding process. Note that the minimum/maximum length requirement of 3/4 is only applicable if using Mortgage Connect's internal product codes, otherwise when mapping to the client's product codes, the minimum/maximum is 1/50.
comment	Required	String	1 / MAX	A general comment indicating that the default title order is cleared.
commentDate	Required	DateTime		The date when the default title order was cleared.
titleGrade	Optional	String	32	The grade assigned to the title.

Property Definitions - Transaction Extensions

Defines the properties represented in the TransactionExtensions object (JSON) or node (XML). Note that this message artifact is identical for each and every message type.

View Transaction Extension Details

Default Title - MC175 - Recording Data

🌐 The following is an example payload to be posted in the body of the HTTP request.

/* Copyright © 2024 Mortgage Connect LP */
{
  "transactionHeader": {
    "transactionIdempotentId": "3B34A671-BB17-400D-90BF-7CBF9C96E8ED",
    "transactionDate": "2022-07-11T02:03:40",
    "clientCode": "1799",
    "clientName": "AcmeInc",
    "vendorCode": "MC",
    "vendorName": "Mortgage Connect"
  },
  "transactionBody": {
    "transactionCode": "Recording-Data",
    "transactionId": "7832143",
    "productTransactionId": "",
    "orderNumber": 2429888,
    "productCode": "TSG",
    "clientOrderNumber": "20241111-TSG-1234",
    "recordings": {
      "recording": [
        {
          "recordingID": "3276851-55277",
          "sequenceNo": 1,
          "entryType": "Modification",
          "recordedDate": "2024-11-08",
          "instrument": "0742873782",
          "book": "640",
          "page": "36",
          "recordingFee": "97.0000"
        },
        {
          "recordingID": "3276851-55278",
          "sequenceNo": 2,
          "entryType": "DEED OF TRUST",
          "recordedDate": "2024-11-08",
          "instrument": "0730651307",
          "book": "567",
          "page": "85",
          "recordingFee": "43.0000"
        }
      ]
    }
  },
  "transactionExtensions": {
    "transactionExtension": [
      {
        "key": "Client Specific Key 1",
        "value": "Client Specific Value 1"
      },
      {
        "key": "Client Specific Key 2",
        "value": "Client Specific Value 2"
      }
    ]
  }
}
/* Copyright © 2024 Mortgage Connect LP */

<!-- Copyright © 2024 Mortgage Connect LP -->
<root>
    <transactionHeader>
        <transactionIdempotentId>3B34A671-BB17-400D-90BF-7CBF9C96E8ED</transactionIdempotentId>
        <transactionDate>022-07-11T02:03:40</transactionDate>
        <clientCode>1799</clientCode>
        <clientName>AcmeInc</clientName>
        <vendorCode>MC</vendorCode>
        <vendorName>Mortgage Connect</vendorName>
    </transactionHeader>
    <transactionBody>
        <transactionCode>Recording-Data</transactionCode>
        <transactionId>7832143</transactionId>
        <productTransactionId></productTransactionId>
        <orderNumber>2429888</orderNumber>
        <productCode>TSG</productCode>
        <clientOrderNumber>20241111-TSG-1234</clientOrderNumber>
        <recordings>
            <recording>
            <recordingID>3276851-55277<recordingID>
            <sequenceNo>1</sequenceNo>
            <entryType>Modification</entryType>
            <recordedDate>2024-11-08</recordedDate>
            <instrument>0742873782</instrument>
            <book>640</book>
            <page>36</page>
            <recordingFee>97.0000</recordingFee>
            </recording>
            <recording>
            <recordingID>3276851-55278<recordingID>
            <sequenceNo>2</sequenceNo>
            <entryType>DEED OF TRUST</entryType>
            <recordedDate>2024-11-08</recordedDate>
            <instrument>0730651307</instrument>
            <book>567</book>
            <page>85</page>
            <recordingFee>43.0000</recordingFee>
            </recording>
        </recordings>
    </transactionBody>
    <transactionExtensions>
        <transactionExtension>
            <key>Client Specific Key 1</key>
            <value>Client Specific Value 1</value>
        </transactionExtension>
        <transactionExtension>
            <key>Client Specific Key 2</key>
            <value>Client Specific Value 1</value>
        </transactionExtension>
    </transactionExtensions>
</root>
<!-- Copyright © 2024 Mortgage Connect LP -->

👍 The request payload can be verified using the following validation schema.

/* Copyright © 2023 Mortgage Connect LP */
{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "$id": "root",
  "description": "Copyright @ 2022 Mortgage Connect LP",
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "legalHeader": {
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "version": {
          "examples": [
            "1.0.8.0"
          ],
          "type": "string",
          "minLength": 1,
          "maxLength": 20
        },
        "disclosingParty": {
          "examples": [
            "Copyright @ 2022 Mortgage Connect LP"
          ],
          "type": "string",
          "minLength": 1,
          "maxLength": 100
        },
        "proprietaryInformationAndConfidential": {
          "examples": [
            "Ownership of Proprietary Information. The Recipient agrees that it shall not receive any right, title or interest, or any license or right to use, the Disclosing Partys Proprietary Information, including, but not limited to, technology, ideas, concepts, drawings, documentation, designs, prototypes, processes, trade secrets, trademarks or other intellectual property rights therein, by implication or otherwise."
          ],
          "type": "string",
          "minLength": 1,
          "maxLength": 2000
        }
      },
      "required": [
        "version",
        "disclosingParty",
        "proprietaryInformationAndConfidential"
      ],
      "minProperties": 3,
      "maxProperties": 3
    },
    "transactionHeader": {
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "transactionIdempotentId": {
          "examples": [
            "3B34A671-BB17-400D-90BF-7CBF9C96E8ED"
          ],
          "type": "string",
          "minLength": 36,
          "maxLength": 36,
          "pattern": "^[\\da-fA-F]{8}-[\\da-fA-F]{4}-[\\da-fA-F]{4}-[\\da-fA-F]{4}-[\\da-fA-F]{12}$"
        },
        "transactionDate": {
          "examples": [
            "2022-07-11T02:03:40"
          ],
          "type": "string",
          "format": "date-time"
        },
        "clientCode": {
          "examples": [
            "1799"
          ],
          "type": "string",
          "minLength": 1,
          "maxLength": 100,
          "format": "integer"
        },
        "clientName": {
          "examples": [
            "AcmeInc"
          ],
          "type": "string",
          "minLength": 1,
          "maxLength": 100
        },
        "vendorCode": {
          "examples": [
            "MC"
          ],
          "type": "string",
          "minLength": 1,
          "maxLength": 100
        },
        "vendorName": {
          "examples": [
            "Mortgage Connect"
          ],
          "type": "string",
          "minLength": 1,
          "maxLength": 100
        }
      },
      "required": [
        "transactionIdempotentId",
        "transactionDate",
        "clientCode",
        "clientName",
        "vendorCode",
        "vendorName"
      ],
      "minProperties": 6,
      "maxProperties": 6
    },
    "transactionBody": {
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "transactionCode": {
          "examples": [
            "Recording-Data"
          ],
          "type": "string",
          "const": "Recording-Data"
        },
        "transactionId": {
          "examples": [
            "7832143"
          ],
          "type": "string",
          "minLength": 1,
          "maxLength": 50
        },
        "productTransactionId": {
          "examples": [
            "7832143"
          ],
          "type": "string",
          "minLength": 0,
          "maxLength": 50
        },
        "orderNumber": {
          "examples": [
            "2429888"
          ],
          "type": "integer"
        },
        "productCode": {
          "type": "string",
          "minLength": 3,
          "maxLength": 4,
          "enum": [
            "PRLM",
            "PRLP",
            "TTLP",
            "TTLN"
          ]
        },
        "clientOrderNumber": {
          "type": "string",
          "maxLength": 64
        },
        "recordings": {
          "type": "object",
          "properties": {
            "recording": {
            "type": "array",
            "items": {
              "recordingID": {
                "type": "string",
                "maxLength": 50
              },
              "sequenceNo": {
                "type": "integer"
              },
              "entryType": {
                "type": "string",
                "maxLength": 255
              },
              "recordedDate": {
                "type": "string",
                "format": "date",
                "examples": [ "05-10-2022" ]
              },
              "instrument": {
                "type": "string",
                "format": "date",
                "examples": [ "05-10-2022" ]
              },
              "book": {
                "type": "string",
                "maxLength": 32,
                "examples": [ "11" ]
              },
              "page": {
                "type": "string",
                "maxLength": 32,
                "examples": [ "12" ]
              },
              "recordingFee": {
                "type": "string",
                "format": "money",
                "examples": [ "0.00" ]
              }
            },
            "minItems": 1
            }
          }
        }
      },
      "required": [
        "transactionCode",
        "transactionId",
        "orderNumber",
        "productCode"
      ]
    },
    "transactionExtensions": {
      "type": "object",
      "properties": {
        "transactionExtension": {
          "type": "array",
          "items": {
            "type": "object",
            "additionalProperties": false,
            "properties": {
              "key": {
                "examples": [
                  "Client Specific Key"
                ],
                "type": "string",
                "minLength": 1,
                "maxLength": 200
              },
              "value": {
                "examples": [
                  "Client Specific Value"
                ],
                "type": "string",
                "minLength": 1
              }
            },
            "required": [
              "key",
              "value"
            ],
            "minProperties": 2,
            "maxProperties": 2
          },
          "minItems": 0
        }
      }
    }
  },
  "required": [
    "transactionHeader",
    "transactionBody"
  ],
  "minProperties": 2,
  "maxProperties": 4
}
/* Copyright © 2024 Mortgage Connect LP */

<?xml version="1.0" encoding="utf-8"?>
<xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema">
  <xs:element name="root">
    <xs:complexType>
      <xs:sequence>
        <xs:element ref="legalHeader" minOccurs="0"/>
        <xs:element ref="transactionHeader"/>
        <xs:element name="transactionBody">
          <xs:complexType>
            <xs:all>
              <xs:element name="transactionCode" type="xs:string" fixed="Recording-Data"/>
              <xs:element ref="transactionId"/>
              <xs:element name="productTransactionId" type="transactionId" minOccurs="0"/>
              <xs:element name="orderNumber" type="orderNo"/>
              <xs:element ref="productCode"/>
              <xs:element name="clientOrderNumber" minOccurs="0">
                <xs:simpleType>
                  <xs:restriction base="xs:string">
                    <xs:maxLength value="64"/>
                  </xs:restriction>
                </xs:simpleType>
              </xs:element>
              <xs:element name="recordings" minOccurs="0">
                <xs:complexType>
                  <xs:sequence>
                    <xs:element name="recording" minOccurs="1" maxOccurs="unbounded">
                      <xs:complexType>
                        <xs:all>
                          <xs:element name="recordingID" minOccurs="0">
                            <xs:simpleType>
                              <xs:restriction base="xs:string">
                                <xs:maxLength value="50"/>
                              </xs:restriction>
                            </xs:simpleType>
                          </xs:element>
                          <xs:element name="sequenceNo" type="xs:integer" minOccurs="0"/>
                          <xs:element name="entryType" minOccurs="0">
                            <xs:simpleType>
                              <xs:restriction base="xs:string">
                                <xs:maxLength value="255"/>
                              </xs:restriction>
                            </xs:simpleType>
                          </xs:element>
                          <xs:element name="recordedDate" type="xs:date" minOccurs="0"/>
                          <xs:element name="instrument" type="instrument" minOccurs="0"/>
                          <xs:element name="book" type="book" minOccurs="0"/>
                          <xs:element name="page" type="page" minOccurs="0"/>
                          <xs:element name="recordingFee" type="money" minOccurs="0"/>
                        </xs:all>
                      </xs:complexType>
                    </xs:element>
                  </xs:sequence>
                </xs:complexType>
              </xs:element>
            </xs:all>
          </xs:complexType>
        </xs:element>
        <xs:element ref="transactionExtensions" minOccurs="0"/>
      </xs:sequence>
    </xs:complexType>
  </xs:element>
</xs:schema>

✅ The following is an 'Accepted' example payload to be returned in the HTTP response.

Accepted Acknowledgment payloads are typically message type agnostic.

Accepted Acknowledgment payloads are typically message type agnostic.

⛔ The following is a 'Rejected' example payload to be returned in the HTTP response.

Rejected Acknowledgment payloads are typically message type agnostic.

Rejected Acknowledgment payloads are typically message type agnostic.

The Recording Data API method is the mechanism in which Mortgage Connect can provide to the client, a list of recording data for the Default Title Order.

View Workflow Orchestration

Client URL

POST 🔒 To be determined during onboarding process.

Mortgage Connect URL

POST 🔒 https://{BaseUrl}/Api/V1.0/{ClientCode}/SubmitMessage

Mortgage Connect URL Properties

Property	Requirement	Description
BaseUrl	Required	A unique base Url that represents a specific Mortgage Connect endpoint and targeted environment.
ClientCode	Required	A unique code assigned to all clients that is used for identification, authentication, and customization purposes.

Property Definitions - Transaction Header

Defines the properties represented in the Transaction Header object (JSON) or node (XML). Note that this message artifact is identical for each and every message type.

View Transaction Header Details

Property Definitions - Transaction Body

Property	Requirement	Data Type	Min / Max	Description
transactionBody	Required			A parent object (JSON) or node (XML) that contains the transaction metadata.
transactionCode	Required	String	14 / 14	A static value of `Recording-Data`. The transaction code is meant to identify the message type and the context or action that should be taken. In this context it implies that a list recording data and all supporting metadata are to be delivered to the client. Possible Values: Recording-Data
transactionId	Required	String	1 / 50	Represents the Client's unique order number.
productTransactionId	Optional	String	0 / 50	Represents the Client's unique product order number. Note that the `productTransactionId` field is not used in most circumstances. However, when there is a need to further differentiate order numbers at a product level, that share the same `transactionId`, (i.e. the primary order level id), then the `productTransactionId` can be used to ensure uniqueness across the integration transactions. This makes it possible for multiple orders of the same product type to be placed using the same `transactionId`. The use of the `productTransactionId` field and any specific workflow deviations will be vetted during the onboarding process.
orderNumber	Required	Integer		Represents Mortgage Connects unique order number.
productCode	Required	String	3 / 4	Represents Mortgage Connect's product code. Possible Values: PRLM `Property Report Loan Mod` TSG `Trustee Sale Guarantee` PFCF `Pre-Foreclosure Report` PJR `Preliminary Judicial Report` etc. Traditionally, clients use Mortgage Connects `Product Code` names and thus there is a one to one mapping relationship that is maintained by the client. However, Mortgage Connect is aware that our naming conventions may not resonate and that there are many inconsistencies in product code naming conventions and nomenclatures. It is for this reason that Mortgage Connect is able to map the client's product code to Mortgage Connect's product code to ease the transition. Any required product code mapping exercises will be addressed during the onboarding process. The supported `productCode`(s) are specific per integration and will be determined during the onboarding process. Note that the minimum/maximum length requirement of 3/4 is only applicable if using Mortgage Connect's internal product codes, otherwise when mapping to the client's product codes, the minimum/maximum is 1/50.
clientOrderNumber	Optional	String	0 / 64	Alternate Client identifier.
recordings	Optional	Array	1 / MAX	An array of recording data items.
recording	Optional			A parent object (JSON) or node (XML) that contains metadata associated with recording data.
recordingID	Optional	String	0 / 50	A value that uniquely identifies the recording item within the Mortgage Connect system.
sequenceNo	Optional	Integer		A system assigned value used for sorting and display.
entryType	Optional	String	0 / 255	Identifies the type of document that was recorded.
recordedDate	Optional	DateTime		The recorded document recorded date.
instrument	Optional	String	0 / 32	The recorded document instrument number.
book	Optional	String	0 / 32	The recorded document book.
page	Optional	String	0 / 32	The recorded document page.
recordingFee	Optional	Money	1 / 100	The amount associated with a fee.

Property Definitions - Transaction Extensions

Defines the properties represented in the TransactionExtensions object (JSON) or node (XML). Note that this message artifact is identical for each and every message type.

View Transaction Extension Details

Default Title - MC180 - Order Complete

🌐 The following is an example payload to be posted in the body of the HTTP request.

/* Copyright © 2023 Mortgage Connect LP */
{
    "transactionHeader": {
        "transactionIdempotentId": "3B34A671-BB17-400D-90BF-7CBF9C96E8ED",
        "transactionDate": "2022-07-11T02:03:40",
        "clientCode": "1799",
        "clientName": "AcmeInc",
        "vendorCode": "MC",
        "vendorName": "Mortgage Connect"
    },
    "transactionBody": {
        "transactionCode": "Order-Complete",
        "transactionId": "7832143",
        "productTransactionId": "",
        "orderNumber": 2429888,
        "productCode": "PRLM",
        "comment": "The order is complete.",
        "commentDate": "2022-07-11T02:03:40"
    },
    "transactionExtensions": {
        "transactionExtension": [
            {
                "key": "Client Specific Key 1",
                "value": "Client Specific Value 1"
            },
            {
                "key": "Client Specific Key 2",
                "value": "Client Specific Value 2"
            }
        ]
    }
}
/* Copyright © 2023 Mortgage Connect LP */

<!-- Copyright © 2023 Mortgage Connect LP -->
<root>
    <transactionHeader>
        <transactionIdempotentId>3B34A671-BB17-400D-90BF-7CBF9C96E8ED</transactionIdempotentId>
        <transactionDate>022-07-11T02:03:40</transactionDate>
        <clientCode>1799</clientCode>
        <clientName>AcmeInc</clientName>
        <vendorCode>MC</vendorCode>
        <vendorName>Mortgage Connect</vendorName>
    </transactionHeader>
    <transactionBody>
        <transactionCode>Order-Complete</transactionCode>
        <transactionId>7832143</transactionId>
        <productTransactionId></productTransactionId>
        <orderNumber>2429888</orderNumber>
        <productCode>PRLM</productCode>
        <comment>The order is complete.</comment>
        <commentDate>2022-07-11T02:03:40</commentDate>
    </transactionBody>
    <transactionExtensions>
        <transactionExtension>
            <key>Client Specific Key 1</key>
            <value>Client Specific Value 1</value>
        </transactionExtension>
        <transactionExtension>
            <key>Client Specific Key 2</key>
            <value>Client Specific Value 1</value>
        </transactionExtension>
    </transactionExtensions>
</root>
<!-- Copyright © 2023 Mortgage Connect LP -->

👍 The request payload can be verified using the following validation schema.

/* Copyright © 2023 Mortgage Connect LP */
{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "$id": "root",
  "description": "Copyright @ 2022 Mortgage Connect LP - Title & Tax Schema.",
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "legalHeader": {
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "version": {
          "examples": [
            "1.0.8.0"
          ],
          "type": "string",
          "minLength": 1,
          "maxLength": 20
        },
        "disclosingParty": {
          "examples": [
            "Copyright @ 2022 Mortgage Connect LP"
          ],
          "type": "string",
          "minLength": 1,
          "maxLength": 100
        },
        "proprietaryInformationAndConfidential": {
          "examples": [
            "Ownership of Proprietary Information. The Recipient agrees that it shall not receive any right, title or interest, or any license or right to use, the Disclosing Partys Proprietary Information, including, but not limited to, technology, ideas, concepts, drawings, documentation, designs, prototypes, processes, trade secrets, trademarks or other intellectual property rights therein, by implication or otherwise."
          ],
          "type": "string",
          "minLength": 1,
          "maxLength": 2000
        }
      },
      "required": [
        "version",
        "disclosingParty",
        "proprietaryInformationAndConfidential"
      ],
      "minProperties": 3,
      "maxProperties": 3
    },
    "transactionHeader": {
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "transactionIdempotentId": {
          "examples": [
            "3B34A671-BB17-400D-90BF-7CBF9C96E8ED"
          ],
          "type": "string",
          "minLength": 36,
          "maxLength": 36,
          "pattern": "^[\\da-fA-F]{8}-[\\da-fA-F]{4}-[\\da-fA-F]{4}-[\\da-fA-F]{4}-[\\da-fA-F]{12}$"
        },
        "transactionDate": {
          "examples": [
            "2022-07-11T02:03:40"
          ],
          "type": "string",
          "format": "date-time"
        },
        "clientCode": {
          "examples": [
            "1799"
          ],
          "type": "string",
          "minLength": 1,
          "maxLength": 100,
          "format": "integer"
        },
        "clientName": {
          "examples": [
            "AcmeInc"
          ],
          "type": "string",
          "minLength": 1,
          "maxLength": 100
        },
        "vendorCode": {
          "examples": [
            "MC"
          ],
          "type": "string",
          "minLength": 1,
          "maxLength": 100
        },
        "vendorName": {
          "examples": [
            "Mortgage Connect"
          ],
          "type": "string",
          "minLength": 1,
          "maxLength": 100
        }
      },
      "required": [
        "transactionIdempotentId",
        "transactionDate",
        "clientCode",
        "clientName",
        "vendorCode",
        "vendorName"
      ],
      "minProperties": 6,
      "maxProperties": 6
    },
    "transactionBody": {
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "transactionCode": {
          "examples": [
            "Order-Complete"
          ],
          "type": "string",
          "const": "Order-Complete"
        },
        "transactionId": {
          "examples": [
            "7832143"
          ],
          "type": "string",
          "minLength": 1,
          "maxLength": 50
        },
        "productTransactionId": {
          "examples": [
            "7832143"
          ],
          "type": "string",
          "minLength": 0,
          "maxLength": 50
        },
        "orderNumber": {
          "examples": [
            "2429888"
          ],
          "type": "integer"
        },
        "productCode": {
          "type": "string",
          "minLength": 3,
          "maxLength": 4,
          "enum": [
            "PRLM",
            "PRLP",
            "TTLP",
            "TTLN"
          ]
        },
        "comment": {
          "example": [
            "Clear to close."
          ],
          "type": "string"
        },
        "commentDate": {
          "example": [
            "07-11-2022T14:00:00-4:00"
          ],
          "type": "string",
          "format": "date-time"
        }
      },
      "required": [
        "transactionCode",
        "transactionId",
        "orderNumber",
        "productCode",
        "comment",
        "commentDate"
      ]
    },
    "transactionExtensions": {
      "type": "object",
      "properties": {
        "transactionExtension": {
          "type": "array",
          "items": {
            "type": "object",
            "additionalProperties": false,
            "properties": {
              "key": {
                "examples": [
                  "Client Specific Key"
                ],
                "type": "string",
                "minLength": 1,
                "maxLength": 200
              },
              "value": {
                "examples": [
                  "Client Specific Value"
                ],
                "type": "string",
                "minLength": 1
              }
            },
            "required": [
              "key",
              "value"
            ],
            "minProperties": 2,
            "maxProperties": 2
          },
          "minItems": 0
        }
      }
    }
  },
  "required": [
    "transactionHeader",
    "transactionBody"
  ],
  "minProperties": 2,
  "maxProperties": 4
}
/* Copyright © 2023 Mortgage Connect LP */

<?xml version="1.0" encoding="utf-8"?>
<xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema">
  <xs:element name="root">
  <xs:complexType>
    <xs:sequence>
      <xs:element ref="legalHeader" minOccurs="0"/>
      <xs:element ref="transactionHeader"/>
      <xs:element name="transactionBody">
        <xs:complexType>
          <xs:all>
            <xs:element name="transactionCode" type="xs:string" fixed="Order-Complete"/>
            <xs:element ref="transactionId"/>
            <xs:element name="productTransactionId" type="transactionId" minOccurs="0"/>
            <xs:element name="orderNumber" type="orderNo"/>
            <xs:element ref="productCode"/>
            <xs:element name="comment" type="xs:string"/>
            <xs:element name="commentDate" type="xs:dateTime"/>
          </xs:all>
        </xs:complexType>
      </xs:element>
      <xs:element ref="transactionExtensions" minOccurs="0"/>
    </xs:sequence>
  </xs:complexType>
  </xs:element>
</xs:schema>

✅ The following is an 'Accepted' example payload to be returned in the HTTP response.

Accepted Acknowledgment payloads are typically message type agnostic.

Accepted Acknowledgment payloads are typically message type agnostic.

⛔ The following is a 'Rejected' example payload to be returned in the HTTP response.

Rejected Acknowledgment payloads are typically message type agnostic.

Rejected Acknowledgment payloads are typically message type agnostic.

The Order Complete API method is the mechanism in which Mortgage Connect can submit a message to the Client to indicate that the Default Title order is complete.

View Workflow Orchestration

Client URL

POST 🔒 To be determined during onboarding process.

Property Definitions - Transaction Header

Defines the properties represented in the Transaction Header object (JSON) or node (XML). Note that this message artifact is identical for each and every message type.

View Transaction Header Details

Property Definitions - Transaction Body

Defines the properties represented in the Transaction Body object (JSON) or node (XML).

Property	Requirement	Data Type	Min / Max	Description
transactionBody	Required			A parent object (JSON) or node (XML) that contains the transaction metadata.
transactionCode	Required	String	14 / 14	A static value of `Order-Complete`. The transaction code is meant to identify the message type and the context or action that should be taken. In this context it implies that a order has been completed. Possible Values: Order-Complete
transactionId	Required	String	1 / 50	Represents the Client's unique order number.
productTransactionId	Optional	String	0 / 50	Represents the Client's unique product order number. Note that the `productTransactionId` field is not used in most circumstances. However, when there is a need to further differentiate order numbers at a product level, that share the same `transactionId`, (i.e. the primary order level id), then the `productTransactionId` can be used to ensure uniqueness across the integration transactions. This makes it possible for multiple orders of the same product type to be placed using the same `transactionId`. The use of the `productTransactionId` field and any specific workflow deviations will be vetted during the onboarding process.
orderNumber	Required	Integer		Represents Mortgage Connects unique order number.
productCode	Required	String	3 / 4	Represents Mortgage Connect's product code. Possible Values: PRLM `Property Report Loan Mod` TSG `Trustee Sale Guarantee` PFCF `Pre-Foreclosure Report` PJR `Preliminary Judicial Report` etc. Traditionally, clients use Mortgage Connects `Product Code` names and thus there is a one to one mapping relationship that is maintained by the client. However, Mortgage Connect is aware that our naming conventions may not resonate and that there are many inconsistencies in product code naming conventions and nomenclatures. It is for this reason that Mortgage Connect is able to map the client's product code to Mortgage Connect's product code to ease the transition. Any required product code mapping exercises will be addressed during the onboarding process. The supported `productCode`(s) are specific per integration and will be determined during the onboarding process. Note that the minimum/maximum length requirement of 3/4 is only applicable if using Mortgage Connect's internal product codes, otherwise when mapping to the client's product codes, the minimum/maximum is 1/50.
comment	Required	String	1 / MAX	A general comment indicating that the order is complete.
commentDate	Required	DateTime		The date when the order was completed.

Property Definitions - Transaction Extensions

Defines the properties represented in the TransactionExtensions object (JSON) or node (XML). Note that this message artifact is identical for each and every message type.

View Transaction Extension Details

Default Title - MC190 - Title Policy

🌐 The following is an example payload to be posted in the body of the HTTP request.

/* Copyright © 2023 Mortgage Connect LP */
{
    "transactionHeader": {
        "transactionIdempotentId": "3B34A671-BB17-400D-90BF-7CBF9C96E8ED",
        "transactionDate": "2022-07-11T02:03:40",
        "clientCode": "1799",
        "clientName": "AcmeInc",
        "vendorCode": "MC",
        "vendorName": "Mortgage Connect"
    },
    "transactionBody": {
        "transactionCode": "Title-Policy",
        "transactionId": "7832143",
        "productTransactionId": "",
        "orderNumber": 2429888,
        "productCode": "PRLM",
        "comment": "Title policy completed.",
        "commentDate": "2022-07-11T02:03:40",
        "policyNumber": "73194-34",
        "policyDate": "2022-07-11T02:03:40",
        "documents": {
            "document": [
                {
                    "documentId": "1388109",
                    "type": "Final Title Policy",
                    "name": "final-title-policy.pdf",
                    "fileType": "PDF",
                    "contentMediaType": "application/pdf",
                    "contentUnicodeTextEncodingType": "UTF8",
                    "contentBinaryEncodingType": "Base64",
                    "content": "Base64 String",
                    "description": "Brief overview of the document"
                }
            ]
        }
    },
    "transactionExtensions": {
        "transactionExtension": [
            {
                "key": "Client Specific Key 1",
                "value": "Client Specific Value 1"
            },
            {
                "key": "Client Specific Key 2",
                "value": "Client Specific Value 2"
            }
        ]
    }
}
/* Copyright © 2023 Mortgage Connect LP */

<!-- Copyright © 2023 Mortgage Connect LP -->
<root>
    <transactionHeader>
        <transactionIdempotentId>3B34A671-BB17-400D-90BF-7CBF9C96E8ED</transactionIdempotentId>
        <transactionDate>022-07-11T02:03:40</transactionDate>
        <clientCode>1799</clientCode>
        <clientName>AcmeInc</clientName>
        <vendorCode>MC</vendorCode>
        <vendorName>Mortgage Connect</vendorName>
    </transactionHeader>
    <transactionBody>
        <transactionCode>Title-Policy</transactionCode>
        <transactionId>7832143</transactionId>
        <productTransactionId></productTransactionId>
        <orderNumber>2429888</orderNumber>
        <productCode>PRLM</productCode>
        <comment>Title policy completed.</comment>
        <commentDate>2022-07-11T02:03:40</commentDate>
        <policyNumber>73194-34</policyNumber>
        <policyDate>2022-07-11T02:03:40</policyDate>
        <documents>
            <document>
                <documentId>1388109</documentId>
                <type>Final Title Policy</type>
                <name>final-title-policy.pdf</name>
                <fileType>PDF</fileType>
                <contentMediaType>application/pdf</contentMediaType>
                <contentUnicodeTextEncodingType>UTF8</contentUnicodeTextEncodingType>
                <contentBinaryEncodingType>Base64</contentBinaryEncodingType>
                <content>Base64 String</content>
                <description>Brief overview of the document</description>
            </document>
        </documents>
    </transactionBody>
    <transactionExtensions>
        <transactionExtension>
            <key>Client Specific Key 1</key>
            <value>Client Specific Value 1</value>
        </transactionExtension>
        <transactionExtension>
            <key>Client Specific Key 2</key>
            <value>Client Specific Value 1</value>
        </transactionExtension>
    </transactionExtensions>
</root>
<!-- Copyright © 2023 Mortgage Connect LP -->

👍 The request payload can be verified using the following validation schema.

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "$id": "root",
  "description": "Copyright @ 2022 Mortgage Connect LP - Title & Tax Schema.",
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "legalHeader": {
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "version": {
          "examples": [
            "1.0.8.0"
          ],
          "type": "string",
          "minLength": 1,
          "maxLength": 20
        },
        "disclosingParty": {
          "examples": [
            "Copyright @ 2022 Mortgage Connect LP"
          ],
          "type": "string",
          "minLength": 1,
          "maxLength": 100
        },
        "proprietaryInformationAndConfidential": {
          "examples": [
            "Ownership of Proprietary Information. The Recipient agrees that it shall not receive any right, title or interest, or any license or right to use, the Disclosing Partys Proprietary Information, including, but not limited to, technology, ideas, concepts, drawings, documentation, designs, prototypes, processes, trade secrets, trademarks or other intellectual property rights therein, by implication or otherwise."
          ],
          "type": "string",
          "minLength": 1,
          "maxLength": 2000
        }
      },
      "required": [
        "version",
        "disclosingParty",
        "proprietaryInformationAndConfidential"
      ],
      "minProperties": 3,
      "maxProperties": 3
    },
    "transactionHeader": {
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "transactionIdempotentId": {
          "examples": [
            "3B34A671-BB17-400D-90BF-7CBF9C96E8ED"
          ],
          "type": "string",
          "minLength": 36,
          "maxLength": 36,
          "pattern": "^[\\da-fA-F]{8}-[\\da-fA-F]{4}-[\\da-fA-F]{4}-[\\da-fA-F]{4}-[\\da-fA-F]{12}$"
        },
        "transactionDate": {
          "examples": [
            "2022-07-11T02:03:40"
          ],
          "type": "string",
          "format": "date-time"
        },
        "clientCode": {
          "examples": [
            "1799"
          ],
          "type": "string",
          "minLength": 1,
          "maxLength": 100,
          "format": "integer"
        },
        "clientName": {
          "examples": [
            "AcmeInc"
          ],
          "type": "string",
          "minLength": 1,
          "maxLength": 100
        },
        "vendorCode": {
          "examples": [
            "MC"
          ],
          "type": "string",
          "minLength": 1,
          "maxLength": 100
        },
        "vendorName": {
          "examples": [
            "Mortgage Connect"
          ],
          "type": "string",
          "minLength": 1,
          "maxLength": 100
        }
      },
      "required": [
        "transactionIdempotentId",
        "transactionDate",
        "clientCode",
        "clientName",
        "vendorCode",
        "vendorName"
      ],
      "minProperties": 6,
      "maxProperties": 6
    },
    "transactionBody": {
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "transactionCode": {
          "examples": [
            "Title-Policy"
          ],
          "type": "string",
          "const": "Title-Policy"
        },
        "transactionId": {
          "examples": [
            "7832143"
          ],
          "type": "string",
          "minLength": 1,
          "maxLength": 50
        },
        "productTransactionId": {
          "examples": [
            "7832143"
          ],
          "type": "string",
          "minLength": 0,
          "maxLength": 50
        },
        "orderNumber": {
          "examples": [
            "2429888"
          ],
          "type": "integer"
        },
        "productCode": {
          "type": "string",
          "minLength": 3,
          "maxLength": 4,
          "enum": [
            "PRLM",
            "PRLP",
            "TTLP",
            "TTLN"
          ]
        },
        "comment": {
          "example": [
            "Clear to close."
          ],
          "type": "string"
        },
        "commentDate": {
          "example": [
            "07-11-2022T14:00:00-4:00"
          ],
          "type": "string",
          "format": "date-time"
        },
        "policyNumber": {
          "example": [
            "73194-34"
          ],
          "type": "string",
          "maxLength": 100
        },
        "policyDate": {
          "example": [
            "07-11-2022T14:00:00-4:00"
          ],
          "type": "string",
          "format": "date-time"
        },
        "documents": {
          "type": "object",
          "properties": {
            "document": {
              "type": "array",
              "items": {
                "type": "object",
                "properties": {
                  "documentId": {
                    "examples": [
                      "1243992"
                    ],
                    "type": "string"
                  },
                  "type": {
                    "type": "string",
                    "minLength": 0,
                    "maxLength": 0,
                    "enum": [
                      "Other"
                    ]
                  },
                  "name": {
                    "examples": [
                      "patriot-search.pdf"
                    ],
                    "type": "string",
                    "maxLength": 100
                  },
                  "fileType": {
                    "type": "string",
                    "enum": [
                      "DOC",
                      "DOCX",
                      "PDF",
                      "doc",
                      "docx",
                      "pdf"
                    ]
                  },
                  "contentMediaType": {
                    "type": "string",
                    "enum": [
                      "application/msword",
                      "application/vnd.openxmlformats-officedocument.wordprocessingml.document",
                      "application/pdf"
                    ]
                  },
                  "contentUnicodeTextEncodingType": {
                    "type": "string",
                    "enum": [
                      "UTF8"
                    ]
                  },
                  "contentBinaryEncodingType": {
                    "type": "string",
                    "enum": [
                      "Base64"
                    ]
                  },
                  "content": {
                    "contentEncoding": "base64",
                    "type": "string"
                  },
                  "description": {
                    "type": "string",
                    "maxLength": 255
                  }
                },
                "required": [
                  "documentId",
                  "type",
                  "name",
                  "fileType",
                  "contentMediaType",
                  "contentUnicodeTextEncodingType",
                  "contentBinaryEncodingType",
                  "content"
                ],
                "allOf": [
                  {
                    "if": {
                      "properties": {
                        "fileType": {
                          "enum": [
                            "DOC",
                            "doc"
                          ]
                        }
                      }
                    },
                    "then": {
                      "properties": {
                        "contentMediaType": "application/msword"
                      }
                    }
                  },
                  {
                    "if": {
                      "properties": {
                        "fileType": {
                          "enum": [
                            "DOCX",
                            "docx"
                          ]
                        }
                      }
                    },
                    "then": {
                      "properties": {
                        "contentMediaType": "application/vnd.openxmlformats-officedocument.wordprocessingml.document"
                      }
                    }
                  },
                  {
                    "if": {
                      "properties": {
                        "fileType": {
                          "enum": [
                            "PDF",
                            "pdf"
                          ]
                        }
                      }
                    },
                    "then": {
                      "properties": {
                        "contentMediaType": "application/pdf"
                      }
                    }
                  }
                ]
              },
              "minItems": 1
            }
          }
        }
      },
      "required": [
        "transactionCode",
        "transactionId",
        "orderNumber",
        "productCode",
        "comment",
        "commentDate",
        "policyNumber",
        "policyDate",
        "documents"
      ]
    },
    "transactionExtensions": {
      "type": "object",
      "properties": {
        "transactionExtension": {
          "type": "array",
          "items": {
            "type": "object",
            "additionalProperties": false,
            "properties": {
              "key": {
                "examples": [
                  "Client Specific Key"
                ],
                "type": "string",
                "minLength": 1,
                "maxLength": 200
              },
              "value": {
                "examples": [
                  "Client Specific Value"
                ],
                "type": "string",
                "minLength": 1
              }
            },
            "required": [
              "key",
              "value"
            ],
            "minProperties": 2,
            "maxProperties": 2
          },
          "minItems": 0
        }
      }
    }
  },
  "required": [
    "transactionHeader",
    "transactionBody"
  ],
  "minProperties": 2,
  "maxProperties": 4
}

<?xml version="1.0" encoding="utf-8"?>
<xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema">
  <xs:element name="root">
  <xs:complexType>
    <xs:sequence>
      <xs:element ref="legalHeader" minOccurs="0"/>
      <xs:element ref="transactionHeader"/>
      <xs:element name="transactionBody">
        <xs:complexType>
          <xs:all>
            <xs:element name="transactionCode" type="xs:string" fixed="Title-Policy"/>
            <xs:element ref="transactionId"/>
            <xs:element name="productTransactionId" type="transactionId" minOccurs="0"/>
            <xs:element name="orderNumber" type="orderNo"/>
            <xs:element ref="productCode"/>
            <xs:element name="comment" type="xs:string"/>
            <xs:element name="commentDate" type="xs:dateTime"/>
            <xs:element name="policyNumber">
              <xs:simpleType>
                <xs:restriction base="xs:string">
                  <xs:minLength value="1"/>
                  <xs:maxLength value="100"/>
                </xs:restriction>
              </xs:simpleType>
            </xs:element>
            <xs:element name="policyDate" type="xs:dateTime"/>
            <xs:element name="documents">
              <xs:complexType>
                <xs:sequence>
                  <xs:element ref="document" minOccurs="1" maxOccurs="unbounded"/>
                </xs:sequence>
              </xs:complexType>
            </xs:element>
          </xs:all>
        </xs:complexType>
      </xs:element>
      <xs:element ref="transactionExtensions" minOccurs="0"/>
    </xs:sequence>
  </xs:complexType>
  </xs:element>
</xs:schema>

✅ The following is an 'Accepted' example payload to be returned in the HTTP response.

Accepted Acknowledgment payloads are typically message type agnostic.

Accepted Acknowledgment payloads are typically message type agnostic.

⛔ The following is a 'Rejected' example payload to be returned in the HTTP response.

Rejected Acknowledgment payloads are typically message type agnostic.

Rejected Acknowledgment payloads are typically message type agnostic.

The Title Policy API method is the mechanism in which Mortgage Connect can submit a message to the Client to deliver the Final Default Title Policy and supporting metadata.

View Workflow Orchestration

Client URL

POST 🔒 To be determined during onboarding process.

Property Definitions - Transaction Header

Defines the properties represented in the Transaction Header object (JSON) or node (XML). Note that this message artifact is identical for each and every message type.

View Transaction Header Details

Property Definitions - Transaction Body

Defines the properties represented in the Transaction Body object (JSON) or node (XML).

Property	Requirement	Data Type	Min / Max	Description
transactionBody	Required			A parent object (JSON) or node (XML) that contains the transaction metadata.
transactionCode	Required	String	12 / 12	A static value of `Title-Policy`. The transaction code is meant to identify the message type and the context or action that should be taken. In this context it implies that the default title is policy is complete and being delivered. Possible Values: Title-Policy
transactionId	Required	String	1 / 50	Represents the Client's unique order number.
productTransactionId	Optional	String	0 / 50	Represents the Client's unique product order number. Note that the `productTransactionId` field is not used in most circumstances. However, when there is a need to further differentiate order numbers at a product level, that share the same `transactionId`, (i.e. the primary order level id), then the `productTransactionId` can be used to ensure uniqueness across the integration transactions. This makes it possible for multiple orders of the same product type to be placed using the same `transactionId`. The use of the `productTransactionId` field and any specific workflow deviations will be vetted during the onboarding process.
orderNumber	Required	Integer		Represents Mortgage Connects unique order number.
productCode	Required	String	3 / 4	Represents Mortgage Connect's product code. Possible Values: PRLM `Property Report Loan Mod` TSG `Trustee Sale Guarantee` PFCF `Pre-Foreclosure Report` PJR `Preliminary Judicial Report` etc. Traditionally, clients use Mortgage Connects `Product Code` names and thus there is a one to one mapping relationship that is maintained by the client. However, Mortgage Connect is aware that our naming conventions may not resonate and that there are many inconsistencies in product code naming conventions and nomenclatures. It is for this reason that Mortgage Connect is able to map the client's product code to Mortgage Connect's product code to ease the transition. Any required product code mapping exercises will be addressed during the onboarding process. The supported `productCode`(s) are specific per integration and will be determined during the onboarding process. Note that the minimum/maximum length requirement of 3/4 is only applicable if using Mortgage Connect's internal product codes, otherwise when mapping to the client's product codes, the minimum/maximum is 1/50.
comment	Required	String	1 / MAX	A general comment indicating that the default title policy is completed.
commentDate	Required	DateTime		The date when the default title policy was completed.
policyNumber	Required	String	1 / 100	The title policy number.
policyDate	Required	DateTime		The title policy date.
documents	Required			A parent object (JSON) or node (XML) that contains a list of document metadata. `(1 to Many)`
document	Required			A parent object (JSON) or node (XML) that contains the metadata associated with a single document.
documentId	Required	Integer		A number or string that uniquely identifies the document within the host system. When an outbound Title-Policy event is sent by Mortgage Connect to the Client, the documentId will be a string in the form of an integer. The integer value represents the Identity Field and Primary Key associated with the corresponding document record. There is no hard requirement to capture this information. However, both parties are encouraged to do so, in order that conversations or any triaging of exceptions around these values can be correlated across systems.
type	Required	String	1 / 255	A name that uniquely identifies the document type. Traditionally, clients use Mortgage Connects `Document Type` names and thus there is a one to one mapping relationship that is maintained by the client. However, Mortgage Connect is aware that our naming conventions may not resonate and that there are many inconsistencies in document type naming conventions and nomenclatures. It is for this reason that Mortgage Connect is able to map the client's document type to Mortgage Connect's document type to ease the transition. Any required document mapping exercises will be addressed during the onboarding process. The supported `types`(s) are specific per integration and will be determined during the onboarding process.
name	Required	String	1 / 100	This is the user friendly name that is associated with the document.
fileType	Required	String	3 / 4	This indicates what type of document it is. This in the context of what the file extension represents. Possible Values: DOC DOCX PDF Future Values: CSV HTML JSON TXT XLS XLSX XML `DOC`, `DOCX`, and `PDF` are currently supported with the vast majority of the documents being delivered as `PDF` documents. The other types are included to support additional documents in the future.
contentMediaType	Required	String	1 / 100	This represents the content media type, i.e. `MIME Type`. Possible Values: application/msword (DOC) application/vnd.openxmlformats-officedocument.wordprocessingml.document (DOCX) application/pdf (PDF) Future Values: text/csv (CSV) text/html (HTML) application/json (JSON) text/plain (TXT) application/vnd.ms-excel (XLS) application/vnd.openxmlformats-officedocument.spreadsheetml.sheet (XLSX) application/xml (XML) At this time `application/msword (DOC)`, `application/vnd.openxmlformats-officedocument.wordprocessingml.document (DOCX)`, and `application/pdf (PDF)` are supported with `application/pdf (PDF)` being used 90+% of the time. The other types are added to support future media types.
contentUnicode TextEncodingType	Required	String	4 / 4	This indicates what unicode text encoding type was used to generate the document. Possible Values: UTF8
contentBinary EncodingType	Required	String	6 / 6	This indicates what binary encoding type was used to generate the document content. Possible Values: Base64
content	Required	String	1 / MAX	This represents the digital representation of the document after it has been encoded using Base64. See: https://en.wikipedia.org/wiki/Base64 for more information regarding Base64 formatting.
description	Optional	String	0 / 255	Provides a brief overview of the document contents.

Property Definitions - Transaction Extensions

Defines the properties represented in the TransactionExtensions object (JSON) or node (XML). Note that this message artifact is identical for each and every message type.

View Transaction Extension Details

Rate Quote API

The following sections detail the Rate Quote API methods that are specific to Mortgage Connect's provided services.

Rate Quote - API Event Matrix

The following matrix details the API event matrix supported by the Rate Quote API. The EventId is an internal Mortgage Connect code that the individual methods are often referenced by.

Client & Mortgage Connect Acknowledgments

The Rate Quote workflow orchestration currently supports the following acknowledgment events. While technically speaking an Acknowledgment response is not an event, it is being loosely grouped in this category for documentation purposes.

EventId	Event Code	HTTP	Description
MC010 ⇄	Acknowledgment	POST	The `Acknowledgment` response is the mechanism in which the Client and Mortgage Connect can communicate that a message was processed succesfully or failed. In addition, exception information can be returned as well if applicable. These are essentially the response payloads returned in response to a request and are virtually the same for each request with a couple deviations that are outlined in the `MC010 - Acknowledgment` section. All events whether initiated by the Client or Mortgage Connect should return a `MC010 Acknowledgment` message. View Details

Client Initiated Events

The Integration Rate Quote workflow orchestration currently supports the following events that are to be initiated by the Client LOS and sent to the Mortgage Connect Integration API.

flowchart LR Client(Client LOS) -- POST --> API(MC Integration API)

EventId	Event Code	HTTP	Description
MC300 →	Rate-Quote	POST	The `Rate Quote` API method is the mechanism in which a Client can submit a request to Mortgage Connect for a rate quote. View Details

Rate Quote - API Message Structure

✅ The following is an example 'Message Envelope'.

/* Copyright © 2023 Mortgage Connect LP */
{
    "transactionHeader": {
        "transactionIdempotentId": "90039F81-73C1-4788-98BC-90553888D301",
        "transactionDate": "2022-07-11T02:03:40",
        "clientCode": "1799",
        "clientName": "AcmeInc",
        "vendorCode": "MC",
        "vendorName": "Mortgage Connect"
    },
    "transactionBody": {
        /* Message Type Specific Metadata Goes Here */
    },
    "transactionExtensions": {
        "transactionExtension": [
            {
                "key": "Client Specific Key 1",
                "value": "Client Specific Value 1"
            },
            {
                "key": "Client Specific Key 2",
                "value": "Client Specific Value 2"
            }
        ]
    }
}
/* Copyright © 2023 Mortgage Connect LP */

<!-- Copyright © 2023 Mortgage Connect LP -->
<root>
    <transactionHeader>
        <transactionIdempotentId>90039F81-73C1-4788-98BC-90553888D301</transactionIdempotentId>
        <transactionDate>022-07-11T02:03:40</transactionDate>
        <clientCode>1799</clientCode>
        <clientName>AcmeInc</clientName>
        <vendorCode>MC</vendorCode>
        <vendorName>Mortgage Connect</vendorName>
    </transactionHeader>
    <transactionBody>
        <!-- Message Type Specific Metadata Goes Here -->
    </transactionBody>
    <transactionExtensions>
        <transactionExtension>
            <key>Client Specific Key 1</key>
            <value>Client Specific Value 1</value>
        </transactionExtension>
        <transactionExtension>
            <key>Client Specific Key 2</key>
            <value>Client Specific Value 1</value>
        </transactionExtension>
    </transactionExtensions>
</root>
<!-- Copyright © 2023 Mortgage Connect LP -->

All of the messages are wrapped in a parent object which serves as the Message Envelope that encompasses all of the message's metadata.

Within the Message Envelope you will find three (3) root level objects.

Transaction Header (transactionHeader)
Transaction Body (transactionBody)
Transaction Extensions (transactionExtensions)

The Transaction Body on the other hand is message type specific and will be documentated separately in a section dedicated to each supported message type.

Property Definitions - Transaction Header

Defines the properties represented in the Transaction Header object (JSON) or node (XML). Note that this message artifact is identical for each and every message type.

Property	Requirement	Data Type	Min / Max	Description
transactionHeader	Required			A parent object (JSON) or node (XML) that contains the transaction header metadata.
transactionIdempotentId	Conditional	GUID		A new globally unique identifier to be generated per every single response. This value is used to ensure transactions are processed idempotently. Idempotent message identification is `NOT` currently implemented. However when a need for this feature bubbles up to the top and it is added to the development pipeline it will work as follows. The API supports idempotency for safely retrying requests without accidentally performing the same operation twice. This is useful when an API call is disrupted in transit and you do not receive a response. For example, if a request to create a new order does not respond due to a network connection error, you can retry the request with the same idempotency Id to guarantee that no more than one order is created. Idempotency works by saving the resulting status code and body of the first request made for any given idempotency Id, regardless of whether it succeeded or failed. Subsequent requests with the same idempotency Id will return the same result, including 500 errors. An idempotency key is a unique value generated by the client which the server uses to recognize subsequent retries of the same request. Idempotent Ids should be GUIDs to ensure uniqueness. Under consideration is also the ability to expire previously processed idempotent Ids, for example ignoring those that are 24 hours old or more. Thus enabling the same transaction to be sent again. Results are only saved if an API endpoint started executing. If incoming parameters failed validation, or the request conflicted with another that was executing concurrently, no idempotent result is saved because no API endpoint began execution. It is safe to retry these requests. All POST requests will accept idempotency keys. Sending idempotent Id in GET and DELETE requests has no effect, as these requests are idempotent by definition. `TransactionIdempotentId` will be required for all `POST` messages once this feature is implemented.
transactionDate	Required	DateTime		The date and time that is associated with the message request.
clientCode	Required	String		This represents Mortgage Connect's client code which uniquely identifies a client. Internally Mortgage Connect often refers to this property as the `ClientId`. A given integration can be associated with one or more `ClientCode`(s). As part of the onboarding process, the Client will need to map their client codes to Mortgage Connects `ClientCode`(s).
clientName	Required	String	1 / 100	This represents the name associated with the client. It is not uncommon for multiple clients, i.e. `ClientCode`(s) to be grouped under the same parent client and thus this field often reflects the parent name instead of individual branch names. This field is not technically of importance from a mapping perspective and is only included to aid in identifying the client when viewing the raw payload, versus memorizing or looking up the `ClientCode`.
vendorCode	Required	String	1 / 100	A code supplied by Mortgage Connect that uniquely identifes the `Integration Platform Instance` or `Tenant` being used to service the integration. Note that typically this value is static per integration.
vendorName	Required	String	1 / 100	A name supplied by Mortgage Connect that uniquely identifes the `Integration Platform Instance` or `Tenant` being used to service the integration. While this value is essentially synonymous to the `VendorCode` it is included for readability, much like the `ClientName` property.

Property Definitions - Transaction Body

Defines the properties represented in the Transaction Body object (JSON) or node (XML).

Property Definitions - Transaction Extensions

Defines the properties represented in the TransactionExtensions object (JSON) or node (XML). Note that this message artifact is identical for each and every message type.

Property	Requirement	Data Type	Min / Max	Description
transactionExtensions	Optional			A parent object (JSON) or node (XML) that contains a list of transaction extensions. `(0 to Many)`.
transactionExtension	Required			A parent object (JSON) or node (XML) that contains the metadata associated with a transaction extension.
key	Required	String	1 / 200	The key (i.e. name) that uniquely identifies the transaction extension.
value	Required	String	1 / MAX	The value that is associated with the transaction extension.

Rate Quote - API Workflow Orchestration

The following sections provide a graphical overview of the typical Rate API worflow, from an API sequencing and orchestration perspective.

Rate Quote - MC010 - Acknowledgment

✅ The following is an 'Accepted' example payload to be returned in the HTTP response.

/* Copyright © 2023 Mortgage Connect LP */
{
    "transactionHeader": {
        "transactionIdempotentId": "90039F81-73C1-4788-98BC-90553888D301",
        "transactionDate": "2022-07-11T02:03:40",
        "clientCode": "1799",
        "clientName": "AcmeInc",
        "vendorCode": "MC",
        "vendorName": "Mortgage Connect"
    },
    "transactionBody": {
        "transactionCode": "Acknowledgment",
        "transactionId": "7832143",
        "productTransactionId": "",
        "orderNumber": 2429888,
        "ackStatus": true,
        "ackMessage": "Accepted",
        "ackException": "",
        "responseType": "",
        "response": ""
    },
    "transactionExtensions": {
        "transactionExtension": [
            {
                "key": "Client Specific Key 1",
                "value": "Client Specific Value 1"
            },
            {
                "key": "Client Specific Key 2",
                "value": "Client Specific Value 2"
            }
        ]
    }
}
/* Copyright © 2023 Mortgage Connect LP */

<!-- Copyright © 2023 Mortgage Connect LP -->
<root>
    <transactionHeader>
        <transactionIdempotentId>90039F81-73C1-4788-98BC-90553888D301</transactionIdempotentId>
        <transactionDate>022-07-11T02:03:40</transactionDate>
        <clientCode>1799</clientCode>
        <clientName>AcmeInc</clientName>
        <vendorCode>MC</vendorCode>
        <vendorName>Mortgage Connect</vendorName>
    </transactionHeader>
    <transactionBody>
        <transactionCode>Acknowledgment</transactionCode>
        <transactionId>7832143</transactionId>
        <productTransactionId></productTransactionId>
        <orderNumber>2429888</orderNumber>
        <ackStatus>true</ackStatus>
        <ackMessage>Accepted</ackMessage>
        <ackException></ackException>
        <responseType></responseType>
        <response></resonse>
        </transactionBody>
    <transactionExtensions>
        <transactionExtension>
            <key>Client Specific Key 1</key>
            <value>Client Specific Value 1</value>
        </transactionExtension>
        <transactionExtension>
            <key>Client Specific Key 2</key>
            <value>Client Specific Value 1</value>
        </transactionExtension>
    </transactionExtensions>
</root>
<!-- Copyright © 2023 Mortgage Connect LP -->

⛔ The following is a 'Rejected' example payload to be returned in the HTTP response.

/* Copyright © 2023 Mortgage Connect LP */
{
    "transactionHeader": {
        "transactionIdempotentId": "90039F81-73C1-4788-98BC-90553888D301",
        "transactionDate": "2022-07-11T02:03:40",
        "clientCode": "1799",
        "clientName": "AcmeInc",
        "vendorCode": "MC",
        "vendorName": "Mortgage Connect"
    },
    "transactionBody": {
        "transactionCode": "Acknowledgment",
        "transactionId": "7832143",
        "orderNumber": 0,
        "ackStatus": false,
        "ackMessage": "Rejected",
        "ackException": "Invalid Credentials",
        "responseType": "",
        "response": ""
    },
    "transactionExtensions": {
        "transactionExtension": [
            {
                "key": "Client Specific Key 1",
                "value": "Client Specific Value 1"
            },
            {
                "key": "Client Specific Key 2",
                "value": "Client Specific Value 2"
            }
        ]
    }
}
/* Copyright © 2023 Mortgage Connect LP */

<!-- Copyright © 2023 Mortgage Connect LP -->
<root>
    <transactionHeader>
        <transactionIdempotentId>90039F81-73C1-4788-98BC-90553888D301</transactionIdempotentId>
        <transactionDate>2022-07-11T02:03:40</transactionDate>
        <clientCode>1799</clientCode>
        <clientName>AcmeInc</clientName>
        <vendorCode>MC</vendorCode>
        <vendorName>Mortgage Connect</vendorName>
    </transactionHeader>
    <transactionBody>
        <transactionCode>Acknowledgment</transactionCode>
        <transactionId>7832143</transactionId>
        <orderNumber>0</orderNumber>
        <ackStatus>false</ackStatus>
        <ackMessage>Rejected</ackMessage>
        <ackException>Invalid Credentials</ackException>
    </transactionBody>
    <transactionExtensions>
        <transactionExtension>
            <key>Client Specific Key 1</key>
            <value>Client Specific Value 1</value>
        </transactionExtension>
        <transactionExtension>
            <key>Client Specific Key 2</key>
            <value>Client Specific Value 1</value>
        </transactionExtension>
    </transactionExtensions>
</root>
<!-- Copyright © 2023 Mortgage Connect LP -->

👍 The response payload can be verified using the following validation schema.

/* Copyright © 2023 Mortgage Connect LP */
{
    "$schema": "http://json-schema.org/draft-07/schema#",
    "$id": "root",
    "description": "Copyright @ 2022 Mortgage Connect LP - Rate Quote.",
    "type": "object",
    "additionalProperties": false,
    "properties": {
        "legalHeader": {
            "type": "object",
            "additionalProperties": false,
            "properties": {
                "version": {
                    "examples": [
                        "1.0.8.0"
                    ],
                    "type": "string",
                    "minLength": 1,
                    "maxLength": 20
                },
                "disclosingParty": {
                    "examples": [
                        "Copyright @ 2022 Mortgage Connect LP"
                    ],
                    "type": "string",
                    "minLength": 1,
                    "maxLength": 100
                },
                "proprietaryInformationAndConfidential": {
                    "examples": [
                        "Ownership of Proprietary Information. The Recipient agrees that it shall not receive any right, title or interest, or any license or right to use, the Disclosing Partys Proprietary Information, including, but not limited to, technology, ideas, concepts, drawings, documentation, designs, prototypes, processes, trade secrets, trademarks or other intellectual property rights therein, by implication or otherwise."
                    ],
                    "type": "string",
                    "minLength": 1,
                    "maxLength": 2000
                }
            },
            "required": [
                "version",
                "disclosingParty",
                "proprietaryInformationAndConfidential"
            ],
            "minProperties": 3,
            "maxProperties": 3
        },
        "transactionHeader": {
            "type": "object",
            "additionalProperties": false,
            "properties": {
                "transactionIdempotentId": {
                    "examples": [
                        "3B34A671-BB17-400D-90BF-7CBF9C96E8ED"
                    ],
                    "type": "string",
                    "minLength": 36,
                    "maxLength": 36,
                    "pattern": "^[\\da-fA-F]{8}-[\\da-fA-F]{4}-[\\da-fA-F]{4}-[\\da-fA-F]{4}-[\\da-fA-F]{12}$"
                },
                "transactionDate": {
                    "examples": [
                        "2022-07-11T02:03:40"
                    ],
                    "type": "string",
                    "format": "date-time"
                },
                "clientCode": {
                    "examples": [
                        "1799"
                    ],
                    "type": "string",
                    "minLength": 1,
                    "maxLength": 100,
                    "format": "integer"
                },
                "clientName": {
                    "examples": [
                        "AcmeInc"
                    ],
                    "type": "string",
                    "minLength": 1,
                    "maxLength": 100
                },
                "vendorCode": {
                    "examples": [
                        "MC"
                    ],
                    "type": "string",
                    "minLength": 1,
                    "maxLength": 100
                },
                "vendorName": {
                    "examples": [
                        "Mortgage Connect"
                    ],
                    "type": "string",
                    "minLength": 1,
                    "maxLength": 100
                }
            },
            "required": [
                "transactionIdempotentId",
                "transactionDate",
                "clientCode",
                "clientName",
                "vendorCode",
                "vendorName"
            ],
            "minProperties": 6,
            "maxProperties": 6
        },
        "transactionBody": {
            "type": "object",
            "additionalProperties": false,
            "properties": {
                "transactionCode": {
                    "examples": [
                        "Acknowledgment"
                    ],
                    "type": "string",
                    "const": "Acknowledgment"
                },
                "transactionId": {
                    "examples": [
                        "7832143"
                    ],
                    "type": "string",
                    "minLength": 1,
                    "maxLength": 50
                },
                "productTransactionId": {
                    "examples": [
                        "7832143"
                    ],
                    "type": "string",
                    "minLength": 0,
                    "maxLength": 50
                },
                "orderNumber": {
                    "examples": [
                        "2429888"
                    ],
                    "type": "integer"
                },
                "ackStatus": {
                    "examples": [
                        true,
                        false
                    ],
                    "type": "boolean"
                },
                "ackMessage": {
                    "type": "string"
                },
                "ackException": {
                    "type": "string"
                },
                "responseType": {
                    "type": "string"
                },
                "response": {
                    "type": "object"
                }
            },
            "allOf": [
                {
                    "if": {
                        "properties": { "responseType": { "const": "RateQuoteResponse" } }
                    },
                    "then": {
                        "properties": {
                            "response": { 
                                "type": "object",
                                "properties": {
                                    "transactionType": {
                                        "type": "string",
                                        "enum": [
                                            "Purchase",
                                            "Refinance",
                                            "Home Equity",
                                            "Default",
                                            "Assumptions"
                                        ]
                                    },
                                    "message": {
                                        "type": "string"
                                    },
                                    "error": {
                                        "type": "array",
                                        "items": {
                                            "type": "string"
                                        }
                                    },
                                    "loanNumber": {
                                        "type": "string"
                                    },
                                    "state": {
                                        "type": "string"
                                    },
                                    "zipCode": {
                                        "type": "string"
                                    },
                                    "county": {
                                        "type": "string"
                                    },
                                    "address": {
                                        "type": "string"
                                    },
                                    "loanAmount": {
                                        "type": "string"
                                    },
                                    "rateQuoteId": {
                                        "type": "string"
                                    },
                                    "requestedTime": {
                                        "type": "string"
                                    },
                                    "rates": {
                                        "type": "object",
                                        "properties": {
                                            "rate": {
                                                "type": "array",
                                                "items": {
                                                    "type": "object",
                                                    "properties": {
                                                        "feeAmount": {
                                                            "type": "number"
                                                        },
                                                        "feeName": {
                                                            "type": "string"
                                                        },
                                                        "hudLine": {
                                                            "type": "integer"
                                                        }
                                                    }
                                                }
                                            }
                                        }
                                    },
                                    "recordingFee": {
                                        "type": "object",
                                        "properties": {
                                            "fees": {
                                                "type": "array",
                                                "items": {
                                                    "type": "object",
                                                    "properties": {
                                                        "feeAmount": {
                                                            "type": "number"
                                                        },
                                                        "feeName": {
                                                            "type": "string"
                                                        },
                                                        "hudLine": {
                                                            "type": "integer"
                                                        }
                                                    }
                                                }
                                            }
                                        }
                                    }
                                },
                                "required": [
                                    "transactionType"
                                ]
                             }
                        }
                    }
                },
                {
                    "if": {
                        "properties": { "ackStatus": { "const": false } }
                    },
                    "then": {
                        "required": [
                            "transactionCode",
                            "ackStatus",
                            "ackMessage",
                            "ackException"
                        ]
                    },
                    "else": {
                        "required": [
                            "transactionCode",
                            "ackStatus",
                            "ackMessage"
                        ]
                    }
                }
            ]
        },
        "transactionExtensions": {
            "type": "object",
            "properties": {
                "transactionExtension": {
                    "type": "array",
                    "items": {
                        "type": "object",
                        "additionalProperties": false,
                        "properties": {
                            "key": {
                                "examples": [
                                    "Client Specific Key"
                                ],
                                "type": "string",
                                "minLength": 1,
                                "maxLength": 200
                            },
                            "value": {
                                "examples": [
                                    "Client Specific Value"
                                ],
                                "type": "string",
                                "minLength": 1
                            }
                        },
                        "required": [
                            "key",
                            "value"
                        ],
                        "minProperties": 2,
                        "maxProperties": 2
                    },
                    "minItems": 0
                }
            }
        }
    },
    "required": [
        "transactionHeader",
        "transactionBody"
    ],
    "minProperties": 2,
    "maxProperties": 4
}
/* Copyright © 2023 Mortgage Connect LP */

<?xml version="1.0" encoding="utf-8"?>
<xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema">
  <xs:element name="root">
  <xs:complexType>
    <xs:sequence>
      <xs:element ref="legalHeader" minOccurs="0"/>
      <xs:element ref="transactionHeader"/>
      <xs:element name="transactionBody">
        <xs:complexType>
          <xs:all>
            <xs:element name="transactionCode" type="xs:string" fixed="Acknowledgment"/>
            <xs:element ref="transactionId"/>
            <xs:element name="productTransactionId" type="transactionId" minOccurs="0"/>
            <xs:element name="orderNumber" type="orderNo" minOccurs="0"/>
            <xs:element name="ackStatus" type="xs:boolean"/>
            <xs:element name="ackMessage" type="xs:string"/>
            <xs:element name="ackException" type="xs:string" minOccurs="0"/>
            <xs:element name="responseType" type="xs:string" minOccurs="0"/>
            <xs:element ref="ackResponse" minOccurs="0"/>
          </xs:all>
        </xs:complexType>
      </xs:element>
      <xs:element ref="transactionExtensions" minOccurs="0" />
    </xs:sequence>
  </xs:complexType>
  </xs:element>
</xs:schema>

<!-- Schema for ackRespone when supplied. Currently this is used only when responseType is rateQuoteResponse -->
<?xml version="1.0" encoding="utf-8"?>
<xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema">
  <xs:element name="ackResponse">
    <xs:complexType>
      <xs:choice>
        <xs:element name="rateQuoteResponse" minOccurs="0">
          <xs:complexType>
            <xs:all>
              <xs:element name="transactionType">
                <xs:simpleType>
                  <xs:restriction base="xs:string">
                    <xs:enumeration value="Purchase"/>
                    <xs:enumeration value="Refinance"/>
                    <xs:enumeration value="Home Equity"/>
                    <xs:enumeration value="Default"/>
                    <xs:enumeration value="Assumptions"/>
                  </xs:restriction>
                </xs:simpleType>
              </xs:element>
              <xs:element name="message" type="xs:string" minOccurs="0"/>
              <xs:element name="error">
                <xs:complexType>
                  <xs:sequence>
                    <xs:element name="error" type="xs:string" minOccurs="0" maxOccurs="unbounded"/>
                  </xs:sequence>
                </xs:complexType>
              </xs:element>
              <xs:element name="loanNumber" type="xs:string" minOccurs="0"/>
              <xs:element name="state" type="xs:string" minOccurs="0"/>
              <xs:element name="zipCode" type="xs:string" minOccurs="0"/>
              <xs:element name="county" type="xs:string" minOccurs="0"/>
              <xs:element name="address" type="xs:string" minOccurs="0"/>
              <xs:element name="loanAmount" type="xs:string" minOccurs="0"/>
              <xs:element name="rateQuoteId" type="xs:string" minOccurs="0"/>
              <xs:element name="requestedTime" type="xs:string" minOccurs="0"/>
              <xs:element name="rates">
                <xs:complexType>
                  <xs:sequence>
                    <xs:element name="rate" minOccurs="0" maxOccurs="unbounded">
                      <xs:complexType>
                        <xs:all>
                          <xs:element name="feeAmount" type="xs:decimal" minOccurs="0"/>
                          <xs:element name="feeName" type="xs:string" minOccurs="0"/>
                          <xs:element name="hudLine" type="xs:integer" minOccurs="0"/>
                        </xs:all>
                      </xs:complexType>
                    </xs:element>
                  </xs:sequence>
                </xs:complexType>
              </xs:element>
              <xs:element name="recordingFee">
                <xs:complexType>
                  <xs:sequence>
                    <xs:element name="fees" minOccurs="0" maxOccurs="unbounded">
                      <xs:complexType>
                        <xs:all>
                          <xs:element name="feeAmount" type="xs:decimal" minOccurs="0"/>
                          <xs:element name="feeName" type="xs:string" minOccurs="0"/>
                          <xs:element name="hudLine" type="xs:integer" minOccurs="0"/>
                        </xs:all>
                      </xs:complexType>
                    </xs:element>
                  </xs:sequence>
                </xs:complexType>
              </xs:element>
              <xs:element name="document" minOccurs="0">
                <xs:complexType>
                  <xs:all>
                    <xs:element name="documentId">
                      <xs:simpleType>
                        <xs:restriction base="xs:string">
                          <xs:maxLength value="36"/>
                        </xs:restriction>
                      </xs:simpleType>
                    </xs:element>
                    <xs:element name="name">
                      <xs:simpleType>
                        <xs:restriction base="xs:string">
                          <xs:maxLength value="100"/>
                        </xs:restriction>
                      </xs:simpleType>
                    </xs:element>
                    <xs:element name="fileType">
                      <xs:simpleType>
                        <xs:restriction base="xs:string">
                          <xs:enumeration value="DOC"/>
                          <xs:enumeration value="DOCX"/>
                          <xs:enumeration value="PDF"/>
                          <xs:enumeration value="doc"/>
                          <xs:enumeration value="docx"/>
                          <xs:enumeration value="pdf"/>
                        </xs:restriction>
                      </xs:simpleType>
                    </xs:element>
                    <xs:element name="contentMediaType">
                      <xs:simpleType>
                        <xs:restriction base="xs:string">
                          <xs:enumeration value="application/msword"/>
                          <xs:enumeration value="application/vnd.openxmlformats-officedocument.wordprocessingml.document"/>
                          <xs:enumeration value="application/pdf"/>
                        </xs:restriction>
                      </xs:simpleType>
                    </xs:element>
                    <xs:element name="contentUnicodeTextEncodingType">
                      <xs:simpleType>
                        <xs:restriction base="xs:string">
                          <xs:enumeration value="UTF8"/>
                        </xs:restriction>
                      </xs:simpleType>
                    </xs:element>
                    <xs:element name="contentBinaryEncodingType">
                      <xs:simpleType>
                        <xs:restriction base="xs:string">
                          <xs:enumeration value="Base64"/>
                        </xs:restriction>
                      </xs:simpleType>
                    </xs:element>
                    <xs:element name="content" type="xs:base64Binary"/>
                  </xs:all>
                </xs:complexType>
              </xs:element>
            </xs:all>
          </xs:complexType>
        </xs:element>
      </xs:choice>
  </xs:complexType>
  </xs:element>
</xs:schema>

The Acknowledgment event is essentially the payload that is to be returned by all HTTP requests whether it was initialized by the Client or Mortgage Connect.

Property Definitions - Transaction Header

Defines the properties represented in the Transaction Header object (JSON) or node (XML). Note that this message artifact is identical for each and every message type.

View Transaction Header Details

Property Definitions - Transaction Body

Defines the properties represented in the Transaction Body object (JSON) or node (XML).

Property	Requirement	Data Type	Min / Max	Description
transactionBody	Required			A parent object (JSON) or node (XML) that contains the transaction metadata.
transactionCode	Required	String	14 / 14	A static value of `Acknowledgment`. The transaction code is meant to identify the message type and the context or action that should be taken. An `Acknowledgment` transaction code is unique from all other transaction codes in that the context is actually derived from the value of the `AckStatus` property. Possible Values: Acknowledgment
transactionId	Required	String	1 / 50	Represents the Client's unique order number.
productTransactionId	Optional	String	0 / 50	Represents the Client's unique product order number. Note that the `productTransactionId` field is not used in most circumstances. However, when there is a need to further differentiate order numbers at a product level, that share the same `transactionId`, (i.e. the primary order level id), then the `productTransactionId` can be used to ensure uniqueness across the integration transactions. This makes it possible for multiple orders of the same product type to be placed using the same `transactionId`. The use of the `productTransactionId` field and any specific workflow deviations will be vetted during the onboarding process.
orderNumber	Conditional	Integer		Represents Mortgage Connects unique order number. Note this property `Must` be populated in response to a `MC100 - New Order` message that is successfully processed `Synchronously`. For all other messages types, if the `OrderNumber` can be ascertained then it should be included, otherwise it should be set to zero (0) by default.
ackStatus	Required	Boolean		A boolean code indicating whether the request message was successfully processed. This is the property you should interrogate to determine if the message was successful or a failure. Possible Values: true false
ackMessage	Required	String	1 / MAX	A message indicating whether the request message was successfully processed. This property is typically just populated with `Success` or `Failure`. However, it can optionally be populated with additional metadata that provides additional context as to why it was a successful or failed message. It is for this reason you should key off of the `ackStatus` field to determine whether it was a successful or failed message. `Typical` Values: Accepted Rejected
ackException	Conditional	String	0 / MAX	A message that provides additional exception details in the event the message was not sucessfully processed. This property is only ever populated if the message failed to be processed and there are applicable exception details that are appropriate to share, such as `Invalid Credentials` when trying to authenticate the request.
responseType	Conditional	String	0 / MAX	The requested action has returned a response object of the type specified by this property's value. The response type is defined in the `Response Definition` section of the event providing the response. Currently applicable to the following events: MC300 Rate Quote
response	Conditional	String	0 / MAX	A string containing the JSON or XML representation of the response object. The response object is defined in the `Response Definition` section of the event providing the response.

Property Definitions - Transaction Extensions

Defines the properties represented in the TransactionExtensions object (JSON) or node (XML). Note that this message artifact is identical for each and every message type.

View Transaction Extension Details

Rate Quote - MC300 - Rate Quote Request

🌐 The following is an example payload to be posted in the body of the HTTP request.

/* Copyright © 2023 Mortgage Connect LP */
{
    "transactionHeader": {
        "transactionIdempotentId": "3B34A671-BB17-400D-90BF-7CBF9C96E8ED",
        "transactionDate": "2022-07-11T02:03:40",
        "clientCode": "1799",
        "clientName": "AcmeInc",
        "vendorCode": "MC",
        "vendorName": "Mortgage Connect"
    },
    "transactionBody": {
        "transactionCode": "Rate-Quote",
        "transactionId": "7832143",
        "transactionType": "Refinance",
        "loanNumber": "73201-3433",
        "requestedTime": "2022-07-11T02:03:40",
        "state": "CA",
        "zipCode": "93950",
        "county": "Monterey",
        "address": "1234 Main St",
        "loanAmount": "200000",
        "priorPolicyAmount": "120000",
        "salesPrice": "150000",
        "priorPolicyDate": "2001-01-11",
        "isPUD": false,
        "isCondo": false,
        "isMobileHome": false,
        "isTorrens": false,
        "isWaterFrontBayOcean": false,
        "isWaterFrontRiverStream": false,
        "isLeaseHold": false,
        "texas50a6": false,
        "recordingDocuments": {
            "document": [
                {
                    "documentType": "Deed",
                    "numberOfPages": 6,
                    "numberOfNames": 2,
                    "consideration": "132000"
                },
                {
                    "documentType": "Mortgage",
                    "numberOfPages": 20,
                    "numberOfNames": 2,
                    "originalAmount": "120000",
                    "unpaidBalance": "40000"
                },
                {
                    "documentType": "Release",
                    "numberOfPages": 10,
                    "numberOfNames": 1
                }
            ]
        }
    },
    "transactionExtensions": {
        "transactionExtension": [
            {
                "key": "Client Specific Key 1",
                "value": "Client Specific Value 1"
            },
            {
                "key": "Client Specific Key 2",
                "value": "Client Specific Value 2"
            }
        ]
    }
}
/* Copyright © 2023 Mortgage Connect LP */

<!-- Copyright © 2023 Mortgage Connect LP -->
<root>
    <transactionHeader>
        <transactionIdempotentId>3B34A671-BB17-400D-90BF-7CBF9C96E8ED</transactionIdempotentId>
        <transactionDate>022-07-11T02:03:40</transactionDate>
        <clientCode>1799</clientCode>
        <clientName>AcmeInc</clientName>
        <vendorCode>MC</vendorCode>
        <vendorName>Mortgage Connect</vendorName>
    </transactionHeader>
    <transactionBody>
        <transactionCode>Rate-Quote</transactionCode>
        <transactionId>7832143</transactionId>
        <transactionType>Refinance</transactionType>
        <loanNumber>73201-3433</loanNumber>
        <requestedTime>2022-07-11T02:03:40</requestedTime>
        <state>CA</state>
        <zipCode>93950</zipCode>
        <county>Monterey</county>
        <address>1234 Main St</address>
        <loanAmount>200000</loanAmount>
        <priorPolicyAmount>120000</priorPolicyAmount>
        <salesPrice>120000</salesPrice>
        <priorPolicyDate>2001-01-11</priorPolicyDate>
        <isPUD>false</isPUD>
        <isCondo>false</isCondo>
        <isMobileHome>false</isMobileHome>
        <isTorrens>false</isTorrens>
        <isWaterFrontBayOcean>false</isWaterFrontBayOcean>
        <isWaterFrontRiverStream>false</isWaterFrontRiverStream>
        <isLeaseHold>false</isLeaseHold>
        <texas50a6>false</texas50a6>
        <recordingDocuments>
            <document>
                <documentType>Deed</documentType>
                <numberOfPages>6</numberOfPages>
                <numberOfNames>2</numberOfNames>
                <consideration>132000</consideration>
            </document>
            <document>
                <documentType>Mortgage</documentType>
                <numberOfPages>20</numberOfPages>
                <numberOfNames>2</numberOfNames>
                <originalAmount>120000</originalAmount>
                <unpaidBalance>40000</unpaidBalance>
            </document>
            <document>
                <documentType>Release</documentType>
                <numberOfPages>10</numberOfPages>
                <numberOfNames>1</numberOfNames>
            </document>
        </recordingDocuments>
    </transactionBody>
    <transactionExtensions>
        <transactionExtension>
            <key>Client Specific Key 1</key>
            <value>Client Specific Value 1</value>
        </transactionExtension>
        <transactionExtension>
            <key>Client Specific Key 2</key>
            <value>Client Specific Value 1</value>
        </transactionExtension>
    </transactionExtensions>
</root>
<!-- Copyright © 2023 Mortgage Connect LP -->

👍 The request payload can be verified using the following validation schema.

/* Copyright © 2023 Mortgage Connect LP */
{
    "$schema": "http://json-schema.org/draft-07/schema#",
    "$id": "root",
    "description": "Copyright @ 2022 Mortgage Connect LP - Title & Tax Schema.",
    "type": "object",
    "additionalProperties": false,
    "properties": {
        "legalHeader": {
            "type": "object",
            "additionalProperties": false,
            "properties": {
                "version": {
                    "examples": [
                        "1.0.8.0"
                    ],
                    "type": "string",
                    "minLength": 1,
                    "maxLength": 20
                },
                "disclosingParty": {
                    "examples": [
                        "Copyright @ 2022 Mortgage Connect LP"
                    ],
                    "type": "string",
                    "minLength": 1,
                    "maxLength": 100
                },
                "proprietaryInformationAndConfidential": {
                    "examples": [
                        "Ownership of Proprietary Information. The Recipient agrees that it shall not receive any right, title or interest, or any license or right to use, the Disclosing Partys Proprietary Information, including, but not limited to, technology, ideas, concepts, drawings, documentation, designs, prototypes, processes, trade secrets, trademarks or other intellectual property rights therein, by implication or otherwise."
                    ],
                    "type": "string",
                    "minLength": 1,
                    "maxLength": 2000
                }
            },
            "required": [
                "version",
                "disclosingParty",
                "proprietaryInformationAndConfidential"
            ],
            "minProperties": 3,
            "maxProperties": 3
        },
        "transactionHeader": {
            "type": "object",
            "additionalProperties": false,
            "properties": {
                "transactionIdempotentId": {
                    "examples": [
                        "3B34A671-BB17-400D-90BF-7CBF9C96E8ED"
                    ],
                    "type": "string",
                    "minLength": 36,
                    "maxLength": 36,
                    "pattern": "^[\\da-fA-F]{8}-[\\da-fA-F]{4}-[\\da-fA-F]{4}-[\\da-fA-F]{4}-[\\da-fA-F]{12}$"
                },
                "transactionDate": {
                    "examples": [
                        "2022-07-11T02:03:40"
                    ],
                    "type": "string",
                    "format": "date-time"
                },
                "clientCode": {
                    "examples": [
                        "1799"
                    ],
                    "type": "string",
                    "minLength": 1,
                    "maxLength": 100,
                    "format": "integer"
                },
                "clientName": {
                    "examples": [
                        "AcmeInc"
                    ],
                    "type": "string",
                    "minLength": 1,
                    "maxLength": 100
                },
                "vendorCode": {
                    "examples": [
                        "MC"
                    ],
                    "type": "string",
                    "minLength": 1,
                    "maxLength": 100
                },
                "vendorName": {
                    "examples": [
                        "Mortgage Connect"
                    ],
                    "type": "string",
                    "minLength": 1,
                    "maxLength": 100
                }
            },
            "required": [
                "transactionIdempotentId",
                "transactionDate",
                "clientCode",
                "clientName",
                "vendorCode",
                "vendorName"
            ],
            "minProperties": 6,
            "maxProperties": 6
        },
        "transactionBody": {
            "title": "TransactionBody",
            "type": "object",
            "additionalProperties": false,
            "properties": {
                "transactionCode": {
                    "examples": [
                        "Rate-Quote"
                    ],
                    "type": "string",
                    "const": "Rate-Quote"
                },
                "transactionId": {
                    "examples": [
                        "7832143"
                    ],
                    "type": "string",
                    "minLength": 1,
                    "maxLength": 50
                },
                "transactionType": {
                    "type": "string",
                    "enum": [
                        "Purchase",
                        "Refinance",
                        "Home Equity",
                        "Default",
                        "Assumptions"
                    ]
                },
                "loanNumber": {
                    "type": "string",
                    "examples": [
                        "7313993"
                    ],
                    "minLength": 1,
                    "maxLength": 64
                },
                "requestedTime": {
                    "type": "string",
                    "format": "date-time",
                    "examples": [ "2020-01-01 13:00:01" ],
                    "default": "Current DateTime"
                },
                "state": {
                    "type": "string",
                    "examples": [
                        "PA"
                    ],
                    "enum": [
                        "AK",
                        "AL",
                        "AR",
                        "AS",
                        "AZ",
                        "CA",
                        "CO",
                        "CT",
                        "DC",
                        "DE",
                        "FL",
                        "FM",
                        "GA",
                        "GU",
                        "HI",
                        "IA",
                        "ID",
                        "IL",
                        "IN",
                        "KS",
                        "KY",
                        "LA",
                        "MA",
                        "MD",
                        "ME",
                        "MH",
                        "MI",
                        "MN",
                        "MO",
                        "MP",
                        "MS",
                        "MT",
                        "NC",
                        "ND",
                        "NE",
                        "NH",
                        "NJ",
                        "NM",
                        "NV",
                        "NY",
                        "OH",
                        "OK",
                        "OR",
                        "PA",
                        "PR",
                        "PW",
                        "RI",
                        "SC",
                        "SD",
                        "TN",
                        "TX",
                        "UT",
                        "VA",
                        "VI",
                        "VT",
                        "WA",
                        "WI",
                        "WV",
                        "WY"
                    ]
                },
                "zipCode": {
                    "type": "string",
                    "examples": [
                        "15136"
                    ],
                    "pattern": "^[0-9]{5}$",
                    "minLength": 5,
                    "maxLength": 5
                },
                "county": {
                    "type": "string",
                    "examples": [
                        "Allegheny"
                    ],
                    "maxLength": 32
                },
                "address": {
                    "type": "string",
                    "examples": [
                        "1204 New York Drive"
                    ],
                    "maxLength": 255
                },
                "loanAmount": {
                    "type": "string",
                    "format": "money",
                    "examples": [ "0.00" ]
                },
                "priorPolicyAmount": {
                    "type": "string",
                    "format": "money",
                    "examples": [ "0.00" ]
                },
                "salesPrice": {
                    "type": "string",
                    "format": "money",
                    "examples": [ "0.00" ]
                },
                "priorPolicyDate": {
                    "type": "string",
                    "format": "date",
                    "examples": [ "2003-11-01" ]
                },
                "isPUD": {
                    "type": "boolean",
                    "default": false,
                    "examples": [ true, false ]
                },
                "isCondo": {
                    "type": "boolean",
                    "default": false,
                    "examples": [ true, false ]
                },
                "isMobileHome": {
                    "type": "boolean",
                    "default": false,
                    "examples": [ true, false ]
                },
                "isTorrens": {
                    "type": "boolean",
                    "default": false,
                    "examples": [ true, false ]
                },
                "isWaterFrontBayOcean": {
                    "type": "boolean",
                    "default": false
                },
                "isWaterFrontRiverStream": {
                    "type": "boolean",
                    "default": false,
                    "examples": [ true, false ]
                },
                "isLeaseHold": {
                    "type": "boolean",
                    "default": false,
                    "examples": [ true, false ]
                },
                "texas50a6": {
                    "type": "boolean",
                    "default": false,
                    "examples": [ true, false ]
                },
                "recordingDocuments": {
                    "type": "object",
                    "properties": {
                        "document": {
                            "type": "array",
                            "items": {
                                "type": "object",
                                "properties": {
                                    "documentType": {
                                        "type": "string",
                                        "examples": [ "Mortgage" ],
                                        "enum": [
                                            "Deed",
                                            "Mortgage",
                                            "Release"
                                        ]
                                    },
                                    "numberOfPages": {
                                        "type": "integer",
                                        "examples": [ 10 ]
                                    },
                                    "numberOfNames": {
                                        "type": "integer",
                                        "examples": [ 2 ]
                                    },
                                    "consideration": {
                                        "type": "string",
                                        "format": "money",
                                        "examples": [ "0.00" ]
                                    },
                                    "originalAmount": {
                                            "type": "string",
                                        "format": "money",
                                        "examples": [ "0.00" ]
                                    },
                                    "unpaidBalance": {
                                        "type": "string",
                                        "format": "money",
                                        "examples": [ "0.00" ]
                                    },
                                    "stateQuestions": {
                                        "type": "object",
                                        "properties": {
                                            "question": {
                                                "type": "array",
                                                "items": {
                                                    "type": "object",
                                                    "properties": {
                                                        "id": {
                                                            "type": "string"
                                                        },
                                                        "ernstQuestionId": {
                                                            "type": "integer"
                                                        },
                                                        "description": {
                                                            "type": "string"
                                                        },
                                                        "value": {
                                                            "type": "string"
                                                        }
                                                    }
                                                }
                                            }
                                        }
                                    }
                                },
                                "required": [
                                    "documentType"
                                ]
                            }
                        },
                        "minItems": 1
                    },
                      "minItems": 1
                },
            },
            "allOf": [
                {
                    "if": {
                        "properties": { "transactionType": { "enum": [ "Purchase" ] } }
                    },
                    "then": {
                        "required": [ "salesPrice" ]
                    }
                }
            ],
            "required": [
                "transactionCode",
                "transactionId",
                "transactionType",
                "state",
                "zipCode",
                "county",
                "loanAmount"
            ]
        },
        "transactionExtensions": {
            "type": "object",
            "properties": {
                "transactionExtension": {
                    "type": "array",
                    "items": {
                        "type": "object",
                        "additionalProperties": false,
                        "properties": {
                            "key": {
                                "examples": [
                                    "Client Specific Key"
                                ],
                                "type": "string",
                                "minLength": 1,
                                "maxLength": 200
                            },
                            "value": {
                                "examples": [
                                    "Client Specific Value"
                                ],
                                "type": "string",
                                "minLength": 1
                            }
                        },
                        "required": [
                            "key",
                            "value"
                        ],
                        "minProperties": 2,
                        "maxProperties": 2
                    },
                    "minItems": 0
                }
            }
        }
    },
    "required": [
        "transactionHeader",
        "transactionBody"
    ],
    "minProperties": 2,
    "maxProperties": 4
}
/* Copyright © 2023 Mortgage Connect LP */

<?xml version="1.0" encoding="utf-8"?>
<xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema">
  <xs:element name="root">
    <xs:complexType>
      <xs:sequence>
        <xs:element ref="legalHeader" minOccurs="0"/>
        <xs:element ref="transactionHeader"/>
        <xs:element name="transactionBody">
          <xs:complexType>
            <xs:all>
              <xs:element name="transactionCode" type="xs:string" fixed="Rate-Quote"/>
              <xs:element ref="transactionId"/>
              <xs:element name="transactionType">
                <xs:simpleType>
                  <xs:restriction base="xs:string">
                    <xs:enumeration value="Purchase"/>
                    <xs:enumeration value="Refinance"/>
                    <xs:enumeration value="Home Equity"/>
                    <xs:enumeration value="Default"/>
                    <xs:enumeration value="Assumptions"/>
                  </xs:restriction>
                </xs:simpleType>
              </xs:element>
              <xs:element name="loanNumber" type="xs:string" minOccurs="0"/>
              <xs:element name="requestedTime" type="xs:datetime" minOccurs="0"/>
              <xs:element name="state" type="xs:string" minOccurs="0"/>
              <xs:element name="zipCode" type="xs:string" minOccurs="0"/>
              <xs:element name="county" type="xs:string" minOccurs="0"/>
              <xs:element name="address" type="xs:string" minOccurs="0"/>
              <xs:element name="loanAmount" type="money" minOccurs="0"/>
              <xs:element name="priorPolicyAmount" type="money" minOccurs="0"/>
              <xs:element name="salesPrice" type="money" minOccurs="0"/>
              <xs:element name="priorPolicyDate" type="xs:date" minOccurs="0"/>
              <xs:element name="isPUD" type="xs:boolean" minOccurs="0"/>
              <xs:element name="isCondo" type="xs:boolean" minOccurs="0"/>
              <xs:element name="isMobileHome" type="xs:boolean" minOccurs="0"/>
              <xs:element name="isTorrens" type="xs:boolean" minOccurs="0"/>
              <xs:element name="isWaterFrontBayOcean" type="xs:boolean" minOccurs="0"/>
              <xs:element name="isWaterFrontRiverStream" type="xs:boolean" minOccurs="0"/>
              <xs:element name="isLeaseHold" type="xs:boolean" minOccurs="0"/>
              <xs:element name="tx50a6" type="xs:boolean" minOccurs="0"/>
              <xs:element name="recordingDocuments" minOccurs="0">
                <xs:complexType>
                  <xs:sequence>
                    <xs:element name="document" minOccurs="1" maxOccurs="unbounded">
                      <xs:complexType>
                        <xs:all>
                          <xs:element name="documentType" minOccurs="0">
                            <xs:simpleType>
                              <xs:restriction base="xs:string">
                                <xs:enumeration value="Deed"/>
                                <xs:enumeration value="Mortgage"/>
                                <xs:enumeration value="Release"/>
                              </xs:restriction>
                            </xs:simpleType>
                          </xs:element>
                          <xs:element name="numberOfPages" type="xs:integer" minOccurs="0"/>
                          <xs:element name="numberOfNames" type="xs:integer" minOccurs="0"/>
                          <xs:element name="consideration" type="money" minOccurs="0"/>
                          <xs:element name="originalAmount" type="money" minOccurs="0"/>
                          <xs:element name="unpaidBalance" type="money" minOccurs="0"/>
                        </xs:all>
                      </xs:complexType>
                    </xs:element>
                  </xs:sequence>
                </xs:complexType>
              </xs:element>
              <xs:element name="stateQuestions" minOccurs="0">
                <xs:complexType>
                  <xs:sequence>
                    <xs:element name="question" minOccurs="1" maxOccurs="unbounded">
                      <xs:complexType>
                        <xs:all>
                          <xs:element name="id" type="xs:string" minOccurs="0"/>
                          <xs:element name="ernstQuestionId" type="xs:integer" minOccurs="0"/>
                          <xs:element name="description" type="xs:string" minOccurs="0"/>
                          <xs:element name="value" type="xs:string" minOccurs="0"/>
                        </xs:all>
                      </xs:complexType>
                    </xs:element>
                  </xs:sequence>
                </xs:complexType>
              </xs:element>
            </xs:all>
          </xs:complexType>
        </xs:element>
        <xs:element ref="transactionExtensions" minOccurs="0"/>
      </xs:sequence>
    </xs:complexType>
  </xs:element>
</xs:schema>

✅ The following is an 'Accepted' example payload to be returned in the HTTP response.

{
    "transactionHeader": {
        "transactionIdempotentId": "90039F81-73C1-4788-98BC-90553888D301",
        "transactionDate": "2022-07-11T02:03:40",
        "clientCode": "1799",
        "clientName": "AcmeInc",
        "vendorCode": "MC",
        "vendorName": "Mortgage Connect"
    },
    "transactionBody": {
        "transactionCode": "Acknowledgment",
        "transactionId": "7832143",
        "ackStatus": true,
        "ackMessage": "Accepted",
        "ackException": "",
        "responseType": "RateQuoteResponse",
        "response": {
            "transactionType": "Refinance",
            "message": "OK",
            "error": [],
            "loanNumber": "73201-3433",
            "state": "CA",
            "zipCode": "93950",
            "county": "Monterey",
            "address": "1234 Main St",
            "loanAmount": "200000",
            "rateQuoteId": "443328",
            "requestedTime": "2022-07-11T02:03:40",
            "rates": {
                "rate": [
                    {
                        "feeAmount": 380,
                        "feeName": "Title - Lenders Title Policy",
                        "hudLine": 1108
                    },
                    {
                        "feeAmount": 25,
                        "feeName": "Closing Protection Letter",
                        "hudLine": 1112
                    }
                ]
            },
            "recordingFee": {
                "fees": [
                    {
                        "feeAmount": 80,
                        "feeName": "Mortgage Recording Fee",
                        "hudLine": 1203
                    },
                    {
                        "feeAmount": 75,
                        "feeName": "Mortgage State Tax",
                        "hudLine": 1205
                    }
                ]
            },
            "document": {
                "documentId": "MC_Quote_445318",
                "name": "Rate_Quote.pdf",
                "fileType": "PDF",
                "contentMediaType": "application/pdf",
                "contentUnicodeTextEncodingType": "UTF8",
                "contentBinaryEncodingType": "Base64",
                "content": "Base64 String",
                "description": "Brief overview of the document"
            }
        } 
    },
    "transactionExtensions": {
        "transactionExtension": [
            {
                "key": "Client Specific Key 1",
                "value": "Client Specific Value 1"
            },
            {
                "key": "Client Specific Key 2",
                "value": "Client Specific Value 2"
            }
        ]
    }
}
/* Copyright © 2023 Mortgage Connect LP */

Accepted Acknowledgment payload is under construction. 🚧

⛔ The following is a 'Rejected' example payload to be returned in the HTTP response.

Rejected Acknowledgment payloads are typically message type agnostic.

Rejected Acknowledgment payloads are typically message type agnostic.

The Rate Quote API method is the mechanism in which a Client can submit a message to Mortgage Connect requesting a Rate Quote.

View Workflow Orchestration

Mortgage Connect URL

POST 🔒 https://{BaseUrl}/Api/V1.0/{ClientCode}/SubmitMessage

Mortgage Connect URL Properties

Property	Requirement	Description
BaseUrl	Required	A unique base Url that represents a specific Mortgage Connect endpoint and targeted environment.
ClientCode	Required	A unique code assigned to all clients that is used for identification, authentication, and customization purposes.

Property Definitions - Transaction Header

Defines the properties represented in the Transaction Header object (JSON) or node (XML). Note that this message artifact is identical for each and every message type.

View Transaction Header Details

Property Definitions - Transaction Body

Defines the properties represented in the Transaction Body object (JSON) or node (XML).

Property	Requirement	Data Type	Min / Max	Description
transactionBody	Required			A parent object (JSON) or node (XML) that contains the transaction metadata.
transactionCode	Required	String	10 / 10	A static value of `Rate-Quote`. The transaction code is meant to identify the message type and the context or action that should be taken. In this context it implies that a Rate Quote is being requested. Possible Values: Rate-Quote
transactionId	Required	String	1 / 50	Represents the Client's unique order number.
transactionType	Required	String	1 / 20	Represents the type of quote being requested. Possible Values: Purchase Refinance Home Equity Default Assumptions
loanNumber	Optional	String	1 / 10	The clients loan number `alpha-numeric`.
requestedTime	Optional	DateTime		The date and time the request was made. `Defaults to current date and time.`
state	Required	String	2 / 2	The property state abbreviation. Possible Values: AK, AL, AR, AS, AZ, CA, CO, CT, DC, DE, FL, FM, GA, GU, HI, IA, ID, IL, IN, KS, KY, LA, MA, MD, ME, MH, MI, MN, MO, MP, MS, MT, NC, ND, NE, NH, NJ, NM, NV, NY, OH, OK, OR, PA, PR, PW, RI, SC, SD, TN, TX, UT, VA, VI, VT, WA, WI, WV, WY.
zipCode	Required	String	5 / 5	The property zip code.
county	Required	String	1 / 32	The property county.
address	Optional	String	0 / 255	The property street address.
loanAmount	Required	Money		The loan amount
priorPolicyAmount	Optional	Money		The original Loan amount.
salesPrice	Optional*	Money		The sale price amount. *Required for transactionType of `Purchase.`
priorPolicyDate	Optional	Date		The date the previous policy was put into effect.
isPUD	Optional	Boolean		Indicates the request is for a Planned Unit Development. `Defaults to false.`
isCondo	Optional	Boolean		Indicates the request is for a Condominium. `Defaults to false.`
isMobileHome	Optional	Boolean		Indicates the request is for a Mobile Home. `Defaults to false.`
isTorrens	Optional	Boolean		Indicates the request is for Torrens Land. `Defaults to false.`
isWaterFrontBayOcean	Optional	Boolean		Indicates the request is for Waterfront Property. `Defaults to false.`
isWaterFrontRiverStream	Optional	Boolean		Indicates the request is for Waterfront Property. `Defaults to false.`
isLeaseHold	Optional	Bollean		Indicates the request is for a Lease Hold. `Defaults to false.`
texas50a6	Optional	Boolean		Indicates the request is for a Texas Section 50(a)(6) Loan. `Defaults to false.`
recordingDocuments	Required	Array		A parent object (JSON) or node (XML) that contains a list of documents. `(1 to Many)`
document	Required	Object		A parent object (JSON) or node (XML) that contains the metadata associated with the request.
documentType	Required	String	0 / 255	Represents the type of metadata contained in the document. Possible Values: Deed Mortgage Release
numberOfPages	Optional	Integer		The document page count.
numberOfNames	Optional	Integer		The document name count.
consideration	Optional	Money		The agreed upon purchase price for the property.
originalAmount	Optional	Money		The original loan amount.
unpaidBalance	Optional	Money		The portion of the original loan amount that is still outstanding.
stateQuestions	Optional	Array		A parent object (JSON) or node (XML) that contains a list of state questions. Submitting state questions is not currently supported. Default values will be used for developing the `Rate Quote`.
question	Required	Object		A parent object (JSON) or node (XML) that contains the metadata associated with the request. Not currently supported, future feature.
id	Optional	String		Not currently supported, future feature.
ernstQuestionId	Optional	Integer		Not currently supported, future feature.
description	Optional	String		Not currently supported, future feature.
value	Optional	String		Not currently supported, future feature.

Property Definitions - Transaction Extensions

Defines the properties represented in the TransactionExtensions object (JSON) or node (XML). Note that this message artifact is identical for each and every message type.

View Transaction Extension Details

Response Definition - Acknowledgment Response Properties

Property	Requirement	Data Type	Min / Max	Description
responseType	Required	String	17 / 17	A static value of `RateQuoteResponse`.
response	Required	String	1 / MAX	JSON/XML representation of the rate quote as defined in the next section.

Response Definition - Response Properties

Property	Requirement	Data Type	Min / Max	Description
transactionType	Required	String	1 / 20	Represents the type of quote being requested. Possible Values: Purchase Refinance Home Equity Default Assumptions
message	Optional	String	0 / MAX
error	Optional	String Array	0 / MAX
loanNumber	Optional	String	1 / 10	The clients loan number `alpha-numeric`.
state	Required	String	2 / 2	The property state abbreviation. Possible Values: AK, AL, AR, AS, AZ, CA, CO, CT, DC, DE, FL, FM, GA, GU, HI, IA, ID, IL, IN, KS, KY, LA, MA, MD, ME, MH, MI, MN, MO, MP, MS, MT, NC, ND, NE, NH, NJ, NM, NV, NY, OH, OK, OR, PA, PR, PW, RI, SC, SD, TN, TX, UT, VA, VI, VT, WA, WI, WV, WY.
zipCode	Required	String	5 / 5	The property zip code.
county	Required	String	1 / 32	The property county.
address	Optional	String	0 / 255	The property street address.
loanAmount	Required	Money		The loan amount
rateQuoteId	Required	Integer		Mortgage Connect's unique quotation identifier.
requestedTime	Optional	DateTime		The date and time the request was made.
rates	Required	Array		An array of rate objects generated in response to the Rate Quote request.
rate	Required			Represents a specific type of rate. `A list of all the Fee Names and Hud Lines will be provided during the onboarding process so that the client can account for the appropriate mapping of the data points in their LOS.`
feeAmount	Required	Money		The cost associated with a specified service or activity on a per unit basis.
feeName	Required	String	1 / 50	The type of service or activity that's to be provided.
hudLine	Required	String	1 / 50	HUD identifier.
recordingFees	Required	Array		An array of fee objects generated in response to the Rate Quote request.
recordingFee	Required			Represents a specific type of fee. `A list of all the Fee Names and Hud Lines will be provided during the onboarding process so that the client can account for the appropriate mapping of the data points in their LOS.`
feeAmount	Required	Money		The cost associated with a specified service or activity.
feeName	Required	String	1 / 50	The type of service or activity that's to be provided.
hudLine	Required	String	1 / 50	HUD identifier.
document	Optional			A parent object (JSON) or node (XML) that contains the metadata associated with a single document.
documentId	Optional	String	1/36	A string that uniquely identifies the document within the host system.
name	Optional	String	1 / 100	This is the user friendly name that is associated with the document.
fileType	Optional	String	3 / 4	This indicates what type of document it is. This in the context of what the file extension represents. Possible Values: DOC DOCX PDF Future Values: CSV HTML JSON TXT XLS XLSX XML `DOC`, `DOCX`, and `PDF` are currently supported with the vast majority of the documents being delivered as `PDF` documents. The other types are included to support additional documents in the future.
contentMediaType	Optional	String	1 / 100	This represents the content media type, i.e. `MIME Type`. Possible Values: application/msword (DOC) application/vnd.openxmlformats-officedocument.wordprocessingml.document (DOCX) application/pdf (PDF) Future Values: text/csv (CSV) text/html (HTML) application/json (JSON) text/plain (TXT) application/vnd.ms-excel (XLS) application/vnd.openxmlformats-officedocument.spreadsheetml.sheet (XLSX) application/xml (XML) At this time `application/msword (DOC)`, `application/vnd.openxmlformats-officedocument.wordprocessingml.document (DOCX)`, and `application/pdf (PDF)` are supported with `application/pdf (PDF)` being used 90+% of the time. The other types are added to support future media types.
contentUnicode TextEncodingType	Optional	String	4 / 4	This indicates what unicode text encoding type was used to generate the document. Possible Values: UTF8
contentBinary EncodingType	Optional	String	6 / 6	This indicates what binary encoding type was used to generate the document content. Possible Values: Base64
content	Optional	String	1 / MAX	This represents the digital representation of the document after it has been encoded using Base64. See: https://en.wikipedia.org/wiki/Base64 for more information regarding Base64 formatting.
description	Optional	String	0 / 255	Provides a brief overview of the document contents.

Mapping Artifacts

The following sections highlight internal Mortgage Connect artifacts such as Document Types, Product Codes, etc. that will need mapped by the client to their corresponding internal code.

Product Codes

The following section defines the Mortgage Connect Title Product Codes. These product codes need to be mapped to the client's corresponding product name or code.

The actual subset of supported Product Codes will be determined during the onboarding process.

You can download the following table contents in the form of an Excel, CSV, or PDF file by clicking on of the following icons.

Product Code Downloads:

Type	Product Code	Client Product Name / Code
Closing	ADVF - ADVANCE FEE
Closing	ASGN - ATTORNEY REMOTE SIGNING
Closing	CCOM - COMMERCIAL CLOSING
Closing	CEMA - CEMA CLOSING WITH INSURANCE
Closing	CEMW - CEMA CLOSING W/O INSURANCE
Closing	CFA - CLIENT BRANCH CLOSING
Closing	CMAA - CEMA ATTORNEY FEE
Closing	COC - CASH OUT/HELOC CLOSING WITH INSURANCE
Closing	CPC - Commercial Purchase Closing
Closing	CPIG - PIGGYBACK CLOSING
Closing	CPUR - PURCHASE CLOSING
Closing	CPWO - PURCHASE CLOSING W/OUT INSURANCE
Closing	CREV - REVERSE MORTGAGE CLOSING
Closing	CRF - COURIER FEE
Closing	CRN - CLOSING RE-SIGN
Closing	CRVO - REVERSE MORTGAGE CLOSING W/OUT INSURANCE
Closing	CSC - CORE CLOSING SERVICES
Closing	CWI - CLOSING WITH INSURANCE
Closing	CWO - CLOSING W/OUT INSURANCE
Closing	DDRQ - DOCUMENT REQUEST - DEFAULT
Closing	DERQ - DEED REQUEST - Closing
Closing	DIL - DEED IN LIEU
Closing	DISB - DISBURSEMENT
Closing	DOCF - DOCUMENT PREPARATION FEE
Closing	DOCP - DOCUMENT PROCESSING
Closing	ECEM - CEMA W/eCLOSING
Closing	ECOM - E COMMERCIAL CLOSING
Closing	ECPR - E PURCHASE CLOSING
Closing	ECRN - E CLOSING RE-SIGN
Closing	ECRV - E REVERSE MORTGAGE CLOSING
Closing	ECWI - E CLOSING WITH INSURANCE
Closing	ECWO - E CLOSING W/OUT INSURANCE
Closing	EMD - EMAIL DOCS
Closing	EPIG - E PIGGYBACK CLOSING
Closing	ESCR - ESCROW SERVICE ONLY
Closing	F2C - TEXAS CONVERSION LOAN
Closing	HCWI - HYBRID CLOSING WITH INSURANCE
Closing	HCWO - HYBRID CLOSING WITHOUT INSURANCE
Closing	HDDB - HUD AND DISBURSEMENT ONLY
Closing	HUD - HUD ONLY
Closing	LMOD - LOAN MODIFICATION
Closing	MCCF - COORDINATION CLOSING
Closing	OTH - OTHER FEE
Closing	PCDF - Prepare CDF
Closing	PCRN - PAID CLOSING RESIGN
Closing	PCV - POST CLOSING VALIDATION
Closing	PGPU - PURCHASE W/PIGGYBACK CLOSING
Closing	PHON - ATTORNEY PHONE CALL CLOSING
Closing	PIG - PIGGYBACK CLOSING
Closing	PIGO - PIGGY BACK SIGNING ONLY
Closing	PMOD - PRE-LOAN MODIFICATION
Closing	PRCD - Prepare Revised CDF
Closing	PRTF - PRINT FEE
Closing	PRTP - RESIGN/TRIP FEE
Closing	PSGO - PIGGY SIGNING ONLY
Closing	PSNO - PURCHASE SIGNING SERVICE
Closing	PTF - PRINT AND TRIP FEE
Closing	RCWI - REO CLOSING
Closing	RCWO - REO CLOSING
Closing	REVP - REVERSE PURCHASE
Closing	RSO - RON SIGNING ONLY
Closing	SGNO - SIGNING SERVICE ONLY
Closing	SIGN - SIGNING FEE
Closing	STRM - STREAMLINE CLOSING
Closing	SUB - SUBCONTRACTOR FEE
Closing	SUBE - SUB-ESCROW
Closing	TCC - TITLE CLOSER CLOSING
Closing	TCW - TAX CERT/COURIER/WIRE FEE
Closing	TRDC - TRAILING DOCS
Closing	TRPF - TRIP FEE
Closing	TTC - TITLE CLOSER
Closing	WCWI - WEB RATE - CLOSING WITH INSURANCE
Title	1023 - 1023
Title	2OPR - 2 Owner Property Report
Title	30YS - 30 YEAR SEARCH REQUIREMENTS
Title	40YS - 40 YEAR SEARCH REQUIREMENTS
Title	50YS - 50 YEAR SEARCH REQUIREMENTS
Title	A2PT - Dual Assignment Property Report
Title	ABF - ABSTRACTING FEE
Title	ACOT - ADDITIONAL CHAIN OF TITLE
Title	ACUP - Attorney Certification Update
Title	ADF - ADVANCE FEE
Title	ADMN - Administrative Fee
Title	ADOC - Assignment Document Prep
Title	ADV - ADVANCE RECORDING FEE
Title	APRT - Assignment Property Report
Title	ARC - ATTORNEY RECORDING CERTIFICATION
Title	AREC - Assignment Recording
Title	ARF - ATTORNEY REVIEW FEE
Title	ASTR - Assumption Transfer
Title	ATC - ATTORNEY CERTIFICATION
Title	ATSO - AUDIT TITLE SEARCH ONLY
Title	AUDP - AUDIT - PROPERTY
Title	AUDT - AUDIT - TITLE
Title	BANK - BANKRUPTCY SEARCH
Title	BENE - Benecheck
Title	BIND - TITLE BINDER FEE
Title	BLVR - BASIC LEGAL AND VESTING
Title	BPRT - BASIC PROPERTY REPORT
Title	CATO - CALIFORNIA TITLE ONLY
Title	CCM - CERTIFIED COPY MTG/DOT
Title	CDDL - DEMAND LETTER - COLLATERAL DEFICIENCIES
Title	CDMR - MANAGER REVIEW - COLLATERAL DEFICIENCIES
Title	CDOC - CURATIVE DOCUMENT PREP
Title	CDPS - POLICY SEARCH - COLLATERAL DEFICIENCIES
Title	CDRP - REPLACEMENT POLICY - COLLATERAL DEFICIENCIES
Title	CDRR - RECORDABLE CERT COPY - COLLATERAL DEFICIENCIES
Title	CDRS - RECORDABLE SEARCH - COLLATERAL DEFICIENCIES
Title	CFUL - FULL SEARCH- CAPITAL MARKETS
Title	CHAN - Chancery Abstracts
Title	CJUD - Creation of Judgement Contin
Title	CLVR - LEGAL AND VESTING - CAPITAL MARKETS
Title	COMM - COMMITMENT FEE
Title	CONT - CONTRACT PREPERATION
Title	COO - CERTIFICATE OF OCCUPANCY
Title	COOP - CO-OP LIEN REPORT
Title	COPY - COPY FEES
Title	CORP - Good Standing and Lien Cert
Title	CPL - CLOSING PROTECTION LETTER
Title	CPRC - PRT WITH COPIES- CAPITAL MARKETS
Title	CPRT - PROPERTY REPORT - CAP MARKETS
Title	CPTH - Connect Path
Title	CPTU - Connect Path - Update
Title	CSOC - CORE SERVICES - ORANGE COAST
Title	CSRA - CORE SERVICES - REAL ADVANTAGE
Title	CTP - COMMERCIAL TITLE PURCHASE
Title	CTS - COMMERCIAL TITLE
Title	CTWO - TWO OWNER - CAPITAL MARKETS
Title	CUPT - UPDATE- CAPITAL MARKETS
Title	CURE - Curative
Title	CWCT - CWCOT - REDACTED
Title	CWRP - REPLACEMENT POLICY - WORKSHARE
Title	DCR - DEED COPY REPORT
Title	DGRD - DEFAULT GRADING
Title	DHOA - HOA - DEFAULT
Title	DLEN - DEFAULT LIEN
Title	DLPD - DIL Product Delivery
Title	DMLC - DEFAULT MUNICIPAL LIEN SEARCH
Title	DMON - MONITOR DEFAULT
Title	DMVR - Default Mortgage Verification Report
Title	DOCR - DOCUMENT RETRIEVAL
Title	DPLC - Data Placeholder
Title	DRF - DOCUMENT REVIEW FEE
Title	DTAX - DEFAULT TAX SEARCH
Title	DTPL - Default Title Placeholder
Title	DTUP - DEFAULT TAX UPDATE
Title	DUHO - HOA UPDATE - DEFAULT
Title	DUML - DEFAULT MLC - UPDATE
Title	EARC - Electronic Assignment Recording
Title	EDCF - E-Document Coordination Fee
Title	EDEL - Electronic Document Delivery
Title	ELRC - Lien Release Recording
Title	EMRS - EMERGENCY REPAIR SEARCH
Title	EPOL - POLICY & ERECORDING
Title	EPRC - PROPERTY REPORT ERECORDING
Title	EREC - ERECORDING
Title	ERF - E-RECORDING FEE
Title	ERR - EXTRAORDINARY RISK RATE
Title	EUPT - ERECORDING UPDATE
Title	FCTP - Foreclosure Title Policy
Title	FIRE - FIRE SEARCH
Title	FJR - Final Judicial Report
Title	FLDS - FLOOD SEARCH
Title	FLSC - FLORIDA SURCHARGE
Title	FLVR - FINAL WARRANTY WITH LVR
Title	FPRT - FINAL WARRANTY WITH PRT
Title	FULL - FULL SEARCH
Title	GRMA - GRMA FEE
Title	HARP - HARP Title
Title	HBS - HOUSING & BUILDING SEARCH
Title	INRL - BPO IN RREAL CETIFICATE
Title	JLP - JUNIOR LIEN POLICY
Title	JUDS - JUDGMENT SEARCH
Title	L2PT - Dual Lien Release Property Report
Title	LAFE - Lender Attorney Fee
Title	LDOC - Loan Mod Doc Generation
Title	LIEN - LIEN
Title	LITG - Litigation Guarantee
Title	LIVR - Lien Verification Report
Title	LMPD - Loan Mod Product Delivery
Title	LMTR - LOAN MODIFICATION TRACKING
Title	LPR - Limited Property Report
Title	LPRT - Lien Release Property Report
Title	LREC - Lien Release Recording
Title	LVR - LEGAL & VESTING REPORT
Title	LVRO - Lien Verification Report Online
Title	LXAM - LOAN MOD EXAM
Title	MDLC - Maryland Lien Cert
Title	MFC - Mortgage Foreclosure Certificate
Title	MLC - MUNICIPAL LIEN CERTIFICATE
Title	MPUF - MULTI-PARCEL UNDERWRITING FEE
Title	NOS - NOTICE OF SETTLEMENT FEE
Title	NPI - NO POLICY ISSUED
Title	NYS - NY SALES TAX
Title	OE - OWNERSHIP & ENCUMBRANCE
Title	OMS - OPEN MORTGAGE SEARCH
Title	OOS - ONE OWNER SEARCH
Title	OPOL - POLICY & RECORDING (ONLINE SEARCH)
Title	OPRC - PROPERTY REPORT RECORDING (ONLINE SEARCH)
Title	OUPT - RECORDING UPDATE (ONLINE SEARCH)
Title	OV - Original's Vault
Title	OXAM - ORIGINATIONS EXAM
Title	PAS - Printed Document Delivery
Title	PFCF - Pre-Foreclosure Report Full
Title	PFCL - Pre-Foreclosure - Two Owner
Title	PHOA - HOA- PURCHASE
Title	PJR - Preliminary Judicial Report
Title	PJRE - Preliminary Judicial Report with Endorsement
Title	PMLC - PURCHASE MUNICIPAL LIEN SEARCH
Title	POL - POLICY & RECORDING
Title	POLO - POLICY ONLY
Title	PPG - PIGGYBACK W/OUT INSURANCE
Title	PPRE - PROPERTY PROFILE REQUEST
Title	PRC - PROPERTY REPORT RECORDING
Title	PRDS - PROBATE DEATH SEARCH
Title	PREM - PREMIUM TAX
Title	PRLM - Property Report Loan Mod
Title	PRLP - Property Report with Pertinent Copies
Title	PROC - PROPERTY REPORT WITH TITLE CLEARANCE
Title	PRT - PROPERTY REPORT
Title	PRTC - Property Report with copies
Title	PSAL - FINTRAC PRESALE
Title	PTS - PATRIOT SEARCH
Title	PUHO - HOA UPDATE - PURCHASE
Title	PUML - MUNICIPAL UPDATE- PURCHASE
Title	PUR - PURCHASE
Title	PURO - TITLE ONLY PURCHASE
Title	PURP - PURCHASE PIGGYBACK
Title	PXAM - PFCL EXAM
Title	QARC - Assignment Reconciliation Services
Title	QCAV - Commercial AVR
Title	QCRP - Non-Billable Search
Title	QDRT - Doc Retrieval
Title	QPOL - CapMkts Policy Revenue or Charges
Title	QRGL - Remediation of Intervening/Gap Assignment
Title	QRGP - Remediation of Intervening/Gap Assignment
Title	QRMA - Reverse Mortgage AVR
Title	QTDR - County record pull of specifically identified documents
Title	QTUP - Traditional Update
Title	RATC - REPLACEMENT ATTY CERT
Title	RCEM - CEMA PROJ. RECORDING
Title	RDOC - Lien Release Document Prep
Title	REC - RECORDING
Title	RECO - MODIFICATION RECORDING
Title	REFI - INSTITUTIONAL LENDER SEARCH
Title	REM - REMITTANCE
Title	REO - FORECLOSURE
Title	REOS - REO TITLE SEARCH
Title	RFLA - INSTITUTIONAL LENDER SEARCH - LA
Title	RMTG - MORTGAGE PROJ. RECORDING
Title	RPOL - Replacement Policy - Final
Title	RPU1 - PURCHASE PROJ. RECORDING
Title	RREC - Re-Recording
Title	RSF - RECORDING SERVICE FEE
Title	RWB - RECORDING W/BRINGDOWN
Title	RWOB - RECORDING W/OUT BRINGDOWN
Title	SIDE - SIDEWALK VIOLATION SEARCH
Title	SIMP - SIMPLIFILE
Title	SREF - SHORT REFINANCE
Title	STM - STREET MAINTENANCE
Title	STR - STREET REPORT
Title	SVS - SIDEWALK VIOLATION SEARCH
Title	TAD - TITLE ADDENDUM
Title	TADJ - TITLE PREMIUM ADJUSTMENT
Title	TASK - REPLACEMENT POLICY ADDITIONAL CHARGE
Title	TAX - TAX SEARCH
Title	TCPF - Title Commitment Post Foreclosure
Title	TDIL - 2 Owner DIL
Title	TEND - TITLE ENDORSEMENT
Title	TEXM - TITLE EXAM
Title	TGAR - TX Guaranty Assessment Recoupment Charge
Title	TIDE - TIDELAND SEARCH
Title	TIEF - Title Insurance Enforcement Fund Fee
Title	TPG - PIGGYBACK W/INSURANCE
Title	TPLC - TITLE PLACEHOLDER
Title	TPRM - TITLE PREMIUM
Title	TREV - REVERSE MTG TITLE INSURANCE
Title	TSDL - Title Search Deed in Lieu
Title	TSG - Trustee Sale Guarantee - Full
Title	TSGL - Trustee Sale Guarantee - Limited
Title	TSO - TITLE SEARCH ONLY
Title	TTL - TITLE INSURANCE
Title	TTLC - TITLE CLEARANCE AND TAX ONLY
Title	TTLN - ALTA Loan Mod
Title	TTLO - TITLE INSURANCE ONLY
Title	TTLP - ALTA with Pertinent Copies
Title	TTLW - ALTA with Copies
Title	TUP - TAX UPDATE
Title	TWOO - TWO OWNER SEARCH
Title	TYPE - EXTERNAL DATA ENTRY
Title	UCC - UCC SEARCH
Title	UCC1 - UCC1 FILING
Title	UCC3 - UCC3 FILING
Title	UCS - UPPER COURT SEARCH
Title	UPGR - UPGRADE
Title	UPT - UPDATE
Title	UTAX - Tax Utility
Title	UTUP - Tax Utility Contin
Title	UXAM - UPDATE EXAM
Title	VDSB - VENDOR DISBURSEMENT
Title	VIST - INSTITUTIONAL LENDER SEARCH
Title	VRI - VERIFY RECORDING/ASSIGNMENT INFO.
Title	WIRE - WIRE TRANSFER
Title	WORK - WORK CHARGE

Document Types

The following section defines the Mortgage Connect Title Document Types. These document types need to be mapped to the client's corresponding document type name or code.

You can download the following table contents in the form of an Excel, CSV, or PDF file by clicking on of the following icons.

Document Type Downloads:

Document Type Name	Client Document Type Name / Code
10 Day
10 Day Mailing
1003
30 Day Mailing
3157-HAMP
3179-FNMA
4506T ESign Cert
4506T Tax Returns
5 Day
5 Day Mailing
AB6 NV Deposit for FCL Mediation
AB6 NV Deposit for State General Fund
Additional Work Charge
AFFIDAVIT OF AFFIXTURE
Affidavit of Erroneous Recording
Affidavit Recording
Affidavit Sub by Code
AFFIDAVIT TO BE SIGNED AT CLOSING
After Sale Endorsement
ALTA Commitment with Full copies
ALTA Commitment with Pertinent copies
Amended NOS Recording
AoAff
Appointment of Substitute Trustee
Appointment of Successor Trustee
Appointment of Trustee
Archwell Commitment
Arizona Commitment
ASSESSMENT INFORMATION
Assessment Lien / HOA
ASSIGNMENT
Assignment - Gap
Assignment - Last
Assignment - Merger/ACQ
Assignment of Certificate of Sale
Assignment of Deed
Assignment of Deed of Trust
ASSIGNMENT OF LEASE AND RENTS
Assignments of Rents
Attorney Authorization
ATTORNEY CERTIFICATION
Attorney Certification/OK to Disburse
Attorney Certification/OK to Record
AUDIT SEARCH
BANKRUPTCY DOCUMENTS
Bankruptcy Search
Bargain and Sale Deed
Benecheck
Benecheck Order
Black Box Checklist
BOA Wiring Instructions
BORROWER AUTHORIZATION
Borrower Executed Document - Fail
Borrower Executed Document - Pass
Cancellation
Cancellation of NOS Recording
Cancellation Of Notice Of Sale
Cash Sale Deed
CEMA
CEMA Assignment
CEMA Authorization
CEMA Processing Documents
Certificate of Mediation
CERTIFICATE OF OCCUPANCY SEARCH
Certificate of Occupancy Search
Certificate of Sale
Certificate of Title
CERTIFICATION OF TRUST
Certified Copies
CHECK REQUEST
CHILD SUPPORT SEARCH
Citi Lien
Clear to Close Bundle
CLEAR TO CLOSE CERTIFICATION
CLEAR TO CLOSE RECERT
Clear2Go Report Search
Close end Mortgage
Collaboration worksheet
Collateral Docs from Lender
Commission Statement
COMMITMENT
Commitment Eff. Date
Commitment from 1st National Title of UT
Commitment from Attorney Traystman
COMMITMENT FROM CAPITAL TITLE
Commitment from Cherokee Capital Abstract and Title
COMMITMENT FROM ENTITLE
Commitment from Equity Title
Commitment from Lawyers
COMMITMENT FROM Metro Title
Commitment from OC
Commitment from OK Land Title
Commitment from Old Republic
COMMITMENT FROM PIONEER
Commitment from Precision Title of AZ
Commitment from Provider
Commitment from RA
Commitment from TICOR
Commitment from Title Co in ND
Commitment from WFG
COMMITMENT PACKAGE
Compliance Affidavit Recording
Condominium Unit Deed
Confirmation Letter
Consolidated Mortgage
Consolidation
Continuation of UCC
Copies
Corp Docs (LLC)
Corporation Grant Deed
Corrective Assignment
Corrective Deed
Corrective Trustee's Deed
Courtesy Endorsement
Cover Sheet
CPL
Credit Line Mortgage
CREDIT REPORT
Curative
Curative Documentation
Currrent Deed
Customer Documentation
Customer Recorded Modification
Customer Unrecorded Modification
Datedown
Death Certificate
Declaration of Value
Deed Bundle
DEED COPY
DEED COPY (LVR)
Deed from Vendor
Deed In Lieu
Deed in lieu of foreclosure
Deed in Trust
DEED OF TRUST
Deed of Trust w/o Maturity Date
Default Mortgage Verification Report
DefaultInvoice
DISBURSEMENT LEDGER
Docs Sent to County
Document Copies
Document Name
Document Transfer Tax Fee
Documents pulled from Prior File
Documents To Record
DOT Re-Recording
E & O INSURANCE
E&O
E-Filing Recording
Elimination Endorsement
EMD Confirmed
EMERGENCY REPAIR SEARCH
Emergency Repair Search
Entitle Closing Package
Entitle Commitment
Executor/Administrator Deed
EXHIBIT A
External CEMA Requirements
FEE SHEET
Fiduciary Deed
Final Assignment
Final Judgment of Foreclosure
Final Lien Release
FINAL TITLE BILL
Final Title Package
Final Title Policy
Final Water
FIRE SEARCH
Fire Search
Fixed Rate Home Equity Conversion Mortgage
Flueid Decision Report
Foreclosure Deed
Foreclosure Title Policy
Foreclosure Title Policy Package
FPS Direct Commitment
Fraud Report
Freddie 5161
FSE Search
GAP Mortgage
Garbage Cert
General Endorsement
General Warranty Deed
GFE
Gift Deed
GIRunSheetReport
GOOD FUNDS
Grade Report
Grade Sheet
Graded Property Report
Graded Title Commitment
Grading Sheet
Grant Deed
Greenbelt Search
GUARANTEE POLICY
Hazard Insurance
HOA
HOA Transfer Fee
Home Equity Property Report
Home Warranty
HOUSING AND BUILDING SEARCH
Housing and Building Search
HUD-MOD
In-Sale Deed
Initial Fee Estimate
Initial Title Bundle
Internal
Interspousal Deed
Invoice to client
IRS Lien
JUDGMENT/LIEN REPORT
Last Deed of Record
Legal and Vesting
Legal Description
Lender Title Package
Lien Cert
Lien Release
Lien Verification Report
Lien Verification Report Package
Limited Property Report
Limited Property Report Package
Lis Pendens
LIS Pendens Recording
Litigation Documents
Litigation Guarantee
Litigation Guarantee Package
Loan disclosures
Loan Modification Invoice
LOAN POLICY
Loan?Disclosures?To?Be?Signed
Lost Assignment Affidavit
Lost Note Affidavit
Mailing
MAP
MARKED UP COMMITMENT
MarriageCertificate
MCLegalAndVestingReport
MCPropertyReport
MD Lien Cert
MERS
Miscellaneous Document
Miscellaneous Recording
Modification
Mortgage Modification Policy
Mortgage without Maturity Date
Municipal Inspections
Non-Compliance
Non-Identity Affidavit
Notice of Default
Notice of Rescission
Notice of Resignation of Trustee
Notice of Sale
Notice of Trustee Sale
NV Mediation Form
NY CEMA MORTGAGE SCHEDULE
NY DISBURSEMENT LEDGER
NY EXHIBIT A
NY SCHEDULE A
NY SCHEDULE B
NY TITLE REPORT PACKAGE
NYCOMMITMENT
Online Search Package
Open Mortgage
Open-end Deed of Trust
Open-end Mortgage
Order confirmation
Order Update
ORIG REC DEED
ORIG REC RELEASE/SATISFACTION
ORIG REC SUB
ORIG REC. MTG/DOT
Other Endorsement
Other from Provider
Out-Sale Deed
OWNER'S POLICY
Package Not Audited
Partial Claim
Partial Reconveyance
Partial Release
Patriot Search
PATRIOT SEARCH HIT
PAYOFF
PAYOFF - UPDATED
PAYOFF 2ND
PAYOFF 2ND - UPDATED
PAYOFF DEMAND
Personal Representative's Deed
PGW Gas
Philadelphia L&I
Photo ID
PIRunSheetReport
PJR_Endorsement
PLAT MAP
POLICY CHECKLIST
POLICY REQUEST PACKAGE
POST CLOSING CLEARANCE ISSUES
Power of Attorney
PRE HUD
PRE-AUDIT DOCUMENT PACKAGE
Pre-Foreclosure FJR
Pre-Foreclosure Framed
Pre-Foreclosure MFG
Pre-Foreclosure Unframed
Pre-Foreclosure Update
PreJudicial
Prelim
Preliminary Attorney Certification
Preliminary Title Report
Prior Policy
Product Copies
Property Report
Property Report Plus
Property Report with Full Copies
Property Report with Pertinent Copies
Publication Endorsement
PUD
Purchase Agreement
QC Audit
QC Checklist
QC TSG
QCD
Quit Claim Deed
Quote
Re-Recorded Deed
Re-Recorded Deed of Trust
Re-recorded Mortgage
Real Estate Transfer Tax – WA
RealEC Commitment
RealEC Order Confirmation
Reconveyance
RECORDABLE COPY FOUND
Recorded Assignment
RECORDED ASSIGNMENT/MTG/CEMA
RECORDED ASSIGNMENT/MTG/CEMA/POA
RECORDED CEMA
RECORDED CHECK COPY
RECORDED DEATH CERT
RECORDED DEED
RECORDED DEED/CEMA
RECORDED DEED/MTG
RECORDED DEED/MTG/CEMA
RECORDED DOCS(ALL)
RECORDED LEASE
RECORDED LIEN
Recorded Loan Modification
RECORDED MISC. DOCS
RECORDED MODIFICATION
RECORDED MORTGAGE
RECORDED MTG AND CEMA
Recorded Notice of Default
Recorded Notice of Rescission
Recorded Notice of Sale
RECORDED NOTICE OF SETTLEMENT
Recorded Partial Claim
RECORDED POA
RECORDED RELEASE
RECORDED SATISFACTION
RECORDED SUBORDINATION
RECORDED SUBSTITUTION FOR TRUSTEE
Recorded Substitution of Trustee
RECORDED UCC 1 FINANCE STATEMENT
RECORDED UCC 3 FINANCE STATEMENT
Recorder Assignment
RECORDING CONFIRMATION
RECORDING CONFIRMATION FROM LAWYERS
RECORDING CONFIRMATION FROM VENDOR
RECORDING CONFRIMATION FROM OC
Recordings
REFUND CHECK
REGIONS HE BUNDLE
RELEASE
Release / Satisfaction of Mortgage
Release Deed
Release of Lis Pendens
REO Title Work
Request for Notice
Rescinded loan package
Rescission of Assignment
Rescission of NOD Recording
Rescission of Partial Reconveyance
Rescission of Reconveyance
Rescission of Trustee's Deed Upon Sale
Resignation of Trustee Recording
REVERSE MORTGAGE
Revised Limited Property Report Package
Revised Property Report
REVISED TITLE COMMITMENT
Run Sheet
Sale Endorsement
SB1137 NOD
SB1137 NOD Declaration
SB1137 NOS Declaration
SC ATTORNEY APPROVAL LETTER
SCHEDULE A
SCHEDULE B
Scrivener's Affidavit
Search
Search Package
SEARCH UPLOADED TO ENTITLE SITE
Security Deed
SENIOR DEFAULT DOCUMENTS
Sewer Cert
Sheriff's Deed
Signing Service Document
Special Warranty Deed
Start Over Endorsement
Start Over Notice of Default
Start Over Notice of Sale
State Tax Lien
Statement of Information
Statutory Warranty Deed
Street Maintenance
STREET REPORT SEARCH
Street Report Search
Streets Dep Lien Letter
SUB - MC HAS ORIGINAL IN FILE
SUB - SOFT COPY EXECUTED
Sub Assoc
Sub from Borrower - MC has Original in File
SUB REQS SENT TO SUB LENDER
SUB REQUIREMENTS SENT TO CLIENT
Subordinate Mortgage
SUBORDINATION
SUBORDINATION - INTERNAL - APPROVED BY TITLE PROVIDER
Subordination Agreement
Subordination of Deed of Trust
Subordination of Mortgage/Agreement
Substitute trustee Deed
Substitution of Trustee
Supporting docs
Supporting Search Docs
SURVEY
SURVEY FROM BORROWER
TAX AUDIT
TAX CERTIFICATION
Tax invoice
Tax Lien
Tax Property Sheet
TAX SEARCH FROM ONLINE
Tax Search From Vendor
TAX SHEET
Tax Update
Tax/ Lien Search Ordered
Taxes
Tideland Search
Title Abstract
Title Bill
Title Borrower Docs
Title Cancel File
Title Chain
Title Closing Affidavit
Title Closing package
Title Commitment Xml
Title Company Forms
TITLE DECISION
Title Deed Vesting
Title Disbursement Ledger
Title FedEx Label
Title Grading Sheet
Title HOI Invoice
Title Mortgage Statement
Title Order
TITLE OVERNIGHT LABEL
Title Package
Title Policy Retrieval
Title Privacy Policy
Title Signed Docs
Title Signed Docs PreQC
Title Supplement
TitleSummary
Transmittal
TRUST
Trustee Deed
Trustee's Deed Upon Sale
Trustees Deed Upon Sale for Reverted
TSG
TSG Cover Letter
TSG MAP
TSG Order Form
TSG-Limited
UCC
UCC 1 FINANCE STATEMENT
UCC 3 FINANCE STATEMENT
UCC Assignment
Ungraded Completed Package
Ungraded Completed Update Package
Ungraded Property Report
Ungraded Revised Completed Package
Ungraded Revised Completed Update Package
Ungraded Title Commitment
Unit Deed
Unrecorded Assignment
Unrecorded Deed
Unrecorded Modification
Unrecorded Notice of Default
Unrecorded Notice of Rescission
Unrecorded Notice of Sale
Unrecorded Partial Claim
Unrecorded Satisfaction
Unrecorded Signed Documents
Unrecorded Substitution of Trustee
Unreviewed Completed Product
Unsigned Policy
Update Benecheck
Update Final Judicial Report
Update Mortgage FC Certificate
Update Preliminary Judicial Report
Update Trustee Sale Guarantee
Update Uploaded to Entitle
Updated Commitment from Provider
Updated FeeSheet
Updated Graded Property Report
Updated Graded Title Commitment
Updated Lien Verification Report
Updated Lien Verification Report Package
Updated Limited Property Report Package
Updated Search
Updated UnGraded Property Report
Updated Ungraded Title Commitment
Upper Court Search
Valutrust Commitment
Vesting Deed
VESTING INFORMATION
WA State Sales Tax
Warranty Cert
Warranty Cert (LVR)
Warranty Certificate
Warranty Deed
Warranty Deed with Vendor's Lien
WATER AND SEWER
Water Cert
Water/Sewer
WELCOME LETTER
WIRE INSTRUCTIONS
Writ of Execution
X1 ATO Report
X1 Copies
X1 Decision Report
X1 General Index History
X1 Masked Decision Report
X1 Property History
X1 Report
X1 Update Report
Xpanse Commitment
Zoning

Client Code & Ids

The ClientCode and ClientId(s) will be assigned during the onboarding process.

Validation

The following sections provide details regarding the JSON and XML schema validation specifications.

Common Schema Types

👍 The Root Schema Definition for Shared Objects.

/* Copyright © 2023 Mortgage Connect LP */
{
    "description": "Copyright @ 2022 Mortgage Connect LP - Title & Tax Schema.",
    "$id": "root",
    "$schema": "http://json-schema.org/draft-07/schema#",
    "type": "object",
    "properties": {
        "legalHeader": {
            "type": "object",
            "properties": {
                "version": {
                    "type": "string",
                    "examples": [
                        "0.8 Beta"
                    ],
                    "minLength": 1,
                    "maxLength": 20
                },
                "disclosingParty": {
                    "type": "string",
                    "examples": [
                        "Copyright @ 2022 Mortgage Connect LP"
                    ],
                    "minLength": 1,
                    "maxLength": 100
                },
                "proprietaryInformationAndConfidential": {
                    "type": "string",
                    "examples": [
                        "Ownership of Proprietary Information. The Recipient agrees that it shall not receive any right, title or interest, or any license or right to use, the Disclosing Party’s Proprietary Information, including, but not limited to, technology, ideas, concepts, drawings, documentation, designs, prototypes, processes, trade secrets, trademarks or other intellectual property rights therein, by implication or otherwise."
                    ],
                    "minLength": 1,
                    "maxLength": 2000
                }
            },
            "required": [
                "version",
                "disclosingParty",
                "proprietaryInformationAndConfidential"
            ],
            "additionalProperties": false,
            "maxProperties": 3,
            "minProperties": 3
        },
        "transactionHeader": {
            "type": "object",
            "properties": {
                "transactionIdempotentId": {
                    "type": "string",
                    "pattern": "^[\\da-fA-F]{8}-[\\da-fA-F]{4}-[\\da-fA-F]{4}-[\\da-fA-F]{4}-[\\da-fA-F]{12}$",
                    "examples": [
                        "3B34A671-BB17-400D-90BF-7CBF9C96E8ED"
                    ],
                    "minLength": 36,
                    "maxLength": 36
                },
                "transactionDate": {
                    "type": "string",
                    "format": "date-time",
                    "examples": [
                        "2022-07-11T02:03:40"
                    ]        },
                "clientCode": {
                    "type": "string",
                    "format": "integer",
                    "examples": [
                        "1799"
                    ],
                    "minLength": 1,
                    "maxLength": 100
                },
                "clientName": {
                    "type": "string",
                    "examples": [
                        "AcmeInc"
                    ],
                    "minLength": 1,
                    "maxLength": 100
                },
                "vendorCode": {
                    "type": "string",
                    "minLength": 1,
                    "maxLength": 100
                },
                "vendorName": {
                    "type": "string",
                    "minLength": 1,
                    "maxLength": 100
                }
            },
            "required": [
                "transactionIdempotentId",
                "transactionDate",
                "clientCode",
                "clientName",
                "vendorCode",
                "vendorName"
            ],
            "additionalProperties": false,
            "maxProperties": 6,
            "minProperties": 6
        },
        "transactionBody": {
            "$ref": "TransactionType#"
        },
        "transactionExtensions": {
            "type": "object",
            "properties": {
                "transactionExtension": {
                    "type": "array",
                    "items": {
                        "type": "object",
                        "properties": {
                            "key": {
                                "type": "string",
                                "examples": [
                                    "Client Specific Key"
                                ],
                                "minLength": 1,
                                "maxLength": 200
                            },
                            "value": {
                                "type": "string",
                                "examples": [
                                    "Client Specific Value"
                                ],
                                "minLength": 1
                            }
                        },
                        "required": [
                            "key",
                            "value"
                        ],
                        "additionalProperties": false,
                        "maxProperties": 2,
                        "minProperties": 2
                    },
                    "minItems": 0
                }
            }

        }
    },
    "required": [
        "transactionHeader",
        "transactionBody"
    ],
    "additionalProperties": false,
    "maxProperties": 4,
    "minProperties": 2
}

/* Copyright © 2023 Mortgage Connect LP */

👍 The Common Schema Definition for Shared Objects.

/* Copyright © 2023 Mortgage Connect LP */
{
    "$id": "CommonTypes",
    "$defs": {
        "address": {
            "type": "object",
            "properties": {
                "address1": {
                    "type": "string",
                    "examples": [
                        "1204 New York Drive"
                    ],
                    "maxLength": 255
                },
                "address2": {
                    "type": "string",
                    "examples": [
                        "1204 New York Drive"
                    ],
                    "maxLength": 255
                },
                "city": {
                    "type": "string",
                    "examples": [
                        "Mckees Rocks"
                    ],
                    "maxLength": 32
                },
                "state": {
                    "type": "string",
                    "examples": [
                        "PA"
                    ],
                    "enum": [
                        "AK",
                        "AL",
                        "AR",
                        "AS",
                        "AZ",
                        "CA",
                        "CO",
                        "CT",
                        "DC",
                        "DE",
                        "FL",
                        "FM",
                        "GA",
                        "GU",
                        "HI",
                        "IA",
                        "ID",
                        "IL",
                        "IN",
                        "KS",
                        "KY",
                        "LA",
                        "MA",
                        "MD",
                        "ME",
                        "MH",
                        "MI",
                        "MN",
                        "MO",
                        "MP",
                        "MS",
                        "MT",
                        "NC",
                        "ND",
                        "NE",
                        "NH",
                        "NJ",
                        "NM",
                        "NV",
                        "NY",
                        "OH",
                        "OK",
                        "OR",
                        "PA",
                        "PR",
                        "PW",
                        "RI",
                        "SC",
                        "SD",
                        "TN",
                        "TX",
                        "UT",
                        "VA",
                        "VI",
                        "VT",
                        "WA",
                        "WI",
                        "WV",
                        "WY"
                    ]
                },
                "zipCode": {
                    "type": "string",
                    "examples": [
                        "15136"
                    ],
                    "pattern": "^[0-9]{5}$",
                    "minLength": 5,
                    "maxLength": 5
                },
                "county": {
                    "type": "string",
                    "examples": [
                        "Allegheny"
                    ],
                    "maxLength": 32
                }
            },
            "required": [
                "address1",
                "city",
                "state",
                "zipCode"
            ],
            "additionalProperties": false,
            "maxProperties": 6,
            "minProperties": 4
        },
        "amortizationType": {
            "type": "string",
            "enum": [
                "ARM",
                "Fixed",
                "Interest Only",
                "Reverse",
                ""
            ],
            "maxLength": 64
        },
        "borrower": {
            "type": "object",
            "additionalProperties": false,
            "properties": {
                "firstName": {
                    "$ref": "#/$defs/person/properties/firstName"
                },
                "middleName": {
                    "$ref": "#/$defs/person/properties/middleName"
                },
                "lastName": {
                    "$ref": "#/$defs/person/properties/lastName"
                },
                "suffix": {
                    "$ref": "#/$defs/person/properties/suffix"
                },
                "type": {
                    "type": "string",
                    "enum": [
                        "Asset Management Company",
                        "Asset Manager",
                        "Assignee",
                        "Assignor",
                        "Attorney",
                        "Bank Attorney",
                        "Borrower",
                        "Borrower/Buyer",
                        "Builder",
                        "Buyer",
                        "Buyer Agent",
                        "Buyer Attorney",
                        "Buyer Title Company",
                        "Buyers Broker",
                        "Condo Association",
                        "Custodian",
                        "Foreclosed Party",
                        "Investor",
                        "LENDER",
                        "Lender Loan Officer",
                        "Listing Agent",
                        "MC MC Auction Company",
                        "Mortgage Connect Closer",
                        "Non-HUD Borrower",
                        "Non-Vested Signer",
                        "Other",
                        "Processor",
                        "Property Access",
                        "Real Estate Agent",
                        "Real Estate Agent - Seller",
                        "Seller",
                        "Seller Attorney",
                        "Sellers Broker",
                        "Selling Agent",
                        "Servicer",
                        "Settlement Agent",
                        "Title Company",
                        "Underwriter",
                        "Vested Signer - Non-Borrower"
                    ]
                },
                "email": {
                    "type": "string",
                    "maxLength": 255
                },
                "cellPhone": {
                    "type": "string",
                    "maxLength": 24
                },
                "ssn": {
                    "type": "string",
                    "maxLength": 128
                },
                "maritalStatus": {
                    "$ref": "#/$defs/person/properties/maritalStatus"
                },
                "language": {
                    "$ref": "#/$defs/language"
                },
                "dateOfBirth": {
                    "type": "string",
                    "format": "date"
                },
                "borrowerAddress": {
                    "$ref": "#/$defs/address"
                }
            },
            "required": [
                "firstName",
                "lastName",
                "type"
            ],
            "title": "Borrower"
        },
        "recording": {
            "type": "object",
            "properties": {
                "recordingFeeAmount": {
                    "type": "string",
                    "format": "money",
                    "examples": [ "0.00" ]
                },
                "firstPageNumberValue": {
                    "type": "string",
                    "maxLength": 50,
                    "examples": [ 1243992 ]
                },
                "recordedDatetime": {
                    "type": "string",
                    "format": "date-time",
                    "example": [ "07-11-2022T14:00:00-4:00" ]
                },
                "recordingType": {
                    "type": "string",
                    "format": "string",
                    "maxLength": 24
                },
                "volumeIdentifier": {
                    "type": "string",
                    "format": "string",
                    "maxLength": 50
                },
                "volumeType": {
                    "type": "string",
                    "format": "string",
                    "maxLength": 60
                }
            },
            "required": [
                "recordingFeeAmount",
                "firstPageNumberValue",
                "recordedDatetime",
                "recordingType",
                "volumeIdentifier",
                "volumeType"
            ]
        },
        "signer": {
            "type": "object",
            "additionalProperties": false,
            "properties": {
                "firstName": {
                    "$ref": "#/$defs/person/properties/firstName"
                },
                "middleName": {
                    "$ref": "#/$defs/person/properties/middleName"
                },
                "lastName": {
                    "$ref": "#/$defs/person/properties/lastName"
                },
                "homePhone": {
                    "type": "string",
                    "format": "string",
                    "maxLength": 24
                },
                "workPhone": {
                    "type": "string",
                    "format": "string",
                    "maxLength": 24
                },
                "cellPhone": {
                    "type": "string",
                    "maxLength": 24
                },
                "otherPhone": {
                    "type": "string",
                    "maxLength": 24
                },
                "email": {
                    "type": "string",
                    "format": "email",
                    "maxLength": 255
                },
                "signingDateTime": {
                    "type": "string",
                    "format": "date-time",
                    "example": [ "07-11-2022T14:00:00-4:00" ]
                },
                "closingLocation": {
                    "type": "string",
                    "enum": [
                        "In-Home",
                        "Other"
                    ],
                    "maxLength": 50
                },
                "signingAddress": {
                    "$ref": "#/$defs/address"
                }
            },
            "required": [
                "signingDateTime",
                "closingLocation",
                "signingAddress"
            ],
            "title": "Signer"
        },
        "document": {
            "type": "object",
            "properties": {
                "documentId": {
                    "type": "string",
                    "maxLength": 36,
                    "examples": [
                        1243992
                    ]
                },
                "type": {
                    "$ref": "DocumentType#"
                },
                "name": {
                    "type": "string",
                    "maxLength": 100,
                    "examples": [
                        "patriot-search.pdf"
                    ]
                },
                "fileType": {
                    "type": "string",
                    "enum": [
                        "DOC",
                        "DOCX",
                        "PDF",
                        "doc",
                        "docx",
                        "pdf"
                    ]
                },
                "contentMediaType": {
                    "type": "string",
                    "enum": [
                        "application/msword",
                        "application/vnd.openxmlformats-officedocument.wordprocessingml.document",
                        "application/pdf"
                    ]
                },
                "contentUnicodeTextEncodingType": {
                    "type": "string",
                    "enum": [
                        "UTF8"
                    ]
                },
                "contentBinaryEncodingType": {
                    "type": "string",
                    "enum": [
                        "Base64"
                    ]
                },
                "content": {
                    "type": "string",
                    "contentEncoding": "base64"
                },
                "description": {
                    "type": "string",
                    "maxLength": 100,
                    "examples": [
                        "Brief overview of the document"
                    ]
                }
            },
            "allOf": [
                {
                    "if": {
                        "properties": { "fileType": { "enum": [ "DOC", "doc" ] } }
                    },
                    "then": {
                        "properties": { "contentMediaType": { "enum": [ "application/msword" ] } }
                    }
                },
                {
                    "if": {
                        "properties": { "fileType": { "enum": [ "DOCX", "docx" ] } }
                    },
                    "then": {
                        "properties": { "contentMediaType": { "enum": [ "application/vnd.openxmlformats-officedocument.wordprocessingml.document" ] } }
                    }
                },
                {
                    "if": {
                        "properties": { "fileType": { "enum": [ "PDF", "pdf" ] } }
                    },
                    "then": {
                        "properties": { "contentMediaType": { "enum": [ "application/pdf" ] } }
                    }
                }
            ],
            "required": [
                "documentId",
                "type",
                "name",
                "fileType",
                "contentMediaType",
                "contentUnicodeTextEncodingType",
                "contentBinaryEncodingType",
                "content"
            ]
        },
        "clearanceItem": {
            "type": "object",
            "properties": {
                "rowId": {
                    "type": "integer",
                    "examples": [
                        "1"
                    ],
                    "minimum": 1
                },
                "clearingType": {
                    "type": "string",
                    "maxLength": 80
                },
                "name": {
                    "type": "string"
                },
                "followUpDate": {
                    "type": "string",
                    "format": "date",
                    "examples": [ "05-10-2022" ]
                },
                "dueDate": {
                    "type": "string",
                    "format": "date",
                    "examples": [ "05-10-2022" ]
                },
                "status": {
                    "type": "string",
                    "enum": [
                        "Awaiting Approval",
                        "Cleared",
                        "Open",
                        "Overdue"
                    ]
                },
                "team": {
                    "type": "string",
                    "maxLength": 60
                },
                "requestTypes": {
                    "type": "string",
                    "maxLength": 64
                },
                "tcMethod": {
                    "type": "string",
                    "maxLength": 300
                }
            }
        },
        "itemNumber": {
            "type": "integer",
            "examples": [
                "1"
            ],
            "minimum": 1,
            "maximum": 40
        },
        "language": {
            "type": "string",
            "enum": [
                "English",
                "Spanish"
            ]
        },
        "lender": {
            "type": "object",
            "additionalProperties": false,
            "properties": {
                "name": {
                    "type": "string",
                    "maxLength": 255
                },
                "address": {
                    "type": "string",
                    "examples": [
                        "1204 New York Drive"
                    ],
                    "maxLength": 255
                },
                "city": {
                    "$ref": "#/$defs/address/properties/city"
                },
                "state": {
                    "$ref": "#/$defs/address/properties/state"
                },
                "zipCode": {
                    "$ref": "#/$defs/address/properties/zipCode"
                }
            },
            "required": [
                "address",
                "city",
                "state",
                "zipCode"
            ],
            "title": "Lender"
        },
        "loanNumber": {
            "type": "string",
            "examples": [
                "7313993"
            ],
            "minLength": 1,
            "maxLength": 64
        },
        "loanType": {
            "type": "string",
            "enum": [
                "Deed in Lieu",
                "Equity",
                "Loan Modification",
                "Post-Foreclosure",
                "Pre-Foreclosure",
                "Pre Sale",
                "Purchase",
                "Refinance",
                "REO/Foreclosure", 
                "Reverse",
                "TSG"
            ],
            "minLength": 1,
            "maxLength": 24
        },
        "money": {
            "type": "string",
            "format": "money",
            "examples": [ "0.00" ]
        },
        "occupancyType": {
            "type": "string",
            "enum": [
                "Primary",
                "Secondary",
                "Investment"
            ],
            "minLength": 1,
            "maxLength": 64
        },
        "orderNo": {
            "type": "integer",
            "examples": [
                "2429888"
            ]
        },
        "party": {
            "type": "object",
            "additionalProperties": false,
            "properties": {
                "sequenceNo": {
                    "type": "integer"
                },
                "firstName": {
                    "type": "string",
                    "maxLength": 150
                },
                "lastName": {
                    "type": "string",
                    "maxLength": 150
                },
                "phone": {
                    "type": "string",
                    "maxLength": 24
                },
                "email": {
                    "type": "string",
                    "format": "email",
                    "maxLength": 255
                },
                "role": {
                    "type": "string",
                    "enum": [
                        "Closer",
                        "LoanOfficer",
                        "LoanOfficerAssistant",
                        "Other",
                        "Processor",
                        "ProcessorAssistant",
                        "Underwriter",
                        "User"
                    ]
                }
            },
            "required": [
                "firstName",
                "lastName",
                "role"
            ],
            "title": "Party"
        },
        "person": {
            "type": "object",
            "properties": {
                "firstName": {
                    "type": "string",
                    "examples": [
                        "John"
                    ],
                    "minLength": 1,
                    "maxLength": 150
                },
                "middleName": {
                    "type": "string",
                    "examples": [
                        "M"
                    ],
                    "minLength": 0,
                    "maxLength": 150
                },
                "lastName": {
                    "type": "string",
                    "examples": [
                        "Smith"
                    ],
                    "minLength": 1,
                    "maxLength": 255
                },
                "suffix": {
                    "type": "string",
                    "examples": [
                        "Sr."
                    ],
                    "enum": [
                        "II",
                        "III",
                        "Esq.",
                        "Jr.",
                        "M.D.",
                        "P.A.",
                        "Sr.",
                        ""
                    ],
                    "minLength": 0,
                    "maxLength": 4
                },
                "maritalStatus": {
                    "type": "string",
                    "enum": [
                        "Divorced",
                        "Married",
                        "Separated",
                        "Single",
                        "Widowed",
                        ""
                    ]
                },
                "language": {
                    "$ref": "#/$defs/language"
                }
            }
        },
        "propertyType": {
            "type": "string",
            "enum": [
                "Condominium",
                "Cooperative",
                "Manufactured",
                "Multi-Family",
                "Other",
                "PUD",
                "SingleFamily"
            ],
            "minLength": 1,
            "maxLength": 64
        },
        "recordingInfo": {
            "type": "object",
            "properties": {
                "datedDate": {
                    "type": "string",
                    "format": "date",
                    "examples": [ "05-10-2022" ]
                },
                "book": {
                    "type": "string",
                    "maxLength": 32,
                    "examples": [ "11" ]
                },
                "page": {
                    "type": "string",
                    "maxLength": 32,
                    "examples": [ "12" ]
                },
                "instrument": {
                    "type": "string",
                    "maxLength": 32,
                    "examples": [ "234" ]
                },
                "recordedDate": {
                    "type": "string",
                    "format": "date",
                    "examples": [ "05-10-2022" ]
                },
                "amount": {
                    "$ref": "#/$defs/money"
                }
            }
        },
        "transactionId": {
            "type": "string",
            "examples": [
                "7832143"
            ],
            "minLength": 1,
            "maxLength": 50
        },
        "comment": {
            "type": "string",
            "maxLength": 1000
        }
    }
}
/* Copyright © 2023 Mortgage Connect LP */

<?xml version="1.0" encoding="utf-8"?>
<xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema">
    <!-- Simple Types -->
    <xs:simpleType name="addressLine">
        <xs:restriction base="xs:string">
            <xs:maxLength value="255"/>
        </xs:restriction>
    </xs:simpleType>
    <xs:simpleType name="city">
        <xs:restriction base="xs:string">
            <xs:maxLength value="32"/>
        </xs:restriction>
    </xs:simpleType>
    <xs:simpleType name="county">
        <xs:restriction base="xs:string">
            <xs:maxLength value="32"/>
        </xs:restriction>
    </xs:simpleType>
    <xs:simpleType name="email">
        <xs:restriction base="xs:string">
            <xs:maxLength value="255"/>
        </xs:restriction>
    </xs:simpleType>
    <xs:simpleType name="itemNumber">
        <xs:restriction base="xs:integer">
            <xs:minInclusive value="1"/>
            <xs:maxInclusive value="40"/>
        </xs:restriction>
    </xs:simpleType>
    <xs:simpleType name="language">
        <xs:restriction base="xs:string">
            <xs:enumeration value="English"/>
            <xs:enumeration value="Spanish"/>
        </xs:restriction>
    </xs:simpleType>
    <xs:simpleType name="money">
        <xs:restriction base="xs:decimal">
            <xs:fractionDigits value="2"/>
        </xs:restriction>
    </xs:simpleType>
    <xs:simpleType name="orderNo">
        <xs:restriction base="xs:integer"/>
    </xs:simpleType>
    <xs:simpleType name="phone">
        <xs:restriction base="xs:string">
            <xs:maxLength value="24"/>
        </xs:restriction>
    </xs:simpleType>
    <xs:simpleType name="transactionId">
        <xs:restriction base="xs:string">
            <xs:minLength value="1"/>
            <xs:maxLength value="50"/>
        </xs:restriction>
    </xs:simpleType>
    <xs:simpleType name="propertyType">
        <xs:restriction base="xs:string">
            <xs:enumeration value="Condominium"/>
            <xs:enumeration value="Cooperative"/>
            <xs:enumeration value="Manufactured"/>
            <xs:enumeration value="Multi-Family"/>
            <xs:enumeration value="Other"/>
            <xs:enumeration value="PUD"/>
            <xs:enumeration value="SingleFamily"/>
        </xs:restriction>
    </xs:simpleType>

    <xs:simpleType name="state">
        <xs:restriction base="xs:string">
            <xs:enumeration value="AK"/>
            <xs:enumeration value="AL"/>
            <xs:enumeration value="AR"/>
            <xs:enumeration value="AS"/>
            <xs:enumeration value="AZ"/>
            <xs:enumeration value="CA"/>
            <xs:enumeration value="CO"/>
            <xs:enumeration value="CT"/>
            <xs:enumeration value="DC"/>
            <xs:enumeration value="DE"/>
            <xs:enumeration value="FL"/>
            <xs:enumeration value="FM"/>
            <xs:enumeration value="GA"/>
            <xs:enumeration value="GU"/>
            <xs:enumeration value="HI"/>
            <xs:enumeration value="IA"/>
            <xs:enumeration value="ID"/>
            <xs:enumeration value="IL"/>
            <xs:enumeration value="IN"/>
            <xs:enumeration value="KS"/>
            <xs:enumeration value="KY"/>
            <xs:enumeration value="LA"/>
            <xs:enumeration value="MA"/>
            <xs:enumeration value="MD"/>
            <xs:enumeration value="ME"/>
            <xs:enumeration value="MH"/>
            <xs:enumeration value="MI"/>
            <xs:enumeration value="MN"/>
            <xs:enumeration value="MO"/>
            <xs:enumeration value="MP"/>
            <xs:enumeration value="MS"/>
            <xs:enumeration value="MT"/>
            <xs:enumeration value="NC"/>
            <xs:enumeration value="ND"/>
            <xs:enumeration value="NE"/>
            <xs:enumeration value="NH"/>
            <xs:enumeration value="NJ"/>
            <xs:enumeration value="NM"/>
            <xs:enumeration value="NV"/>
            <xs:enumeration value="NY"/>
            <xs:enumeration value="OH"/>
            <xs:enumeration value="OK"/>
            <xs:enumeration value="OR"/>
            <xs:enumeration value="PA"/>
            <xs:enumeration value="PR"/>
            <xs:enumeration value="PW"/>
            <xs:enumeration value="RI"/>
            <xs:enumeration value="SC"/>
            <xs:enumeration value="SD"/>
            <xs:enumeration value="TN"/>
            <xs:enumeration value="TX"/>
            <xs:enumeration value="UT"/>
            <xs:enumeration value="VA"/>
            <xs:enumeration value="VI"/>
            <xs:enumeration value="VT"/>
            <xs:enumeration value="WA"/>
            <xs:enumeration value="WI"/>
            <xs:enumeration value="WV"/>
            <xs:enumeration value="WY"/>
        </xs:restriction>
    </xs:simpleType>
    <xs:simpleType name="zipCode">
        <xs:restriction base="xs:string">
            <xs:pattern value="^[0-9]{5}$" />
            <xs:minLength value="5" />
            <xs:maxLength value="5" />
        </xs:restriction>
    </xs:simpleType>
    <!-- Person -->
    <xs:simpleType name="firstName">
        <xs:restriction base="xs:string">
            <xs:maxLength value="150"/>
        </xs:restriction>
    </xs:simpleType>
    <xs:simpleType name="middleName">
        <xs:restriction base="xs:string">
            <xs:maxLength value="150"/>
        </xs:restriction>
    </xs:simpleType>
    <xs:simpleType name="lastName">
        <xs:restriction base="xs:string">
            <xs:maxLength value="255"/>
        </xs:restriction>
    </xs:simpleType>
    <xs:simpleType name="suffix">
        <xs:restriction base="xs:string">
            <xs:enumeration value="II"/>
            <xs:enumeration value="III"/>
            <xs:enumeration value="Esq."/>
            <xs:enumeration value="Jr."/>
            <xs:enumeration value="M.D."/>
            <xs:enumeration value="P.A."/>
            <xs:enumeration value="Sr."/>
            <xs:enumeration value=""/>
        </xs:restriction>
    </xs:simpleType>
    <xs:simpleType name="maritalStatus">
        <xs:restriction base="xs:string">
            <xs:enumeration value="Divorced"/>
            <xs:enumeration value="Married"/>
            <xs:enumeration value="Separated"/>
            <xs:enumeration value="Single"/>
            <xs:enumeration value="Widowed"/>
            <xs:enumeration value=""/>
        </xs:restriction>
    </xs:simpleType>
    <!-- End Person -->

    <!-- Recording Info -->
    <xs:simpleType name="book">
        <xs:restriction base="xs:string">
            <xs:maxLength value="32"/>
        </xs:restriction>
    </xs:simpleType>
    <xs:simpleType name="page">
        <xs:restriction base="xs:string">
            <xs:maxLength value="32"/>
        </xs:restriction>
    </xs:simpleType>
    <xs:simpleType name="instrument">
        <xs:restriction base="xs:string">
            <xs:maxLength value="32"/>
        </xs:restriction>
    </xs:simpleType>
    <xs:simpleType name="deedType">
        <xs:restriction base="xs:string">
            <xs:maxLength value="50"/>
        </xs:restriction>
    </xs:simpleType>

    <!-- End Recording Info -->
    <!-- EndSimple Types -->

    <!-- Complex Types -->
    <xs:complexType name="address">
        <xs:all>
            <xs:element name="address1" type="addressLine"/>
            <xs:element name="address2" type="addressLine" minOccurs="0"/>
            <xs:element name="city" type="city"/>
            <xs:element name="state" type="state"/>
            <xs:element name="zipCode" type="zipCode"/>
            <xs:element name="county" type="county" minOccurs="0"/>
        </xs:all>
    </xs:complexType>
    <xs:complexType name="recordingInfo">
        <xs:sequence>
            <xs:element name="datedDate" type="xs:date"/>
            <xs:element name="book" type="book" minOccurs="0"/>
            <xs:element name="page" type="page" minOccurs="0"/>
            <xs:element name="instrument" type="instrument" minOccurs="0"/>
            <xs:element name="recordedDate" type="xs:date"/>
            <xs:element name="amount" type="money"/>
        </xs:sequence>
    </xs:complexType>
    <xs:complexType name="signer">
        <xs:all>
            <xs:element name="firstName" type="firstName" minOccurs="0"/>
            <xs:element name="middleName" type="middleName" minOccurs="0"/>
            <xs:element name="lastName" type="lastName" minOccurs="0"/>
            <xs:element name="homePhone" type="phone" minOccurs="0"/>
            <xs:element name="workPhone" type="phone" minOccurs="0"/>
            <xs:element name="cellPhone" type="phone" minOccurs="0"/>
            <xs:element name="otherPhone" type="phone" minOccurs="0"/>
            <xs:element name="email" type="email" minOccurs="0"/>
            <xs:element name="signingDateTime" type="xs:dateTime" />
            <xs:element name="closingLocation">
                <xs:simpleType>
                    <xs:restriction base="xs:string">
                        <xs:enumeration value="In-Home"/>
                        <xs:enumeration value="Other"/>
                        <xs:maxLength value="50"/>
                    </xs:restriction>
                </xs:simpleType>
            </xs:element>
            <xs:element name="signingAddress" type="address"/>
        </xs:all>
    </xs:complexType>
    <!-- End Complex Types -->

    <!-- Elements -->
    <xs:element name="legalHeader">
        <xs:complexType>
            <xs:sequence>
                <xs:element name="version">
                    <xs:simpleType>
                        <xs:restriction base="xs:string">
                            <xs:minLength value="1" />
                            <xs:maxLength value="20" />
                        </xs:restriction>
                    </xs:simpleType>
                </xs:element>
                <xs:element name="disclosingParty">
                    <xs:simpleType>
                        <xs:restriction base="xs:string">
                            <xs:minLength value="1" />
                            <xs:maxLength value="100" />
                        </xs:restriction>
                    </xs:simpleType>
                </xs:element>
                <xs:element name="proprietaryInformationAndConfidential">
                    <xs:simpleType>
                        <xs:restriction base="xs:string">
                            <xs:minLength value="1" />
                            <xs:maxLength value="2000" />
                        </xs:restriction>
                    </xs:simpleType>
                </xs:element>
            </xs:sequence>
        </xs:complexType>
    </xs:element>
    <xs:element name="transactionHeader">
        <xs:complexType>
            <xs:sequence>
                <xs:element name="transactionIdempotentId">
                    <xs:simpleType>
                        <xs:restriction base="xs:string">
                            <xs:pattern value="^[\da-fA-F]{8}-[\da-fA-F]{4}-[\da-fA-F]{4}-[\da-fA-F]{4}-[\da-fA-F]{12}$" />
                            <xs:minLength value="36" />
                            <xs:maxLength value="36" />
                        </xs:restriction>
                    </xs:simpleType>
                </xs:element>
                <xs:element name="transactionDate">
                    <xs:simpleType>
                        <xs:restriction base="xs:dateTime" />
                    </xs:simpleType>
                </xs:element>
                <xs:element name="clientCode">
                    <xs:simpleType>
                        <xs:restriction base="xs:string">
                            <xs:minLength value="1"/>
                            <xs:maxLength value="100" />
                        </xs:restriction>
                    </xs:simpleType>
                </xs:element>
                <xs:element name="clientName">
                    <xs:simpleType>
                        <xs:restriction base="xs:string">
                            <xs:minLength value="1"/>
                            <xs:maxLength value="100" />
                        </xs:restriction>
                    </xs:simpleType>
                </xs:element>
                <xs:element name="vendorCode">
                    <xs:simpleType>
                        <xs:restriction base="xs:string">
                            <xs:minLength value="1"/>
                            <xs:maxLength value="100" />
                        </xs:restriction>
                    </xs:simpleType>
                </xs:element>
                <xs:element name="vendorName">
                    <xs:simpleType>
                        <xs:restriction base="xs:string">
                            <xs:minLength value="1"/>
                            <xs:maxLength value="100" />
                        </xs:restriction>
                    </xs:simpleType>
                </xs:element>
            </xs:sequence>
        </xs:complexType>
    </xs:element>
    <xs:element name="transactionExtensions">
        <xs:complexType>
            <xs:sequence>
                <xs:element name="transactionExtension" minOccurs="0" maxOccurs="unbounded">
                    <xs:complexType>
                        <xs:sequence>
                            <xs:element name="key">
                                <xs:simpleType>
                                    <xs:restriction base="xs:string">
                                        <xs:minLength value="1"/>
                                        <xs:maxLength value="200" />
                                    </xs:restriction>
                                </xs:simpleType>
                            </xs:element>
                            <xs:element name="value">
                                <xs:simpleType>
                                    <xs:restriction base="xs:string">
                                        <xs:minLength value="1"/>
                                    </xs:restriction>
                                </xs:simpleType>
                            </xs:element>
                        </xs:sequence>
                    </xs:complexType>
                </xs:element>
            </xs:sequence>
        </xs:complexType>
    </xs:element>

    <xs:element name="amortizationType">
        <xs:simpleType>
            <xs:restriction base="xs:string">
                <xs:enumeration value="ARM"/>
                <xs:enumeration value="Fixed"/>
                <xs:enumeration value="Interest Only"/>
                <xs:enumeration value="Reverse"/>
                <xs:enumeration value=""/>
                <xs:maxLength value="64"/>
            </xs:restriction>
        </xs:simpleType>
    </xs:element>
    <xs:element name="borrower">
        <xs:complexType>
            <xs:sequence>
                <xs:element name="firstName" type="firstName"/>
                <xs:element name="middleName" type="middleName" minOccurs="0"/>
                <xs:element name="lastName" type="lastName"/>
                <xs:element name="suffix" type="suffix" minOccurs="0"/>
                <xs:element name="type">
                    <xs:simpleType>
                        <xs:restriction base="xs:string">
                            <xs:enumeration value="Asset Management Company"/>
                            <xs:enumeration value="Asset Manager"/>
                            <xs:enumeration value="Assignee"/>
                            <xs:enumeration value="Assignor"/>
                            <xs:enumeration value="Attorney"/>
                            <xs:enumeration value="Bank Attorney"/>
                            <xs:enumeration value="Borrower"/>
                            <xs:enumeration value="Borrower/Buyer"/>
                            <xs:enumeration value="Builder"/>
                            <xs:enumeration value="Buyer"/>
                            <xs:enumeration value="Buyer Agent"/>
                            <xs:enumeration value="Buyer Attorney"/>
                            <xs:enumeration value="Buyer Title Company"/>
                            <xs:enumeration value="Buyers Broker"/>
                            <xs:enumeration value="Condo Association"/>
                            <xs:enumeration value="Custodian"/>
                            <xs:enumeration value="Foreclosed Party"/>
                            <xs:enumeration value="Investor"/>
                            <xs:enumeration value="LENDER"/>
                            <xs:enumeration value="Lender Loan Officer"/>
                            <xs:enumeration value="Listing Agent"/>
                            <xs:enumeration value="MC MC Auction Company"/>
                            <xs:enumeration value="Mortgage Connect Closer"/>
                            <xs:enumeration value="Non-HUD Borrower"/>
                            <xs:enumeration value="Non-Vested Signer"/>
                            <xs:enumeration value="Other"/>
                            <xs:enumeration value="Processor"/>
                            <xs:enumeration value="Property Access"/>
                            <xs:enumeration value="Real Estate Agent"/>
                            <xs:enumeration value="Real Estate Agent - Seller"/>
                            <xs:enumeration value="Seller"/>
                            <xs:enumeration value="Seller Attorney"/>
                            <xs:enumeration value="Sellers Broker"/>
                            <xs:enumeration value="Selling Agent"/>
                            <xs:enumeration value="Servicer"/>
                            <xs:enumeration value="Settlement Agent"/>
                            <xs:enumeration value="Title Company"/>
                            <xs:enumeration value="Underwriter"/>
                            <xs:enumeration value="Vested Signer - Non-Borrower"/>
                        </xs:restriction>
                    </xs:simpleType>
                </xs:element>
                <xs:element name="email" type="email" minOccurs="0"/>
                <xs:element name="cellPhone" type="phone" minOccurs="0"/>
                <xs:element name="ssn" minOccurs="0">
                    <xs:simpleType>
                        <xs:restriction base="xs:string">
                            <xs:maxLength value="128"/>
                        </xs:restriction>
                    </xs:simpleType>
                </xs:element>
                <xs:element name="maritalStatus" type="maritalStatus" minOccurs="0"/>
                <xs:element name="language" type="language" minOccurs="0"/>
                <xs:element name="dateOfBirth" type="xs:date" minOccurs="0"/>
                <xs:element name="borrowerAddress" type="address" minOccurs="0"/>
            </xs:sequence>
        </xs:complexType>
    </xs:element>
    <xs:element name="recording">
        <xs:complexType>
            <xs:sequence>
                <xs:element name="recordingFeeAmount" type="money"/>
                <xs:element name="firstPageNumberValue">
                    <xs:simpleType>
                        <xs:restriction base="xs:string">
                            <xs:maxLength value="50"/>
                        </xs:restriction>
                    </xs:simpleType>
                </xs:element>
                <xs:element name="recordedDatetime">
                    <xs:simpleType>
                        <xs:restriction base="xs:string">
                            <xs:maxLength value="50"/>
                        </xs:restriction>
                    </xs:simpleType>
                </xs:element>
                <xs:element name="recordingType">
                    <xs:simpleType>
                        <xs:restriction base="xs:string">
                            <xs:maxLength value="24"/>
                        </xs:restriction>
                    </xs:simpleType>
                </xs:element>
                <xs:element name="volumeIdentifier">
                    <xs:simpleType>
                        <xs:restriction base="xs:string">
                            <xs:maxLength value="50"/>
                        </xs:restriction>
                    </xs:simpleType>
                </xs:element>
                <xs:element name="volumeType">
                    <xs:simpleType>
                        <xs:restriction base="xs:string">
                            <xs:maxLength value="60"/>
                        </xs:restriction>
                    </xs:simpleType>
                </xs:element>
            </xs:sequence>
        </xs:complexType>
    </xs:element>
    <xs:element name="clearanceItem">
        <xs:complexType>
            <xs:sequence>
                <xs:element name="rowId" type="xs:integer" minOccurs="0" />
                <xs:element name="clearingType" minOccurs="0">
                    <xs:simpleType>
                        <xs:restriction base="xs:string">
                            <xs:maxLength value="80"/>
                        </xs:restriction>
                    </xs:simpleType>
                </xs:element>
                <xs:element name="name" type="xs:string" minOccurs="0" />
                <xs:element name="followUpDate" type="xs:date" minOccurs="0"/>
                <xs:element name="dueDate" type="xs:date" minOccurs="0"/>
                <xs:element name="status">
                    <xs:simpleType>
                        <xs:restriction base="xs:string">
                            <xs:enumeration value="Awaiting Approval"/>
                            <xs:enumeration value="Cleared"/>
                            <xs:enumeration value="Open"/>
                            <xs:enumeration value="Overdue"/>
                        </xs:restriction>
                    </xs:simpleType>
                </xs:element>
                <xs:element name="team" minOccurs="0">
                    <xs:simpleType>
                        <xs:restriction base="xs:string">
                            <xs:maxLength value="60"/>
                        </xs:restriction>
                    </xs:simpleType>
                </xs:element>
                <xs:element name="requestTypes" minOccurs="0">
                    <xs:simpleType>
                        <xs:restriction base="xs:string">
                            <xs:maxLength value="64"/>
                        </xs:restriction>
                    </xs:simpleType>
                </xs:element>
                <xs:element name="tcMethod" minOccurs="0">
                    <xs:simpleType>
                        <xs:restriction base="xs:string">
                            <xs:maxLength value="300"/>
                        </xs:restriction>
                    </xs:simpleType>
                </xs:element>
            </xs:sequence>
        </xs:complexType>
    </xs:element>
    <xs:element name="document">
        <xs:complexType>
            <xs:sequence>
                <xs:element name="documentId">
                    <xs:simpleType>
                        <xs:restriction base="xs:string">
                            <xs:maxLength value="36"/>
                        </xs:restriction>
                    </xs:simpleType>
                </xs:element>
                <xs:element name="type" type="documentType" />
                <xs:element name="name">
                    <xs:simpleType>
                        <xs:restriction base="xs:string">
                            <xs:maxLength value="100"/>
                        </xs:restriction>
                    </xs:simpleType>
                </xs:element>
                <xs:element name="fileType">
                    <xs:simpleType>
                        <xs:restriction base="xs:string">
                            <xs:enumeration value="DOC"/>
                            <xs:enumeration value="DOCX"/>
                            <xs:enumeration value="PDF"/>
                            <xs:enumeration value="doc"/>
                            <xs:enumeration value="docx"/>
                            <xs:enumeration value="pdf"/>
                        </xs:restriction>
                    </xs:simpleType>
                </xs:element>
                <xs:element name="contentMediaType">
                    <xs:simpleType>
                        <xs:restriction base="xs:string">
                            <xs:enumeration value="application/msword"/>
                            <xs:enumeration value="application/vnd.openxmlformats-officedocument.wordprocessingml.document"/>
                            <xs:enumeration value="application/pdf"/>
                        </xs:restriction>
                    </xs:simpleType>
                </xs:element>
                <xs:element name="contentUnicodeTextEncodingType">
                    <xs:simpleType>
                        <xs:restriction base="xs:string">
                            <xs:enumeration value="UTF8"/>
                        </xs:restriction>
                    </xs:simpleType>
                </xs:element>
                <xs:element name="contentBinaryEncodingType">
                    <xs:simpleType>
                        <xs:restriction base="xs:string">
                            <xs:enumeration value="Base64"/>
                        </xs:restriction>
                    </xs:simpleType>
                </xs:element>
                <xs:element name="content" type="xs:base64Binary"/>
                <xs:element name="description">
                    <xs:simpleType>
                        <xs:restriction base="xs:string">
                            <xs:maxLength value="255"/>
                        </xs:restriction>
                    </xs:simpleType>
                </xs:element>
            </xs:sequence>
        </xs:complexType>
    </xs:element>
    <xs:element name="lender">
        <xs:complexType>
            <xs:sequence>
                <xs:element name="name" type="lastName" minOccurs="0"/>
                <xs:element name="address">
                    <xs:simpleType>
                        <xs:restriction base="xs:string">
                            <xs:maxLength value="255"/>
                        </xs:restriction>
                    </xs:simpleType>
                </xs:element>
                <xs:element name="city" type="city"/>
                <xs:element name="state" type="state"/>
                <xs:element name="zipCode" type="zipCode"/>
            </xs:sequence>
        </xs:complexType>
    </xs:element>
    <xs:element name="loanNumber">
        <xs:simpleType>
            <xs:restriction base="xs:string">
                <xs:minLength value="1"/>
                <xs:maxLength value="64"/>
            </xs:restriction>
        </xs:simpleType>
    </xs:element>
    <xs:element name="loanType">
        <xs:simpleType>
            <xs:restriction base="xs:string">
                <xs:enumeration value="Deed in Lieu"/>
                <xs:enumeration value="Equity"/>
                <xs:enumeration value="Loan Modification"/>
                <xs:enumeration value="Post-Foreclosure"/>
                <xs:enumeration value="Pre-Foreclosure"/>
                <xs:enumeration value="Pre Sale"/>
                <xs:enumeration value="Purchase"/>
                <xs:enumeration value="Refinance"/>
                <xs:enumeration value="REO/Foreclosure"/>
                <xs:enumeration value="Reverse"/>
                <xs:enumeration value="TSG"/>
                <xs:minLength value="1"/>
                <xs:maxLength value="24"/>
            </xs:restriction>
        </xs:simpleType>
    </xs:element>
    <xs:element name="occupancyType">
        <xs:simpleType>
            <xs:restriction base="xs:string">
                <xs:enumeration value="Primary"/>
                <xs:enumeration value="Secondary"/>
                <xs:enumeration value="Investment"/>
                <xs:minLength value="1"/>
                <xs:maxLength value="64"/>
            </xs:restriction>
        </xs:simpleType>
    </xs:element>
    <xs:element name="party">
        <xs:complexType>
            <xs:all>
                <xs:element name="sequenceNo" type="xs:integer" minOccurs="0"/>
                <xs:element name="firstName" type="firstName"/>
                <xs:element name="lastName">
                    <xs:simpleType>
                        <xs:restriction base="xs:string">
                            <xs:maxLength value="150"/>
                        </xs:restriction>
                    </xs:simpleType>
                </xs:element>
                <xs:element name="phone" type="phone" minOccurs="0"/>
                <xs:element name="email" type="email" minOccurs="0"/>
                <xs:element name="role">
                    <xs:simpleType>
                        <xs:restriction base="xs:string">
                            <xs:enumeration value="Closer"/>
                            <xs:enumeration value="LoanOfficer"/>
                            <xs:enumeration value="LoanOfficerAssistant"/>
                            <xs:enumeration value="Other"/>
                            <xs:enumeration value="Processor"/>
                            <xs:enumeration value="ProcessorAssistant"/>
                            <xs:enumeration value="Underwriter"/>
                            <xs:enumeration value="User"/>
                        </xs:restriction>
                    </xs:simpleType>
                </xs:element>
            </xs:all>
        </xs:complexType>
    </xs:element>
    <xs:element name="productCode" type="productCodeType"/>
    <xs:element name="transactionId">
        <xs:simpleType>
            <xs:restriction base="xs:string">
                <xs:minLength value="1"/>
                <xs:maxLength value="50"/>
            </xs:restriction>
        </xs:simpleType>
    </xs:element>
    <xs:element name="comment">
        <xs:simpleType>
            <xs:restriction base="xs:string">
                <xs:maxLength value="1000"/>
            </xs:restriction>
        </xs:simpleType>
    </xs:element>
    <!-- End Elements -->
</xs:schema>

The JSON common schema definitions consist of two parts. The Root schema defines the shared major elements of the request. This would include the legalHeader, transactionHeader, and transactionExtensions. The Common schema contains user defined type and objects that are reused throughout the API.

The JSON and XML schema definitions per event, all inherit from the same Common global schema type definition.
For example, the MC100→New-Order event contains a definition for the propertyAddress object and is configured to be of type address, which is a member of the common global schema definition. Below is an example schema snippet for the propertyAddress.

"propertyAddress": { "$ref": "CommonTypes#/$defs/address" }

Notice that it references the address object from CommonTypes and that we did not have to declare the City, State, etc., because the common address definition already contains those fields.

Common Schema - Object Definitions

This same pattern is used througout the schema validation definitions and thus reduces the length of the schemas and promotes consistency from message to message where similar metadata is leveraged.

The following common schema types are supported:

address
amortizationType
borrower
document
itemNumber
language
lender
loanNumber
loanType
money
orderNo
party
propertyType
recordingInfo
transactionId

Note that the corresponding schema validation definitions that are documented per event, do not contain references to the Common Schema Defintions. This is because the schema validation definitions per event were programmatically generated and everywhere a Common Schema Definition was referenced, it was automatically merged into a single specification file.

This was done because it is more likely that clients will want to use a single complete schema specification file instead of working with multiple schema definition files.

If you desire to have copies of the schema definitions where the Common Schema Definition is separate from the message events schemas, and the message event schemas contain references to the Common Schema Definition, then please make a request by contacting Mortgage Connect.

Environments

The following sections define the different environments and BaseUrls supported by the Mortgage Connect Integration API.

Test Environment

The following section provides details about the Mortgage Connect Integration Test environments.

Mortgage Connect Base URLs

Base URL	Description
https://testclientintegrations.mortgageconnectlp.com/Api/V1.0/`{ClientCode}`/SubmitMessage	The primary test environment.
https://democlientintegrations.mortgageconnectlp.com/Api/V1.0/`{ClientCode}`/SubmitMessage	The secondary test environment.

Mortgage Connect URL Properties

Property	Requirement	Description
ClientCode	Required	A unique code assigned to all clients that is used for identification, authentication, and customization purposes.

Production Environment

The following section provides details about the Mortgage Connect Integration Production environments.

Mortgage Connect Base URLs

Base URL	Description
https://clientintegrations.mortgageconnectlp.com/Api/V1.0/`{ClientCode}`/SubmitMessage	The primary production environment.

Mortgage Connect URL Properties

Property	Requirement	Description
ClientCode	Required	A unique code assigned to all clients that is used for identification, authentication, and customization purposes.

Try It Out

The following sections provide details on how a client can interact with the Mortgage Connect Integration API, using tools such as Swagger and PostMan.

Swagger

The following section provides information on how to access and use Swagger to test the Mortgage Connect Integration API.

Swagger Tool

This is a future feature to be implemented. 🚧

Postman

A client specific Postman collection that can be used to test the Mortgage Connect Integration API will be provided upon request.

Onboarding

The following sections identify steps and procedures required of the Client and Mortgage Connect to onboard and integrate.

Client Checklist

The following section defines the action items to be taken by the Client to successfully onboard and integrate with the Mortgage Connect Integration API platform.

Action Items

Check	Action Item
⬜	Identify the public facing URLs for the Mortgage Connect Gateway REST API Service endpoints per targeted environment.
⬜	Optionally, if your company whitelists inbound traffic, then you will need to work with Mortgage Connects to acquire the public IP Addresses (per environment), of the Mortgage Connect services that send outbound messages to the client.
⬜	Obtain the username and password required to authenticate to each Mortgage Connect environment to be targeted.
⬜	Obtain the Client Integration Code assigned to the Client by Mortgage Connect, which is used to uniquely identify the client when invoking the Mortgage Connect Gateway.
⬜
⬜
⬜
⬜
⬜

Mortgage Connect Checklist

The following section defines the action items to be taken by Mortgage Connect to successfully on board the Client to the Mortgage Connect Integration API platform.

Action Items

Check	Action Item
⬜	Identify the public facing URLs for the Client endpoints per targeted environment. These are the applicable URLs that will be invoked when sending outbound asynchronous message back to the Client.
⬜	Optionally, Mortgage Connect may choose to whitelist inbound traffic, which will require working with the Client to acquire the public IP Addresses (per environment), of the Client services that send inbound messages to Mortgage Connect.
⬜	Obtain the username and password required to authenticate to each Client environment to be targeted.
⬜	Build and configure the integration configuration.
⬜	Build and configure the client profiles in each of the targeted sub systems.
⬜
⬜
⬜
⬜

Onboarding Milestones

The following sections provide a graphical overview at a macro level of the milestones required to be completed to on board a client.

Appendix

The following sections highlight additional information such as terms, abbreviations, tools, and helpful links.

Terms & Definitions

The following section defines the Mortgage Connect Integration API terms and defintions

Terms & Abbreviations

Term	Definition
eConnect	Mortgage Connects's proprietary valuation and title system.
Asynchronous	Asynchronous in this context is in relationship to an HTTP request. Specifically, an asynchronous response does not return to the client in the same HTTP connection as the request was made. In fact, many time this means that another out of process service, is responsible to sending the response back to the client by invoking an endpoint on the client’s server.
Base64 Encoding	Base64 Encoding is a group of binary-to-text encoding schemes that represent binary data (more specifically, a sequence of 8-bit bytes) in sequences of 24 bits that can be represented by four 6-bit Base64 digits. Base64 is designed to carry data stored in binary formats across channels that only reliably support text content. See: https://en.wikipedia.org/wiki/Base64.
Basic Auth	This stands for Basic Access Authentication, which is a method for an HTTP user agent (e.g. a web browser) to provide a user name and password when making a request. In basic HTTP authentication, a request contains a header field in the form of Authorization: Basic "credentials", where "credentials" are the Base64 encoding of an ID and password joined by a single colon : https://en.wikipedia.org/wiki/Basic_access_authentication.
ClientCode	A client code is a unique code assigned to a client by Mortgage Connect that is used to identifiy client requests in the early stages of the API processing pipeline.
DMZ	DMZ refers to a Demilitarized Zone (sometimes referred to as a perimeter network or screened subnet) which is a physical or logical subnetwork that contains and exposes an organization's external-facing services to an untrusted, usually larger, network such as the internet. See: https://en.wikipedia.org/wiki/DMZ_(computing).
EventId	This a unique code, which is a short cut annotation to refer to the context of a specific API message payload. For example, "MC100" is the code associated with a "New-Order" request.
Gateway	Gateway is the informal name that Mortgage Connect used to refer to the public REST based Web API service that exists in the DMZ that accepts inbound messages from clients.
LOS	Loan Origination System
LVR	Legal and Vesting Report
MC	Mortgage Connect
PRT	Property Report
QC	Quality Control
REST	A REST API (also known as RESTful API) is an application programming interface (API or web API) that conforms to the constraints of REST architectural style and allows for interaction with RESTful web services. REST stands for representational state transfer and was created by computer scientist Roy Fielding.
SessionId	A session Id is a unique code assigned to a client that is used to uniquely identify their messages from other client messages. It is in many ways synonymous to ClientCode and ClientId.
SLA	A service-level agreement (SLA) defines the level of service expected by a client.
Synchronous	Synchronous in this context is in relation to an HTTP request. Specifically, a synchronous response returns to the client in the same HTTP connection as the request was made.
TTL	Title Insurance

HTTP Status Codes

The following HTTP status codes are examples of the types of codes returned from the Mortgage Connect Integration API.

A 400, 401, 404, and 500, are the typical HTTP codes a client will want code against.

HTTP Status Codes

Status Code	Meaning
400	Bad Request -- The request could not be understood by the server due to malformed syntax.
401	Unauthorized -- Your Basic Authentication credentials are invalid your account has not been setup.
403	Forbidden -- The requested is hidden for administrators only.
404	Not Found -- The specified URL could not be found.
405	Method Not Allowed -- You tried to access an invalid method.
406	Not Acceptable -- You requested a format that permitted.
500	Internal Server Error -- We had a problem with our server. Try again later.
503	Service Unavailable -- We're temporarily offline for maintenance. Please try again later.

Tools and Links

The following sections define some general tools, links and references that can accelerate your integration development and testing.

JSON Schema Validator

JSON Schema Validator is an online utility that validates JSON against a JSON Schema. It Supports JSON Schema Draft 3, Draft 4, Draft 6, Draft 7 and Draft 2019-09. This can be a very convenient tool for quickly validating an integration message.

https://www.jsonschemavalidator.net/

Newtonsoft

Newtonsoft is a popular high-performance JSON framework for .NET that makes it relatively easy to interact with JSON payloads, from serialization and deserialization to and from strongly typed types to schema validation.

https://www.newtonsoft.com/json

Postman

Postman is an online or locally installed utility that facilitates invoking REST APIs in real-time.

https://www.postman.com/

Quick Type

Quick Type is an online utility that enables you to convert JSON and/or JSON Schema files to C# classes or one of many other languages such as C++, Java, JavaScript, Python, and Ruby to name a few. This can significantly jump start your development.

https://app.quicktype.io/

Support

The following sections identify methods of communcation and options for obtaining help in support of the Mortgage Connect Integration API platform.

Service Desk

The following section defines the different options for contacting Mortgage Connect's service desk.

Service Desk Contact Information

Internal Call: ext. 22501

External Call: 855-595-3563 x22501

Service Portal Url: https://mortgageconnect.samanage.com/welcome.portal

MC Client Integration API Guide

Introduction

Layout & Navigation

Browser Support

Menu

Content

Examples

Action Buttons

Schemas

Nomenclatures & Legends

Directional Indicator Definitions

Property Definitions

NULL Values

Authentication

Basic Access Authentication

Basic Auth Specification Details

Title API

Title - API Event Matrix

Client & Mortgage Connect Acknowledgments

Client Initiated Events

Mortgage Connect Initiated Events

Title - API Message Structure

Property Definitions - Transaction Header

Property Definitions - Transaction Body

Property Definitions - Transaction Extensions

Title - API Workflow Orchestration

Title - MC010 - Acknowledgment

Property Definitions - Transaction Header

Property Definitions - Transaction Body

Property Definitions - Transaction Extensions

Title - MC100 - New Order

Mortgage Connect URL

Mortgage Connect URL Properties

Property Definitions - Transaction Header

Property Definitions - Transaction Body

Property Definitions - Transaction Extensions

Title - MC110 - Order Confirmation

Client URL

Property Definitions - Transaction Header

Property Definitions - Transaction Body

Property Definitions - Transaction Extensions

Title - MC115 - Instant Title

Client URL

Property Definitions - Transaction Header

Property Definitions - Transaction Body

Property Definitions - Decisions Details

Property Definitions - Borrower Details

Property Definitions - Property Details

Property Definitions - Lender Details

Property Definitions - Consumer Report Details

Property Definitions - Mortgage Details

Property Definitions - Lien Details

Property Definitions - Ownership Details

Property Definitions - Loan And Encumbrace Details

Property Definitions - Other Recording Details

Property Definitions - Tax Details

Property Definitions - Other Owner Property Details

Property Definitions - Transaction Extensions

Title - MC117 - Cancel Order

Mortgage Connect URL

Mortgage Connect URL Properties

Property Definitions - Transaction Header

Property Definitions - Transaction Body

Property Definitions - Transaction Extensions

Title - MC120 - Update Order

Mortgage Connect URL

Mortgage Connect URL Properties

Property Definitions - Transaction Header

Property Definitions - Transaction Body

Property Definitions - Transaction Extensions

Title - MC130 - Add Note

Client URL

Mortgage Connect URL

Mortgage Connect URL Properties

Property Definitions - Transaction Header

Property Definitions - Transaction Body

Property Definitions - Transaction Extensions

Title - MC140 - Add Note Action

Client URL

Mortgage Connect URL