CDM Mortgage JSON

The following section further describes the data attributes of the CDM Mortgage Schema that seeks to follow the data structure of the Financial Products Markup Language (FpML). Selected examples of the CDM data attribute definitions are used as illustrations to help explain various dimensions of the model, and include data samples and code snippets to help demonstrate the CDM structure, where applicable.

Contract Details

Contract details: defines specific attributes that relate to contractual details of a trade; it describes the key documentation and party contractual information of the model.

  • The Documentation Identification set of data attributes represents the legal document(s) meta data that governs a trade and associated contractual product terms, either as a reference to such documents when specified as part of the CDM, or through identification of some of the key terms of those documents, such as the type of document, the document identifier, the publisher, the document vintage and the agreement date.

"documentationIdentification": {
      "otherAgreement": [
           {
              "identifier": "1234XXX23",
              "otherAgrementType": "Retail Mortgage 2016",
              "version": "1.0",
              "unadjustedDate": {
                "day": 6,
                "month": 3,
                "year": 2016
              }
            }
          ]
        }

  • Within Other Agreement is a set of attributes that defines agreement executed between parties, it consists of the following additional attributes:

    • Identifier is a metadata attribute that is used to identify the agreement.

    • Other Agreement Type is a metadata attribute that shows the agreement executed between the parties and intended to govern product-specific transactions between those parties.

    • Unadjusted Date describes a date field that is subjected to adjustment based on (day, month and year).

  • The Governing Law sub-attribute of Contract Detail represents the law governing the trade and associated contractual product terms.

"governingLaw": "GBEN"

  • The Party Contract Details, sub attribute of Contract Details, represents additional contractual information provided by each involved party. 

"partyReference": {
    "externalReference": "party1",
    "globalReference": "1ab3e71c"
    },
   "naturalPersonRole": [
       {
           "personReference": {},
           "role": "MainBuyer"
       }
  ]

  • Party Reference is a set of attributes that describes both the external and global reference that links to this particular data model.

  • Natural Person Role is a set of attributes to specify the role(s) that natural person(s) may have in relation to the contract.

    • Person Reference is an attribute that references the natural person to whom the role refers to.

    • Role is an attribute that specifies a person role that is distinct from the party role.

Party

A set of metadata key that represents, without a qualification, as to whether this party is a legal entity or a natural person.

  • The Party ID identifier associated with a party and the scheme standards that is being used (ie 20 digits LEI code).

"partyId": [
  { 
  "meta": { "scheme": "http://www.fpml.org/coding-scheme/external/iso17442" }, 
  "value": "ML5798312-1" 
 }

  • The person set of data attributes consists of first name and surname.

"person": {
      "value": {
        "firstName": "James",
        "surname": "Smith"
      }
    }

Credit Details

Credit Details is set of data attributes that is associated with the borrower's credit information. It consists of income, employment, and whether the borrower has an existing mortgage which is denoted as as a boolean flag.

"creditDetails": { 
     "hasAMortgage": "False",
     "employmentStatus": "Employed",
     "income": [
      {
        "incomeAmount": {
                 "value": {
                    "amount": 5000,
                     "unitOfAmount": {
                           "currency": {
                             "value": "GBP"
                             }
                           }
                         }
                       }
                    }

Tradable Product

A tradable product represents a financial product that is ready to be traded, ie included in an execution or contract, by associating a specific price and quantity to this product plus an (optional) mechanism for any potential future quantity adjustment.

"tradableProduct": {
      "counterparty": [
        {
          "partyReference": {
            "externalReference": "party1",
            "globalReference": "1ab3e71c"
          },
          "role": "PARTY_1"
        },
        {
          "partyReference": {
            "externalReference": "party2",
            "globalReference": "e6c82f54"
          },
          "role": "PARTY_2"
        }

  • Counterpartyattributes is an enumerated value (ie Party1 or Party2 ). The Counterparty attribute can then be positioned in the product (eg to specify which counterparty is the payer, receiver etc) with a counterparty type, that is positioned outside of the product definition, and allows the Counterparty attribute to be associated with an actual party reference.

  "priceQuantity": [
    {
      "meta": {
        "globalKey": "27a2ef6f"
      },
      "price": [
        {
          "meta": {
            "location": [
              {
                "scope": "DOCUMENT",
                "value": "price-1"
              }
            ]
          },
          "value": {
            "amount": 0.0164,
            "unitOfAmount": {
              "currency": {
                "value": "GPB"
              }
            },
            "perUnitOfAmount": {
              "currency": {
                "value": "GPB"
              }
            },
            "priceType": "INTEREST_RATE"
          }
        }
      ],
      "quantity": [
        {
          "meta": {
            "location": [
              {
                "scope": "DOCUMENT",
                "value": "quantity-1"
              }
            ]
          },
          "value": {
            "amount": 250000,
            "unitOfAmount": {
              "currency": {
                "value": "GBP"
              }
            }
          }
        }
      ]

  • Price Quantity attribute defines the settlement information as an exchange between two parties of a specified quantity of an asset (the quantity) against a specified quantity of another asset (the price). The settlement can be either cash or physical. In the case of non-cash products, the settlement of the price/quantity would not be specified here and instead would be delegated to the product mechanics as the price/quantity values.

  "product": {
    "loan": {
      "creditAgreeemtDate": {
        "meta": {
          "globalKey": "3f105d"
        },
        "value": {
          "day": 30,
          "month": 4,
          "year": 2021
        }
      },
      "loanLeg": [
        {
          "rateSpecification": {
            "fixedRate": {
              "meta": {
                "globalKey": "0"
              },
              "rateSchedule": {
                "initialValue": {
                  "address": {
                    "scope": "DOCUMENT",
                    "value": "price-1"
                  }
                }
              }
            }
          }

  • Product attribute defines the underlying product details that is the ready to be traded (ie included in the contract or execution).

    • Loan Leg identifies a loan by referencing a product identifier with a set of optional attributes.

    • Rate Schedule is a set of attributes defining a schedule of rates or amounts in terms of an initial value and then a series of step date and value pairs.

    • Credit Agreement Date specifies the closing date (the date where the agreement has been signed) for the loans in the credit agreement. Funding of the facilities occurs on (or sometimes a little after) the Credit Agreement date. This attribute is used to help identify which of the company's outstanding loans are being referenced by knowing which credit agreement it belongs to.

    • ISDA Standards Terms Supplement term: Date of Original Credit Agreement.

Trade Date

Trade date attribute specifies the date which the trade was agreed. The trade date attribute is based on (day, month, year).

"tradeDate": {
  "meta": {
    "globalKey": "3f105d"
  },
  "value": {
    "day": 30,
    "month": 4,
    "year": 2021
  }

Trade Identifier

Trade Identifier is a set of data attributes that consist of the 2 sub attributes. It represents identifier(s) that uniquely reference a trade for an identity issuer. A trade can include multiple identifiers (ie a trade that is reported to multiple jurisdictions, and has an associated USI (Unique Swap Identifier) UTI (Unique Trade Identifier).

"assignedIdentifier": [
      {
        "identifier": {
          "meta": {
            "scheme": "http://www.fpml.org/coding-scheme/external/uti"
          },
          "value": "UITD7895394"
        }
      }
    ]

  • Assigned Identifier refers to the issuer and the identifier and its associated version that provides the ability to associate multiple identifiers to one issuer and is consistent with the FpML Party Trade Identifier.

     "issuer": {      
       "meta": {
       "scheme": "http://www.fpml.org/coding-scheme/external/iso17442"
      },
      "value": "54930084UKLVMY22DS16"
   }

  • Issuer is an attribute when specified explicitly alongside the identifier value (instead of being specified by reference to a party).

Collateral

Collateral is a set of metadata attributes that defines the obligations of the counterparty that is subjected to credit support requirements. 

"propertyType": "PrivateResidential",
"dwellingType": "ApartmentOrFlat",
"physicalAddress": {
"street": "Sun Street",
"city": "Holbrokk",
"country": {
     "meta": {
          "scheme": "http://www.fpml.org/coding-scheme/external/iso3166"
          },
     "value": "GBR"

  • Within the collateral data type, property information such as the physical address, dwelling and property type would be specified.

    "ValuationDate": {
      "meta": {
        "globalKey": "3f105d"
      },
      "value": {
        "day": 15,
        "month": 4,
        "year": 2021
      }

  • Valuation date defines when payment will occur relative to the valuation date.

"PropertyValuation":
  {
  "address":
   { 
   "scope": "DOCUMENT", 
    "value": "price-2"
   } 
  },
  "PurchasePrice": {
    "address": { "scope": "DOCUMENT", 
    "value": "price-3" 
    }
  }

  • Property Valuation set of attributes specifies final valuation price. This price can be expressed either as an actual amount/currency. The value attribute can reference to another value specified in the swap document.

PreviousNormalising Common ComponentsNextProgrammable Reporting Logic and Machine Executable Reports

Last updated