NAV

Link API Overview

The Link API allows an application to submit mortgage applications to lenders and facilitates electronic interaction between brokers and lenders.

The Link API is a RESTful API that accepts both XML and JSON for requests and responses.

The Link API has the following operations:

For more information, check out the detailed API documentation below.

Authentication

POST https://api-link.newton.ca/identity/connect/token HTTP/1.1
Content-Type: application/x-www-form-urlencoded

Request Body

grant_type=client_credentials&scope=Link.Pos.Api&client_id=<client id>&client_secret=<secret password>

Authentication Response

{
    "access_token": "ie7JIONyQC8EdP4LCaJXn9HkkxnMt-VQ9D3a4SghfhCXITf_WoFop7tNnwu7-6SxViCQX...", 
    "token_type": "bearer", 
    "expires_in": 43199,
    "scope": "Link.Pos.Api"
}

Link API consumers must be authenticated and authorized to make API calls.

Link API uses JSON Web Tokens (JWTs) to authenticate requests.

Successful authentication request will return a payload containing a bearer token and a time (in seconds) until it expires. All API calls must include this token in the Authorization header. The token may be reused to make consecutive API calls as long as it is not expired, and once it is, an authentication request will need to be issued to receive a new token.

Consumers are encouraged to cache authorization tokens and only issue authentication request before an API call if the token had expired or is about to expire.

Authorization

All Link API calls will go through an authorzation process that wil determine if a given PoS system is allowed to perform requested operation on behalf of a given Firm. Therefore, all requests must provide posSystemId and unitId parameters.

Each PoS system consuming Link API will be assigned a unique posSystemId.

Errors

Error Response

{
  "error": [
    {
      "message": "[LinkApi] Validation Exception : PrimaryCustomer.Address.StreetType - The field StreetType is invalid.",
      "type": 1
    }
  ],
  "status": "error"
}

Link API calls will return a response with a 4XX HTTP status code when API is unable to process request, or a 5XX HTTP status code when a syste failure occurs.

4XX responses may include a response body including a list of errors, with an error type (business, vendor, system) and a message.

Examples of 4XX responses:

Status Description Most Likely Cause
400 Bad Request Invalid/missing data
401 Unauthorized Invalid/missing credentials
403 Forbidden Unauthorized request
404 Not Found The resource doesn't exists
409 Conflict Trying to overwrite a resource

Lender Details

GET https://api-link.newton.ca/v1/lender-details

GetLenderDetails allows a consumer to query a list of lenders and lender products.

Parameters

Name In Type Description
unitId query string (see Authorization)
posSystemId query string (see Authorization)

Responses

Sample Response

200 Response

{
  "lender": [
    {
      "lenderName": "Test Lender",
      "lenderCode": 9011,
      "lenderType": 1,
      "isPrime": true,
      "isAlternative": true,
      "isEquifaxAccredited": true,
      "isTransUnionAccredited": true,
      "lenderProduct": [
        {
          "productId": "b591810a-4796-bc11-a9b9-000d3af448b9",
          "productCode": "LLVAR10",
          "productName": "1 Year Variable",
          "productTerm": 12,
          "rateCompoundFrequency": 2,
          "postedRate": 3.2,
          "earlyPayout": 20,
          "startDate": "2022-01-27T00:00:00"
        },
        {
          "productId": "320c7618-937f-ec11-a9b8-000d3af458b9",
          "productCode": "LL5000",
          "productName": "5 Year Fixed",
          "productTerm": 60,
          "rateCompoundFrequency": 2,
          "postedRate": 3.33,
          "earlyPayout": 20,
          "startDate": "2021-12-10T00:00:00"
        }
      ],
      "underwriter": [
        {
          "businessType": 10,
          "userId": "PRIME",
          "unitId": "9011",
          "name": "Prime"
        },
        {
          "businessType": 20,
          "userId": "ALT",
          "unitId": "9011",
          "name": "Alternative"
        }
      ],
      "channel": [
        {
          "name": "Direct",
          "type": 0,
          "acceptSubmit": true,
          "acceptUpdate": true,
          "acceptCancel": false,
          "acceptNotes": false,
          "acceptDocs": true
        }
      ]
    }
  ],
  "status": "ok"
}
Status Schema
200 OK GetLenderDetails > Response

Response

GetLenderDetails

Name Type Description
error nullable array(ServiceError) List of errors
status required ResponseStatus
Enums
lender nullable array(Lender)
GetLenderDetails > Response
 List of Lenders

Lender

GetLenderDetails > Response

Name Type Description
lenderName nullable string max-length(50) ^[\s\S]*\S[\s\S]*$ Lender name
lenderCode nullable integer(int32) range(1000,9999) Lender code
lenderType LenderType
Enums
 Lender type
isPrime nullable boolean Is prime?
isAlternative nullable boolean Is alternative?
isEquifaxAccredited nullable boolean Is Equifax accredited?
isTransUnionAccredited nullable boolean Is TransUnion accredited?
isCMHCApproved nullable boolean Is CMHC approved?
lenderProduct nullable array(LenderProduct)
GetLenderDetails > Response
 List of Lender products
underwriter nullable array(Underwriter)
GetLenderDetails > Response
 List of Underwriters
channel nullable array(Channel) min-items(1)
GetLenderDetails > Response
 List of Submission channels

LenderProduct

GetLenderDetails > Response

Name Type Description
productId nullable string max-length(36) ^[\s\S]*\S[\s\S]*$ Product Id
productCode nullable string max-length(10) ^[\s\S]*\S[\s\S]*$ Product code
productName nullable string ^[\s\S]*\S[\s\S]*$ Product name
productNameFrench nullable string ^[\s\S]*\S[\s\S]*$ Product name (French)
productDescription nullable string ^[\s\S]*\S[\s\S]*$ Product description
productDescriptionFrench nullable string ^[\s\S]*\S[\s\S]*$ Product description (French)
productTerm nullable integer(int32) Product term
productBusinessType BusinessType
Enums
 Business type
rateCompoundFrequency RateCompoundFrequency
Enums
 Rate compound frequency
postedRate nullable number(double) range(0,999.99) Posted rate
basisPoints nullable integer(int32) Basis points
cashBack nullable integer(int32) Cashback
prePaymentOption PrePaymentOption
Enums
 Prepayment option
earlyPayout EarlyPayout
Enums
 Early payout
startDate nullable string(date-time) Start date
rateType RateType
Enums
 Rate type
lineofCreditIndicator nullable boolean Line of Credit indicator
lineofCreditRepayment LoCRepaymentType
Enums
 LoC repayment type

Underwriter

GetLenderDetails > Response

Name Type Description
userId nullable string max-length(10) ^\S+$ Underwriter user Id
unitId nullable string max-length(4) ^[A-Z0-9]{3,4}$ Underwriter unit Id
name nullable string ^[\s\S]*\S[\s\S]*$ Underwriter name
businessType BusinessType
Enums
 Business type

Channel

GetLenderDetails > Response

Name Type Description
name nullable string ^[\s\S]*\S[\s\S]*$ Channel name
type nullable integer(int32) range(0,9999) Lender channel
acceptSubmit nullable boolean Is submission accepted?
acceptUpdate nullable boolean Is update submission accepted?
acceptCancel nullable boolean Is cancel submission accepted?
acceptNotes nullable boolean Is notes submission accepted?
acceptDocs nullable boolean Is document submission accepted?

Submit Application

POST https://api-link.newton.ca/v1/applications

The Submit Application operation electronically submits a mortgage application to the lender for review. The application will move to a pending state until the lender responds with a decision (accepted, declined, cancelled, etc.)

Parameters

Sample Request

{
  "commonData": {
    "assetList": {
      "assetRealEstate": [
        {
          "key": "property-48853",
          "value": 500000,
          "originalPrice": 350000,
          "originalDate": "2008-04-29"
        }
      ],
      "assetOther": [
        {
          "key": "asset-40788",
          "value": 10000,
          "assetType": 70,
          "description": "savings"
        },
        {
          "key": "asset-40783",
          "value": 50000,
          "assetType": 10,
          "description": "Cash in the bank"
        }
      ]
    },
    "liabilityList": {
      "liabilityRealEstate": [
        {
          "key": "property-48853-1",
          "fromCreditBureau": false,
          "accountNumber": "598685",
          "monthlyRepayment": 1000,
          "originalLoanAmount": 250000,
          "outstandingBalance": 100000,
          "closingDate": "2008-04-29",
          "lenderName": "RBC",
          "chargeType": 1,
          "repaymentType": 2,
          "redemptionStatus": 4,
          "maturityDate": "2023-02-01",
          "netRate": 5,
          "rateType": 0
        }
      ],
      "liabilityOther": [
        {
          "key": "liability-42362",
          "fromCreditBureau": false,
          "repaymentIndicator": false,
          "monthlyRepayment": 150,
          "creditLimit": 1000,
          "outstandingBalance": 2000,
          "lenderName": "AMEX",
          "liabilityType": 6
        }
      ]
    },
    "addressList": {
      "applicationAddressCanada": [
        {
          "cityTown": "High River",
          "provinceCode": 20,
          "postalCode": "T1V1J5",
          "key": "address-402175",
          "postalAddressStreetAddress": {
            "streetNumber": "311",
            "streetName": "Aurora",
            "streetType": 190
          }
        },
        {
          "cityTown": "Markham",
          "provinceCode": 50,
          "postalCode": "L3S4N5",
          "key": "address-402176",
          "postalAddressStreetAddress": {
            "unitNumber": "10",
            "streetNumber": "11",
            "streetName": "Chruch",
            "streetType": 490
          }
        },
        {
          "cityTown": "Toronto",
          "provinceCode": 50,
          "postalCode": "M2J5C4",
          "key": "address-402174",
          "postalAddressStreetAddress": {
            "unitNumber": "8",
            "streetNumber": "567",
            "streetName": "Brock",
            "streetType": 490,
            "streetDirection": 7
          }
        }
      ]
    }
  },
  "customerData": {
    "customerList": {
      "customerPrimaryBorrower": {
        "key": "borrower-112109",
        "correspondenceLanguage": 1,
        "dateBirth": "1976-11-12",
        "honorific": 1,
        "lastName": "Daniels",
        "firstName": "Bob",
        "emailAddress1": "bob@test.com",
        "sin": "999999998",
        "maritalStatus": 2,
        "numberOfDependents": 1,
        "sex": 1,
        "residentType": 10,
        "customerTelephoneNumberList": [
          {
            "usage": 1,
            "preferred": true,
            "telephoneNumber": {
              "countryCode": "1",
              "areaCode": "905",
              "phoneNumber": "9100010"
            }
          },
          {
            "usage": 2,
            "preferred": false,
            "telephoneNumber": {
              "countryCode": "1",
              "areaCode": "905",
              "phoneNumber": "9101457",
              "phoneExtension": "333"
            }
          },
          {
            "usage": 3,
            "preferred": false,
            "telephoneNumber": {
              "countryCode": "1",
              "areaCode": "647",
              "phoneNumber": "9101547"
            }
          }
        ],
        "employmentList": {
          "employment": [
            {
              "employmentType": 1,
              "employmentStatus": 10,
              "dateStart": "2021-11-01",
              "industryType": 8,
              "dateStartedInIndustry": "2011-06-13",
              "occupationType": 5,
              "jobTitle": "Manager",
              "companyName": "American Express",
              "addressCanada": {
                "cityTown": "Toronto",
                "provinceCode": 50,
                "postalCode": "M9M9M9",
                "postalAddressStreetAddress": {
                  "streetNumber": "456",
                  "streetName": "Yorkland",
                  "streetType": 380
                }
              },
              "earnedIncomeList": {
                "earnedIncome": [
                  {
                    "earnedIncomeType": 9,
                    "paymentFrequency": 1,
                    "earnedIncomeAmount": 90000
                  }
                ]
              },
              "contactTelephoneNumber": {
                "usage": 10,
                "telephoneNumber": {
                  "countryCode": "1",
                  "areaCode": "403",
                  "phoneNumber": "3431234",
                  "phoneExtension": "12"
                }
              }
            },
            {
              "employmentType": 1,
              "employmentStatus": 10,
              "dateStart": "2015-05-01",
              "dateEnd": "2021-11-01",
              "industryType": 8,
              "dateStartedInIndustry": "2011-06-13",
              "occupationType": 1,
              "jobTitle": "Manager",
              "companyName": "Prev Company",
              "earnedIncomeList": {
                "earnedIncome": [
                  {
                    "earnedIncomeType": 10,
                    "paymentFrequency": 1,
                    "earnedIncomeAmount": 50000
                  }
                ]
              },
              "contactTelephoneNumber": {
                "usage": 10,
                "telephoneNumber": {
                  "countryCode": "1",
                  "areaCode": "528",
                  "phoneNumber": "2965859"
                }
              }
            }
          ]
        },
        "unearnedIncomeList": {
          "unearnedIncome": [
            {
              "unearnedIncomeAmount": 800,
              "unearnedIncomeType": 99,
              "paymentFrequency": 12,
              "unearnedIncomeDetails": "From FD"
            }
          ]
        }
      },
      "customerBorrower": [
        {
          "key": "borrower-112110",
          "correspondenceLanguage": 1,
          "dateBirth": "1975-04-14",
          "honorific": 4,
          "lastName": "Daniels",
          "firstName": "Marsha",
          "emailAddress1": "marsha@test.com",
          "maritalStatus": 2,
          "numberOfDependents": 0,
          "sex": 2,
          "residentType": 10,
          "customerTelephoneNumberList": [
            {
              "usage": 1,
              "preferred": false,
              "telephoneNumber": {
                "countryCode": "1",
                "areaCode": "905",
                "phoneNumber": "9100010"
              }
            },
            {
              "usage": 3,
              "preferred": true,
              "telephoneNumber": {
                "countryCode": "1",
                "areaCode": "647",
                "phoneNumber": "7891546"
              }
            }
          ],
          "employmentList": {
            "employment": [
              {
                "employmentType": 1,
                "employmentStatus": 10,
                "dateStart": "2017-02-01",
                "industryType": 8,
                "dateStartedInIndustry": "2007-07-13",
                "occupationType": 1,
                "jobTitle": "Marketing Manager",
                "companyName": "Chase Bank",
                "addressCanada": {
                  "cityTown": "Toronto",
                  "provinceCode": 50,
                  "postalCode": "M9M9M9",
                  "postalAddressStreetAddress": {
                    "unitNumber": "659",
                    "streetNumber": "585",
                    "streetName": "3663 South",
                    "streetType": 320,
                    "streetDirection": 2
                  }
                },
                "earnedIncomeList": {
                  "earnedIncome": [
                    "[Object]"
                  ]
                },
                "contactTelephoneNumber": {
                  "usage": 10,
                  "telephoneNumber": {
                    "countryCode": "1",
                    "areaCode": "403",
                    "phoneNumber": "5298259",
                    "phoneExtension": "859"
                  }
                }
              }
            ]
          },
          "unearnedIncomeList": {
            "unearnedIncome": [
              {
                "unearnedIncomeAmount": 800,
                "unearnedIncomeType": 3,
                "paymentFrequency": 12,
                "unearnedIncomeDetails": "From FD"
              }
            ]
          },
          "customerRelationship": {
            "relationshipToOwnerType": 1
          }
        }
      ]
    },
    "customerAddressList": {
      "customerAddressPrimaryResidence": [
        {
          "currentPropertyIntendedActionType": 1,
          "annualHeatingAmount": 1500,
          "annualTaxAmount": 2560,
          "refkeyAddress": "address-402175",
          "customerReference": [
            {
              "refkeyCustomer": "borrower-112109"
            }
          ],
          "customerCurrentAddressTimeAt": [
            {
              "fromDate": "2021-02-01",
              "refkeyCustomer": "borrower-112109"
            }
          ],
          "customerLiabilityRealEstate": [
            {
              "refkeyLiability": "property-48853-1",
              "customerReference": {
                "refkeyCustomer": "borrower-112109"
              }
            }
          ],
          "addressOccupancyPartialOwnerOccupied": {
            "refkeyAsset": "property-48853",
            "rentalDetails": {
              "annualGrossRentalIncome": 15000,
              "hydro": 1500,
              "rentalOffset": 65,
              "rentalCalcType": 2
            }
          }
        },
        {
          "currentPropertyIntendedActionType": 1,
          "annualHeatingAmount": 1500,
          "annualTaxAmount": 2560,
          "refkeyAddress": "address-402175",
          "customerReference": [
            {
              "refkeyCustomer": "borrower-112110"
            }
          ],
          "customerCurrentAddressTimeAt": [
            {
              "fromDate": "2017-01-01",
              "refkeyCustomer": "borrower-112110"
            }
          ],
          "addressOccupancyPartialOwnerOccupied": {
            "refkeyAsset": "property-48853",
            "rentalDetails": {
              "annualGrossRentalIncome": 15000,
              "hydro": 1500,
              "rentalOffset": 65,
              "rentalCalcType": 2
            }
          }
        }
      ],
      "customerAddressCorrespondence": [
        {
          "refkeyAddress": "address-402176",
          "customerReference": [
            {
              "refkeyCustomer": "borrower-112109"
            }
          ],
          "addressOccupancyNone": {}
        }
      ]
    },
    "customerAssetList": [
      {
        "refkeyAsset": "asset-40788",
        "customerReference": {
          "refkeyCustomer": "borrower-112109"
        }
      },
      {
        "refkeyAsset": "asset-40783",
        "customerReference": {
          "refkeyCustomer": "borrower-112110"
        }
      }
    ],
    "customerLiabilityList": [
      {
        "refkeyLiability": "liability-42362",
        "customerReference": {
          "refkeyCustomer": "borrower-112109"
        }
      }
    ]
  },
  "mortgageApplication": {
    "posApplicationNumber": "VXDTB-70014",
    "fundingDate": "2022-11-08",
    "loanPurposeType": 5,
    "purchasePriceEstimatedValue": 600000,
    "typeOfBuyer": 20,
    "additionalPurpose": "Switch and Transfer",
    "subjectProperty": {
      "occupancyPurpose": 4,
      "mlsListed": true,
      "mlsNumber": "4891256",
      "heatingType": 2,
      "parkingType": 1,
      "yearBuilt": 2001,
      "waterSupplyType": 10,
      "waterWasteType": 10,
      "propertySize": 2222,
      "propertySizeUnits": 1,
      "lotSize": 2222,
      "lotSizeUnits": 1,
      "environmentalHazardIndicator": false,
      "annualHeatingAmount": 1800,
      "numberOfUnitsTotal": 1,
      "propertyType": 99,
      "propertyDescriptionType": 6,
      "propertyUsageType": 90,
      "propertyZoningType": 1,
      "newPropertyIndicator": false,
      "subjectPropertyOccupancyOwnerOccupied": {},
      "legalAddress": {
        "details": "6 Toronto",
        "pin": "777"
      },
      "condo": {
        "annualCondoFees": 4200
      },
      "propertyTax": {
        "annualTaxAmount": 3500,
        "taxesPaidBy": 1
      },
      "subjectPropertyAddress": {
        "refkeyAddress": "address-402174"
      }
    },
    "loan": {
      "loanAmount": 0,
      "chargeType": 1,
      "termMonths": 6,
      "amortizationMonths": 188,
      "netRate": 3.33,
      "qualifyingRate": 3.75,
      "maturityDate": "2023-05-08",
      "firstPaymentDate": "2022-12-08",
      "interestAdjustmentDate": "2022-11-08",
      "requestedPayment": 2733.58,
      "paymentAmount": 2733.58,
      "paymentFrequency": 12,
      "repaymentType": 2,
      "lenderCode": 9011,
      "customProduct": {
        "productCode": "LL5000",
        "productName": "5 Year Fixed EST",
        "rateType": 0,
        "rateCompoundFrequency": 12,
        "postedRate": 3.33,
        "productTerm": 6
      }
    },
    "downpaymentList": {
      "downpayment": [
        {
          "downpaymentSourceType": 9,
          "description": "Property - 311 Aurora Drive, Calgary, Alberta",
          "amount": 200000
        }
      ]
    },
    "firm": {
      "firmId": "XDTB",
      "externalPoSFirm": [
        {
          "posSystemId": 50,
          "firmId": "XDTB"
        }
      ]
    },
    "submittingAgent": {
      "firstName": "Aleesha",
      "lastName": "Ashraf",
      "emailAddress": "aleesha.ashraf@newton.ca",
      "mortgageLicenseNumber": "9988889",
      "externalPoSUser": [
        {
          "posSystemId": 50,
          "firmId": "XDTB",
          "userId": "112233"
        }
      ]
    },
    "originatingAgent": {
      "firstName": "Karen",
      "lastName": "Poulin",
      "emailAddress": "karen.poulin@mscanada.com",
      "mortgageLicenseNumber": "B7403",
      "externalPoSUser": [
        {
          "posSystemId": 50,
          "firmId": "XDTB",
          "userId": "11246"
        }
      ],
      "addressCanada": {
        "cityTown": "Vancouver",
        "provinceCode": 10,
        "postalCode": "V6H3V3",
        "postalAddressStreetAddress": {
          "unitNumber": "550",
          "streetNumber": "2608",
          "streetName": "Granville",
          "streetType": 490,
          "streetDirection": 6
        }
      }
    },
    "broker": {
      "firstName": "Aleesha",
      "lastName": "Ashraf",
      "emailAddress": "aleesha.ashraf@newton.ca",
      "mortgageLicenseNumber": "9988889",
      "externalPoSUser": [
        {
          "posSystemId": 50,
          "firmId": "XDTB",
          "userId": "112233"
        }
      ]
    }
  }
}
Name In Type Description
body Request
SubmitApplication

At the top level, the body of a SubmitApplication request is broken down into elements (XML) and objects (JSON) that represent different sections of the request.

Request

SubmitApplication

Name Type Description
unitId required string min-length(1) Unit Id (see Authorization)
posSystem required string min-length(1) max-length(10) PoS System (see Authorization)
commonData required CommonData
SubmitApplication > Request
 Common data - AssetList, LiabilityList, AddressList, CreditBureauList
customerData required CustomerData
SubmitApplication > Request
 Customer data
mortgageApplication required MortgageApplication
SubmitApplication > Request
 Mortgage application
memo nullable string Memo (freeform text)

CommonData

SubmitApplication > Request

Name Type Description
assetList required AssetList
SubmitApplication > Request
 List of assets
liabilityList required LiabilityList
SubmitApplication > Request
 Liability list
addressList required AddressList
SubmitApplication > Request
 Address list
creditBureauList CreditBureauList
SubmitApplication > Request
 List of Credit bureaus

AssetList

SubmitApplication > Request

Name Type Description
assetRealEstate nullable array(AssetRealEstate) max-items(99)
SubmitApplication > Request
 List of Real estate assets
assetOther nullable array(AssetOther) max-items(99)
SubmitApplication > Request
 List of Other assets

AssetRealEstate

SubmitApplication > Request

Name Type Description
key required string max-length(256) ^\S+$ Asset key (see Refkeys)
value required number(double) range(0,99999999.99) Asset value
originalPrice nullable number(double) range(0,99999999.99) Original price
originalDate nullable string(date) Original date

AssetOther

SubmitApplication > Request

Name Type Description
key required string max-length(256) ^\S+$ Asset key (see Refkeys)
value required number(double) range(0,99999999.99) Asset value
assetType required AssetOtherType
Enums
 Asset other type
location nullable string max-length(50) ^[\s\S]*\S[\s\S]*$ Asset location
maturityDate nullable string(date) Asset maturity date
additionalAssetHolders nullable string max-length(255) ^[\s\S]*\S[\s\S]*$ Additional asset holders
description nullable string max-length(50) ^[\s\S]*\S[\s\S]*$ Asset description

LiabilityList

SubmitApplication > Request

Name Type Description
liabilityRealEstate nullable array(LiabilityRealEstate) max-items(99)
SubmitApplication > Request
 Liability list (Real estate)
liabilityOther nullable array(LiabilityOther) max-items(99)
SubmitApplication > Request
 Liability list (Other)

LiabilityRealEstate

SubmitApplication > Request

Name Type Description
key required string max-length(256) ^\S+$ Liability key (see Refkeys)
fromCreditBureau nullable boolean From credit bureau?
accountNumber nullable string max-length(20) ^[\s\S]*\S[\s\S]*$ Account number
othersResponsible nullable boolean Are others responsible?
othersResponsibleDetails nullable string max-length(255) ^[\s\S]*\S[\s\S]*$ Others responsible details
monthlyRepayment required number(double) range(0,9999999.99) Monthly repayment
originalLoanAmount required number(double) range(0,99999999.99) Original loan amount
outstandingBalance required number(double) range(0,99999999.99) Outstanding balance
closingDate nullable string(date) Closing date
lenderName required string min-length(1) max-length(44) Lender name
chargeType required ChargeType
Enums
 Charge type
repaymentType required LoanRepaymentType
Enums
 Loan repayment type
redemptionStatus required LoanRedemptionStatus
Enums
 Loan redemption status
inDefault nullable boolean Is in default?
purchasePrice nullable number(double) range(0,99999999.99) Purchase price
maturityDate nullable string(date) Maturity date
netRate nullable number(double) range(0,999.99) Net rate
rateType RateType
Enums
 Rate type
mortgageInsurer MortgageInsurerType
Enums
 Mortgage insurer type
insuredAmount nullable number(double) range(0,99999999.99) Insured amount
insurancePremium nullable number(double) range(0,999999.99) Insurance premium
insuranceCertificateNumber nullable string max-length(10) ^[\s\S]*\S[\s\S]*$ Insurance certificate number

LiabilityOther

SubmitApplication > Request

Name Type Description
key required string max-length(256) ^\S+$ Liability key (see Refkeys)
fromCreditBureau nullable boolean From credit bureau?
dateEnd nullable string(date) End date
accountNumber nullable string max-length(30) ^[\s\S]*\S[\s\S]*$ Account number
repaymentIndicator nullable boolean Repayment indicator
payoffType PayoffType
Enums
 Payoff type
monthlyRepayment nullable number(double) range(0,9999999.99) Monthly repayment
creditLimit nullable number(double) range(0,99999999.99) Credit limit
outstandingBalance nullable number(double) range(0,99999999.99) Outstanding balance
lenderName required string min-length(1) max-length(50) Lender name
creditCardType CreditCardType
Enums
 Credit card type
liabilityType required LiabilityType
Enums
 Liability type
additionalHolders nullable boolean Additional holders?
additionalHoldersDetails nullable string max-length(255) ^[\s\S]*\S[\s\S]*$ Additional holders details

AddressList

SubmitApplication > Request

Name Type Description
applicationAddressCanada nullable array(ApplicationAddressCanada) max-items(99)
SubmitApplication > Request
 List of addresses (Canada)
applicationAddressUSA nullable array(ApplicationAddressUSA) max-items(99)
SubmitApplication > Request
 List of addresses (USA)
applicationAddressOther nullable array(ApplicationAddressOther) max-items(99)
SubmitApplication > Request
 List of addresses (Other)
applicationAddressCanadaPartial ApplicationAddressCanadaPartial
SubmitApplication > Request
 Partial address (Canada)

ApplicationAddressCanada

SubmitApplication > Request

Remarks

  • Only one of PostalAddressStreetAddress or PostalAddressPOBox needs to be provided
Name Type Description
cityTown required string min-length(1) max-length(40) City/town (municipality)
provinceCode required ProvinceStateCodeCanada
Enums
 Province code (Canada)
postalCode required string ^[A-Za-z][0-9][A-Za-z][ ]?[0-9][A-Za-z][0-9]$ Postal code
key required string max-length(256) ^\S+$ Address key (see Refkeys)
postalAddressStreetAddress PostalAddressStreetAddress
SubmitApplication > Request
 Postal address (Street address)
postalAddressPOBox PostalAddressPOBox
SubmitApplication > Request
 Postal address (PO box)

PostalAddressStreetAddress

SubmitApplication > Request

Name Type Description
unitNumber nullable string max-length(10) Unit number
streetNumber nullable string max-length(10) ^[\s\S]*\S[\s\S]*$ Street number
streetName required string min-length(1) max-length(26) Street name
streetType StreetTypeCode
Enums
 Street type code
streetDirection StreetDirectionCode
Enums
 Street direction code

PostalAddressPOBox

SubmitApplication > Request

Name Type Description
unitNumber nullable string max-length(10) Unit number
streetNumber nullable string max-length(10) Street number
streetName nullable string max-length(26) Street name
streetType StreetTypeCode
Enums
 Street type code
streetDirection StreetDirectionCode
Enums
 Street direction code
poBoxRRNumber required string min-length(1) max-length(40) PO box/RR number

ApplicationAddressUSA

SubmitApplication > Request

Remarks

  • Only one of PostalAddressStreetAddress or PostalAddressPOBox needs to be provided
Name Type Description
cityTown required string min-length(1) max-length(40) City/town (municipality)
provinceCode required ProvinceStateCodeUSA
Enums
 State Code (USA)
postalCode required string ^[0-9]{5}(-[0-9]{4})?$ Postal code
key required string max-length(256) ^\S+$ Address key (see Refkeys)
postalAddressStreetAddress PostalAddressStreetAddress
SubmitApplication > Request
 Postal address (Street address)
postalAddressPOBox PostalAddressPOBox
SubmitApplication > Request
 Postal address (PO box)

ApplicationAddressOther

SubmitApplication > Request

Remarks

  • Only one of PostalAddressStreetAddress or PostalAddressPOBox needs to be provided
Name Type Description
cityTown required string min-length(1) max-length(40) City/town (municipality)
postalCode required string max-length(10) Postal code
key required string max-length(256) ^\S+$ Address key (see Refkeys)
postalAddressStreetAddress PostalAddressStreetAddress
SubmitApplication > Request
 Postal address (Street address)
postalAddressPOBox PostalAddressPOBox
SubmitApplication > Request
 Postal address (PO box)

ApplicationAddressCanadaPartial

SubmitApplication > Request

Name Type Description
key required string max-length(256) ^\S+$ Address key (see Refkeys)
provinceCode required ProvinceStateCodeCanada
Enums
 Province code (Canada)

CreditBureauList

SubmitApplication > Request

Name Type Description
creditBureau nullable array(CreditBureau) max-items(99)
SubmitApplication > Request
 List of Credit bureaus

CreditBureau

SubmitApplication > Request

Remarks

  • Only one of CreditReportEquifax or CreditReportTransUnion needs to be provided
Name Type Description
key required string max-length(256) ^\S+$ Credit bureau key (see Refkeys)
provider required CreditReportProvider
Enums
 Credit report provider
creditReportEquifax CreditReportEquifax
SubmitApplication > Request
 Credit bureau report (Equifax)
creditReportTransUnion CreditReportTransUnion
SubmitApplication > Request
 Credit bureau report (TransUnion)
humanReadableReport required HumanReadableReport
SubmitApplication > Request
 Human readable report
xmlData XMLData
SubmitApplication > Request
 XML data (with PDF)

CreditReportEquifax

SubmitApplication > Request

Name Type Description
reportDate nullable string(date-time) Report data
creditScore nullable integer(int32) range(0,99999) Credit score
jointCreditScore nullable integer(int32) range(0,99999) Joint credit score
noHit nullable boolean Not hit?
jointNoHit nullable boolean Joint no hit?
dataFormat CreditReportDataFormat
Enums
 Credit report data format
value required string min-length(1) Credit report

CreditReportTransUnion

SubmitApplication > Request

Name Type Description
reportDate nullable string(date-time) Report data
creditScore nullable integer(int32) range(0,99999) Credit score
jointCreditScore nullable integer(int32) range(0,99999) Joint credit score
noHit nullable boolean Not hit?
jointNoHit nullable boolean Joint no hit?
value required string min-length(1) Credit report

HumanReadableReport

SubmitApplication > Request

Name Type Description
type required HumanReadableReportType
Enums
 Human readable report type
value required string min-length(1) Value is used to hold the report body

XMLData

SubmitApplication > Request

Name Type Description
value nullable string ^[\s\S]*\S[\s\S]*$ XML data (with PDF)

CustomerData

SubmitApplication > Request

Remarks

  • refkeyCustomer referenced in customerCreditBureaus may not be duplicated
Name Type Description
customerList required CustomerList
SubmitApplication > Request
 Customer list
customerAddressList required CustomerAddressList
SubmitApplication > Request
 Customer address list
customerAssetList nullable array(CustomerAssetOther)
SubmitApplication > Request
 Customer asset list
customerLiabilityList nullable array(CustomerLiabilityOther)
SubmitApplication > Request
 Customer liability list
customerCreditBureauList nullable array(CustomerCreditBureau)
SubmitApplication > Request
 Customer credit bureau list

CustomerList

SubmitApplication > Request

Name Type Description
customerPrimaryBorrower required CustomerPrimaryBorrower
SubmitApplication > Request
 Customer Primary Borrower
customerBorrower nullable array(CustomerBorrower) max-items(4)
SubmitApplication > Request
 List of Customer Borrowers
customerGuarantor nullable array(CustomerGuarantor) max-items(4)
SubmitApplication > Request
 List of Customer Guarantors

CustomerPrimaryBorrower

SubmitApplication > Request

Name Type Description
key required string max-length(256) ^\S+$ Key - see refkeys
correspondenceLanguage CorrespondenceLangugageType
Enums
 Correspondence langugage type
dateBirth nullable string(date) Date of birth
honorific HonorificType
Enums
 Title
lastName required string min-length(1) max-length(40) Last name
firstName required string min-length(1) max-length(30) First name
middleName nullable string max-length(30) ^[\s\S]*\S[\s\S]*$ Middle name
suffix SuffixType
Enums
 Suffix
emailAddress1 nullable string max-length(100) ^[\s\S]*\S[\s\S]*$ Email address 1
emailAddress2 nullable string max-length(100) ^[\s\S]*\S[\s\S]*$ Email address 2
sin nullable string max-length(9) ^[\s\S]*\S[\s\S]*$ Social insurance number
maritalStatus MaritalStatusType
Enums
 Marital status type
numberOfDependents nullable integer(int32) range(0,999) Number of dependents
sex Sex
Enums
 Sex
residentType Resident
Enums
 Resident
customerTelephoneNumberList nullable array(CustomerTelephoneNumber) max-items(99)
SubmitApplication > Request
 Customer telephone number list
employmentList EmploymentList
SubmitApplication > Request
 List of employments
bankruptcyHistoryList BankruptcyHistoryList
SubmitApplication > Request
 List of Bankruptcy history
unearnedIncomeList UnearnedIncomeList
SubmitApplication > Request
 List of unearned incomes
customerRelationship CustomerRelationship
SubmitApplication > Request
 Customer relationship

CustomerTelephoneNumber

SubmitApplication > Request

Name Type Description
usage TelephoneUsageType
Enums
 Telephone usage type
contactTime nullable string max-length(30) ^[\s\S]*\S[\s\S]*$ Contact time
preferred nullable boolean Preferred?
telephoneNumber required TelephoneNumber
SubmitApplication > Request
 Telephone number

TelephoneNumber

SubmitApplication > Request

Name Type Description
countryCode nullable string max-length(3) ^\d+$ Country code
areaCode nullable string max-length(5) ^\d+$ Area code
phoneNumber required string max-length(30) ^\d+$ Phone number
phoneExtension nullable string max-length(8) ^\d+$ Phone extension

EmploymentList

SubmitApplication > Request

Name Type Description
employment nullable array(Employment) max-items(99)
SubmitApplication > Request
 List of Employments

Employment

SubmitApplication > Request

Remarks

  • Only one of AddressCanada, AddressUSA or AddressOther may be provided
Name Type Description
employmentType EmploymentType
Enums
 Employment type
employmentStatus EmploymentStatus
Enums
 Employment status
dateStart required string(date) Start date
dateEnd nullable string(date) End date
industryType EmploymentIndustryType
Enums
 Employment industry type
dateStartedInIndustry nullable string(date) Date started in industry
occupationType EmploymentOccupationType
Enums
 Employment occupation type
jobTitle nullable string max-length(50) ^[\s\S]*\S[\s\S]*$ Job title
companyName nullable string max-length(45) ^[\s\S]*\S[\s\S]*$ Company name
companyType nullable string max-length(35) ^[\s\S]*\S[\s\S]*$ Company type
operatingAs nullable string max-length(35) ^[\s\S]*\S[\s\S]*$ Operating as
addressCanada AddressCanada
SubmitApplication > Request
 Address (Canada)
addressUSA AddressUSA
SubmitApplication > Request
 Address (USA)
addressOther AddressOther
SubmitApplication > Request
 Address (Other)
earnedIncomeList EarnedIncomeList
SubmitApplication > Request
 List of earned income
contactPerson ContactPerson
SubmitApplication > Request
 Contact person
contactTelephoneNumber ContactTelephoneNumber
SubmitApplication > Request
 Contact telephone number

AddressCanada

SubmitApplication > Request

Remarks

  • Only one of PostalAddressStreetAddress or PostalAddressPOBox needs to be provided
Name Type Description
cityTown required string min-length(1) max-length(40) City/town (municipality)
provinceCode required ProvinceStateCodeCanada
Enums
 Province code (Canada)
postalCode required string ^[A-Za-z][0-9][A-Za-z][ ]?[0-9][A-Za-z][0-9]$ Postal code
postalAddressStreetAddress PostalAddressStreetAddress
SubmitApplication > Request
 Postal address (Street address)
postalAddressPOBox PostalAddressPOBox
SubmitApplication > Request
 Postal address (PO box)

AddressUSA

SubmitApplication > Request

Remarks

  • Only one of PostalAddressStreetAddress or PostalAddressPOBox needs to be provided
Name Type Description
cityTown required string min-length(1) max-length(40) City/town (municipality)
provinceCode required ProvinceStateCodeUSA
Enums
 State Code (USA)
postalCode required string ^[0-9]{5}(-[0-9]{4})?$ Postal code
postalAddressStreetAddress PostalAddressStreetAddress
SubmitApplication > Request
 Postal address (Street address)
postalAddressPOBox PostalAddressPOBox
SubmitApplication > Request
 Postal address (PO box)

AddressOther

SubmitApplication > Request

Remarks

  • Only one of PostalAddressStreetAddress or PostalAddressPOBox needs to be provided
Name Type Description
cityTown required string min-length(1) max-length(40) City/town (municipality)
postalCode required string max-length(10) Postal code
postalAddressStreetAddress PostalAddressStreetAddress
SubmitApplication > Request
 Postal address (Street address)
postalAddressPOBox PostalAddressPOBox
SubmitApplication > Request
 Postal address (PO box)

EarnedIncomeList

SubmitApplication > Request

Name Type Description
earnedIncome nullable array(EarnedIncome) max-items(99)
SubmitApplication > Request
 List of Earned incomes

EarnedIncome

SubmitApplication > Request

Name Type Description
earnedIncomeType required EarnedIncomeType
Enums
 Earned income type
paymentFrequency required PaymentFrequency
Enums
 Payment frequency
earnedIncomeAmount required number(double) range(0,9999999.99) Earned income amount

ContactPerson

SubmitApplication > Request

Name Type Description
honorific HonorificType
Enums
 Title
lastName required string min-length(1) max-length(40) Last name
firstName required string min-length(1) max-length(30) First name
emailAddress nullable string max-length(100) ^[\s\S]*\S[\s\S]*$ Email address

ContactTelephoneNumber

SubmitApplication > Request

Name Type Description
usage ContactTelephoneUsageType
Enums
 Contact telephone usage type
contactTime nullable string max-length(30) ^[\s\S]*\S[\s\S]*$ Contact time
telephoneNumber required TelephoneNumber
SubmitApplication > Request
 Telephone number

BankruptcyHistoryList

SubmitApplication > Request

Name Type Description
bankruptcyHistory nullable array(BankruptcyHistory) max-items(99)
SubmitApplication > Request
 List of Bankruptcy history

BankruptcyHistory

SubmitApplication > Request

Name Type Description
debtAmount nullable number(double) range(0,99999999.99) Debt amount
dateDeclared nullable string(date) Date declared
dateDischarged required string(date) Date discharged
monthlyRepayment nullable number(double) range(0,9999999.99) Monthly repayment
otherDetails nullable string max-length(255) ^[\s\S]*\S[\s\S]*$ Other details

UnearnedIncomeList

SubmitApplication > Request

Name Type Description
unearnedIncome nullable array(UnearnedIncome) max-items(99)
SubmitApplication > Request
 List of Unearned incomes

UnearnedIncome

SubmitApplication > Request

Name Type Description
unearnedIncomeAmount nullable number(double) range(0,9999999.99) Unearned income amount
unearnedIncomeType required UnearnedIncomeType
Enums
 Unearned income type
paymentFrequency required PaymentFrequency
Enums
 Payment frequency
unearnedIncomeDetails nullable string max-length(255) ^[\s\S]*\S[\s\S]*$ Unearned income details

CustomerRelationship

SubmitApplication > Request

Name Type Description
relationshipToOwnerType ApplicantRelationship
Enums
 Applicant relationship

CustomerBorrower

SubmitApplication > Request

Name Type Description
key required string max-length(256) ^\S+$ Key - see refkeys
correspondenceLanguage CorrespondenceLangugageType
Enums
 Correspondence langugage type
dateBirth nullable string(date) Date of birth
honorific HonorificType
Enums
 Title
lastName required string min-length(1) max-length(40) Last name
firstName required string min-length(1) max-length(30) First name
middleName nullable string max-length(30) ^[\s\S]*\S[\s\S]*$ Middle name
suffix SuffixType
Enums
 Suffix
emailAddress1 nullable string max-length(100) ^[\s\S]*\S[\s\S]*$ Email address 1
emailAddress2 nullable string max-length(100) ^[\s\S]*\S[\s\S]*$ Email address 2
sin nullable string max-length(9) ^[\s\S]*\S[\s\S]*$ Social insurance number
maritalStatus MaritalStatusType
Enums
 Marital status type
numberOfDependents nullable integer(int32) range(0,999) Number of dependents
sex Sex
Enums
 Sex
residentType Resident
Enums
 Resident
customerTelephoneNumberList nullable array(CustomerTelephoneNumber) max-items(99)
SubmitApplication > Request
 Customer telephone number list
employmentList EmploymentList
SubmitApplication > Request
 List of employments
bankruptcyHistoryList BankruptcyHistoryList
SubmitApplication > Request
 List of Bankruptcy history
unearnedIncomeList UnearnedIncomeList
SubmitApplication > Request
 List of unearned incomes
customerRelationship CustomerRelationship
SubmitApplication > Request
 Customer relationship

CustomerGuarantor

SubmitApplication > Request

Name Type Description
key required string max-length(256) ^\S+$ Key - see refkeys
correspondenceLanguage CorrespondenceLangugageType
Enums
 Correspondence langugage type
dateBirth nullable string(date) Date of birth
honorific HonorificType
Enums
 Title
lastName required string min-length(1) max-length(40) Last name
firstName required string min-length(1) max-length(30) First name
middleName nullable string max-length(30) ^[\s\S]*\S[\s\S]*$ Middle name
suffix SuffixType
Enums
 Suffix
emailAddress1 nullable string max-length(100) ^[\s\S]*\S[\s\S]*$ Email address 1
emailAddress2 nullable string max-length(100) ^[\s\S]*\S[\s\S]*$ Email address 2
sin nullable string max-length(9) ^[\s\S]*\S[\s\S]*$ Social insurance number
maritalStatus MaritalStatusType
Enums
 Marital status type
numberOfDependents nullable integer(int32) range(0,999) Number of dependents
sex Sex
Enums
 Sex
residentType Resident
Enums
 Resident
customerTelephoneNumberList nullable array(CustomerTelephoneNumber) max-items(99)
SubmitApplication > Request
 Customer telephone number list
employmentList EmploymentList
SubmitApplication > Request
 List of employments
bankruptcyHistoryList BankruptcyHistoryList
SubmitApplication > Request
 List of Bankruptcy history
unearnedIncomeList UnearnedIncomeList
SubmitApplication > Request
 List of unearned incomes
customerRelationship CustomerRelationship
SubmitApplication > Request
 Customer relationship

CustomerAddressList

SubmitApplication > Request

Name Type Description
items nullable array(CustomerAddress)
SubmitApplication > Request
 List of customer addresses
customerAddressPrimaryResidence nullable array(CustomerAddressPrimaryResidence) min-items(1) max-items(99)
SubmitApplication > Request
 List of Customer addresses (Primary residence)
customerAddressPreviousResidence nullable array(CustomerAddressPreviousResidence) max-items(99)
SubmitApplication > Request
 List of Customer addresses (Previous residence)
customerAddressSecondaryResidence nullable array(CustomerAddressSecondaryResidence) max-items(99)
SubmitApplication > Request
 List of Customer addresses (Secondary residence)
customerAddressVacationProperty nullable array(CustomerAddressVacationProperty) max-items(99)
SubmitApplication > Request
 List of Customer addresses (Vacation property)
customerAddressInvestmentProperty nullable array(CustomerAddressInvestmentProperty) max-items(99)
SubmitApplication > Request
 List of Customer addresses (Investment property)
customerAddressCorrespondence nullable array(CustomerAddressCorrespondence) max-items(99)
SubmitApplication > Request
 List of Customer addresses (Correspondence)

CustomerAddressPrimaryResidence

SubmitApplication > Request

Remarks

  • Only one of AddressOccupancyOwnerOccupied, AddressOccupancyPartialOwnerOccupied, AddressOccupancyRental or AddressOccupancyTenant needs to be provided
Name Type Description
currentPropertyIntendedActionType CurrentPropertyIntendedAction
Enums
 Current property intended action
annualHeatingAmount nullable number(double) range(0,9999999.99) Annual heating amount
annualTaxAmount nullable number(double) range(0,9999999.99) Annual tax amount
annualCondoFees nullable number(double) range(0,9999999.99) Annual condo fees
refkeyAddress required string max-length(256) ^\S+$ Address key (see Refkeys)
includeInTDS nullable boolean Include in TDS?
customerReference nullable array(CustomerReference) min-items(1) max-items(99)
SubmitApplication > Request
 List of Customer reference
customerCurrentAddressTimeAt nullable array(CustomerCurrentAddressTimeAt) max-items(99)
SubmitApplication > Request
 List of CustomerCurrentAddressTimeAts
customerLiabilityRealEstate nullable array(CustomerLiabilityRealEstate) max-items(99)
SubmitApplication > Request
 List of customer liabilities (Real estate)
addressOccupancyOwnerOccupied AddressOccupancyOwnerOccupied
SubmitApplication > Request
 Address occupancy - Owner Occupied
addressOccupancyPartialOwnerOccupied AddressOccupancyPartialOwnerOccupied
SubmitApplication > Request
 Address occupancy - Partial Owner Occupied
addressOccupancyRental AddressOccupancyRental
SubmitApplication > Request
 Address occupancy - Rental
addressOccupancyTenant AddressOccupancyTenant
SubmitApplication > Request
 Address occupancy - Tenant

CustomerReference

SubmitApplication > Request

Name Type Description
refkeyCustomer required string max-length(256) ^\S+$ Customer key (see Refkeys)

CustomerCurrentAddressTimeAt

SubmitApplication > Request

Name Type Description
fromDate required string(date) From date
refkeyCustomer required string max-length(256) ^\S+$ Customer key (see Refkeys)

CustomerLiabilityRealEstate

SubmitApplication > Request

Name Type Description
refkeyLiability required string max-length(256) ^\S+$ Liability key (see Refkeys)
customerReference required CustomerReference
SubmitApplication > Request
 Customer reference

AddressOccupancyOwnerOccupied

SubmitApplication > Request

Name Type Description
refkeyAsset required string max-length(256) ^\S+$ Asset key (see Refkeys)

AddressOccupancyPartialOwnerOccupied

SubmitApplication > Request

Name Type Description
refkeyAsset required string max-length(256) ^\S+$ Asset key (see Refkeys)
rentalDetails required RentalDetails
SubmitApplication > Request
 Rental details

RentalDetails

SubmitApplication > Request

Name Type Description
annualGrossRentalIncome required number(double) range(0,9999999.99) Annual gross rental income
managementExpenses nullable number(double) range(0,9999999.99) Management expenses
insurance nullable number(double) range(0,9999999.99) Insurance
hydro nullable number(double) range(0,9999999.99) Hydro
waterAndSewer nullable number(double) range(0,9999999.99) Water and sewer
maintenanceAndRepairs nullable number(double) range(0,9999999.99) Maintenance and repairs
interest nullable number(double) range(0,9999999.99) Interest
generalExpenses nullable number(double) range(0,9999999.99) General expenses
rentalOffset RentalOffset
Enums
 Rental offset
rentalCalcType RentalCalcType
Enums
 Rental calc type

AddressOccupancyRental

SubmitApplication > Request

Name Type Description
refkeyAsset required string max-length(256) ^\S+$ Asset key (see Refkeys)
rentalDetails required RentalDetails
SubmitApplication > Request
 Rental details

AddressOccupancyTenant

SubmitApplication > Request

Name Type Description
monthlyRentPaid required number(double) range(0,9999999.99) Monthly rent paid
tenancyType TenancyType
Enums
 Tenancy type

CustomerAddressPreviousResidence

SubmitApplication > Request

Remarks

  • Only one of PreviousAddressOccupancyNone, PreviousAddressOccupancyOwnerOccupied, PreviousAddressOccupancyPartialOwnerOccupied, PreviousAddressOccupancyRental or PreviousAddressOccupancyTenant needs to be provided
Name Type Description
refkeyAddress required string max-length(256) ^\S+$ Address key (see Refkeys)
customerReference nullable array(CustomerReference) min-items(1) max-items(99)
SubmitApplication > Request
 List of Customer reference
customerPreviousAddressTimeAt nullable array(CustomerPreviousAddressTimeAt) max-items(99)
SubmitApplication > Request
 List of CustomerPreviousAddressTimeAt
previousAddressOccupancyNone Empty object Previous address occupancy - None
previousAddressOccupancyOwnerOccupied Empty object Previous address occupancy - Owner Occupied
previousAddressOccupancyPartialOwnerOccupied Empty object Previous address occupancy - Partial Owner Occupied
previousAddressOccupancyRental Empty object Previous address occupancy - Rental
previousAddressOccupancyTenant PreviousAddressOccupancyTenant
SubmitApplication > Request
 Previous address occupancy - Tenant

CustomerPreviousAddressTimeAt

SubmitApplication > Request

Name Type Description
fromDate required string(date) From date
toDate required string(date) To date
refkeyCustomer required string max-length(256) ^\S+$ Customer key (see Refkeys)

PreviousAddressOccupancyTenant

SubmitApplication > Request

Name Type Description
tenancyType TenancyType
Enums
 Tenancy type

CustomerAddressSecondaryResidence

SubmitApplication > Request

Remarks

  • Only one of AddressOccupancyOwnerOccupied, AddressOccupancyPartialOwnerOccupied, AddressOccupancyRental or AddressOccupancySecondHome needs to be provided
Name Type Description
currentPropertyIntendedActionType CurrentPropertyIntendedAction
Enums
 Current property intended action
annualHeatingAmount nullable number(double) range(0,9999999.99) Annual heating amount
annualTaxAmount nullable number(double) range(0,9999999.99) Annual tax amount
annualCondoFees nullable number(double) range(0,9999999.99) Annual condo fees
refkeyAddress required string max-length(256) ^\S+$ Address key (see Refkeys)
includeInTDS nullable boolean Include in TDS?
customerReference nullable array(CustomerReference) min-items(1) max-items(99)
SubmitApplication > Request
 List of Customer reference
customerCurrentAddressTimeAt nullable array(CustomerCurrentAddressTimeAt) max-items(99)
SubmitApplication > Request
 List of CustomerCurrentAddressTimeAts
customerLiabilityRealEstate nullable array(CustomerLiabilityRealEstate) max-items(99)
SubmitApplication > Request
 List of customer liabilities (Real estate)
addressOccupancyOwnerOccupied AddressOccupancyOwnerOccupied
SubmitApplication > Request
 Address occupancy - Owner Occupied
addressOccupancyPartialOwnerOccupied AddressOccupancyPartialOwnerOccupied
SubmitApplication > Request
 Address occupancy - Partial Owner Occupied
addressOccupancyRental AddressOccupancyRental
SubmitApplication > Request
 Address occupancy - Rental
addressOccupancySecondHome AddressOccupancySecondHome
SubmitApplication > Request
 Address occupancy - Second Home

AddressOccupancySecondHome

SubmitApplication > Request

Name Type Description
refkeyAsset required string max-length(256) ^\S+$ Asset key (see Refkeys)

CustomerAddressVacationProperty

SubmitApplication > Request

Remarks

  • Only one of AddressOccupancyOwnerOccupied, AddressOccupancyPartialOwnerOccupied, AddressOccupancyRental or AddressOccupancySecondHome needs to be provided
Name Type Description
currentPropertyIntendedActionType CurrentPropertyIntendedAction
Enums
 Current property intended action
annualHeatingAmount nullable number(double) range(0,9999999.99) Annual heating amount
annualTaxAmount nullable number(double) range(0,9999999.99) Annual tax amount
annualCondoFees nullable number(double) range(0,9999999.99) Annual condo fees
refkeyAddress required string max-length(256) ^\S+$ Address key (see Refkeys)
includeInTDS nullable boolean Include in TDS?
customerReference nullable array(CustomerReference) min-items(1) max-items(99)
SubmitApplication > Request
 List of Customer reference
customerCurrentAddressTimeAt nullable array(CustomerCurrentAddressTimeAt) max-items(99)
SubmitApplication > Request
 List of CustomerCurrentAddressTimeAts
customerLiabilityRealEstate nullable array(CustomerLiabilityRealEstate) max-items(99)
SubmitApplication > Request
 List of customer liabilities (Real estate)
addressOccupancyOwnerOccupied AddressOccupancyOwnerOccupied
SubmitApplication > Request
 Address occupancy - Owner Occupied
addressOccupancyPartialOwnerOccupied AddressOccupancyPartialOwnerOccupied
SubmitApplication > Request
 Address occupancy - Partial Owner Occupied
addressOccupancyRental AddressOccupancyRental
SubmitApplication > Request
 Address occupancy - Rental
addressOccupancySecondHome AddressOccupancySecondHome
SubmitApplication > Request
 Address occupancy - Second Home

CustomerAddressInvestmentProperty

SubmitApplication > Request

Remarks

  • Only one of AddressOccupancyOwnerOccupied, AddressOccupancyPartialOwnerOccupied, AddressOccupancyRental or AddressOccupancySecondHome needs to be provided
Name Type Description
currentPropertyIntendedActionType CurrentPropertyIntendedAction
Enums
 Current property intended action
annualHeatingAmount nullable number(double) range(0,9999999.99) Annual heating amount
annualTaxAmount nullable number(double) range(0,9999999.99) Annual tax amount
annualCondoFees nullable number(double) range(0,9999999.99) Annual condo fees
refkeyAddress required string max-length(256) ^\S+$ Address key (see Refkeys)
includeInTDS nullable boolean Include in TDS?
customerReference nullable array(CustomerReference) min-items(1) max-items(99)
SubmitApplication > Request
 List of Customer reference
customerCurrentAddressTimeAt nullable array(CustomerCurrentAddressTimeAt) max-items(99)
SubmitApplication > Request
 List of CustomerCurrentAddressTimeAts
customerLiabilityRealEstate nullable array(CustomerLiabilityRealEstate) max-items(99)
SubmitApplication > Request
 List of customer liabilities (Real estate)
addressOccupancyOwnerOccupied AddressOccupancyOwnerOccupied
SubmitApplication > Request
 Address occupancy - Owner Occupied
addressOccupancyPartialOwnerOccupied AddressOccupancyPartialOwnerOccupied
SubmitApplication > Request
 Address occupancy - Partial Owner Occupied
addressOccupancyRental AddressOccupancyRental
SubmitApplication > Request
 Address occupancy - Rental
addressOccupancySecondHome AddressOccupancySecondHome
SubmitApplication > Request
 Address occupancy - Second Home

CustomerAddressCorrespondence

SubmitApplication > Request

Name Type Description
refkeyAddress required string max-length(256) ^\S+$ Address key (see Refkeys)
annualHeatingAmount nullable number(double) range(0,9999999.99) Annual heating amount
annualTaxAmount nullable number(double) range(0,9999999.99) Annual tax amount
annualCondoFees nullable number(double) range(0,9999999.99) Annual condo fees
includeInTDS nullable boolean Include in TDS?
customerReference nullable array(CustomerReference) min-items(1) max-items(99)
SubmitApplication > Request
 List of Customer reference
customerCurrentAddressTimeAt nullable array(CustomerCurrentAddressTimeAt) max-items(99)
SubmitApplication > Request
 List of CustomerCurrentAddressTimeAts
addressOccupancyNone required Empty object Address occupancy - None

CustomerAssetOther

SubmitApplication > Request

Name Type Description
refkeyAsset required string max-length(256) ^\S+$ Asset key (see Refkeys)
customerReference required CustomerReference
SubmitApplication > Request
 Customer reference

CustomerLiabilityOther

SubmitApplication > Request

Name Type Description
refkeyLiability required string max-length(256) ^\S+$ Liability key (see Refkeys)
customerReference required CustomerReference
SubmitApplication > Request
 Customer reference

CustomerCreditBureau

SubmitApplication > Request

Name Type Description
refkeyCreditBureau required string max-length(256) ^\S+$ Credit bureau key (see Refkeys)
customerReference nullable array(CustomerReference) min-items(1) max-items(2)
SubmitApplication > Request
 List of Customer reference

MortgageApplication

SubmitApplication > Request

Name Type Description
applicationNumber nullable string max-length(12) ^[A-Z][0-9]{9}$ Application number
brokerRefNumber nullable string min-length(1) max-length(50) Broker reference number
posApplicationNumber nullable string min-length(1) max-length(20) PoS application number
isPreapproval nullable boolean Is pre-approval?
fundingDate nullable string(date) Funding date
loanPurposeType LoanPurposeType
Enums
 Loan purpose type
purchasePriceEstimatedValue nullable number(double) range(0,99999999.99) Purchase price/estimated value
improvements nullable number(double) range(0,99999999.99) Improvements
typeOfBuyer required TypeOfBuyer
Enums
 Type of buyer
additionalPurpose nullable string max-length(80) ^[\s\S]*\S[\s\S]*$ Additional purpose
improveDescription nullable string max-length(80) ^[\s\S]*\S[\s\S]*$ Improve description
subjectProperty SubjectProperty
SubmitApplication > Request
 Subject property
loan required Loan
SubmitApplication > Request
 Loan
downpaymentList DownpaymentList
SubmitApplication > Request
 List of downpayments
firm Firm
SubmitApplication > Request
 Firm
submittingAgent required SubmittingAgent
SubmitApplication > Request
 Submitting Agent
originatingAgent OriginatingAgent
SubmitApplication > Request
 Originating Agent
broker Broker
SubmitApplication > Request
 Broker
owner Owner
SubmitApplication > Request
 Owner

SubjectProperty

SubmitApplication > Request

Remarks

  • Only one of SubjectPropertyOccupancyOwnerOccupied, SubjectPropertyOccupancyPartialOwnerOccupied, SubjectPropertyOccupancyRental or SubjectPropertyOccupancySecondHome needs to be provided
  • Only one of Freehold, Leasehold or Condo needs to be provided
Name Type Description
occupancyPurpose SubjectPropertyOccupancyPurpose
Enums
 Subject property occupancy purpose
mlsListed nullable boolean MLS listed
mlsNumber nullable string max-length(30) ^[\s\S]*\S[\s\S]*$ MLS number
heatingType HeatingType
Enums
 Heating type
parkingType ParkingType
Enums
 Parking type
yearBuilt nullable integer(int32) range(1,3000) Year built
waterSupplyType WaterSupplyType
Enums
 Water supply type
waterWasteType WaterWasteType
Enums
 Water waste type
propertySize nullable integer(int32) range(0,99999) Property size
propertySizeUnits AreaMeasurementType
Enums
 Area measurement type
lotSize nullable integer(int64) range(0,99999999999) Lot size
lotSizeUnits AreaMeasurementType
Enums
 Area measurement type
environmentalHazardIndicator nullable boolean Environmental hazard indicator
buildingConstructionType BuildingConstructionType
Enums
 Building construction type
annualHeatingAmount required number(double) range(0,9999999.99) Annual heating amount
numberOfUnitsTotal nullable integer(int32) range(1,99999) Number of units total
numberOfUnitsRented nullable integer(int32) range(0,99999) Number of units rented
propertyType PropertyType
Enums
 Property type
propertyDescriptionType PropertyDescriptionType
Enums
 Property description type
propertyUsageType PropertyUsageType
Enums
 Property usage type
selfBuildIndicator nullable boolean Self-build?
propertyZoningType PropertyZoningType
Enums
 Property zoning type
newPropertyIndicator nullable boolean New property?
cof nullable string(date) COF (Condition of finance) date
subjectPropertyOccupancyOwnerOccupied Empty object Subject property occupancy - Owner occupied
subjectPropertyOccupancyPartialOwnerOccupied SubjectPropertyOccupancyPartialOwnerOccupied
SubmitApplication > Request
 Subject property occupancy - Partial Owner Occupied
subjectPropertyOccupancyRental SubjectPropertyOccupancyRental
SubmitApplication > Request
 Subject property occupancy - Rental
subjectPropertyOccupancySecondHome Empty object Subject property occupancy - Second Home
legalAddress LegalAddress
SubmitApplication > Request
 Legal address
freehold Empty object Freehold
leasehold Leasehold
SubmitApplication > Request
 Leasehold
condo Condo
SubmitApplication > Request
 Condo
propertyTax required PropertyTax
SubmitApplication > Request
 Property tax
propertyAppraisal PropertyAppraisal
SubmitApplication > Request
 Property appraisal
subjectPropertyAddress required SubjectPropertyAddress
SubmitApplication > Request
 Subject property address
subjectPropertyInsuranceConsent SubjectPropertyInsuranceConsent
SubmitApplication > Request
 Subject property insurance consent

SubjectPropertyOccupancyPartialOwnerOccupied

SubmitApplication > Request

Name Type Description
rentalDetails required RentalDetails
SubmitApplication > Request
 Rental details

SubjectPropertyOccupancyRental

SubmitApplication > Request

Name Type Description
rentalDetails required RentalDetails
SubmitApplication > Request
 Rental details

LegalAddress

SubmitApplication > Request

Name Type Description
details nullable string max-length(255) ^[\s\S]*\S[\s\S]*$ Details
pin nullable string max-length(30) ^[\s\S]*\S[\s\S]*$ PIN
lotNumber nullable string max-length(30) ^[\s\S]*\S[\s\S]*$ Lot number
planNumber nullable string max-length(30) ^[\s\S]*\S[\s\S]*$ Plan number
unitNumber nullable string max-length(30) ^[\s\S]*\S[\s\S]*$ Unit number
levelNumber nullable string max-length(30) ^[\s\S]*\S[\s\S]*$ Level number

Leasehold

SubmitApplication > Request

Name Type Description
annualLeaseAmount nullable number(double) range(0,9999999.99) Annual lease amount

Condo

SubmitApplication > Request

Name Type Description
annualCondoFees nullable number(double) range(0,9999999.99) Annual condo fees

PropertyTax

SubmitApplication > Request

Name Type Description
annualTaxAmount required number(double) range(0,9999999.99) Annual tax amount
taxesPaidBy PropertyTaxPayor
Enums
 Property tax payor

PropertyAppraisal

SubmitApplication > Request

Name Type Description
appraisedValue nullable number(double) range(0,99999999.99) Appraised value
dateAppraised nullable string(date) Date appraised
companyName nullable string ^[\s\S]*\S[\s\S]*$ Company name
appraiserAddress AppraiserAddress
SubmitApplication > Request
 Appraiser address

AppraiserAddress

SubmitApplication > Request

Remarks

  • Only one of PostalAddressStreetAddress or PostalAddressPOBox needs to be provided
Name Type Description
cityTown required string min-length(1) max-length(40) City/town (municipality)
provinceCode required ProvinceStateCodeCanada
Enums
 Province code (Canada)
postalCode required string ^[A-Za-z][0-9][A-Za-z][ ]?[0-9][A-Za-z][0-9]$ Postal code
key required string max-length(256) ^\S+$ Address key (see Refkeys)
postalAddressStreetAddress PostalAddressStreetAddress
SubmitApplication > Request
 Postal address (Street address)
postalAddressPOBox PostalAddressPOBox
SubmitApplication > Request
 Postal address (PO box)

SubjectPropertyAddress

SubmitApplication > Request

Name Type Description
refkeyAddress required string max-length(256) ^\S+$ Address key (see Refkeys)

SubjectPropertyInsuranceConsent

SubmitApplication > Request

Name Type Description
consentFlag required boolean Consent flag
consentDate required string(date) Consent date

Loan

SubmitApplication > Request

Remarks

  • Only one of CMHCMortgageInsurance, GEMortgageInsurance, SagenMortgageInsurance, CanadaGuarantyMortgageInsurance or OtherMortgageInsurance may be provided
  • Only one of LenderProduct or CustomProduct needs to be provided
  • underwriter is only required when lender underwriters are listed in Lender Details
Name Type Description
loanAmount required number(double) range(0,99999999.99) Loan amount
chargeType required ChargeType
Enums
 Charge type
lineOfBusiness LineOfBusiness
Enums
 Line of business
termMonths nullable integer(int32) range(1,999) Term (months)
amortizationMonths nullable integer(int32) range(0,999) Amortization (months)
netRate nullable number(double) range(0,999.99) Net rate
qualifyingRate required number(double) range(0,999.99) Qualifying rate
acceleratedPayment nullable boolean Accelerated payment
maturityDate nullable string(date) Maturity date
firstPaymentDate nullable string(date) First payment date
interestAdjustmentDate nullable string(date) Interest adjustment date
requestedPayment nullable number(double) range(0,999999.99) Requested payment
paymentAmount nullable number(double) range(0,999999.99) Payment amount
paymentFrequency PaymentFrequency
Enums
 Payment frequency
repaymentType required LoanRepaymentType
Enums
 Loan repayment type
lenderCode required integer(int32) range(1000,9999) Lender code
lenderChannel nullable integer(int32) range(0,9999) Lender channel
variableToPrime nullable string Variable to prime
cmhcMortgageInsurance CMHCMortgageInsurance
SubmitApplication > Request
 CMHC mortgage insurance
geMortgageInsurance GEMortgageInsurance
SubmitApplication > Request
 Genworth mortgage insurance
sagenMortgageInsurance SagenMortgageInsurance
SubmitApplication > Request
 Sagen mortgage insurance
canadaGuarantyMortgageInsurance CanadaGuarantyMortgageInsurance
SubmitApplication > Request
 CanadaGuaranty mortgage insurance
otherMortgageInsurance OtherMortgageInsurance
SubmitApplication > Request
 Other mortgage insurance
lenderProduct LenderProduct
SubmitApplication > Request
 Lender product
customProduct CustomProduct
SubmitApplication > Request
 Custom product
underwriter Underwriter
SubmitApplication > Request
 Underwriter
classification nullable array(Classification) max-items(99)
SubmitApplication > Request
 List of Classifications

CMHCMortgageInsurance

SubmitApplication > Request

Name Type Description
insurancePremium required number(double) range(0,999999.99) Insurance premium
blendedAmortization nullable boolean Blended amortization
addToLoan nullable boolean Add to loan?
serviceType CMHCServiceType
Enums
 CMHC service type

GEMortgageInsurance

SubmitApplication > Request

Name Type Description
insurancePremium required number(double) range(0,999999.99) Insurance premium
blendedAmortization nullable boolean Blended amortization
addToLoan nullable boolean Add to loan?
serviceType GEServiceType
Enums
 GE service type

SagenMortgageInsurance

SubmitApplication > Request

Name Type Description
insurancePremium required number(double) range(0,999999.99) Insurance premium
blendedAmortization nullable boolean Blended amortization
addToLoan nullable boolean Add to loan?
serviceType SagenServiceType
Enums
 Sagen service type

CanadaGuarantyMortgageInsurance

SubmitApplication > Request

Name Type Description
insurancePremium required number(double) range(0,999999.99) Insurance premium
blendedAmortization nullable boolean Blended amortization
addToLoan nullable boolean Add to loan?
serviceType CanadaGuarantyServiceType
Enums
 Canada Guaranty service type

OtherMortgageInsurance

SubmitApplication > Request

Name Type Description
insurancePremium required number(double) range(0,999999.99) Insurance premium
blendedAmortization nullable boolean Blended amortization
addToLoan nullable boolean Add to loan?
serviceType OtherServiceType
Enums
 Other mortgage insurer service type

LenderProduct

SubmitApplication > Request

Name Type Description
adjustment nullable number(double) range(-999.99,999.99) Adjustment
buydown nullable number(double) range(-999.99,999.99) Buydown
productCode required string max-length(10) Product code
productStartDate required string(date-time) Product start date

CustomProduct

SubmitApplication > Request

Name Type Description
adjustment nullable number(double) range(-999.99,999.99) Adjustment
buydown nullable number(double) range(-999.99,999.99) Buydown
productCode nullable string max-length(10) Product code
productName nullable string max-length(50) Product name
rateType required RateType
Enums
 Rate type
rateCompoundFrequency required RateCompoundFrequency
Enums
 Rate compound frequency
postedRate required number(double) range(0,999.99) Posted rate
productTerm required integer(int32) minimum(1) Product term (month)
earlyPayoutOption EarlyPayoutOptionType
Enums
 Early payout option type
prePaymentOptionPercent PrePaymentOptionPercentType
Enums
 Pre-payment option percent type
locIndicator nullable boolean
locRepayment LoCRepaymentType
Enums
 LoC repayment type

Underwriter

SubmitApplication > Request

Name Type Description
userId required string max-length(10) ^\S+$ Underwriter user Id
unitId required string max-length(4) ^[A-Z0-9]{3,4}$ Underwriter unit Id

Classification

SubmitApplication > Request

Name Type Description
mortgageClassification required MortgageClassification
Enums
 Mortgage classification

DownpaymentList

SubmitApplication > Request

Name Type Description
downpayment nullable array(Downpayment) max-items(99)
SubmitApplication > Request
 List of Downpayments

Downpayment

SubmitApplication > Request

Name Type Description
downpaymentSourceType required DownpaymentSourceType
Enums
 Downpayment source type
description nullable string max-length(100) Downpayment description
amount required number(double) range(0,99999999.99) Downpayment amount

Firm

SubmitApplication > Request

Name Type Description
firmId required string max-length(4) ^[A-Z0-9]{3,4}$ Firm Id
name nullable string max-length(50) ^[\s\S]*\S[\s\S]*$ Firm name
externalPoSFirm nullable array(ExternalPoSFirm) max-items(99)
SubmitApplication > Request
 List of External PoS firms

ExternalPoSFirm

SubmitApplication > Request

Name Type Description
posSystemId required PoSSystemType
Enums
 PoS system type
firmId required string min-length(1) max-length(50) Firm Id

SubmittingAgent

SubmitApplication > Request

Remarks

  • Only one of AddressCanada, AddressUSA or AddressOther may be provided
Name Type Description
userId nullable string max-length(10) ^\S+$ User Id
firstName required string max-length(40) First name
lastName required string max-length(40) Last name
emailAddress required string max-length(100) Email address
languagePreference Language
Enums
 Language
mortgageLicenseNumber nullable string max-length(10) Mortgage license number
externalPoSUser nullable array(ExternalPoSUser) max-items(99)
SubmitApplication > Request
 List of External PoS users
addressCanada AddressCanada
SubmitApplication > Request
 Address (Canada)
userTelephoneNumber nullable array(UserTelephoneNumber) max-items(99)
SubmitApplication > Request
 List of User telephone numbers

ExternalPoSUser

SubmitApplication > Request

Name Type Description
posSystemId required PoSSystemType
Enums
 PoS system type
firmId required string min-length(1) max-length(50) Firm Id
userId required string min-length(1) max-length(50) User Id
userName nullable string max-length(50) ^[a-zA-Z][-a-zA-Z0-9_.]*$ User name

UserTelephoneNumber

SubmitApplication > Request

Name Type Description
usage ContactTelephoneUsageType
Enums
 Contact telephone usage type
telephoneNumber required TelephoneNumber
SubmitApplication > Request
 Telephone number

OriginatingAgent

SubmitApplication > Request

Remarks

  • Only one of AddressCanada, AddressUSA or AddressOther may be provided
Name Type Description
userId nullable string max-length(10) ^\S+$ User Id
firstName required string max-length(40) First name
lastName required string max-length(40) Last name
emailAddress required string max-length(100) Email address
languagePreference Language
Enums
 Language
mortgageLicenseNumber nullable string max-length(10) Mortgage license number
externalPoSUser nullable array(ExternalPoSUser) max-items(99)
SubmitApplication > Request
 List of External PoS users
addressCanada AddressCanada
SubmitApplication > Request
 Address (Canada)
userTelephoneNumber nullable array(UserTelephoneNumber) max-items(99)
SubmitApplication > Request
 List of User telephone numbers

Broker

SubmitApplication > Request

Remarks

  • Only one of AddressCanada, AddressUSA or AddressOther may be provided
Name Type Description
userId nullable string max-length(10) ^\S+$ User Id
firstName required string max-length(40) First name
lastName required string max-length(40) Last name
emailAddress required string max-length(100) Email address
languagePreference Language
Enums
 Language
mortgageLicenseNumber nullable string max-length(10) Mortgage license number
externalPoSUser nullable array(ExternalPoSUser) max-items(99)
SubmitApplication > Request
 List of External PoS users
addressCanada AddressCanada
SubmitApplication > Request
 Address (Canada)
userTelephoneNumber nullable array(UserTelephoneNumber) max-items(99)
SubmitApplication > Request
 List of User telephone numbers

Owner

SubmitApplication > Request

Remarks

  • Only one of AddressCanada, AddressUSA or AddressOther may be provided
Name Type Description
userId nullable string max-length(10) ^\S+$ User Id
firstName required string max-length(40) First name
lastName required string max-length(40) Last name
emailAddress required string max-length(100) Email address
languagePreference Language
Enums
 Language
mortgageLicenseNumber nullable string max-length(10) Mortgage license number
externalPoSUser nullable array(ExternalPoSUser) max-items(99)
SubmitApplication > Request
 List of External PoS users
addressCanada AddressCanada
SubmitApplication > Request
 Address (Canada)
userTelephoneNumber nullable array(UserTelephoneNumber) max-items(99)
SubmitApplication > Request
 List of User telephone numbers

Responses

Sample Response

200 Response

{
  "mortgageApplication": {
    "applicationNumber": "M101338314",
    "brokerRefNumber": "XDTB.0003561",
    "submittingAgent": {
      "userId": "aashraf100"
    },
    "originatingAgent": {
      "userId": "kpoulin100"
    },
    "broker": {
      "userId": "aashraf100"
    }
  },
  "status": "ok"
}
Status Schema
200 OK SubmitApplication > Response

Response

SubmitApplication

Name Type Description
error nullable array(ServiceError) List of errors
status required ResponseStatus
Enums
mortgageApplication MortgageApplication
SubmitApplication > Response
 Mortgage application

MortgageApplication

SubmitApplication > Response

Name Type Description
applicationNumber required string max-length(12) ^[A-Z][0-9]{9}$ Application number
brokerRefNumber nullable string min-length(1) max-length(50) Broker reference number
lenderChannel nullable integer(int32) range(0,9999) Lender channel
submittingAgent required SubmittingAgent
SubmitApplication > Response
 Submitting agent
originatingAgent OriginatingAgent
SubmitApplication > Response
 Originating agent
broker Broker
SubmitApplication > Response
 Broker
owner Owner
SubmitApplication > Response
 Owner

SubmittingAgent

SubmitApplication > Response

Name Type Description
userId nullable string max-length(10) ^\S+$ User Id

OriginatingAgent

SubmitApplication > Response

Name Type Description
userId nullable string max-length(10) ^\S+$ User Id

Broker

SubmitApplication > Response

Name Type Description
userId nullable string max-length(10) ^\S+$ User Id

Owner

SubmitApplication > Response

Name Type Description
userId nullable string max-length(10) ^\S+$ User Id

Refkey pairs

With a SubmitApplication request, ref key pairs are used to associate data.

A refkey pair consists of two objects:

For example, refkey pairs are used to associate a single address in the address list with two or more borrowers who are living together.
In this way, using refkey pairs avoids duplication and redundancy.

Examples of refkey pairs:

Properties

"assetRealEstate": [
  {
    "key": "property-28129",
    "...": ...

"customerAddressList": [
  {
    "type": "CustomerAddressPrimaryResidence",
    "addressOccupancyPartialOwnerOccupied": {
      "refkeyAsset": "property-28129",
      "...": ...

The property with key "property-28129":

Assets

"assetOther": [
  {
    "key": "asset-8747",
    "...": ...

"customerAssetList": [
  {
    "refkeyAsset": "asset-8747",
    "...": ...

An asset with key "asset-8747":

Liabilities

"liabilityOther": [
  {
    "key": "liability-108372",
    "...": ...

"customerLiabilityList": [
  {
    "refkeyLiability": "liability-108372",
    "...": ...

A liability with key "liability-108372":

Borrowers

"cusotmerList": {
  "customerPrimaryBorrower": {
    "key": "borrower-89455",
    "...": ...

"customerAddressList": [
  {
    "type": "CustomerAddressPrimaryResidence",
    "cusomterReference": [
      {
        "refkeyCustomer": "borrower-89455",
        "...": ...

A borrower with key "borrower-89455":

Addresses

"addressList": {
  "applicationAddressCanada": {
    "key": "address-359926",
    "...": ...

"customerAddressList": [
  {
    "type": "CustomerAddressPrimaryResidence",
    "refkeyAddress": "address-359926",
    "...": ...

An address with key "address-359926":

Credit Bureaus

"creditBureauList": {
  "creditBureau": {
    "key": "bureau-18840",
    "...": ...

"customerCreditBureauList": [
  {
    "refkeyCreditBureau": "bureau-18840",
    "...": ...

A credit bureau with key "bureau-18840":

Sample Deals

The below examples show different scenarios for submitting an application to Link using the API.
Refer to the section "Getting Started" for information on getting set up to run the example requests.

Deal 1: Minimal Example

Request Body 

{
    "commonData": {
        "addressList": {
            "applicationAddressCanada": [
                {
                    "key": "address-382289",
                    "postalAddressStreetAddress": {
                        "poBoxRRNumber": "",
                        "unitNumber": "",
                        "streetNumber": "22",
                        "streetName": "EMPTY",
                        "streetType": 70,
                        "streetDirection": 1
                    },
                    "cityTown": "LONDON",
                    "provinceCode": 50,
                    "postalCode": "M6Z4R5",
                    "countryCode": 1
                }
            ],
            "applicationAddressCanadaPartial": {
                "key": "address-382288",
                "provinceCode": 50,
                "countryCode": 1
            }
        }
    },
    "customerData": {
        "customerList": {
            "customerPrimaryBorrower": {
                "dateBirth": "1967-05-09T00:00:00",
                "lastName": "ZOLOVSKY",
                "firstName": "MADELLINA",
                "customerTelephoneNumberList": [
                    {
                        "telephoneNumber": {
                            "countryCode": "1",
                            "areaCode": "416",
                            "phoneNumber": "5671234"
                        },
                        "usage": 1,
                        "preferred": false
                    }
                ],
                "employmentList": {
                    "employment": [
                        {
                            "earnedIncomeList": {
                                "earnedIncome": [
                                    {
                                        "earnedIncomeType": 9,
                                        "paymentFrequency": 1,
                                        "earnedIncomeAmount": 120000.0
                                    }
                                ]
                            },
                            "employmentType": 1,
                            "employmentStatus": 40,
                            "dateStart": "2013-07-01T00:00:00",
                            "industryType": 1,
                            "occupationType": 3,
                            "jobTitle": "QA",
                            "companyName": "ACME"
                        }
                    ]
                },
                "customerRelationShip": {},
                "key": "borrower-97964",
                "correspondenceLanguage": 1,
                "maritalStatus": 6,
                "numberOfDependents": 0,
                "sex": 1,
                "residentType": 10
            }
        },
        "customerAddressList": [
            {
                "customerCurrentAddressTimeAt": [
                    {
                        "refkeyCustomer": "borrower-97964",
                        "fromDate": "2015-07-01T00:00:00"
                    }
                ],
                "addressOccupancyTenant": {
                    "monthlyRentPaid": 0,
                    "tenancyType": 20
                },
                "currentPropertyIntendedActionType": 2,
                "customerReference": [
                    {
                        "refkeyCustomer": "borrower-97964"
                    }
                ],
                "refkeyAddress": "address-382289",
                "type": "CustomerAddressPrimaryResidence"
            },
            {
                "addressOccupancyNone": {},
                "customerReference": [
                    {
                        "refkeyCustomer": "borrower-97964"
                    }
                ],
                "refkeyAddress": "address-382289",
                "type": "CustomerAddressCorrespondence"
            }
        ]
    },
    "mortgageApplication": {
        "subjectProperty": {
            "subjectPropertyOccupancyOwnerOccupied": {},
            "legalAddress": {},
            "freehold": {},
            "propertyTax": {
                "annualTaxAmount": 5000.0,
                "taxesPaidBy": 1
            },
            "subjectPropertyAddress": {
                "refkeyAddress": "address-382288"
            },
            "occupancyPurpose": 1,
            "mlsListed": false,
            "parkingType": 7,
            "propertySize": 100,
            "propertySizeUnits": 1,
            "lotSize": 100,
            "lotSizeUnits": 1,
            "environmentalHazardIndicator": false,
            "annualHeatingAmount": 540.0,
            "numberOfUnitsTotal": 1,
            "propertyDescriptionType": 1,
            "propertyUsageType": 1,
            "propertyZoningType": 1
        },
        "loan": {
            "freehold": {},
            "lenderProduct": {
                "productCode": "1YRF",
                "productStartDate": "2018-04-06T11:50:00"
            },
            "underwriter": {
                "userId": "<user_id>",
                "unitId": "<underwriter_unit_id>"
            },
            "loanAmount": 899000.0,
            "chargeType": 1,
            "termMonths": "60",
            "amortizationMonths": "300",
            "netRate": 3.7,
            "qualifyingRate": 5,
            "acceleratedPayment": false,
            "maturityDate": "2025-07-10T00:00:00",
            "firstPaymentDate": "2020-07-17T00:00:00",
            "interestAdjustmentDate": "2020-07-10T00:00:00",
            "requestedPayment": 1057.81,
            "paymentAmount": 4583.86,
            "paymentFrequency": 52,
            "repaymentType": 2,
            "lenderCode": <lender_code>,
            "lenderChannel": 10
        },
        "downpaymentList": {
            "downpayment": [
                {
                    "downpaymentSourceType": 10,
                    "amount": 100000.0
                }
            ]
        },
        "firm": {
            "externalPoSFirm": [
                {
                    "posSystemId": 50,
                    "firmId": "<firm_id>"
                }
            ],
            "firmId": "<firm_id>"
        },
        "submittingAgent": {
            "externalPoSUser": [
                {
                    "posSystemId": 50,
                    "firmId": "<firm_id>",
                    "userId": "<user_external_pos_id_2>"
                }
            ],
            "userId": "<user_id>",
            "firstName": "<user_firstname>",
            "lastName": "<user_lastname>",
            "emailAddress": "<user_email_address>",
            "mortgageLicenseNumber": "<mortgage_license_number>"
        },
        "originatingAgent": {
            "externalPoSUser": [
                {
                    "posSystemId": 50,
                    "firmId": "<firm_id>",
                    "userId": "<user_external_pos_id_2>"
                }
            ],
            "addressCanada": {
                "postalAddressStreetAddress": {
                    "poBoxRRNumber": "",
                    "unitNumber": "123",
                    "streetNumber": "2608",
                    "streetName": "Granville",
                    "streetType": 1240,
                    "streetDirection": 2
                },
                "cityTown": "Vancouver",
                "provinceCode": 10,
                "postalCode": "V6H3V3",
                "countryCode": 1
            },
            "userId": "<user_id>",
            "firstName": "<user_firstname>",
            "lastName": "<user_lastname>",
            "emailAddress": "<user_email_address>",
            "mortgageLicenseNumber": "<mortgage_license_number>"
        },
        "broker": {
            "externalPoSUser": [
                {
                    "posSystemId": 50,
                    "firmId": "<firm_id>",
                    "userId": "<user_external_pos_id_2>"
                }
            ],
            "userId": "<user_id>",
            "firstName": "<user_firstname>",
            "lastName": "<user_lastname>",
            "emailAddress": "<user_email_address>",
            "mortgageLicenseNumber": "<mortgage_license_number>"
        },
        "posApplicationNumber": "ABCD-12345",
        "isPreapproval": true,
        "fundingDate": "2025-01-01T00:00:00",
        "loanPurposeType": 3,
        "purchasePriceEstimatedValue": 999000.0
    },
    "memo": "\n Applicants:\n Participants- Agent: Jane Smith Assoc/Asst: Jane Smith\n File touched by: Jane Smith\n MADELLINA ZORIN for ACME as QA\n\n Selected Product: 1YRF\n ",
    "unitId": "<unit_id>",
    "posSystem": "<pos_system_id>"
}

This example demonstrates a minimal example.

Deal 2

Request Body 

{
    "commonData": {
        "assetList": {
            "assetRealEstate": [
                {
                    "originalPrice": 1345000.0,
                    "originalDate": "2007-05-01T00:00:00",
                    "key": "property-34378",
                    "value": 1345000.0
                },
                {
                    "originalPrice": 500000.0,
                    "originalDate": "2001-01-01T00:00:00",
                    "key": "property-34381",
                    "value": 500000.0
                }
            ],
            "assetOther": [
                {
                    "assetType": 71,
                    "description": "description 1",
                    "key": "asset-82859",
                    "value": 111.0
                },
                {
                    "assetType": 72,
                    "description": "description 2",
                    "key": "asset-82860",
                    "value": 222.0
                },
                {
                    "assetType": 73,
                    "description": "description 3",
                    "key": "asset-82861",
                    "value": 333.0
                },
                {
                    "assetType": 20,
                    "description": "description 4",
                    "key": "asset-82862",
                    "value": 444.0
                },
            ]
        },
        "liabilityList": {
            "liabilityRealEstate": [
                {
                    "accountNumber": "1111",
                    "monthlyRepayment": 55.0,
                    "originalLoanAmount": 200000.0,
                    "outstandingBalance": 50000.0,
                    "closingDate": "2007-05-01T00:00:00",
                    "lenderName": "Gringotts",
                    "chargeType": 1,
                    "repaymentType": 2,
                    "redemptionStatus": 4,
                    "maturityDate": "2020-08-04T00:00:00",
                    "netRate": 3,
                    "rateType": 2,
                    "mortgageInsurer": 10,
                    "insuranceCertificateNumber": "2222",
                    "key": "property-34378-1",
                    "fromCreditBureau": false
                }
            ],
            "liabilityOther": [
                {
                    "dateEnd": "2020-01-01T00:00:00",
                    "repaymentIndicator": true,
                    "payoffType": 2,
                    "monthlyRepayment": 11.0,
                    "creditLimit": 11111.0,
                    "outstandingBalance": 111.0,
                    "lenderName": "Gringotts",
                    "liabilityType": 4,
                    "additionalHolders": true,
                    "additionalHoldersDetails": "test",
                    "key": "liability-112291",
                    "fromCreditBureau": false
                },
                {
                    "dateEnd": "2025-08-07T00:00:00",
                    "repaymentIndicator": true,
                    "payoffType": 2,
                    "monthlyRepayment": 33.0,
                    "creditLimit": 33333.0,
                    "outstandingBalance": 333.0,
                    "lenderName": "Tyrell Corp.",
                    "liabilityType": 6,
                    "additionalHolders": true,
                    "additionalHoldersDetails": "additional holder details",
                    "key": "liability-112293",
                    "fromCreditBureau": false
                },
                {
                    "repaymentIndicator": false,
                    "monthlyRepayment": 0.0,
                    "creditLimit": 19000.0,
                    "outstandingBalance": 18000.0,
                    "lenderName": "Nakatomi Trading Corp.",
                    "liabilityType": 3,
                    "key": "liability-112297",
                    "fromCreditBureau": true
                },
                {
                    "repaymentIndicator": false,
                    "monthlyRepayment": 0.0,
                    "creditLimit": 7000.0,
                    "outstandingBalance": 7000.0,
                    "lenderName": "Tellson's",
                    "liabilityType": 1,
                    "key": "liability-112298",
                    "fromCreditBureau": true
                }
            ]
        },
        "addressList": {
            "applicationAddressCanada": [
                {
                    "key": "address-382297",
                    "postalAddressStreetAddress": {
                        "poBoxRRNumber": "",
                        "unitNumber": "",
                        "streetNumber": "1234",
                        "streetName": "MCMICKLING",
                        "streetType": 220,
                        "streetDirection": 5
                    },
                    "cityTown": "NIAGARA FALLS",
                    "provinceCode": 50,
                    "postalCode": "L2Z1X4",
                    "countryCode": 1
                },
                {
                    "key": "address-382298",
                    "postalAddressStreetAddress": {
                        "poBoxRRNumber": "",
                        "unitNumber": "33",
                        "streetNumber": "4144",
                        "streetName": "Finch",
                        "streetType": 1210,
                        "streetDirection": 7
                    },
                    "cityTown": "TORONTO",
                    "provinceCode": 50,
                    "postalCode": "M5Z6Y2",
                    "countryCode": 1
                },
                {
                    "key": "address-382299",
                    "postalAddressStreetAddress": {
                        "poBoxRRNumber": "",
                        "unitNumber": "",
                        "streetNumber": "1234",
                        "streetName": "MCMICKLING",
                        "streetType": 250,
                        "streetDirection": 5
                    },
                    "cityTown": "NIAGARA FALLS",
                    "provinceCode": 50,
                    "postalCode": "L2Z1X4",
                    "countryCode": 1
                },
                {
                    "key": "address-382301",
                    "postalAddressStreetAddress": {
                        "poBoxRRNumber": "",
                        "unitNumber": "",
                        "streetNumber": "1234",
                        "streetName": "MCMICKING",
                        "streetType": 710,
                        "streetDirection": 1
                    },
                    "cityTown": "NIAGARA FALLS",
                    "provinceCode": 50,
                    "postalCode": "L2Z1X4",
                    "countryCode": 1
                },
                {
                    "key": "address-382303",
                    "postalAddressStreetAddress": {
                        "poBoxRRNumber": "",
                        "unitNumber": "",
                        "streetNumber": "1234",
                        "streetName": "MCMICKING",
                        "streetType": 480,
                        "streetDirection": 1
                    },
                    "cityTown": "NIAGARA FALLS",
                    "provinceCode": 50,
                    "postalCode": "L2Z1X4",
                    "countryCode": 1
                },
                {
                    "key": "address-382309",
                    "postalAddressStreetAddress": {
                        "poBoxRRNumber": "",
                        "unitNumber": "1233",
                        "streetNumber": "234",
                        "streetName": "Warden",
                        "streetType": 100,
                        "streetDirection": 5
                    },
                    "cityTown": "TORONTO",
                    "provinceCode": 50,
                    "postalCode": "M7T3E4",
                    "countryCode": 1
                }
            ]
        },
        "creditBureauList": {
            "creditBureau": [
                {
                    "creditReportEquifax": {
                        "dataFormat": "0H",
                        "reportDate": "2020-06-02T00:00:00",
                        "creditScore": 568,
                        "value": "..."
                    },
                    "humanReadableReport": {
                        "type": "Text",
                        "value": "..."
                    },
                    "key": "bureau-25107",
                    "provider": "Equifax"
                },
                {
                    "creditReportEquifax": {
                        "dataFormat": "0H",
                        "reportDate": "2020-06-02T00:00:00",
                        "creditScore": 682,
                        "value": "..."
                    },
                    "humanReadableReport": {
                        "type": "Text",
                        "value": "..."
                    },
                    "key": "bureau-25121",
                    "provider": "Equifax"
                },
                {
                    "creditReportEquifax": {
                        "dataFormat": "0H",
                        "reportDate": "2020-06-02T00:00:00",
                        "creditScore": 681,
                        "value": "..."
                    },
                    "humanReadableReport": {
                        "type": "Text",
                        "value": "..."
                    },
                    "key": "bureau-25129",
                    "provider": "Equifax"
                },
                {
                    "creditReportEquifax": {
                        "dataFormat": "0H",
                        "reportDate": "2020-06-02T00:00:00",
                        "creditScore": 665,
                        "value": "..."
                    },
                    "humanReadableReport": {
                        "type": "Text",
                        "value": "..."
                    },
                    "key": "bureau-25137",
                    "provider": "Equifax"
                }
            ]
        }
    },
    "customerData": {
        "customerList": {
            "customerPrimaryBorrower": {
                "dateBirth": "1972-02-02T00:00:00",
                "honorific": 1,
                "lastName": "BLACK",
                "firstName": "ALLISON",
                "suffix": "2",
                "customerTelephoneNumberList": [
                    {
                        "telephoneNumber": {
                            "countryCode": "1",
                            "areaCode": "416",
                            "phoneNumber": "1232345"
                        },
                        "usage": 1,
                        "preferred": true
                    },
                    {
                        "telephoneNumber": {
                            "countryCode": "1",
                            "areaCode": "416",
                            "phoneNumber": "1236756"
                        },
                        "usage": 4
                    }
                ],
                "employmentList": {
                    "employment": [
                        {
                            "addressCanada": {
                                "postalAddressStreetAddress": {
                                    "poBoxRRNumber": "",
                                    "unitNumber": "22",
                                    "streetNumber": "333",
                                    "streetName": "DON NILLS",
                                    "streetType": 1380,
                                    "streetDirection": 2
                                },
                                "cityTown": "TORONTO",
                                "provinceCode": 50,
                                "postalCode": "M2X4R5",
                                "countryCode": 1
                            },
                            "earnedIncomeList": {
                                "earnedIncome": [
                                    {
                                        "earnedIncomeType": 8,
                                        "paymentFrequency": 1,
                                        "earnedIncomeAmount": 150000.0
                                    }
                                ]
                            },
                            "contactTelephoneNumber": {
                                "telephoneNumber": {
                                    "countryCode": "1",
                                    "areaCode": "416",
                                    "phoneNumber": "5671234",
                                    "phoneExtension": "56756"
                                },
                                "usage": 10
                            },
                            "employmentType": 1,
                            "employmentStatus": 20,
                            "dateStart": "2014-07-01T00:00:00",
                            "industryType": 3,
                            "dateStartedInIndustry": "2013-07-10T00:00:00",
                            "occupationType": 6,
                            "jobTitle": "QA",
                            "companyName": "Self Company",
                            "companyType": "Test 1",
                            "operatingAs": "Test 2"
                        }
                    ]
                },
                "unearnedIncomeList": {
                    "unearnedIncome": [
                        {
                            "unearnedIncomeAmount": 2222.0,
                            "unearnedIncomeType": 99,
                            "paymentFrequency": 1,
                            "unearnedIncomeDetails": "222"
                        }
                    ]
                },
                "customerRelationShip": {},
                "key": "borrower-97965",
                "correspondenceLanguage": 1,
                "emailAddress1": "BLACK@umbrellacorp.ca",
                "maritalStatus": 1,
                "numberOfDependents": 0,
                "sex": 1,
                "residentType": 10
            },
            "customerBorrower": [
                {
                    "dateBirth": "1959-02-02T00:00:00",
                    "honorific": 2,
                    "lastName": "BLACK",
                    "firstName": "IAN",
                    "suffix": "1",
                    "customerTelephoneNumberList": [
                        {
                            "telephoneNumber": {
                                "countryCode": "1",
                                "areaCode": "416",
                                "phoneNumber": "5671234"
                            },
                            "usage": 1,
                            "preferred": false
                        },
                        {
                            "telephoneNumber": {
                                "countryCode": "1",
                                "areaCode": "416",
                                "phoneNumber": "5671231"
                            },
                            "usage": 4
                        },
                        {
                            "telephoneNumber": {
                                "countryCode": "1",
                                "areaCode": "416",
                                "phoneNumber": "5671234",
                                "phoneExtension": "13423"
                            },
                            "usage": 2,
                            "preferred": false
                        },
                        {
                            "telephoneNumber": {
                                "countryCode": "1",
                                "areaCode": "416",
                                "phoneNumber": "7891234"
                            },
                            "usage": 3,
                            "preferred": true
                        }
                    ],
                    "employmentList": {
                        "employment": [
                            {
                                "addressCanada": {
                                    "postalAddressStreetAddress": {
                                        "poBoxRRNumber": "",
                                        "unitNumber": "11",
                                        "streetNumber": "444",
                                        "streetName": "DON NILLS",
                                        "streetType": 1350,
                                        "streetDirection": 3
                                    },
                                    "cityTown": "TORONTO",
                                    "provinceCode": 50,
                                    "postalCode": "M2Y4R5",
                                    "countryCode": 1
                                },
                                "earnedIncomeList": {
                                    "earnedIncome": [
                                        {
                                            "earnedIncomeType": 9,
                                            "paymentFrequency": 1,
                                            "earnedIncomeAmount": 100000.0
                                        }
                                    ]
                                },
                                "contactTelephoneNumber": {
                                    "telephoneNumber": {
                                        "countryCode": "1",
                                        "areaCode": "416",
                                        "phoneNumber": "5671234",
                                        "phoneExtension": "13423"
                                    },
                                    "usage": 10
                                },
                                "employmentType": 2,
                                "employmentStatus": 10,
                                "dateStart": "2014-01-01T00:00:00",
                                "industryType": 8,
                                "dateStartedInIndustry": "2012-12-10T00:00:00",
                                "occupationType": 5,
                                "jobTitle": "Manager",
                                "companyName": "Bank Canada"
                            }
                        ]
                    },
                    "customerRelationShip": {
                        "relationShipToOwnerType": 4
                    },
                    "key": "borrower-97966",
                    "correspondenceLanguage": 1,
                    "emailAddress1": "BRANDY@mail.com",
                    "maritalStatus": 6,
                    "numberOfDependents": 0,
                    "sex": 2,
                    "residentType": 10
                },
                {
                    "dateBirth": "1955-02-02T00:00:00",
                    "honorific": 1,
                    "lastName": "BLACK",
                    "firstName": "BEATRICE",
                    "customerTelephoneNumberList": [
                        {
                            "telephoneNumber": {
                                "countryCode": "1",
                                "areaCode": "416",
                                "phoneNumber": "5671234"
                            },
                            "usage": 1,
                            "preferred": true
                        },
                        {
                            "telephoneNumber": {
                                "countryCode": "1",
                                "areaCode": "416",
                                "phoneNumber": "5677689"
                            },
                            "usage": 2,
                            "preferred": false
                        },
                        {
                            "telephoneNumber": {
                                "countryCode": "1",
                                "areaCode": "416",
                                "phoneNumber": "5671234"
                            },
                            "usage": 3,
                            "preferred": false
                        }
                    ],
                    "employmentList": {
                        "employment": [
                            {
                                "addressCanada": {
                                    "postalAddressStreetAddress": {
                                        "poBoxRRNumber": "",
                                        "unitNumber": "",
                                        "streetNumber": "11B",
                                        "streetName": "test",
                                        "streetType": 360,
                                        "streetDirection": 1
                                    },
                                    "cityTown": "NIAGARA FALLS",
                                    "provinceCode": 50,
                                    "postalCode": "M2Z2R4",
                                    "countryCode": 1
                                },
                                "earnedIncomeList": {
                                    "earnedIncome": [
                                        {
                                            "earnedIncomeType": 4,
                                            "paymentFrequency": 1,
                                            "earnedIncomeAmount": 120000.0
                                        }
                                    ]
                                },
                                "contactTelephoneNumber": {
                                    "telephoneNumber": {
                                        "countryCode": "1",
                                        "areaCode": "416",
                                        "phoneNumber": "1237689"
                                    },
                                    "usage": 10
                                },
                                "employmentType": 1,
                                "employmentStatus": 40,
                                "dateStart": "2015-07-01T00:00:00",
                                "industryType": 8,
                                "dateStartedInIndustry": "2015-07-10T00:00:00",
                                "occupationType": 3,
                                "jobTitle": "QA",
                                "companyName": "Gringott"
                            }
                        ]
                    },
                    "customerRelationShip": {
                        "relationShipToOwnerType": 14
                    },
                    "key": "borrower-97967",
                    "correspondenceLanguage": 1,
                    "emailAddress1": "BLACK@gmail.com",
                    "maritalStatus": 5,
                    "numberOfDependents": 0,
                    "sex": 1,
                    "residentType": 10
                },
                {
                    "dateBirth": "1965-02-02T00:00:00",
                    "honorific": 1,
                    "lastName": "BLACK",
                    "firstName": "FREDERICK",
                    "customerTelephoneNumberList": [
                        {
                            "telephoneNumber": {
                                "countryCode": "1",
                                "areaCode": "416",
                                "phoneNumber": "5671234"
                            },
                            "usage": 1,
                            "preferred": true
                        },
                        {
                            "telephoneNumber": {
                                "countryCode": "1",
                                "areaCode": "416",
                                "phoneNumber": "5614456"
                            },
                            "usage": 4
                        }
                    ],
                    "employmentList": {
                        "employment": [
                            {
                                "addressCanada": {
                                    "postalAddressStreetAddress": {
                                        "poBoxRRNumber": "",
                                        "unitNumber": "1",
                                        "streetNumber": "66",
                                        "streetName": "test",
                                        "streetType": 930,
                                        "streetDirection": 7
                                    },
                                    "cityTown": "NIAGARA FALLS",
                                    "provinceCode": 50,
                                    "postalCode": "M2J2R4",
                                    "countryCode": 1
                                },
                                "earnedIncomeList": {
                                    "earnedIncome": [
                                        {
                                            "earnedIncomeType": 4,
                                            "paymentFrequency": 1,
                                            "earnedIncomeAmount": 100000.0
                                        }
                                    ]
                                },
                                "employmentType": 2,
                                "employmentStatus": 10,
                                "dateStart": "2014-07-01T00:00:00",
                                "industryType": 4,
                                "dateStartedInIndustry": "2014-07-10T00:00:00",
                                "occupationType": 1,
                                "jobTitle": "QA",
                                "companyName": "Umbrella Corp."
                            }
                        ]
                    },
                    "customerRelationShip": {
                        "relationShipToOwnerType": 14
                    },
                    "key": "borrower-97968",
                    "correspondenceLanguage": 1,
                    "emailAddress1": "FREDERICK@umbrellacorp.ca",
                    "maritalStatus": 6,
                    "numberOfDependents": 0,
                    "sex": 1,
                    "residentType": 20
                }
            ]
        },
        "customerAddressList": [
            {
                "customerCurrentAddressTimeAt": [
                    {
                        "refkeyCustomer": "borrower-97965",
                        "fromDate": "2014-12-01T00:00:00"
                    }
                ],
                "addressOccupancyOwnerOccupied": {
                    "refkeyAsset": "property-34381"
                },
                "addressOccupancyOwnerOccupied": {
                    "refkeyAsset": "property-34381"
                },
                "currentPropertyIntendedActionType": 2,
                "annualHeatingAmount": 804.0,
                "annualTaxAmount": 4567.0,
                "customerReference": [
                    {
                        "refkeyCustomer": "borrower-97965"
                    }
                ],
                "refkeyAddress": "address-382297",
                "type": "CustomerAddressPrimaryResidence"
            },
            {
                "addressOccupancyNone": {},
                "addressOccupancyNone": {},
                "customerReference": [
                    {
                        "refkeyCustomer": "borrower-97965"
                    }
                ],
                "refkeyAddress": "address-382298",
                "type": "CustomerAddressCorrespondence"
            },
            {
                "customerCurrentAddressTimeAt": [
                    {
                        "refkeyCustomer": "borrower-97966",
                        "fromDate": "2012-12-01T00:00:00"
                    }
                ],
                "addressOccupancyTenant": {
                    "monthlyRentPaid": 0,
                    "tenancyType": 20
                },
                "currentPropertyIntendedActionType": 2,
                "customerReference": [
                    {
                        "refkeyCustomer": "borrower-97966"
                    }
                ],
                "refkeyAddress": "address-382299",
                "type": "CustomerAddressPrimaryResidence"
            },
            {
                "customerCurrentAddressTimeAt": [
                    {
                        "refkeyCustomer": "borrower-97967",
                        "fromDate": "2015-07-01T00:00:00"
                    }
                ],
                "addressOccupancyTenant": {
                    "monthlyRentPaid": 0,
                    "tenancyType": 40
                },
                "currentPropertyIntendedActionType": 2,
                "customerReference": [
                    {
                        "refkeyCustomer": "borrower-97967"
                    }
                ],
                "refkeyAddress": "address-382301",
                "type": "CustomerAddressPrimaryResidence"
            },
            {
                "customerCurrentAddressTimeAt": [
                    {
                        "refkeyCustomer": "borrower-97968",
                        "fromDate": "2015-07-01T00:00:00"
                    }
                ],
                "addressOccupancyTenant": {
                    "monthlyRentPaid": 2345.0,
                    "tenancyType": 10
                },
                "currentPropertyIntendedActionType": 2,
                "customerReference": [
                    {
                        "refkeyCustomer": "borrower-97968"
                    }
                ],
                "refkeyAddress": "address-382303",
                "type": "CustomerAddressPrimaryResidence"
            },
            {
                "customerCurrentAddressTimeAt": [
                    {
                        "refkeyCustomer": "borrower-97965",
                        "fromDate": "2007-05-01T00:00:00"
                    }
                ],
                "customerLiabilityRealEstate": [
                    {
                        "customerReference": {
                            "refkeyCustomer": "borrower-97965"
                        },
                        "refkeyLiability": "property-34378-1"
                    }
                ],
                "addressOccupancyPartialOwnerOccupied": {
                    "rentalDetails": {
                        "annualGrossRentalIncome": 24000.0,
                        "managementExpenses": 36.0,
                        "insurance": 48.0,
                        "hydro": 12.0,
                        "maintenanceAndRepairs": 60.0,
                        "interest": 72.0,
                        "generalExpenses": 24.0,
                        "rentalOffset": 50,
                        "rentalCalcType": 2
                    },
                    "refkeyAsset": "property-34378"
                },
                "addressOccupancyPartialOwnerOccupied": {
                    "rentalDetails": {
                        "annualGrossRentalIncome": 24000.0,
                        "managementExpenses": 36.0,
                        "insurance": 48.0,
                        "hydro": 12.0,
                        "maintenanceAndRepairs": 60.0,
                        "interest": 72.0,
                        "generalExpenses": 24.0,
                        "rentalOffset": 50,
                        "rentalCalcType": 2
                    },
                    "refkeyAsset": "property-34378"
                },
                "currentPropertyIntendedActionType": 2,
                "annualHeatingAmount": 1056.0,
                "annualTaxAmount": 2000.0,
                "annualCondoFees": 2808.0,
                "customerReference": [
                    {
                        "refkeyCustomer": "borrower-97965"
                    }
                ],
                "refkeyAddress": "address-382309",
                "type": "CustomerAddressSecondaryResidence"
            }
        ],
        "customerAssetList": [
            {
                "customerReference": {
                    "refkeyCustomer": "borrower-97965"
                },
                "refkeyAsset": "asset-82859"
            },
            {
                "customerReference": {
                    "refkeyCustomer": "borrower-97965"
                },
                "refkeyAsset": "asset-82860"
            },
            {
                "customerReference": {
                    "refkeyCustomer": "borrower-97965"
                },
                "refkeyAsset": "asset-82861"
            },
            {
                "customerReference": {
                    "refkeyCustomer": "borrower-97965"
                },
                "refkeyAsset": "asset-82862"
            },
            {
                "customerReference": {
                    "refkeyCustomer": "borrower-97965"
                },
                "refkeyAsset": "asset-82863"
            },
            {
                "customerReference": {
                    "refkeyCustomer": "borrower-97965"
                },
                "refkeyAsset": "asset-82864"
            },
            {
                "customerReference": {
                    "refkeyCustomer": "borrower-97965"
                },
                "refkeyAsset": "asset-82865"
            },
            {
                "customerReference": {
                    "refkeyCustomer": "borrower-97965"
                },
                "refkeyAsset": "asset-82866"
            },
            {
                "customerReference": {
                    "refkeyCustomer": "borrower-97965"
                },
                "refkeyAsset": "asset-82867"
            }
        ],
        "customerLiabilityList": [
            {
                "customerReference": {
                    "refkeyCustomer": "borrower-97965"
                },
                "refkeyLiability": "liability-112291"
            },
            {
                "customerReference": {
                    "refkeyCustomer": "borrower-97965"
                },
                "refkeyLiability": "liability-112292"
            },
            {
                "customerReference": {
                    "refkeyCustomer": "borrower-97965"
                },
                "refkeyLiability": "liability-112293"
            },
            {
                "customerReference": {
                    "refkeyCustomer": "borrower-97965"
                },
                "refkeyLiability": "liability-112294"
            },
            {
                "customerReference": {
                    "refkeyCustomer": "borrower-97966"
                },
                "refkeyLiability": "liability-112295"
            },
            {
                "customerReference": {
                    "refkeyCustomer": "borrower-97966"
                },
                "refkeyLiability": "liability-112296"
            },
            {
                "customerReference": {
                    "refkeyCustomer": "borrower-97967"
                },
                "refkeyLiability": "liability-112297"
            },
            {
                "customerReference": {
                    "refkeyCustomer": "borrower-97968"
                },
                "refkeyLiability": "liability-112298"
            }
        ],
        "customerCreditBureauList": [
            {
                "customerReference": [
                    {
                        "refkeyCustomer": "borrower-97965"
                    }
                ],
                "refkeyCreditBureau": "bureau-25107"
            },
            {
                "customerReference": [
                    {
                        "refkeyCustomer": "borrower-97966"
                    }
                ],
                "refkeyCreditBureau": "bureau-25121"
            },
            {
                "customerReference": [
                    {
                        "refkeyCustomer": "borrower-97967"
                    }
                ],
                "refkeyCreditBureau": "bureau-25129"
            },
            {
                "customerReference": [
                    {
                        "refkeyCustomer": "borrower-97968"
                    }
                ],
                "refkeyCreditBureau": "bureau-25137"
            }
        ]
    },
    "mortgageApplication": {
        "subjectProperty": {
            "subjectPropertyOccupancyPartialOwnerOccupied": {
                "rentalDetails": {
                    "annualGrossRentalIncome": 24000.0,
                    "managementExpenses": 36.0,
                    "insurance": 24.0,
                    "hydro": 12.0,
                    "maintenanceAndRepairs": 48.0,
                    "interest": 60.0,
                    "generalExpenses": 72.0,
                    "rentalOffset": 50,
                    "rentalCalcType": 2
                }
            },
            "legalAddress": {
                "details": "1",
                "pin": "1",
                "planNumber": "1"
            },
            "condo": {
                "annualCondoFees": 2808.0
            },
            "propertyTax": {
                "annualTaxAmount": 2000.0,
                "taxesPaidBy": 1
            },
            "propertyAppraisal": {
                "appraiserAddress": {
                    "key": "address-382312",
                    "postalAddressStreetAddress": {
                        "poBoxRRNumber": "",
                        "unitNumber": "123",
                        "streetNumber": "3243243",
                        "streetName": "2434543543",
                        "streetType": 100,
                        "streetDirection": 1
                    },
                    "cityTown": "LONDON",
                    "provinceCode": 50,
                    "postalCode": "M7Y4R5",
                    "countryCode": 1
                },
                "appraisedValue": 1345000,
                "dateAppraised": "2020-05-01T00:00:00",
                "companyName": "Appraisal Company"
            },
            "subjectPropertyAddress": {
                "refkeyAddress": "address-382309"
            },
            "occupancyPurpose": 4,
            "mlsListed": false,
            "mlsNumber": "1",
            "heatingType": 1,
            "parkingType": 1,
            "yearBuilt": 2000,
            "waterSupplyType": 10,
            "waterWasteType": 10,
            "propertySize": 2222,
            "propertySizeUnits": 1,
            "lotSize": 3333,
            "lotSizeUnits": 1,
            "environmentalHazardIndicator": false,
            "annualHeatingAmount": 1056.0,
            "numberOfUnitsTotal": 1,
            "propertyType": 1,
            "propertyDescriptionType": 1,
            "propertyUsageType": 1,
            "propertyZoningType": 1,
            "newPropertyIndicator": false
        },
        "loan": {
            "lenderProduct": {
                "productCode": "5YRF",
                "productStartDate": "2018-04-06T11:51:00"
            },
            "underwriter": {
                "userId": "<user_id>",
                "unitId": "1234"
            },
            "loanAmount": 1155000.0,
            "chargeType": 1,
            "termMonths": "64",
            "amortizationMonths": "305",
            "netRate": 3.7,
            "qualifyingRate": 3,
            "acceleratedPayment": false,
            "maturityDate": "2025-07-31T00:00:00",
            "firstPaymentDate": "2020-08-14T00:00:00",
            "interestAdjustmentDate": "2020-07-31T00:00:00",
            "requestedPayment": 2690.89,
            "paymentAmount": 5830.27,
            "paymentFrequency": 26,
            "repaymentType": 2,
            "lenderCode": <lender_code>,
            "lenderChannel": 10
        },
        "downpaymentList": {
            "downpayment": [
                {
                    "downpaymentSourceType": 3,
                    "description": "description 1",
                    "amount": 100000.0
                },
                {
                    "downpaymentSourceType": 9,
                    "description": "description 2",
                    "amount": 20000.0
                },
                {
                    "downpaymentSourceType": 99,
                    "description": "description 3",
                    "amount": 50000.0
                },
                {
                    "downpaymentSourceType": 1,
                    "description": "description 4",
                    "amount": 20000.0
                }
            ]
        },
        "firm": {
            "externalPoSFirm": [
                {
                    "posSystemId": 50,
                    "firmId": "<firm_id>"
                }
            ],
            "firmId": "<firm_id>"
        },
        "submittingAgent": {
            "externalPoSUser": [
                {
                    "posSystemId": 40,
                    "firmId": "<firm_id>",
                    "userId": "<user_external_pos_id_1>"
                },
                {
                    "posSystemId": 50,
                    "firmId": "<firm_id>",
                    "userId": "<user_external_pos_id_2>"
                }
            ],
            "userId": "<user_id>",
            "firstName": "<user_firstname>",
            "lastName": "<user_lastname>",
            "emailAddress": "<user_email_address>",
            "mortgageLicenseNumber": "<mortgage_license_number>"
        },
        "originatingAgent": {
            "externalPoSUser": [
                {
                    "posSystemId": 40,
                    "firmId": "<firm_id>",
                    "userId": "<user_external_pos_id_1>"
                },
                {
                    "posSystemId": 50,
                    "firmId": "<firm_id>",
                    "userId": "<user_external_pos_id_2>"
                }
            ],
            "addressCanada": {
                "postalAddressStreetAddress": {
                    "poBoxRRNumber": "",
                    "unitNumber": "123",
                    "streetNumber": "1608",
                    "streetName": "Granville",
                    "streetType": 1240,
                    "streetDirection": 2
                },
                "cityTown": "Vancouver",
                "provinceCode": 10,
                "postalCode": "V6Z3V3",
                "countryCode": 1
            },
            "userId": "<user_id>",
            "firstName": "<user_firstname>",
            "lastName": "<user_lastname>",
            "emailAddress": "<user_email_address>",
            "mortgageLicenseNumber": "<mortgage_license_number>"
        },
        "broker": {
            "externalPoSUser": [
                {
                    "posSystemId": 40,
                    "firmId": "<firm_id>",
                    "userId": "<user_external_pos_id_1>"
                },
                {
                    "posSystemId": 50,
                    "firmId": "<firm_id>",
                    "userId": "<user_external_pos_id_2>"
                }
            ],
            "userId": "<user_id>",
            "firstName": "<user_firstname>",
            "lastName": "<user_lastname>",
            "emailAddress": "<user_email_address>",
            "mortgageLicenseNumber": "<mortgage_license_number>"
        },
        "posApplicationNumber": "ABCD-12345",
        "isPreapproval": false,
        "fundingDate": "2020-07-31T00:00:00",
        "loanPurposeType": 1,
        "purchasePriceEstimatedValue": 1345000.0,
        "typeOfBuyer": 20
    },
    "memo": "\n    Applicants:\n    Participants-  Agent: Jane Smith Assoc/Asst: Jane Smith\n    File touched by: Jane Smith\n    ALLISON BLACK for Self Company as QA\n    IAN BLACK for Bank Canada as Manager\n    BEATRICE BLACK for ACME as QA222\n    FREDERICK BLACK for NN as QA3333\n    Subj Prop Rental - $2,000.00 add back 50%\n    Assets: (Type - Desc - Amount)\n    Deposit on Purchase - - $111.00\n    Gift - 222 - $222.00\n    Household Goods -  $333.00\n    Life Insurance - 444 - $444.00\n    Mutual Fund/Stock/Bonds -  $555.00\n    Other - 666 - $666.00\n    RRSP - 777 tynrtynrt - $777.00\n    Savings - 888 - $888.00\n    Vehicle - 999 - $999.00\n    Properties: (# - Annual Taxes - Heating /mo)\n    1 (#123 - 12134 Warden Circle S, TORONTO, Ontario, M7Z3E4) - $2,000.00 - $88.00\n    2 (123 MCMICKLING Expressway S, NIAGARA FALLS, Ontario, L2Z1X4) - $4,567.00 - $67.00\n    Credit Bureaus: (Name - Vendor - Pulled By - Requested)\n    ALLISON BLACK - Equifax - JSMITH - 2020-06-02 03:11 PM UTC\n    IAN BLACK - Equifax - JSMITH - 2020-06-02 03:11 PM UTC\n    BEATRICE BLACK - Equifax - JSMITH - 2020-06-02 03:12 PM UTC\n    FREDERICK BLACK - Equifax - JSMITH - 2020-06-02 03:13 PM UTC\n\n    Selected Product: 5YRF\n  ",
    "unitId": "<unit_id>",
    "posSystem": "<pos_system_id>"
}

Deal 2 contains:

Deal 3

Request Body 

{
    "commonData": {
        "assetList": {
            "assetRealEstate": [
                {
                    "originalPrice": 450000.0,
                    "originalDate": "2018-01-01T00:00:00",
                    "key": "property-34383",
                    "value": 500000.0
                },
                {
                    "originalPrice": 4546123.0,
                    "originalDate": "2007-05-01T00:00:00",
                    "key": "property-34387",
                    "value": 456123.0
                },
                {
                    "originalPrice": 345000.0,
                    "originalDate": "2009-01-01T00:00:00",
                    "key": "property-34384",
                    "value": 345000.0
                },
                {
                    "originalPrice": 456000.0,
                    "originalDate": "2007-04-09T00:00:00",
                    "key": "property-34386",
                    "value": 456000.0
                }
            ],
            "assetOther": [
                {
                    "assetType": 71,
                    "description": "(416)5671234",
                    "key": "asset-82868",
                    "value": 11.33
                },
                {
                    "assetType": 72,
                    "description": "Test Liability",
                    "key": "asset-82869",
                    "value": 25.06
                },
                {
                    "assetType": 73,
                    "description": "1234567890!@#$%^&*()_P{}:\"?><>?",
                    "key": "asset-82870",
                    "value": 33.66
                },
                {
                    "assetType": 20,
                    "description": "key=\"liability-93639\" fromCreditBureau=\"true\"",
                    "key": "asset-82871",
                    "value": 444.0
                },
                {
                    "assetType": 70,
                    "description": "dateEnd=\"2013-08-04\"",
                    "key": "asset-82872",
                    "value": 555.0
                },
                {
                    "assetType": 99,
                    "description": "666",
                    "key": "asset-82873",
                    "value": 666.0
                },
                {
                    "assetType": 30,
                    "description": "777",
                    "key": "asset-82874",
                    "value": 777.0
                },
                {
                    "assetType": 10,
                    "description": "888",
                    "key": "asset-82875",
                    "value": 888.0
                },
                {
                    "assetType": 40,
                    "description": "999",
                    "key": "asset-82876",
                    "value": 999.0
                }
            ]
        },
        "liabilityList": {
            "liabilityRealEstate": [
                {
                    "accountNumber": "12345-1234567",
                    "monthlyRepayment": 500.0,
                    "originalLoanAmount": 300000.0,
                    "outstandingBalance": 50000.0,
                    "closingDate": "2018-01-01T00:00:00",
                    "lenderName": "Gringotts",
                    "chargeType": 1,
                    "repaymentType": 2,
                    "redemptionStatus": 1,
                    "maturityDate": "2020-09-18T00:00:00",
                    "netRate": 3,
                    "rateType": 0,
                    "mortgageInsurer": 10,
                    "insuranceCertificateNumber": "1234567890",
                    "key": "property-34383-1",
                    "fromCreditBureau": false
                }
            ],
            "liabilityOther": [
                {
                    "dateEnd": "2019-08-14T00:00:00",
                    "repaymentIndicator": false,
                    "monthlyRepayment": 11.33,
                    "creditLimit": 111.0,
                    "outstandingBalance": 111.0,
                    "lenderName": "Gringotts",
                    "liabilityType": 9,
                    "additionalHolders": true,
                    "additionalHoldersDetails": "111111",
                    "key": "liability-112299",
                    "fromCreditBureau": false
                },
                {
                    "repaymentIndicator": true,
                    "payoffType": 1,
                    "monthlyRepayment": 44.67,
                    "creditLimit": 222.0,
                    "outstandingBalance": 222.0,
                    "lenderName": "Umbrella Corp.",
                    "liabilityType": 4,
                    "key": "liability-112300",
                    "fromCreditBureau": false
                },
                {
                    "repaymentIndicator": true,
                    "payoffType": 2,
                    "monthlyRepayment": 6678.0,
                    "creditLimit": 333.0,
                    "outstandingBalance": 333.0,
                    "lenderName": "Tyrell Corp.",
                    "liabilityType": 3,
                    "additionalHolders": true,
                    "additionalHoldersDetails": "(345)123-6546",
                    "key": "liability-112301",
                    "fromCreditBureau": false
                },
                {
                    "repaymentIndicator": false,
                    "monthlyRepayment": 30.0,
                    "creditLimit": 444.0,
                    "outstandingBalance": 35.0,
                    "lenderName": "Stark Industries",
                    "liabilityType": 8,
                    "key": "liability-112302",
                    "fromCreditBureau": true
                },
                {
                    "repaymentIndicator": true,
                    "payoffType": 1,
                    "monthlyRepayment": 1.0,
                    "creditLimit": 555.0,
                    "outstandingBalance": 33.0,
                    "lenderName": "Gringotts",
                    "liabilityType": 6,
                    "additionalHolders": true,
                    "additionalHoldersDetails": "%^&&*(&%)",
                    "key": "liability-112303",
                    "fromCreditBureau": false
                },
                {
                    "repaymentIndicator": false,
                    "monthlyRepayment": 2.0,
                    "creditLimit": 666.0,
                    "outstandingBalance": 44.0,
                    "lenderName": "CHOAM",
                    "liabilityType": 12,
                    "key": "liability-112304",
                    "fromCreditBureau": false
                },
                {
                    "repaymentIndicator": true,
                    "payoffType": 2,
                    "monthlyRepayment": 3.0,
                    "creditLimit": 777.0,
                    "outstandingBalance": 55.0,
                    "lenderName": "Wayne Enterprises",
                    "liabilityType": 4,
                    "additionalHolders": true,
                    "additionalHoldersDetails": "(41683947p23)",
                    "key": "liability-112305",
                    "fromCreditBureau": false
                },
                {
                    "repaymentIndicator": false,
                    "monthlyRepayment": 4.0,
                    "creditLimit": 88.0,
                    "outstandingBalance": 66.0,
                    "lenderName": "Globex",
                    "liabilityType": 99,
                    "additionalHolders": true,
                    "additionalHoldersDetails": "01.01.2020",
                    "key": "liability-112306",
                    "fromCreditBureau": false
                },
                {
                    "repaymentIndicator": false,
                    "monthlyRepayment": 5.99,
                    "creditLimit": 9999.0,
                    "outstandingBalance": 77.0,
                    "lenderName": "Oscorp",
                    "liabilityType": 1,
                    "key": "liability-112307",
                    "fromCreditBureau": false
                },
                {
                    "repaymentIndicator": true,
                    "payoffType": 2,
                    "monthlyRepayment": 5.0,
                    "creditLimit": 100.0,
                    "outstandingBalance": 88.0,
                    "lenderName": "Nakatomi Trading Corp.",
                    "liabilityType": 2,
                    "additionalHolders": true,
                    "additionalHoldersDetails": "test",
                    "key": "liability-112308",
                    "fromCreditBureau": false
                },
                {
                    "repaymentIndicator": false,
                    "monthlyRepayment": 6.0,
                    "creditLimit": 123.0,
                    "outstandingBalance": 99.0,
                    "lenderName": "Gringotts",
                    "liabilityType": 10,
                    "key": "liability-112309",
                    "fromCreditBureau": false
                },
                {
                    "repaymentIndicator": true,
                    "payoffType": 1,
                    "monthlyRepayment": 7.0,
                    "creditLimit": 1234.0,
                    "outstandingBalance": 123.0,
                    "lenderName": "ACME",
                    "liabilityType": 7,
                    "key": "liability-112310",
                    "fromCreditBureau": false
                },
                {
                    "repaymentIndicator": false,
                    "monthlyRepayment": 8.0,
                    "creditLimit": 2345.0,
                    "outstandingBalance": 233.0,
                    "lenderName": "Frobozz",
                    "liabilityType": 11,
                    "key": "liability-112311",
                    "fromCreditBureau": false
                }
            ]
        },
        "addressList": {
            "applicationAddressCanada": [
                {
                    "key": "address-382315",
                    "postalAddressStreetAddress": {
                        "poBoxRRNumber": "",
                        "unitNumber": "2",
                        "streetNumber": "6",
                        "streetName": "GAGEVIEW CRT",
                        "streetType": 490,
                        "streetDirection": 5
                    },
                    "cityTown": "SCARBOROUGH",
                    "provinceCode": 50,
                    "postalCode": "M1V2E4",
                    "countryCode": 1
                },
                {
                    "key": "address-382316",
                    "postalAddressStreetAddress": {
                        "poBoxRRNumber": "",
                        "unitNumber": "11",
                        "streetNumber": "222",
                        "streetName": "Previous1111",
                        "streetType": 100,
                        "streetDirection": 2
                    },
                    "cityTown": "North York",
                    "provinceCode": 50,
                    "postalCode": "M6R3T5",
                    "countryCode": 1
                },
                {
                    "key": "address-382317",
                    "postalAddressStreetAddress": {
                        "poBoxRRNumber": "",
                        "unitNumber": "22",
                        "streetNumber": "333",
                        "streetName": "Previous222",
                        "streetType": 780,
                        "streetDirection": 1
                    },
                    "cityTown": "Toronto",
                    "provinceCode": 50,
                    "postalCode": "M6T3R4",
                    "countryCode": 1
                },
                {
                    "key": "address-382319",
                    "postalAddressStreetAddress": {
                        "poBoxRRNumber": "",
                        "unitNumber": "1",
                        "streetNumber": "131",
                        "streetName": "MARGARET",
                        "streetType": 30,
                        "streetDirection": 5
                    },
                    "cityTown": "STONEY CREEK",
                    "provinceCode": 50,
                    "postalCode": "L8G3G7",
                    "countryCode": 1
                },
                {
                    "key": "address-382321",
                    "postalAddressStreetAddress": {
                        "poBoxRRNumber": "",
                        "unitNumber": "11",
                        "streetNumber": "123",
                        "streetName": "Finch",
                        "streetType": 590,
                        "streetDirection": 2
                    },
                    "cityTown": "Toronto",
                    "provinceCode": 50,
                    "postalCode": "M6T3R5",
                    "countryCode": 1
                },
                {
                    "key": "address-382331",
                    "postalAddressStreetAddress": {
                        "poBoxRRNumber": "",
                        "unitNumber": "111111",
                        "streetNumber": "22222",
                        "streetName": "Rental Property",
                        "streetType": 620,
                        "streetDirection": 7
                    },
                    "cityTown": "London",
                    "provinceCode": 50,
                    "postalCode": "M3E5T5",
                    "countryCode": 1
                },
                {
                    "key": "address-382314",
                    "postalAddressStreetAddress": {
                        "poBoxRRNumber": "",
                        "unitNumber": "700",
                        "streetNumber": "33",
                        "streetName": "YONGE",
                        "streetType": 490,
                        "streetDirection": 5
                    },
                    "cityTown": "TORONTO",
                    "provinceCode": 50,
                    "postalCode": "M5E1G4",
                    "countryCode": 1
                }
            ]
        },
        "creditBureauList": {
            "creditBureau": [
                {
                    "creditReportEquifax": {
                        "dataFormat": "0H",
                        "reportDate": "2020-06-17T00:00:00",
                        "creditScore": 796,
                        "value": "..."
                    },
                    "humanReadableReport": {
                        "type": "Text",
                        "value": "..."
                    },
                    "key": "bureau-25144",
                    "provider": "Equifax"
                },
                {
                    "creditReportEquifax": {
                        "dataFormat": "0H",
                        "reportDate": "2020-06-17T00:00:00",
                        "creditScore": 525,
                        "value": "..."
                    },
                    "humanReadableReport": {
                        "type": "Text",
                        "value": "..."
                    },
                    "key": "bureau-25148",
                    "provider": "Equifax"
                },
                {
                    "creditReportEquifax": {
                        "dataFormat": "0H",
                        "reportDate": "2020-06-17T00:00:00",
                        "creditScore": 0,
                        "value": "..."
                    },
                    "humanReadableReport": {
                        "type": "Text",
                        "value": "..."
                    },
                    "key": "bureau-25150",
                    "provider": "Equifax"
                }
            ]
        }
    },
    "customerData": {
        "customerList": {
            "customerPrimaryBorrower": {
                "dateBirth": "1952-10-10T00:00:00",
                "honorific": 1,
                "lastName": "ANDERSON",
                "firstName": "JOHN",
                "customerTelephoneNumberList": [
                    {
                        "telephoneNumber": {
                            "countryCode": "1",
                            "areaCode": "416",
                            "phoneNumber": "5672345"
                        },
                        "usage": 1,
                        "preferred": false
                    },
                    {
                        "telephoneNumber": {
                            "countryCode": "1",
                            "areaCode": "416",
                            "phoneNumber": "5551111"
                        },
                        "usage": 4
                    },
                    {
                        "telephoneNumber": {
                            "countryCode": "1",
                            "areaCode": "416",
                            "phoneNumber": "5671234",
                            "phoneExtension": "111"
                        },
                        "usage": 2,
                        "preferred": false
                    },
                    {
                        "telephoneNumber": {
                            "countryCode": "1",
                            "areaCode": "416",
                            "phoneNumber": "7891234"
                        },
                        "usage": 3,
                        "preferred": true
                    }
                ],
                "employmentList": {
                    "employment": [
                        {
                            "addressCanada": {
                                "postalAddressStreetAddress": {
                                    "poBoxRRNumber": "",
                                    "unitNumber": "1D",
                                    "streetNumber": "222",
                                    "streetName": "Employer",
                                    "streetType": 600,
                                    "streetDirection": 4
                                },
                                "cityTown": "Toronto",
                                "provinceCode": 50,
                                "postalCode": "M7Y5T6",
                                "countryCode": 1
                            },
                            "earnedIncomeList": {
                                "earnedIncome": [
                                    {
                                        "earnedIncomeType": 8,
                                        "paymentFrequency": 1,
                                        "earnedIncomeAmount": 150000.0
                                    }
                                ]
                            },
                            "contactTelephoneNumber": {
                                "telephoneNumber": {
                                    "countryCode": "1",
                                    "areaCode": "416",
                                    "phoneNumber": "5671234",
                                    "phoneExtension": "111"
                                },
                                "usage": 10
                            },
                            "employmentType": 1,
                            "employmentStatus": 20,
                            "dateStart": "2014-07-01T00:00:00",
                            "industryType": 99,
                            "dateStartedInIndustry": "2013-07-10T00:00:00",
                            "occupationType": 6,
                            "jobTitle": "QA",
                            "companyName": "Gringott",
                            "companyType": "test",
                            "operatingAs": "test"
                        }
                    ]
                },
                "unearnedIncomeList": {
                    "unearnedIncome": [
                        {
                            "unearnedIncomeAmount": 1.0,
                            "unearnedIncomeType": 3,
                            "paymentFrequency": 1,
                            "unearnedIncomeDetails": "111"
                        },
                        {
                            "unearnedIncomeAmount": 2.33,
                            "unearnedIncomeType": 3,
                            "paymentFrequency": 26,
                            "unearnedIncomeDetails": "222"
                        },
                        {
                            "unearnedIncomeAmount": 3.0,
                            "unearnedIncomeType": 99,
                            "paymentFrequency": 12,
                            "unearnedIncomeDetails": "333"
                        },
                        {
                            "unearnedIncomeAmount": 4.0,
                            "unearnedIncomeType": 99,
                            "paymentFrequency": 4,
                            "unearnedIncomeDetails": "444"
                        },
                        {
                            "unearnedIncomeAmount": 5.0,
                            "unearnedIncomeType": 1,
                            "paymentFrequency": 24,
                            "unearnedIncomeDetails": "555"
                        }
                    ]
                },
                "customerRelationShip": {},
                "key": "borrower-97969",
                "correspondenceLanguage": 1,
                "emailAddress1": "<user_email_address>",
                "maritalStatus": 2,
                "numberOfDependents": 0,
                "sex": 1,
                "residentType": 10
            },
            "customerBorrower": [
                {
                    "dateBirth": "1986-03-07T00:00:00",
                    "honorific": 4,
                    "lastName": "ANDERSON",
                    "firstName": "CHRISTINE",
                    "customerTelephoneNumberList": [
                        {
                            "telephoneNumber": {
                                "countryCode": "1",
                                "areaCode": "416",
                                "phoneNumber": "5671234"
                            },
                            "usage": 1,
                            "preferred": false
                        },
                        {
                            "telephoneNumber": {
                                "countryCode": "1",
                                "areaCode": "416",
                                "phoneNumber": "5671234"
                            },
                            "usage": 2,
                            "preferred": false
                        },
                        {
                            "telephoneNumber": {
                                "countryCode": "1",
                                "areaCode": "416",
                                "phoneNumber": "7891234"
                            },
                            "usage": 3,
                            "preferred": false
                        }
                    ],
                    "employmentList": {
                        "employment": [
                            {
                                "addressCanada": {
                                    "postalAddressStreetAddress": {
                                        "poBoxRRNumber": "",
                                        "unitNumber": "4A",
                                        "streetNumber": "333",
                                        "streetName": "Employer",
                                        "streetType": 100,
                                        "streetDirection": 1
                                    },
                                    "cityTown": "Toronto",
                                    "provinceCode": 50,
                                    "postalCode": "M8N6T5",
                                    "countryCode": 1
                                },
                                "earnedIncomeList": {
                                    "earnedIncome": [
                                        {
                                            "earnedIncomeType": 4,
                                            "paymentFrequency": 1,
                                            "earnedIncomeAmount": 100000.0
                                        }
                                    ]
                                },
                                "contactTelephoneNumber": {
                                    "telephoneNumber": {
                                        "countryCode": "1",
                                        "areaCode": "416",
                                        "phoneNumber": "5671234"
                                    },
                                    "usage": 10
                                },
                                "employmentType": 2,
                                "employmentStatus": 10,
                                "dateStart": "2014-01-01T00:00:00",
                                "industryType": 5,
                                "dateStartedInIndustry": "2012-12-10T00:00:00",
                                "occupationType": 5,
                                "jobTitle": "Manager",
                                "companyName": "TD"
                            }
                        ]
                    }
                    "customerRelationShip": {
                        "relationShipToOwnerType": 1
                    },
                    "key": "borrower-97970",
                    "correspondenceLanguage": 2,
                    "emailAddress1": "CHRISTINE@mail.com",
                    "maritalStatus": 6,
                    "numberOfDependents": 0,
                    "sex": 2,
                    "residentType": 20
                }
            ],
            "customerGuarantor": [
                {
                    "dateBirth": "1967-05-09T00:00:00",
                    "honorific": 5,
                    "lastName": "RENTALANDERSON",
                    "firstName": "HENRY",
                    "customerTelephoneNumberList": [
                        {
                            "telephoneNumber": {
                                "countryCode": "1",
                                "areaCode": "416",
                                "phoneNumber": "5671234"
                            },
                            "usage": 1,
                            "preferred": true
                        },
                        {
                            "telephoneNumber": {
                                "countryCode": "1",
                                "areaCode": "416",
                                "phoneNumber": "5673456"
                            },
                            "usage": 2,
                            "preferred": false
                        },
                        {
                            "telephoneNumber": {
                                "countryCode": "1",
                                "areaCode": "416",
                                "phoneNumber": "7893456"
                            },
                            "usage": 3,
                            "preferred": false
                        }
                    ],
                    "employmentList": {
                        "employment": [
                            {
                                "earnedIncomeList": {
                                    "earnedIncome": [
                                        {
                                            "earnedIncomeType": 10,
                                            "paymentFrequency": 12,
                                            "earnedIncomeAmount": 100.0
                                        }
                                    ]
                                },
                                "contactTelephoneNumber": {
                                    "telephoneNumber": {
                                        "countryCode": "1",
                                        "areaCode": "416",
                                        "phoneNumber": "5673456"
                                    },
                                    "usage": 10
                                },
                                "employmentType": 1,
                                "employmentStatus": 20,
                                "dateStart": "2016-03-01T00:00:00",
                                "industryType": 2,
                                "dateStartedInIndustry": "2013-07-10T00:00:00",
                                "occupationType": 6,
                                "jobTitle": "Boss",
                                "companyName": "HSVBG"
                            }
                        ]
                    },
                    "customerRelationShip": {
                        "relationShipToOwnerType": 4
                    },
                    "key": "borrower-97971",
                    "correspondenceLanguage": 2,
                    "emailAddress1": "HENRY@mail.com",
                    "maritalStatus": 1,
                    "numberOfDependents": 0,
                    "sex": 1,
                    "residentType": 99
                }
            ]
        },
        "customerAddressList": [
            {
                "customerCurrentAddressTimeAt": [
                    {
                        "refkeyCustomer": "borrower-97969",
                        "fromDate": "2019-07-01T00:00:00"
                    }
                ],
                "customerLiabilityRealEstate": [
                    {
                        "customerReference": {
                            "refkeyCustomer": "borrower-97969"
                        },
                        "refkeyLiability": "property-34383-1"
                    }
                ],
                "addressOccupancyPartialOwnerOccupied": {
                    "rentalDetails": {
                        "annualGrossRentalIncome": 18000.0,
                        "managementExpenses": 60.0,
                        "insurance": 72.0,
                        "hydro": 36.0,
                        "maintenanceAndRepairs": 84.0,
                        "interest": 96.0,
                        "generalExpenses": 48.0,
                        "rentalOffset": 50,
                        "rentalCalcType": 1
                    },
                    "refkeyAsset": "property-34383"
                },
                "currentPropertyIntendedActionType": 2,
                "annualHeatingAmount": 660.0,
                "annualTaxAmount": 4000.0,
                "annualCondoFees": 1476.0,
                "customerReference": [
                    {
                        "refkeyCustomer": "borrower-97969"
                    }
                ],
                "refkeyAddress": "address-382315",
                "type": "CustomerAddressPrimaryResidence"
            },
            {
                "customerPreviousAddressTimeAt": [
                    {
                        "refkeyCustomer": "borrower-97969",
                        "fromDate": "2018-07-01T00:00:00",
                        "toDate": "2019-07-01T00:00:00"
                    }
                ],
                "previousAddressOccupancyTenant": {
                    "tenancyType": 10
                },
                "customerReference": [
                    {
                        "refkeyCustomer": "borrower-97969"
                    }
                ],
                "refkeyAddress": "address-382316",
                "type": "CustomerAddressPreviousResidence"
            },
            {
                "customerPreviousAddressTimeAt": [
                    {
                        "refkeyCustomer": "borrower-97969",
                        "fromDate": "2017-07-01T00:00:00",
                        "toDate": "2018-07-01T00:00:00"
                    }
                ],
                "previousAddressOccupancyTenant": {
                    "tenancyType": 20
                },
                "customerReference": [
                    {
                        "refkeyCustomer": "borrower-97969"
                    }
                ],
                "refkeyAddress": "address-382317",
                "type": "CustomerAddressPreviousResidence"
            },
            {
                "addressOccupancyNone": {},
                "customerReference": [
                    {
                        "refkeyCustomer": "borrower-97969"
                    }
                ],
                "refkeyAddress": "address-382315",
                "type": "CustomerAddressCorrespondence"
            },
            {
                "customerCurrentAddressTimeAt": [
                    {
                        "refkeyCustomer": "borrower-97970",
                        "fromDate": "2010-07-01T00:00:00"
                    }
                ],
                "addressOccupancyOwnerOccupied": {
                    "refkeyAsset": "property-34384"
                },
                "currentPropertyIntendedActionType": 2,
                "annualHeatingAmount": 1056.0,
                "annualTaxAmount": 2000.0,
                "annualCondoFees": 1476.0,
                "customerReference": [
                    {
                        "refkeyCustomer": "borrower-97970"
                    }
                ],
                "refkeyAddress": "address-382319",
                "type": "CustomerAddressPrimaryResidence"
            },
            {
                "customerCurrentAddressTimeAt": [
                    {
                        "refkeyCustomer": "borrower-97971",
                        "fromDate": "2012-12-01T00:00:00"
                    }
                ],
                "addressOccupancyPartialOwnerOccupied": {
                    "rentalDetails": {
                        "annualGrossRentalIncome": 120000.0,
                        "managementExpenses": 48.0,
                        "insurance": 60.0,
                        "hydro": 24.0,
                        "maintenanceAndRepairs": 72.0,
                        "interest": 84.0,
                        "generalExpenses": 36.0,
                        "rentalOffset": 100,
                        "rentalCalcType": 2
                    },
                    "refkeyAsset": "property-34386"
                },
                "currentPropertyIntendedActionType": 2,
                "annualHeatingAmount": 924.0,
                "annualTaxAmount": 3000.0,
                "annualCondoFees": 5472.0,
                "customerReference": [
                    {
                        "refkeyCustomer": "borrower-97971"
                    }
                ],
                "refkeyAddress": "address-382321",
                "type": "CustomerAddressPrimaryResidence"
            },
            {
                "customerCurrentAddressTimeAt": [
                    {
                        "refkeyCustomer": "borrower-97969",
                        "fromDate": "2007-05-01T00:00:00"
                    }
                ],
                "addressOccupancyRental": {
                    "rentalDetails": {
                        "annualGrossRentalIncome": 13332.0,
                        "managementExpenses": 12.0,
                        "insurance": 12.0,
                        "hydro": 12.0,
                        "maintenanceAndRepairs": 12.0,
                        "interest": 12.0,
                        "generalExpenses": 12.0,
                        "rentalOffset": 30,
                        "rentalCalcType": 1
                    },
                    "refkeyAsset": "property-34387"
                },
                "currentPropertyIntendedActionType": 2,
                "annualHeatingAmount": 1056.0,
                "annualTaxAmount": 456.0,
                "annualCondoFees": 1476.0,
                "customerReference": [
                    {
                        "refkeyCustomer": "borrower-97969"
                    }
                ],
                "refkeyAddress": "address-382331",
                "type": "CustomerAddressInvestmentProperty"
            }
        ],
        "customerAssetList": [
            {
                "customerReference": {
                    "refkeyCustomer": "borrower-97969"
                },
                "refkeyAsset": "asset-82868"
            },
            {
                "customerReference": {
                    "refkeyCustomer": "borrower-97969"
                },
                "refkeyAsset": "asset-82869"
            },
            {
                "customerReference": {
                    "refkeyCustomer": "borrower-97969"
                },
                "refkeyAsset": "asset-82870"
            },
            {
                "customerReference": {
                    "refkeyCustomer": "borrower-97969"
                },
                "refkeyAsset": "asset-82871"
            },
            {
                "customerReference": {
                    "refkeyCustomer": "borrower-97969"
                },
                "refkeyAsset": "asset-82872"
            },
            {
                "customerReference": {
                    "refkeyCustomer": "borrower-97969"
                },
                "refkeyAsset": "asset-82873"
            },
            {
                "customerReference": {
                    "refkeyCustomer": "borrower-97969"
                },
                "refkeyAsset": "asset-82874"
            },
            {
                "customerReference": {
                    "refkeyCustomer": "borrower-97969"
                },
                "refkeyAsset": "asset-82875"
            },
            {
                "customerReference": {
                    "refkeyCustomer": "borrower-97969"
                },
                "refkeyAsset": "asset-82876"
            }
        ],
        "customerLiabilityList": [
            {
                "customerReference": {
                    "refkeyCustomer": "borrower-97969"
                },
                "refkeyLiability": "liability-112299"
            },
            {
                "customerReference": {
                    "refkeyCustomer": "borrower-97969"
                },
                "refkeyLiability": "liability-112300"
            },
            {
                "customerReference": {
                    "refkeyCustomer": "borrower-97969"
                },
                "refkeyLiability": "liability-112301"
            },
            {
                "customerReference": {
                    "refkeyCustomer": "borrower-97969"
                },
                "refkeyLiability": "liability-112302"
            },
            {
                "customerReference": {
                    "refkeyCustomer": "borrower-97969"
                },
                "refkeyLiability": "liability-112303"
            },
            {
                "customerReference": {
                    "refkeyCustomer": "borrower-97969"
                },
                "refkeyLiability": "liability-112304"
            },
            {
                "customerReference": {
                    "refkeyCustomer": "borrower-97969"
                },
                "refkeyLiability": "liability-112305"
            },
            {
                "customerReference": {
                    "refkeyCustomer": "borrower-97969"
                },
                "refkeyLiability": "liability-112306"
            },
            {
                "customerReference": {
                    "refkeyCustomer": "borrower-97969"
                },
                "refkeyLiability": "liability-112307"
            },
            {
                "customerReference": {
                    "refkeyCustomer": "borrower-97969"
                },
                "refkeyLiability": "liability-112308"
            },
            {
                "customerReference": {
                    "refkeyCustomer": "borrower-97969"
                },
                "refkeyLiability": "liability-112309"
            },
            {
                "customerReference": {
                    "refkeyCustomer": "borrower-97969"
                },
                "refkeyLiability": "liability-112310"
            },
            {
                "customerReference": {
                    "refkeyCustomer": "borrower-97969"
                },
                "refkeyLiability": "liability-112311"
            }
        ],
        "customerCreditBureauList": [
            {
                "customerReference": [
                    {
                        "refkeyCustomer": "borrower-97969"
                    }
                ],
                "refkeyCreditBureau": "bureau-25144"
            },
            {
                "customerReference": [
                    {
                        "refkeyCustomer": "borrower-97970"
                    }
                ],
                "refkeyCreditBureau": "bureau-25148"
            },
            {
                "customerReference": [
                    {
                        "refkeyCustomer": "borrower-97971"
                    }
                ],
                "refkeyCreditBureau": "bureau-25150"
            }
        ]
    },
    "mortgageApplication": {
        "subjectProperty": {
            "subjectPropertyOccupancyPartialOwnerOccupied": {
                "rentalDetails": {
                    "annualGrossRentalIncome": 23988.0,
                    "managementExpenses": 72.0,
                    "insurance": 84.0,
                    "hydro": 96.0,
                    "maintenanceAndRepairs": 60.0,
                    "interest": 48.0,
                    "generalExpenses": 36.0,
                    "rentalOffset": 40,
                    "rentalCalcType": 2
                }
            },
            "legalAddress": {
                "details": "1",
                "pin": "1",
                "planNumber": "1"
            },
            "condo": {
                "annualCondoFees": 1476.0
            },
            "propertyTax": {
                "annualTaxAmount": 3450.0,
                "taxesPaidBy": 1
            },
            "subjectPropertyAddress": {
                "refkeyAddress": "address-382314"
            },
            "occupancyPurpose": 4,
            "mlsListed": false,
            "mlsNumber": "1",
            "heatingType": 2,
            "parkingType": 5,
            "yearBuilt": 2000,
            "waterSupplyType": 20,
            "waterWasteType": 10,
            "propertySize": 2222,
            "propertySizeUnits": 1,
            "lotSize": 3333,
            "lotSizeUnits": 1,
            "environmentalHazardIndicator": false,
            "annualHeatingAmount": 1056.0,
            "numberOfUnitsTotal": 1,
            "propertyType": 5,
            "propertyDescriptionType": 10,
            "propertyUsageType": 8,
            "propertyZoningType": 99,
            "newPropertyIndicator": false
        },
        "loan": {
            "cmhcMortgageInsurance": {
                "insurancePremium": 34160,
                "blendedAmortization": false,
                "addToLoan": true
            },
            "customProduct": {
                "productName": "VAR Product",
                "rateType": 99,
                "rateCompoundFrequency": 1,
                "productTerm": 84,
                "earlyPayoutOption": 20,
                "locIndicator": false,
                "buydown": 0,
                "postedRate": 1.89
            },
            "underwriter": {
                "userId": "<user_id>",
                "unitId": "<underwriter_unit_id>"
            },
            "classification": [
                {
                    "mortgageClassification": 10
                },
                {
                    "mortgageClassification": 20
                },
                {
                    "mortgageClassification": 30
                }
            ],
            "loanAmount": 854000.0,
            "chargeType": 1,
            "termMonths": "84",
            "amortizationMonths": "300",
            "netRate": 1.89,
            "qualifyingRate": 5,
            "acceleratedPayment": false,
            "maturityDate": "2104-11-03T00:00:00",
            "firstPaymentDate": "2020-12-03T00:00:00",
            "interestAdjustmentDate": "2020-11-03T00:00:00",
            "requestedPayment": 1398.85,
            "paymentAmount": 1398.85,
            "paymentFrequency": 12,
            "repaymentType": 1,
            "lenderCode": <lender_code>,
            "lenderChannel": 10
        },
        "downpaymentList": {
            "downpayment": [
                {
                    "downpaymentSourceType": 99,
                    "description": "test",
                    "amount": 111000.0
                }
            ]
        },
        "firm": {
            "externalPoSFirm": [
                {
                    "posSystemId": 50,
                    "firmId": "<firm_id>"
                }
            ],
            "firmId": "<firm_id>"
        },
        "submittingAgent": {
            "externalPoSUser": [
                {
                    "posSystemId": 40,
                    "firmId": "<firm_id>",
                    "userId": "<user_external_pos_id_1>"
                },
                {
                    "posSystemId": 50,
                    "firmId": "<firm_id>",
                    "userId": "<user_external_pos_id_2>"
                }
            ],
            "userId": "<user_id>",
            "firstName": "<user_firstname>",
            "lastName": "<user_lastname>",
            "emailAddress": "<user_email_address>",
            "mortgageLicenseNumber": "<mortgage_license_number>"
        },
        "originatingAgent": {
            "externalPoSUser": [
                {
                    "posSystemId": 40,
                    "firmId": "<firm_id>",
                    "userId": "<user_external_pos_id_1>"
                },
                {
                    "posSystemId": 50,
                    "firmId": "<firm_id>",
                    "userId": "<user_external_pos_id_2>"
                }
            ],
            "addressCanada": {
                "postalAddressStreetAddress": {
                    "poBoxRRNumber": "",
                    "unitNumber": "123",
                    "streetNumber": "2608",
                    "streetName": "Granville",
                    "streetType": 1240,
                    "streetDirection": 2
                },
                "cityTown": "Vancouver",
                "provinceCode": 10,
                "postalCode": "V6H3V3",
                "countryCode": 1
            },
            "userId": "<user_id>",
            "firstName": "<user_firstname>",
            "lastName": "<user_lastname>",
            "emailAddress": "<user_email_address>",
            "mortgageLicenseNumber": "<mortgage_license_number>"
        },
        "broker": {
            "externalPoSUser": [
                {
                    "posSystemId": 40,
                    "firmId": "<firm_id>",
                    "userId": "<user_external_pos_id_1>"
                },
                {
                    "posSystemId": 50,
                    "firmId": "<firm_id>",
                    "userId": "<user_external_pos_id_2>"
                }
            ],
            "userId": "<user_id>",
            "firstName": "<user_firstname>",
            "lastName": "<user_lastname>",
            "emailAddress": "<user_email_address>",
            "mortgageLicenseNumber": "<mortgage_license_number>"
        },
        "posApplicationNumber": "ABCD-56189",
        "isPreapproval": false,
        "fundingDate": "2020-11-03T00:00:00",
        "loanPurposeType": 3,
        "purchasePriceEstimatedValue": 945000.0,
        "improvements": 20000.0,
        "typeOfBuyer": 20,
        "additionalPurpose": "Purpose",
        "improveDescription": "Improve Description"
    },
    "memo": "\n    Applicants:\n    Participants-  Agent: Jane Smith Assoc/Asst: Jane Smith\n    File touched by: Jane Smith\n    JOHN ANDERSON for ACME as QA\n    CHRISTINE ANDERSON for NN as Manager\n    HENRY RENTALANDERSON for HSVBG as Boss\n    Subj Prop Rental - $1,999.00 add back 40%\n    Assets: (Type - Desc - Amount)\n    Deposit on Purchase - (416)5671234 - $11.33\n    Gift - Test Liability - $25.06\n    Household Goods - 1234567890!@#$%^&*()_P{}:\"?><>? - $33.66\n    Life Insurance - key=\"liability-93639\" fromCreditBureau=\"true\" - $444.00\n    Mutual Fund/Stock/Bonds - dateEnd=\"2013-08-04\" - $555.00\n    Other - 666 - $666.00\n    RRSP - 777 - $777.00\n    Savings - 888 - $888.00\n    Vehicle - 999 - $999.00\n    Properties: (# - Annual Taxes - Heating /mo)\n    1 (#2 - 6 GAGEVIEW CRT Street S, SCARBOROUGH, Ontario, M1V2E4) - $4,000.00 - $55.00\n    2 (#111111 - 22222 Rental Property By-pass SW, London, Ontario, M3E5T5) - $456.00 - $88.00\n    3 (#1 - 131 MARGARET AVE Avenue S, STONEY CREEK, Ontario, L8G3G7) - $2,000.00 - $88.00\n    4 (#11 - 123 Finch Abbey N, Toronto, Ontario, M6T3R5) - $3,000.00 - $77.00\n    Credit Bureaus: (Name - Vendor - Pulled By - Requested)\n    JOHN ANDERSON - Equifax - JSMITH - 2020-06-17 07:19 PM UTC\n    CHRISTINE ANDERSON - Equifax - JSMITH - 2020-06-17 07:19 PM UTC\n    HENRY RENTALANDERSON - Equifax - JSMITH - 2020-06-17 07:20 PM UTC\n\n    Selected Product: VAR Product\n  ",
    "unitId": "<firm_id>",
    "posSystem": "<pos_system_id>"
}

Deal 3 contains:

Deal 4

Request Body

{
    "commonData": {
        "assetList": {
            "assetRealEstate": [
                {
                    "originalPrice": 345000.0,
                    "originalDate": "2007-05-01T00:00:00",
                    "key": "property-34400",
                    "value": 345000.0
                },
                {
                    "originalPrice": 300000.0,
                    "originalDate": "2002-01-28T00:00:00",
                    "key": "property-34402",
                    "value": 300000.0
                }
            ],
            "assetOther": [
                {
                    "assetType": 71,
                    "description": "111 description",
                    "key": "asset-82911",
                    "value": 111.0
                },
                {
                    "assetType": 72,
                    "description": "222  description",
                    "key": "asset-82912",
                    "value": 222.0
                },
                {
                    "assetType": 73,
                    "description": "333  description",
                    "key": "asset-82913",
                    "value": 333.0
                },
                {
                    "assetType": 20,
                    "description": "444  description",
                    "key": "asset-82914",
                    "value": 444.0
                },
                {
                    "assetType": 70,
                    "description": "555  description",
                    "key": "asset-82915",
                    "value": 555.0
                },
                {
                    "assetType": 99,
                    "description": "666  description",
                    "key": "asset-82916",
                    "value": 666.0
                },
                {
                    "assetType": 30,
                    "description": "777  description",
                    "key": "asset-82917",
                    "value": 777.0
                },
                {
                    "assetType": 10,
                    "description": "888  description",
                    "key": "asset-82918",
                    "value": 888.0
                },
                {
                    "assetType": 40,
                    "description": "999  description",
                    "key": "asset-82919",
                    "value": 999.0
                }
            ]
        },
        "liabilityList": {
            "liabilityRealEstate": [
                {
                    "accountNumber": "1111",
                    "monthlyRepayment": 55.0,
                    "originalLoanAmount": 200000.0,
                    "outstandingBalance": 50000.0,
                    "closingDate": "2007-05-01T00:00:00",
                    "lenderName": "Gringotts",
                    "chargeType": 1,
                    "repaymentType": 2,
                    "redemptionStatus": 4,
                    "maturityDate": "2020-08-04T00:00:00",
                    "netRate": 3,
                    "rateType": 2,
                    "mortgageInsurer": 10,
                    "insuranceCertificateNumber": "2222",
                    "key": "property-34400-1",
                    "fromCreditBureau": false
                }
            ],
            "liabilityOther": [
                {
                    "dateEnd": "2020-07-31T00:00:00",
                    "repaymentIndicator": true,
                    "payoffType": 2,
                    "monthlyRepayment": 11.0,
                    "creditLimit": 11111.0,
                    "outstandingBalance": 111.0,
                    "lenderName": "Gringotts",
                    "liabilityType": 4,
                    "key": "liability-112331",
                    "fromCreditBureau": false
                },
                {
                    "repaymentIndicator": true,
                    "payoffType": 1,
                    "monthlyRepayment": 22.0,
                    "creditLimit": 22222.0,
                    "outstandingBalance": 222.0,
                    "lenderName": "Tyrell Corp.",
                    "liabilityType": 3,
                    "additionalHolders": true,
                    "additionalHoldersDetails": "additional details",
                    "key": "liability-112332",
                    "fromCreditBureau": false
                },
                {
                    "repaymentIndicator": true,
                    "payoffType": 2,
                    "monthlyRepayment": 33.0,
                    "creditLimit": 33333.0,
                    "outstandingBalance": 333.0,
                    "lenderName": "Umbrella Corp.",
                    "liabilityType": 6,
                    "key": "liability-112333",
                    "fromCreditBureau": false
                },
                {
                    "dateEnd": "2020-12-31T00:00:00",
                    "repaymentIndicator": false,
                    "monthlyRepayment": 79.5,
                    "creditLimit": 5500.0,
                    "outstandingBalance": 2650.0,
                    "lenderName": "Wayne Enterprises",
                    "liabilityType": 6,
                    "additionalHolders": true,
                    "additionalHoldersDetails": "additional details",
                    "key": "liability-112337",
                    "fromCreditBureau": true
                },
                {
                    "repaymentIndicator": true,
                    "payoffType": 1,
                    "monthlyRepayment": 69.75,
                    "creditLimit": 4650.0,
                    "outstandingBalance": 2325.0,
                    "lenderName": "Stark Industries",
                    "liabilityType": 6,
                    "additionalHolders": true,
                    "additionalHoldersDetails": "additional details",
                    "key": "liability-112338",
                    "fromCreditBureau": true
                },
                {
                    "repaymentIndicator": false,
                    "monthlyRepayment": 22.5,
                    "creditLimit": 1500.0,
                    "outstandingBalance": 750.0,
                    "lenderName": "Frobozz",
                    "liabilityType": 6,
                    "key": "liability-112339",
                    "fromCreditBureau": true
                },
                {
                    "dateEnd": "2020-08-05T00:00:00",
                    "repaymentIndicator": true,
                    "payoffType": 1,
                    "monthlyRepayment": 119.4,
                    "creditLimit": 8000.0,
                    "outstandingBalance": 3980.0,
                    "lenderName": "Northwind Traders",
                    "liabilityType": 6,
                    "additionalHolders": true,
                    "additionalHoldersDetails": "additional details",
                    "key": "liability-112334",
                    "fromCreditBureau": true
                },
                {
                    "repaymentIndicator": false,
                    "monthlyRepayment": 43.95,
                    "creditLimit": 3000.0,
                    "outstandingBalance": 1465.0,
                    "lenderName": "Contoso",
                    "liabilityType": 6,
                    "key": "liability-112335",
                    "fromCreditBureau": true
                },
                {
                    "repaymentIndicator": false,
                    "monthlyRepayment": 96.0,
                    "creditLimit": 6500.0,
                    "outstandingBalance": 3200.0,
                    "lenderName": "World Wide Importers",
                    "liabilityType": 6,
                    "additionalHolders": true,
                    "additionalHoldersDetails": "additional details",
                    "key": "liability-112336",
                    "fromCreditBureau": true
                }
            ]
        },
        "addressList": {
            "applicationAddressCanada": [
                {
                    "key": "address-382404",
                    "postalAddressStreetAddress": {
                        "poBoxRRNumber": "",
                        "unitNumber": "700",
                        "streetNumber": "2627",
                        "streetName": "26th St NE",
                        "streetType": 490,
                        "streetDirection": 3
                    },
                    "cityTown": "Calgary",
                    "provinceCode": 20,
                    "postalCode": "T1Y1A4",
                    "countryCode": 1
                },
                {
                    "key": "address-382405",
                    "postalAddressStreetAddress": {
                        "poBoxRRNumber": "",
                        "unitNumber": "11",
                        "streetNumber": "222",
                        "streetName": "Bay",
                        "streetType": 660,
                        "streetDirection": 2
                    },
                    "cityTown": "North York",
                    "provinceCode": 50,
                    "postalCode": "M6R3T5",
                    "countryCode": 1
                },
                {
                    "key": "address-382406",
                    "postalAddressStreetAddress": {
                        "poBoxRRNumber": "",
                        "unitNumber": "22",
                        "streetNumber": "3333",
                        "streetName": "Mailing New address",
                        "streetType": 370,
                        "streetDirection": 7
                    },
                    "cityTown": "TORONTO Mailing",
                    "provinceCode": 50,
                    "postalCode": "M1M1M1",
                    "countryCode": 1
                },
                {
                    "key": "address-382407",
                    "postalAddressStreetAddress": {
                        "poBoxRRNumber": "",
                        "unitNumber": "700",
                        "streetNumber": "33",
                        "streetName": "26th St NE",
                        "streetType": 490,
                        "streetDirection": 5
                    },
                    "cityTown": "Calgary",
                    "provinceCode": 20,
                    "postalCode": "T1Y1A4",
                    "countryCode": 1
                },
                {
                    "key": "address-382413",
                    "postalAddressStreetAddress": {
                        "poBoxRRNumber": "",
                        "unitNumber": "22",
                        "streetNumber": "33",
                        "streetName": "Owner",
                        "streetType": 1140,
                        "streetDirection": 5
                    },
                    "cityTown": "North York",
                    "provinceCode": 50,
                    "postalCode": "M7Y3R5",
                    "countryCode": 1
                },
                {
                    "key": "address-382403",
                    "postalAddressStreetAddress": {
                        "poBoxRRNumber": "",
                        "unitNumber": "111A",
                        "streetNumber": "222",
                        "streetName": "RENTAL PROPERTY",
                        "streetType": 670,
                        "streetDirection": 3
                    },
                    "cityTown": "Toronto",
                    "provinceCode": 50,
                    "postalCode": "M6T3E4",
                    "countryCode": 1
                }
            ]
        },
        "creditBureauList": {
            "creditBureau": [
                {
                    "creditReportEquifax": {
                        "dataFormat": "0H",
                        "reportDate": "2020-07-13T00:00:00",
                        "creditScore": 727,
                        "value": "..."
                    },
                    "humanReadableReport": {
                        "type": "Text",
                        "value": "..."
                    },
                    "key": "bureau-25207",
                    "provider": "Equifax"
                },
                {
                    "creditReportEquifax": {
                        "dataFormat": "0H",
                        "reportDate": "2020-07-13T00:00:00",
                        "creditScore": 794,
                        "value": "..."
                    },
                    "humanReadableReport": {
                        "type": "Text",
                        "value": "..."
                    },
                    "key": "bureau-25208",
                    "provider": "Equifax"
                }
            ]
        }
    },
    "customerData": {
        "customerList": {
            "customerPrimaryBorrower": {
                "dateBirth": "1965-07-01T00:00:00",
                "honorific": 1,
                "lastName": "Zorin",
                "firstName": "Richard",
                "middleName": "WW",
                "suffix": "2",
                "customerTelephoneNumberList": [
                    {
                        "telephoneNumber": {
                            "countryCode": "1",
                            "areaCode": "416",
                            "phoneNumber": "5672345"
                        },
                        "usage": 1,
                        "preferred": false
                    },
                    {
                        "telephoneNumber": {
                            "countryCode": "1",
                            "areaCode": "416",
                            "phoneNumber": "5671234",
                            "phoneExtension": "33333"
                        },
                        "usage": 2,
                        "preferred": false
                    },
                    {
                        "telephoneNumber": {
                            "countryCode": "1",
                            "areaCode": "416",
                            "phoneNumber": "7891234"
                        },
                        "usage": 3,
                        "preferred": true
                    }
                ],
                "employmentList": {
                    "employment": [
                        {
                            "addressCanada": {
                                "postalAddressStreetAddress": {
                                    "poBoxRRNumber": "",
                                    "unitNumber": "234",
                                    "streetNumber": "34543",
                                    "streetName": "Main",
                                    "streetType": 940,
                                    "streetDirection": 3
                                },
                                "cityTown": "North DDDDD",
                                "provinceCode": 50,
                                "postalCode": "M7Y5T6",
                                "countryCode": 1
                            },
                            "earnedIncomeList": {
                                "earnedIncome": [
                                    {
                                        "earnedIncomeType": 9,
                                        "paymentFrequency": 1,
                                        "earnedIncomeAmount": 150000.0
                                    }
                                ]
                            },
                            "contactTelephoneNumber": {
                                "telephoneNumber": {
                                    "countryCode": "1",
                                    "areaCode": "416",
                                    "phoneNumber": "5671234",
                                    "phoneExtension": "33333"
                                },
                                "usage": 10
                            },
                            "employmentType": 1,
                            "employmentStatus": 10,
                            "dateStart": "2014-01-01T00:00:00",
                            "industryType": 8,
                            "dateStartedInIndustry": "2013-01-13T00:00:00",
                            "occupationType": 5,
                            "jobTitle": "BOSS",
                            "companyName": "Bank CANADA"
                        },
                        {
                            "addressCanada": {
                                "postalAddressStreetAddress": {
                                    "poBoxRRNumber": "",
                                    "unitNumber": "",
                                    "streetNumber": "45654",
                                    "streetName": "LONGUEUIL RRR",
                                    "streetType": 790,
                                    "streetDirection": 7
                                },
                                "cityTown": "Pleasant",
                                "provinceCode": 60,
                                "postalCode": "M7Y5T6",
                                "countryCode": 1
                            },
                            "earnedIncomeList": {
                                "earnedIncome": [
                                    {
                                        "earnedIncomeType": 99,
                                        "paymentFrequency": 12,
                                        "earnedIncomeAmount": 2345.0
                                    }
                                ]
                            },
                            "contactTelephoneNumber": {
                                "telephoneNumber": {
                                    "countryCode": "1",
                                    "areaCode": "416",
                                    "phoneNumber": "5672342",
                                    "phoneExtension": "43563"
                                },
                                "usage": 10
                            },
                            "employmentType": 2,
                            "employmentStatus": 10,
                            "dateStart": "2007-07-01T00:00:00",
                            "dateEnd": "2014-01-01T00:00:00",
                            "industryType": 10,
                            "dateStartedInIndustry": "2005-04-13T00:00:00",
                            "occupationType": 2,
                            "jobTitle": "Manager",
                            "companyName": "ABC BANK"
                        }
                    ]
                },
                "unearnedIncomeList": {
                    "unearnedIncome": [
                        {
                            "unearnedIncomeAmount": 2222.0,
                            "unearnedIncomeType": 99,
                            "paymentFrequency": 1,
                            "unearnedIncomeDetails": "222"
                        }
                    ]
                },
                "customerRelationShip": {},
                "key": "borrower-97985",
                "correspondenceLanguage": 1,
                "emailAddress1": "<user_email_address>",
                "maritalStatus": 6,
                "numberOfDependents": 0,
                "sex": 1,
                "residentType": 20
            },
            "customerGuarantor": [
                {
                    "dateBirth": "1965-08-01T00:00:00",
                    "honorific": 1,
                    "lastName": "Hussey",
                    "firstName": "Sina",
                    "suffix": "1",
                    "customerTelephoneNumberList": [
                        {
                            "telephoneNumber": {
                                "countryCode": "1",
                                "areaCode": "416",
                                "phoneNumber": "5671234"
                            },
                            "usage": 1,
                            "preferred": false
                        },
                        {
                            "telephoneNumber": {
                                "countryCode": "1",
                                "areaCode": "416",
                                "phoneNumber": "5671234",
                                "phoneExtension": "33333"
                            },
                            "usage": 2,
                            "preferred": true
                        },
                        {
                            "telephoneNumber": {
                                "countryCode": "1",
                                "areaCode": "416",
                                "phoneNumber": "7891234"
                            },
                            "usage": 3,
                            "preferred": false
                        }
                    ],
                    "employmentList": {
                        "employment": [
                            {
                                "addressCanada": {
                                    "postalAddressStreetAddress": {
                                        "poBoxRRNumber": "",
                                        "unitNumber": "2342",
                                        "streetNumber": "234234",
                                        "streetName": "Leslie",
                                        "streetType": 970,
                                        "streetDirection": 7
                                    },
                                    "cityTown": "King",
                                    "provinceCode": 50,
                                    "postalCode": "M7Y4R5",
                                    "countryCode": 1
                                },
                                "earnedIncomeList": {
                                    "earnedIncome": [
                                        {
                                            "earnedIncomeType": 4,
                                            "paymentFrequency": 1,
                                            "earnedIncomeAmount": 100000.0
                                        }
                                    ]
                                },
                                "contactTelephoneNumber": {
                                    "telephoneNumber": {
                                        "countryCode": "1",
                                        "areaCode": "416",
                                        "phoneNumber": "5671234",
                                        "phoneExtension": "33333"
                                    },
                                    "usage": 10
                                },
                                "employmentType": 2,
                                "employmentStatus": 10,
                                "dateStart": "2014-01-01T00:00:00",
                                "industryType": 5,
                                "dateStartedInIndustry": "2012-12-13T00:00:00",
                                "occupationType": 5,
                                "jobTitle": "Manager",
                                "companyName": "TD"
                            }
                        ]
                    },
                    "customerRelationShip": {
                        "relationShipToOwnerType": 3
                    },
                    "key": "borrower-97986",
                    "correspondenceLanguage": 1,
                    "emailAddress1": "MELISSA@mail.com",
                    "maritalStatus": 6,
                    "numberOfDependents": 0,
                    "sex": 1,
                    "residentType": 10
                }
            ]
        },
        "customerAddressList": [
            {
                "customerCurrentAddressTimeAt": [
                    {
                        "refkeyCustomer": "borrower-97985",
                        "fromDate": "2017-12-01T00:00:00"
                    }
                ],
                "customerLiabilityRealEstate": [
                    {
                        "customerReference": {
                            "refkeyCustomer": "borrower-97985"
                        },
                        "refkeyLiability": "property-34400-1"
                    }
                ],
                "addressOccupancyPartialOwnerOccupied": {
                    "rentalDetails": {
                        "annualGrossRentalIncome": 12000.0,
                        "managementExpenses": 36.0,
                        "insurance": 48.0,
                        "hydro": 48.0,
                        "maintenanceAndRepairs": 24.0,
                        "interest": 36.0,
                        "generalExpenses": 60.0
                    },
                    "refkeyAsset": "property-34400"
                },
                "currentPropertyIntendedActionType": 2,
                "annualHeatingAmount": 1056.0,
                "annualTaxAmount": 2000.0,
                "annualCondoFees": 3996.0,
                "customerReference": [
                    {
                        "refkeyCustomer": "borrower-97985"
                    }
                ],
                "refkeyAddress": "address-382404",
                "type": "CustomerAddressPrimaryResidence"
            },
            {
                "customerPreviousAddressTimeAt": [
                    {
                        "refkeyCustomer": "borrower-97985",
                        "fromDate": "2012-07-01T00:00:00",
                        "toDate": "2017-12-01T00:00:00"
                    }
                ],
                "previousAddressOccupancyTenant": {
                    "tenancyType": 10
                },
                "customerReference": [
                    {
                        "refkeyCustomer": "borrower-97985"
                    }
                ],
                "refkeyAddress": "address-382405",
                "type": "CustomerAddressPreviousResidence"
            },
            {
                "addressOccupancyNone": {},
                "customerReference": [
                    {
                        "refkeyCustomer": "borrower-97985"
                    }
                ],
                "refkeyAddress": "address-382406",
                "type": "CustomerAddressCorrespondence"
            },
            {
                "customerCurrentAddressTimeAt": [
                    {
                        "refkeyCustomer": "borrower-97986",
                        "fromDate": "2012-12-01T00:00:00"
                    }
                ],
                "addressOccupancyTenant": {
                    "monthlyRentPaid": 0,
                    "tenancyType": 40
                },
                "addressOccupancyTenant": {
                    "monthlyRentPaid": 0,
                    "tenancyType": 40
                },
                "currentPropertyIntendedActionType": 2,
                "customerReference": [
                    {
                        "refkeyCustomer": "borrower-97986"
                    }
                ],
                "refkeyAddress": "address-382407",
                "type": "CustomerAddressPrimaryResidence"
            },
            {
                "customerCurrentAddressTimeAt": [
                    {
                        "refkeyCustomer": "borrower-97985",
                        "fromDate": "2002-01-28T00:00:00"
                    }
                ],
                "addressOccupancyOwnerOccupied": {
                    "refkeyAsset": "property-34402"
                },
                "currentPropertyIntendedActionType": 2,
                "annualHeatingAmount": 1188.0,
                "annualTaxAmount": 3000.0,
                "annualCondoFees": 2664.0,
                "customerReference": [
                    {
                        "refkeyCustomer": "borrower-97985"
                    }
                ],
                "refkeyAddress": "address-382413",
                "type": "CustomerAddressSecondaryResidence"
            }
        ],
        "customerAssetList": [
            {
                "customerReference": {
                    "refkeyCustomer": "borrower-97985"
                },
                "refkeyAsset": "asset-82911"
            },
            {
                "customerReference": {
                    "refkeyCustomer": "borrower-97985"
                },
                "refkeyAsset": "asset-82912"
            },
            {
                "customerReference": {
                    "refkeyCustomer": "borrower-97985"
                },
                "refkeyAsset": "asset-82913"
            },
            {
                "customerReference": {
                    "refkeyCustomer": "borrower-97985"
                },
                "refkeyAsset": "asset-82914"
            },
            {
                "customerReference": {
                    "refkeyCustomer": "borrower-97985"
                },
                "refkeyAsset": "asset-82915"
            },
            {
                "customerReference": {
                    "refkeyCustomer": "borrower-97985"
                },
                "refkeyAsset": "asset-82916"
            },
            {
                "customerReference": {
                    "refkeyCustomer": "borrower-97985"
                },
                "refkeyAsset": "asset-82917"
            },
            {
                "customerReference": {
                    "refkeyCustomer": "borrower-97985"
                },
                "refkeyAsset": "asset-82918"
            },
            {
                "customerReference": {
                    "refkeyCustomer": "borrower-97985"
                },
                "refkeyAsset": "asset-82919"
            }
        ],
        "customerLiabilityList": [
            {
                "customerReference": {
                    "refkeyCustomer": "borrower-97985"
                },
                "refkeyLiability": "liability-112331"
            },
            {
                "customerReference": {
                    "refkeyCustomer": "borrower-97985"
                },
                "refkeyLiability": "liability-112332"
            },
            {
                "customerReference": {
                    "refkeyCustomer": "borrower-97985"
                },
                "refkeyLiability": "liability-112333"
            },
            {
                "customerReference": {
                    "refkeyCustomer": "borrower-97985"
                },
                "refkeyLiability": "liability-112337"
            },
            {
                "customerReference": {
                    "refkeyCustomer": "borrower-97985"
                },
                "refkeyLiability": "liability-112338"
            },
            {
                "customerReference": {
                    "refkeyCustomer": "borrower-97985"
                },
                "refkeyLiability": "liability-112339"
            },
            {
                "customerReference": {
                    "refkeyCustomer": "borrower-97986"
                },
                "refkeyLiability": "liability-112334"
            },
            {
                "customerReference": {
                    "refkeyCustomer": "borrower-97986"
                },
                "refkeyLiability": "liability-112335"
            },
            {
                "customerReference": {
                    "refkeyCustomer": "borrower-97986"
                },
                "refkeyLiability": "liability-112336"
            }
        ],
        "customerCreditBureauList": [
            {
                "customerReference": [
                    {
                        "refkeyCustomer": "borrower-97985"
                    }
                ],
                "refkeyCreditBureau": "bureau-25207"
            },
            {
                "customerReference": [
                    {
                        "refkeyCustomer": "borrower-97986"
                    }
                ],
                "refkeyCreditBureau": "bureau-25208"
            }
        ]
    },
    "mortgageApplication": {
        "subjectProperty": {
            "subjectPropertyOccupancyRental": {
                "rentalDetails": {
                    "annualGrossRentalIncome": 24000.0,
                    "managementExpenses": 96.0,
                    "insurance": 84.0,
                    "hydro": 72.0,
                    "maintenanceAndRepairs": 60.0,
                    "interest": 72.0,
                    "rentalOffset": 50,
                    "rentalCalcType": 2
                }
            },
            "legalAddress": {
                "details": "1546735765",
                "pin": "13454645654",
                "planNumber": "12456456456456245"
            },
            "freehold": {},
            "propertyTax": {
                "annualTaxAmount": 4000.0,
                "taxesPaidBy": 1
            },
            "subjectPropertyAddress": {
                "refkeyAddress": "address-382403"
            },
            "occupancyPurpose": 4,
            "mlsListed": false,
            "mlsNumber": "1",
            "heatingType": 1,
            "parkingType": 1,
            "yearBuilt": 2000,
            "waterSupplyType": 20,
            "waterWasteType": 30,
            "propertySize": 2222,
            "propertySizeUnits": 1,
            "lotSize": 3333,
            "lotSizeUnits": 1,
            "environmentalHazardIndicator": false,
            "annualHeatingAmount": 1056.0,
            "numberOfUnitsTotal": 1,
            "propertyType": 1,
            "propertyDescriptionType": 3,
            "propertyUsageType": 7,
            "propertyZoningType": 5,
            "newPropertyIndicator": false
        },
        "loan": {
            "customProduct": {
                "productName": "VAR Product",
                "rateType": 99,
                "rateCompoundFrequency": 1,
                "productTerm": 89,
                "earlyPayoutOption": 20,
                "locIndicator": false,
                "buydown": 0,
                "postedRate": 1.89
            },
            "underwriter": {
                "userId": "<user_id>",
                "unitId": "<underwriter_unit_id>"
            },
            "loanAmount": 1179000.0,
            "chargeType": 1,
            "termMonths": "89",
            "amortizationMonths": "305",
            "netRate": 1.89,
            "qualifyingRate": 4,
            "acceleratedPayment": true,
            "maturityDate": "2104-11-05T00:00:00",
            "firstPaymentDate": "2020-11-19T00:00:00",
            "interestAdjustmentDate": "2020-11-05T00:00:00",
            "requestedPayment": 488.75,
            "paymentAmount": 4925.14,
            "paymentFrequency": 26,
            "repaymentType": 2,
            "lenderCode": <lender_code>,
            "lenderChannel": 10
        },
        "downpaymentList": {
            "downpayment": [
                {
                    "downpaymentSourceType": 99,
                    "description": "Second Financing",
                    "amount": 66000.0
                },
                {
                    "downpaymentSourceType": 4,
                    "description": "gift",
                    "amount": 50000.0
                },
                {
                    "downpaymentSourceType": 8,
                    "description": "grant",
                    "amount": 50000.0
                }
            ]
        },
        "firm": {
            "externalPoSFirm": [
                {
                    "posSystemId": 50,
                    "firmId": "<firm_id>"
                }
            ],
            "firmId": "<firm_id>"
        },
        "submittingAgent": {
            "externalPoSUser": [
                {
                    "posSystemId": 40,
                    "firmId": "<firm_id>",
                    "userId": "<user_external_pos_id_1>"
                },
                {
                    "posSystemId": 50,
                    "firmId": "<firm_id>",
                    "userId": "<user_external_pos_id_2>"
                }
            ],
            "userId": "<user_id>",
            "firstName": "<user_firstname>",
            "lastName": "<user_lastname>",
            "emailAddress": "<user_email_address>",
            "mortgageLicenseNumber": "<mortgage_license_number>"
        },
        "originatingAgent": {
            "externalPoSUser": [
                {
                    "posSystemId": 40,
                    "firmId": "<firm_id>",
                    "userId": "<user_external_pos_id_1>"
                },
                {
                    "posSystemId": 50,
                    "firmId": "<firm_id>",
                    "userId": "<user_external_pos_id_2>"
                }
            ],
            "addressCanada": {
                "postalAddressStreetAddress": {
                    "poBoxRRNumber": "",
                    "unitNumber": "123",
                    "streetNumber": "2608",
                    "streetName": "Granville",
                    "streetType": 1240,
                    "streetDirection": 2
                },
                "cityTown": "Vancouver",
                "provinceCode": 10,
                "postalCode": "V6H3V3",
                "countryCode": 1
            },
            "userId": "<user_id>",
            "firstName": "<user_firstname>",
            "lastName": "<user_lastname>",
            "emailAddress": "<user_email_address>",
            "mortgageLicenseNumber": "<mortgage_license_number>"
        },
        "broker": {
            "externalPoSUser": [
                {
                    "posSystemId": 40,
                    "firmId": "<firm_id>",
                    "userId": "<user_external_pos_id_1>"
                },
                {
                    "posSystemId": 50,
                    "firmId": "<firm_id>",
                    "userId": "<user_external_pos_id_2>"
                }
            ],
            "userId": "<user_id>",
            "firstName": "<user_firstname>",
            "lastName": "<user_lastname>",
            "emailAddress": "<user_email_address>",
            "mortgageLicenseNumber": "<mortgage_license_number>"
        },
        "posApplicationNumber": "ABCD-56197",
        "isPreapproval": false,
        "fundingDate": "2020-11-05T00:00:00",
        "loanPurposeType": 3,
        "purchasePriceEstimatedValue": 1345000.0,
        "typeOfBuyer": 20
    },
    "memo": "\n    Applicants:\n    Participants-  Agent: Jane Smith Assoc/Asst: Jane Smith\n    File touched by: Jane Smith\n    Richard Hussey for ACME as ROC\n    Sina Hussey for NN as Manager\n    Subj Prop Rental - $2,000.00 add back 50%\n    Assets: (Type - Desc - Amount)\n    Deposit on Purchase - 111 sdfhstsryntysnyumtyumt - $111.00\n    Gift - 222 xfghftyrtyndyu uiimyfu - $222.00\n    Household Goods - 333 xfgbtyrtyn d fh y ydun - $333.00\n    Life Insurance - 444 df ty yuyunytum fyju - $444.00\n    Mutual Fund/Stock/Bonds - 555 xdfg tyh bty ru yumui,ui - $555.00\n    Other - 666 fdg ht yu ghj ui - $666.00\n    RRSP - 777 cv ftyrtynyrmrum - $777.00\n    Savings - 888 cgh btynrty - $888.00\n    Vehicle - 999 fgh bf f dfyu - $999.00\n    Properties: (# - Annual Taxes - Heating /mo)\n    1 (#700 - 2627 26th St NE Street NE, Calgary, Alberta, T1Y1A4) - $2,000.00 - $88.00\n    2 (#22 - 33 Owner Path S, North York, Ontario, M7Y3R5) - $3,000.00 - $99.00\n    Credit Bureaus: (Name - Vendor - Pulled By - Requested)\n    Richard Hussey - Equifax - JSMITH - 2020-07-13 02:27 PM UTC\n    Sina Hussey - Equifax - JSMITH - 2020-07-13 02:27 PM UTC\n\n    Selected Product: VAR Product\n    dzfgvtyrty21345326457657n @!%$#^%$R*&TO*BYILUB l?\":{O_)*(*^%#Fvjhcdfsufgleiurwt\n  ",
    "unitId": "<firm_id>",
    "posSystem": "<pos_system_id>"
}

Deal 4 contains:

Deal 5

Request Body

{
    "commonData": {
        "assetList": {
            "assetRealEstate": [
                {
                    "originalPrice": 345000.0,
                    "originalDate": "2007-05-01T00:00:00",
                    "key": "property-34400",
                    "value": 345000.0
                },
                {
                    "originalPrice": 300000.0,
                    "originalDate": "2002-01-28T00:00:00",
                    "key": "property-34402",
                    "value": 300000.0
                }
            ],
            "assetOther": [
                {
                    "assetType": 71,
                    "description": "111 description",
                    "key": "asset-82911",
                    "value": 111.0
                },
                {
                    "assetType": 72,
                    "description": "222  description",
                    "key": "asset-82912",
                    "value": 222.0
                },
                {
                    "assetType": 73,
                    "description": "333  description",
                    "key": "asset-82913",
                    "value": 333.0
                },
                {
                    "assetType": 20,
                    "description": "444  description",
                    "key": "asset-82914",
                    "value": 444.0
                },
                {
                    "assetType": 70,
                    "description": "555  description",
                    "key": "asset-82915",
                    "value": 555.0
                },
                {
                    "assetType": 99,
                    "description": "666  description",
                    "key": "asset-82916",
                    "value": 666.0
                },
                {
                    "assetType": 30,
                    "description": "777  description",
                    "key": "asset-82917",
                    "value": 777.0
                },
                {
                    "assetType": 10,
                    "description": "888  description",
                    "key": "asset-82918",
                    "value": 888.0
                },
                {
                    "assetType": 40,
                    "description": "999  description",
                    "key": "asset-82919",
                    "value": 999.0
                }
            ]
        },
        "liabilityList": {
            "liabilityRealEstate": [
                {
                    "accountNumber": "1111",
                    "monthlyRepayment": 55.0,
                    "originalLoanAmount": 200000.0,
                    "outstandingBalance": 50000.0,
                    "closingDate": "2007-05-01T00:00:00",
                    "lenderName": "Gringotts",
                    "chargeType": 1,
                    "repaymentType": 2,
                    "redemptionStatus": 4,
                    "maturityDate": "2020-08-04T00:00:00",
                    "netRate": 3,
                    "rateType": 2,
                    "mortgageInsurer": 10,
                    "insuranceCertificateNumber": "2222",
                    "key": "property-34400-1",
                    "fromCreditBureau": false
                }
            ],
            "liabilityOther": [
                {
                    "dateEnd": "2020-07-31T00:00:00",
                    "repaymentIndicator": true,
                    "payoffType": 2,
                    "monthlyRepayment": 11.0,
                    "creditLimit": 11111.0,
                    "outstandingBalance": 111.0,
                    "lenderName": "Gringotts",
                    "liabilityType": 4,
                    "key": "liability-112331",
                    "fromCreditBureau": false
                },
                {
                    "repaymentIndicator": true,
                    "payoffType": 1,
                    "monthlyRepayment": 22.0,
                    "creditLimit": 22222.0,
                    "outstandingBalance": 222.0,
                    "lenderName": "Tyrell Corp.",
                    "liabilityType": 3,
                    "additionalHolders": true,
                    "additionalHoldersDetails": "additional details",
                    "key": "liability-112332",
                    "fromCreditBureau": false
                },
                {
                    "repaymentIndicator": true,
                    "payoffType": 2,
                    "monthlyRepayment": 33.0,
                    "creditLimit": 33333.0,
                    "outstandingBalance": 333.0,
                    "lenderName": "Umbrella Corp.",
                    "liabilityType": 6,
                    "key": "liability-112333",
                    "fromCreditBureau": false
                },
                {
                    "dateEnd": "2020-12-31T00:00:00",
                    "repaymentIndicator": false,
                    "monthlyRepayment": 79.5,
                    "creditLimit": 5500.0,
                    "outstandingBalance": 2650.0,
                    "lenderName": "Wayne Enterprises",
                    "liabilityType": 6,
                    "additionalHolders": true,
                    "additionalHoldersDetails": "additional details",
                    "key": "liability-112337",
                    "fromCreditBureau": true
                },
                {
                    "repaymentIndicator": true,
                    "payoffType": 1,
                    "monthlyRepayment": 69.75,
                    "creditLimit": 4650.0,
                    "outstandingBalance": 2325.0,
                    "lenderName": "Stark Industries",
                    "liabilityType": 6,
                    "additionalHolders": true,
                    "additionalHoldersDetails": "additional details",
                    "key": "liability-112338",
                    "fromCreditBureau": true
                },
                {
                    "repaymentIndicator": false,
                    "monthlyRepayment": 22.5,
                    "creditLimit": 1500.0,
                    "outstandingBalance": 750.0,
                    "lenderName": "Frobozz",
                    "liabilityType": 6,
                    "key": "liability-112339",
                    "fromCreditBureau": true
                },
                {
                    "dateEnd": "2020-08-05T00:00:00",
                    "repaymentIndicator": true,
                    "payoffType": 1,
                    "monthlyRepayment": 119.4,
                    "creditLimit": 8000.0,
                    "outstandingBalance": 3980.0,
                    "lenderName": "Northwind Traders",
                    "liabilityType": 6,
                    "additionalHolders": true,
                    "additionalHoldersDetails": "additional details",
                    "key": "liability-112334",
                    "fromCreditBureau": true
                },
                {
                    "repaymentIndicator": false,
                    "monthlyRepayment": 43.95,
                    "creditLimit": 3000.0,
                    "outstandingBalance": 1465.0,
                    "lenderName": "Contoso",
                    "liabilityType": 6,
                    "key": "liability-112335",
                    "fromCreditBureau": true
                },
                {
                    "repaymentIndicator": false,
                    "monthlyRepayment": 96.0,
                    "creditLimit": 6500.0,
                    "outstandingBalance": 3200.0,
                    "lenderName": "World Wide Importers",
                    "liabilityType": 6,
                    "additionalHolders": true,
                    "additionalHoldersDetails": "additional details",
                    "key": "liability-112336",
                    "fromCreditBureau": true
                }
            ]
        },
        "addressList": {
            "applicationAddressCanada": [
                {
                    "key": "address-382404",
                    "postalAddressStreetAddress": {
                        "poBoxRRNumber": "",
                        "unitNumber": "700",
                        "streetNumber": "2627",
                        "streetName": "26th St NE",
                        "streetType": 490,
                        "streetDirection": 3
                    },
                    "cityTown": "Calgary",
                    "provinceCode": 20,
                    "postalCode": "T1Y1A4",
                    "countryCode": 1
                },
                {
                    "key": "address-382405",
                    "postalAddressStreetAddress": {
                        "poBoxRRNumber": "",
                        "unitNumber": "11",
                        "streetNumber": "222",
                        "streetName": "Bay",
                        "streetType": 660,
                        "streetDirection": 2
                    },
                    "cityTown": "North York",
                    "provinceCode": 50,
                    "postalCode": "M6R3T5",
                    "countryCode": 1
                },
                {
                    "key": "address-382406",
                    "postalAddressStreetAddress": {
                        "poBoxRRNumber": "",
                        "unitNumber": "22",
                        "streetNumber": "3333",
                        "streetName": "Mailing New address",
                        "streetType": 370,
                        "streetDirection": 7
                    },
                    "cityTown": "TORONTO Mailing",
                    "provinceCode": 50,
                    "postalCode": "M1M1M1",
                    "countryCode": 1
                },
                {
                    "key": "address-382407",
                    "postalAddressStreetAddress": {
                        "poBoxRRNumber": "",
                        "unitNumber": "700",
                        "streetNumber": "33",
                        "streetName": "26th St NE",
                        "streetType": 490,
                        "streetDirection": 5
                    },
                    "cityTown": "Calgary",
                    "provinceCode": 20,
                    "postalCode": "T1Y1A4",
                    "countryCode": 1
                },
                {
                    "key": "address-382413",
                    "postalAddressStreetAddress": {
                        "poBoxRRNumber": "",
                        "unitNumber": "22",
                        "streetNumber": "33",
                        "streetName": "Owner",
                        "streetType": 1140,
                        "streetDirection": 5
                    },
                    "cityTown": "North York",
                    "provinceCode": 50,
                    "postalCode": "M7Y3R5",
                    "countryCode": 1
                },
                {
                    "key": "address-382403",
                    "postalAddressStreetAddress": {
                        "poBoxRRNumber": "",
                        "unitNumber": "111A",
                        "streetNumber": "222",
                        "streetName": "RENTAL PROPERTY",
                        "streetType": 670,
                        "streetDirection": 3
                    },
                    "cityTown": "Toronto",
                    "provinceCode": 50,
                    "postalCode": "M6T3E4",
                    "countryCode": 1
                }
            ]
        },
        "creditBureauList": {
            "creditBureau": [
                {
                    "creditReportEquifax": {
                        "dataFormat": "0H",
                        "reportDate": "2020-07-13T00:00:00",
                        "creditScore": 727,
                        "value": "..."
                    },
                    "humanReadableReport": {
                        "type": "Text",
                        "value": "..."
                    },
                    "key": "bureau-25207",
                    "provider": "Equifax"
                },
                {
                    "creditReportEquifax": {
                        "dataFormat": "0H",
                        "reportDate": "2020-07-13T00:00:00",
                        "creditScore": 794,
                        "value": "..."
                    },
                    "humanReadableReport": {
                        "type": "Text",
                        "value": "..."
                    },
                    "key": "bureau-25208",
                    "provider": "Equifax"
                }
            ]
        }
    },
    "customerData": {
        "customerList": {
            "customerPrimaryBorrower": {
                "dateBirth": "1965-07-01T00:00:00",
                "honorific": 1,
                "lastName": "Zorin",
                "firstName": "Richard",
                "middleName": "WW",
                "suffix": "2",
                "customerTelephoneNumberList": [
                    {
                        "telephoneNumber": {
                            "countryCode": "1",
                            "areaCode": "416",
                            "phoneNumber": "5672345"
                        },
                        "usage": 1,
                        "preferred": false
                    },
                    {
                        "telephoneNumber": {
                            "countryCode": "1",
                            "areaCode": "416",
                            "phoneNumber": "5671234",
                            "phoneExtension": "33333"
                        },
                        "usage": 2,
                        "preferred": false
                    },
                    {
                        "telephoneNumber": {
                            "countryCode": "1",
                            "areaCode": "416",
                            "phoneNumber": "7891234"
                        },
                        "usage": 3,
                        "preferred": true
                    }
                ],
                "employmentList": {
                    "employment": [
                        {
                            "addressCanada": {
                                "postalAddressStreetAddress": {
                                    "poBoxRRNumber": "",
                                    "unitNumber": "234",
                                    "streetNumber": "34543",
                                    "streetName": "Main",
                                    "streetType": 940,
                                    "streetDirection": 3
                                },
                                "cityTown": "North DDDDD",
                                "provinceCode": 50,
                                "postalCode": "M7Y5T6",
                                "countryCode": 1
                            },
                            "earnedIncomeList": {
                                "earnedIncome": [
                                    {
                                        "earnedIncomeType": 9,
                                        "paymentFrequency": 1,
                                        "earnedIncomeAmount": 150000.0
                                    }
                                ]
                            },
                            "contactTelephoneNumber": {
                                "telephoneNumber": {
                                    "countryCode": "1",
                                    "areaCode": "416",
                                    "phoneNumber": "5671234",
                                    "phoneExtension": "33333"
                                },
                                "usage": 10
                            },
                            "employmentType": 1,
                            "employmentStatus": 10,
                            "dateStart": "2014-01-01T00:00:00",
                            "industryType": 8,
                            "dateStartedInIndustry": "2013-01-13T00:00:00",
                            "occupationType": 5,
                            "jobTitle": "BOSS",
                            "companyName": "Bank CANADA"
                        },
                        {
                            "addressCanada": {
                                "postalAddressStreetAddress": {
                                    "poBoxRRNumber": "",
                                    "unitNumber": "",
                                    "streetNumber": "45654",
                                    "streetName": "LONGUEUIL RRR",
                                    "streetType": 790,
                                    "streetDirection": 7
                                },
                                "cityTown": "Pleasant",
                                "provinceCode": 60,
                                "postalCode": "M7Y5T6",
                                "countryCode": 1
                            },
                            "earnedIncomeList": {
                                "earnedIncome": [
                                    {
                                        "earnedIncomeType": 99,
                                        "paymentFrequency": 12,
                                        "earnedIncomeAmount": 2345.0
                                    }
                                ]
                            },
                            "contactTelephoneNumber": {
                                "telephoneNumber": {
                                    "countryCode": "1",
                                    "areaCode": "416",
                                    "phoneNumber": "5672342",
                                    "phoneExtension": "43563"
                                },
                                "usage": 10
                            },
                            "employmentType": 2,
                            "employmentStatus": 10,
                            "dateStart": "2007-07-01T00:00:00",
                            "dateEnd": "2014-01-01T00:00:00",
                            "industryType": 10,
                            "dateStartedInIndustry": "2005-04-13T00:00:00",
                            "occupationType": 2,
                            "jobTitle": "Manager",
                            "companyName": "ABC BANK"
                        }
                    ]
                },
                "unearnedIncomeList": {
                    "unearnedIncome": [
                        {
                            "unearnedIncomeAmount": 2222.0,
                            "unearnedIncomeType": 99,
                            "paymentFrequency": 1,
                            "unearnedIncomeDetails": "222"
                        }
                    ]
                },
                "customerRelationShip": {},
                "key": "borrower-97985",
                "correspondenceLanguage": 1,
                "emailAddress1": "<user_email_address>",
                "maritalStatus": 6,
                "numberOfDependents": 0,
                "sex": 1,
                "residentType": 20
            },
            "customerGuarantor": [
                {
                    "dateBirth": "1965-08-01T00:00:00",
                    "honorific": 1,
                    "lastName": "Hussey",
                    "firstName": "Sina",
                    "suffix": "1",
                    "customerTelephoneNumberList": [
                        {
                            "telephoneNumber": {
                                "countryCode": "1",
                                "areaCode": "416",
                                "phoneNumber": "5671234"
                            },
                            "usage": 1,
                            "preferred": false
                        },
                        {
                            "telephoneNumber": {
                                "countryCode": "1",
                                "areaCode": "416",
                                "phoneNumber": "5671234",
                                "phoneExtension": "33333"
                            },
                            "usage": 2,
                            "preferred": true
                        },
                        {
                            "telephoneNumber": {
                                "countryCode": "1",
                                "areaCode": "416",
                                "phoneNumber": "7891234"
                            },
                            "usage": 3,
                            "preferred": false
                        }
                    ],
                    "employmentList": {
                        "employment": [
                            {
                                "addressCanada": {
                                    "postalAddressStreetAddress": {
                                        "poBoxRRNumber": "",
                                        "unitNumber": "2342",
                                        "streetNumber": "234234",
                                        "streetName": "Leslie",
                                        "streetType": 970,
                                        "streetDirection": 7
                                    },
                                    "cityTown": "King",
                                    "provinceCode": 50,
                                    "postalCode": "M7Y4R5",
                                    "countryCode": 1
                                },
                                "earnedIncomeList": {
                                    "earnedIncome": [
                                        {
                                            "earnedIncomeType": 4,
                                            "paymentFrequency": 1,
                                            "earnedIncomeAmount": 100000.0
                                        }
                                    ]
                                },
                                "contactTelephoneNumber": {
                                    "telephoneNumber": {
                                        "countryCode": "1",
                                        "areaCode": "416",
                                        "phoneNumber": "5671234",
                                        "phoneExtension": "33333"
                                    },
                                    "usage": 10
                                },
                                "employmentType": 2,
                                "employmentStatus": 10,
                                "dateStart": "2014-01-01T00:00:00",
                                "industryType": 5,
                                "dateStartedInIndustry": "2012-12-13T00:00:00",
                                "occupationType": 5,
                                "jobTitle": "Manager",
                                "companyName": "TD"
                            }
                        ]
                    },
                    "customerRelationShip": {
                        "relationShipToOwnerType": 3
                    },
                    "key": "borrower-97986",
                    "correspondenceLanguage": 1,
                    "emailAddress1": "MELISSA@mail.com",
                    "maritalStatus": 6,
                    "numberOfDependents": 0,
                    "sex": 1,
                    "residentType": 10
                }
            ]
        },
        "customerAddressList": [
            {
                "customerCurrentAddressTimeAt": [
                    {
                        "refkeyCustomer": "borrower-97985",
                        "fromDate": "2017-12-01T00:00:00"
                    }
                ],
                "customerLiabilityRealEstate": [
                    {
                        "customerReference": {
                            "refkeyCustomer": "borrower-97985"
                        },
                        "refkeyLiability": "property-34400-1"
                    }
                ],
                "addressOccupancyPartialOwnerOccupied": {
                    "rentalDetails": {
                        "annualGrossRentalIncome": 12000.0,
                        "managementExpenses": 36.0,
                        "insurance": 48.0,
                        "hydro": 48.0,
                        "maintenanceAndRepairs": 24.0,
                        "interest": 36.0,
                        "generalExpenses": 60.0
                    },
                    "refkeyAsset": "property-34400"
                },
                "currentPropertyIntendedActionType": 2,
                "annualHeatingAmount": 1056.0,
                "annualTaxAmount": 2000.0,
                "annualCondoFees": 3996.0,
                "customerReference": [
                    {
                        "refkeyCustomer": "borrower-97985"
                    }
                ],
                "refkeyAddress": "address-382404",
                "type": "CustomerAddressPrimaryResidence"
            },
            {
                "customerPreviousAddressTimeAt": [
                    {
                        "refkeyCustomer": "borrower-97985",
                        "fromDate": "2012-07-01T00:00:00",
                        "toDate": "2017-12-01T00:00:00"
                    }
                ],
                "previousAddressOccupancyTenant": {
                    "tenancyType": 10
                },
                "customerReference": [
                    {
                        "refkeyCustomer": "borrower-97985"
                    }
                ],
                "refkeyAddress": "address-382405",
                "type": "CustomerAddressPreviousResidence"
            },
            {
                "addressOccupancyNone": {},
                "customerReference": [
                    {
                        "refkeyCustomer": "borrower-97985"
                    }
                ],
                "refkeyAddress": "address-382406",
                "type": "CustomerAddressCorrespondence"
            },
            {
                "customerCurrentAddressTimeAt": [
                    {
                        "refkeyCustomer": "borrower-97986",
                        "fromDate": "2012-12-01T00:00:00"
                    }
                ],
                "addressOccupancyTenant": {
                    "monthlyRentPaid": 0,
                    "tenancyType": 40
                },
                "addressOccupancyTenant": {
                    "monthlyRentPaid": 0,
                    "tenancyType": 40
                },
                "currentPropertyIntendedActionType": 2,
                "customerReference": [
                    {
                        "refkeyCustomer": "borrower-97986"
                    }
                ],
                "refkeyAddress": "address-382407",
                "type": "CustomerAddressPrimaryResidence"
            },
            {
                "customerCurrentAddressTimeAt": [
                    {
                        "refkeyCustomer": "borrower-97985",
                        "fromDate": "2002-01-28T00:00:00"
                    }
                ],
                "addressOccupancyOwnerOccupied": {
                    "refkeyAsset": "property-34402"
                },
                "currentPropertyIntendedActionType": 2,
                "annualHeatingAmount": 1188.0,
                "annualTaxAmount": 3000.0,
                "annualCondoFees": 2664.0,
                "customerReference": [
                    {
                        "refkeyCustomer": "borrower-97985"
                    }
                ],
                "refkeyAddress": "address-382413",
                "type": "CustomerAddressSecondaryResidence"
            }
        ],
        "customerAssetList": [
            {
                "customerReference": {
                    "refkeyCustomer": "borrower-97985"
                },
                "refkeyAsset": "asset-82911"
            },
            {
                "customerReference": {
                    "refkeyCustomer": "borrower-97985"
                },
                "refkeyAsset": "asset-82912"
            },
            {
                "customerReference": {
                    "refkeyCustomer": "borrower-97985"
                },
                "refkeyAsset": "asset-82913"
            },
            {
                "customerReference": {
                    "refkeyCustomer": "borrower-97985"
                },
                "refkeyAsset": "asset-82914"
            },
            {
                "customerReference": {
                    "refkeyCustomer": "borrower-97985"
                },
                "refkeyAsset": "asset-82915"
            },
            {
                "customerReference": {
                    "refkeyCustomer": "borrower-97985"
                },
                "refkeyAsset": "asset-82916"
            },
            {
                "customerReference": {
                    "refkeyCustomer": "borrower-97985"
                },
                "refkeyAsset": "asset-82917"
            },
            {
                "customerReference": {
                    "refkeyCustomer": "borrower-97985"
                },
                "refkeyAsset": "asset-82918"
            },
            {
                "customerReference": {
                    "refkeyCustomer": "borrower-97985"
                },
                "refkeyAsset": "asset-82919"
            }
        ],
        "customerLiabilityList": [
            {
                "customerReference": {
                    "refkeyCustomer": "borrower-97985"
                },
                "refkeyLiability": "liability-112331"
            },
            {
                "customerReference": {
                    "refkeyCustomer": "borrower-97985"
                },
                "refkeyLiability": "liability-112332"
            },
            {
                "customerReference": {
                    "refkeyCustomer": "borrower-97985"
                },
                "refkeyLiability": "liability-112333"
            },
            {
                "customerReference": {
                    "refkeyCustomer": "borrower-97985"
                },
                "refkeyLiability": "liability-112337"
            },
            {
                "customerReference": {
                    "refkeyCustomer": "borrower-97985"
                },
                "refkeyLiability": "liability-112338"
            },
            {
                "customerReference": {
                    "refkeyCustomer": "borrower-97985"
                },
                "refkeyLiability": "liability-112339"
            },
            {
                "customerReference": {
                    "refkeyCustomer": "borrower-97986"
                },
                "refkeyLiability": "liability-112334"
            },
            {
                "customerReference": {
                    "refkeyCustomer": "borrower-97986"
                },
                "refkeyLiability": "liability-112335"
            },
            {
                "customerReference": {
                    "refkeyCustomer": "borrower-97986"
                },
                "refkeyLiability": "liability-112336"
            }
        ],
        "customerCreditBureauList": [
            {
                "customerReference": [
                    {
                        "refkeyCustomer": "borrower-97985"
                    }
                ],
                "refkeyCreditBureau": "bureau-25207"
            },
            {
                "customerReference": [
                    {
                        "refkeyCustomer": "borrower-97986"
                    }
                ],
                "refkeyCreditBureau": "bureau-25208"
            }
        ]
    },
    "mortgageApplication": {
        "subjectProperty": {
            "subjectPropertyOccupancyRental": {
                "rentalDetails": {
                    "annualGrossRentalIncome": 24000.0,
                    "managementExpenses": 96.0,
                    "insurance": 84.0,
                    "hydro": 72.0,
                    "maintenanceAndRepairs": 60.0,
                    "interest": 72.0,
                    "rentalOffset": 50,
                    "rentalCalcType": 2
                }
            },
            "legalAddress": {
                "details": "1546735765",
                "pin": "13454645654",
                "planNumber": "12456456456456245"
            },
            "freehold": {},
            "propertyTax": {
                "annualTaxAmount": 4000.0,
                "taxesPaidBy": 1
            },
            "subjectPropertyAddress": {
                "refkeyAddress": "address-382403"
            },
            "occupancyPurpose": 4,
            "mlsListed": false,
            "mlsNumber": "1",
            "heatingType": 1,
            "parkingType": 1,
            "yearBuilt": 2000,
            "waterSupplyType": 20,
            "waterWasteType": 30,
            "propertySize": 2222,
            "propertySizeUnits": 1,
            "lotSize": 3333,
            "lotSizeUnits": 1,
            "environmentalHazardIndicator": false,
            "annualHeatingAmount": 1056.0,
            "numberOfUnitsTotal": 1,
            "propertyType": 1,
            "propertyDescriptionType": 3,
            "propertyUsageType": 7,
            "propertyZoningType": 5,
            "newPropertyIndicator": false
        },
        "loan": {
            "customProduct": {
                "productName": "VAR Product",
                "rateType": 99,
                "rateCompoundFrequency": 1,
                "productTerm": 89,
                "earlyPayoutOption": 20,
                "locIndicator": false,
                "buydown": 0,
                "postedRate": 1.89
            },
            "underwriter": {
                "userId": "<user_id>",
                "unitId": "<underwriter_unit_id>"
            },
            "loanAmount": 1179000.0,
            "chargeType": 1,
            "termMonths": "89",
            "amortizationMonths": "305",
            "netRate": 1.89,
            "qualifyingRate": 4,
            "acceleratedPayment": true,
            "maturityDate": "2104-11-05T00:00:00",
            "firstPaymentDate": "2020-11-19T00:00:00",
            "interestAdjustmentDate": "2020-11-05T00:00:00",
            "requestedPayment": 488.75,
            "paymentAmount": 4925.14,
            "paymentFrequency": 26,
            "repaymentType": 2,
            "lenderCode": <lender_code>,
            "lenderChannel": 10
        },
        "downpaymentList": {
            "downpayment": [
                {
                    "downpaymentSourceType": 99,
                    "description": "Second Financing",
                    "amount": 66000.0
                },
                {
                    "downpaymentSourceType": 4,
                    "description": "gift",
                    "amount": 50000.0
                },
                {
                    "downpaymentSourceType": 8,
                    "description": "grant",
                    "amount": 50000.0
                }
            ]
        },
        "firm": {
            "externalPoSFirm": [
                {
                    "posSystemId": 50,
                    "firmId": "<firm_id>"
                }
            ],
            "firmId": "<firm_id>"
        },
        "submittingAgent": {
            "externalPoSUser": [
                {
                    "posSystemId": 40,
                    "firmId": "<firm_id>",
                    "userId": "<user_external_pos_id_1>"
                },
                {
                    "posSystemId": 50,
                    "firmId": "<firm_id>",
                    "userId": "<user_external_pos_id_2>"
                }
            ],
            "userId": "<user_id>",
            "firstName": "<user_firstname>",
            "lastName": "<user_lastname>",
            "emailAddress": "<user_email_address>",
            "mortgageLicenseNumber": "<mortgage_license_number>"
        },
        "originatingAgent": {
            "externalPoSUser": [
                {
                    "posSystemId": 40,
                    "firmId": "<firm_id>",
                    "userId": "<user_external_pos_id_1>"
                },
                {
                    "posSystemId": 50,
                    "firmId": "<firm_id>",
                    "userId": "<user_external_pos_id_2>"
                }
            ],
            "addressCanada": {
                "postalAddressStreetAddress": {
                    "poBoxRRNumber": "",
                    "unitNumber": "123",
                    "streetNumber": "2608",
                    "streetName": "Granville",
                    "streetType": 1240,
                    "streetDirection": 2
                },
                "cityTown": "Vancouver",
                "provinceCode": 10,
                "postalCode": "V6H3V3",
                "countryCode": 1
            },
            "userId": "<user_id>",
            "firstName": "<user_firstname>",
            "lastName": "<user_lastname>",
            "emailAddress": "<user_email_address>",
            "mortgageLicenseNumber": "<mortgage_license_number>"
        },
        "broker": {
            "externalPoSUser": [
                {
                    "posSystemId": 40,
                    "firmId": "<firm_id>",
                    "userId": "<user_external_pos_id_1>"
                },
                {
                    "posSystemId": 50,
                    "firmId": "<firm_id>",
                    "userId": "<user_external_pos_id_2>"
                }
            ],
            "userId": "<user_id>",
            "firstName": "<user_firstname>",
            "lastName": "<user_lastname>",
            "emailAddress": "<user_email_address>",
            "mortgageLicenseNumber": "<mortgage_license_number>"
        },
        "posApplicationNumber": "ABCD-56197",
        "isPreapproval": false,
        "fundingDate": "2020-11-05T00:00:00",
        "loanPurposeType": 3,
        "purchasePriceEstimatedValue": 1345000.0,
        "typeOfBuyer": 20
    },
    "memo": "\n    Applicants:\n    Participants-  Agent: Jane Smith Assoc/Asst: Jane Smith\n    File touched by: Jane Smith\n    Richard Hussey for ACME as ROC\n    Sina Hussey for NN as Manager\n    Subj Prop Rental - $2,000.00 add back 50%\n    Assets: (Type - Desc - Amount)\n    Deposit on Purchase - 111 sdfhstsryntysnyumtyumt - $111.00\n    Gift - 222 xfghftyrtyndyu uiimyfu - $222.00\n    Household Goods - 333 xfgbtyrtyn d fh y ydun - $333.00\n    Life Insurance - 444 df ty yuyunytum fyju - $444.00\n    Mutual Fund/Stock/Bonds - 555 xdfg tyh bty ru yumui,ui - $555.00\n    Other - 666 fdg ht yu ghj ui - $666.00\n    RRSP - 777 cv ftyrtynyrmrum - $777.00\n    Savings - 888 cgh btynrty - $888.00\n    Vehicle - 999 fgh bf f dfyu - $999.00\n    Properties: (# - Annual Taxes - Heating /mo)\n    1 (#700 - 2627 26th St NE Street NE, Calgary, Alberta, T1Y1A4) - $2,000.00 - $88.00\n    2 (#22 - 33 Owner Path S, North York, Ontario, M7Y3R5) - $3,000.00 - $99.00\n    Credit Bureaus: (Name - Vendor - Pulled By - Requested)\n    Richard Hussey - Equifax - JSMITH - 2020-07-13 02:27 PM UTC\n    Sina Hussey - Equifax - JSMITH - 2020-07-13 02:27 PM UTC\n\n    Selected Product: VAR Product\n    dzfgvtyrty21345326457657n @!%$#^%$R*&TO*BYILUB l?\":{O_)*(*^%#Fvjhcdfsufgleiurwt\n  ",
    "unitId": "<firm_id>",
    "posSystem": "<pos_system_id>"
}

Deal 5 contains:

Validate Application

POST https://api-link.newton.ca/v1/validations/applications

Validate Application has a request body identical to a Submit Application request. It can be used to validate the request without performing an actual ingestion and submission.

Parameters

Sample Request

{
  "commonData": {
    "assetList": {
      "assetRealEstate": [
        {
          "key": "property-48853",
          "value": 500000,
          "originalPrice": 350000,
          "originalDate": "2008-04-29"
        }
      ],
      "assetOther": [
        {
          "key": "asset-40788",
          "value": 10000,
          "assetType": 70,
          "description": "savings"
        },
        {
          "key": "asset-40783",
          "value": 50000,
          "assetType": 10,
          "description": "Cash in the bank"
        }
      ]
    },
    "liabilityList": {
      "liabilityRealEstate": [
        {
          "key": "property-48853-1",
          "fromCreditBureau": false,
          "accountNumber": "598685",
          "monthlyRepayment": 1000,
          "originalLoanAmount": 250000,
          "outstandingBalance": 100000,
          "closingDate": "2008-04-29",
          "lenderName": "RBC",
          "chargeType": 1,
          "repaymentType": 2,
          "redemptionStatus": 4,
          "maturityDate": "2023-02-01",
          "netRate": 5,
          "rateType": 0
        }
      ],
      "liabilityOther": [
        {
          "key": "liability-42362",
          "fromCreditBureau": false,
          "repaymentIndicator": false,
          "monthlyRepayment": 150,
          "creditLimit": 1000,
          "outstandingBalance": 2000,
          "lenderName": "AMEX",
          "liabilityType": 6
        }
      ]
    },
    "addressList": {
      "applicationAddressCanada": [
        {
          "cityTown": "High River",
          "provinceCode": 20,
          "postalCode": "T1V1J5",
          "key": "address-402175",
          "postalAddressStreetAddress": {
            "streetNumber": "311",
            "streetName": "Aurora",
            "streetType": 190
          }
        },
        {
          "cityTown": "Markham",
          "provinceCode": 50,
          "postalCode": "L3S4N5",
          "key": "address-402176",
          "postalAddressStreetAddress": {
            "unitNumber": "10",
            "streetNumber": "11",
            "streetName": "Chruch",
            "streetType": 490
          }
        },
        {
          "cityTown": "Toronto",
          "provinceCode": 50,
          "postalCode": "M2J5C4",
          "key": "address-402174",
          "postalAddressStreetAddress": {
            "unitNumber": "8",
            "streetNumber": "567",
            "streetName": "Brock",
            "streetType": 490,
            "streetDirection": 7
          }
        }
      ]
    }
  },
  "customerData": {
    "customerList": {
      "customerPrimaryBorrower": {
        "key": "borrower-112109",
        "correspondenceLanguage": 1,
        "dateBirth": "1976-11-12",
        "honorific": 1,
        "lastName": "Daniels",
        "firstName": "Bob",
        "emailAddress1": "bob@test.com",
        "sin": "999999998",
        "maritalStatus": 2,
        "numberOfDependents": 1,
        "sex": 1,
        "residentType": 10,
        "customerTelephoneNumberList": [
          {
            "usage": 1,
            "preferred": true,
            "telephoneNumber": {
              "countryCode": "1",
              "areaCode": "905",
              "phoneNumber": "9100010"
            }
          },
          {
            "usage": 2,
            "preferred": false,
            "telephoneNumber": {
              "countryCode": "1",
              "areaCode": "905",
              "phoneNumber": "9101457",
              "phoneExtension": "333"
            }
          },
          {
            "usage": 3,
            "preferred": false,
            "telephoneNumber": {
              "countryCode": "1",
              "areaCode": "647",
              "phoneNumber": "9101547"
            }
          }
        ],
        "employmentList": {
          "employment": [
            {
              "employmentType": 1,
              "employmentStatus": 10,
              "dateStart": "2021-11-01",
              "industryType": 8,
              "dateStartedInIndustry": "2011-06-13",
              "occupationType": 5,
              "jobTitle": "Manager",
              "companyName": "American Express",
              "addressCanada": {
                "cityTown": "Toronto",
                "provinceCode": 50,
                "postalCode": "M9M9M9",
                "postalAddressStreetAddress": {
                  "streetNumber": "456",
                  "streetName": "Yorkland",
                  "streetType": 380
                }
              },
              "earnedIncomeList": {
                "earnedIncome": [
                  {
                    "earnedIncomeType": 9,
                    "paymentFrequency": 1,
                    "earnedIncomeAmount": 90000
                  }
                ]
              },
              "contactTelephoneNumber": {
                "usage": 10,
                "telephoneNumber": {
                  "countryCode": "1",
                  "areaCode": "403",
                  "phoneNumber": "3431234",
                  "phoneExtension": "12"
                }
              }
            },
            {
              "employmentType": 1,
              "employmentStatus": 10,
              "dateStart": "2015-05-01",
              "dateEnd": "2021-11-01",
              "industryType": 8,
              "dateStartedInIndustry": "2011-06-13",
              "occupationType": 1,
              "jobTitle": "Manager",
              "companyName": "Prev Company",
              "earnedIncomeList": {
                "earnedIncome": [
                  {
                    "earnedIncomeType": 10,
                    "paymentFrequency": 1,
                    "earnedIncomeAmount": 50000
                  }
                ]
              },
              "contactTelephoneNumber": {
                "usage": 10,
                "telephoneNumber": {
                  "countryCode": "1",
                  "areaCode": "528",
                  "phoneNumber": "2965859"
                }
              }
            }
          ]
        },
        "unearnedIncomeList": {
          "unearnedIncome": [
            {
              "unearnedIncomeAmount": 800,
              "unearnedIncomeType": 99,
              "paymentFrequency": 12,
              "unearnedIncomeDetails": "From FD"
            }
          ]
        }
      },
      "customerBorrower": [
        {
          "key": "borrower-112110",
          "correspondenceLanguage": 1,
          "dateBirth": "1975-04-14",
          "honorific": 4,
          "lastName": "Daniels",
          "firstName": "Marsha",
          "emailAddress1": "marsha@test.com",
          "maritalStatus": 2,
          "numberOfDependents": 0,
          "sex": 2,
          "residentType": 10,
          "customerTelephoneNumberList": [
            {
              "usage": 1,
              "preferred": false,
              "telephoneNumber": {
                "countryCode": "1",
                "areaCode": "905",
                "phoneNumber": "9100010"
              }
            },
            {
              "usage": 3,
              "preferred": true,
              "telephoneNumber": {
                "countryCode": "1",
                "areaCode": "647",
                "phoneNumber": "7891546"
              }
            }
          ],
          "employmentList": {
            "employment": [
              {
                "employmentType": 1,
                "employmentStatus": 10,
                "dateStart": "2017-02-01",
                "industryType": 8,
                "dateStartedInIndustry": "2007-07-13",
                "occupationType": 1,
                "jobTitle": "Marketing Manager",
                "companyName": "Chase Bank",
                "addressCanada": {
                  "cityTown": "Toronto",
                  "provinceCode": 50,
                  "postalCode": "M9M9M9",
                  "postalAddressStreetAddress": {
                    "unitNumber": "659",
                    "streetNumber": "585",
                    "streetName": "3663 South",
                    "streetType": 320,
                    "streetDirection": 2
                  }
                },
                "earnedIncomeList": {
                  "earnedIncome": [
                    "[Object]"
                  ]
                },
                "contactTelephoneNumber": {
                  "usage": 10,
                  "telephoneNumber": {
                    "countryCode": "1",
                    "areaCode": "403",
                    "phoneNumber": "5298259",
                    "phoneExtension": "859"
                  }
                }
              }
            ]
          },
          "unearnedIncomeList": {
            "unearnedIncome": [
              {
                "unearnedIncomeAmount": 800,
                "unearnedIncomeType": 3,
                "paymentFrequency": 12,
                "unearnedIncomeDetails": "From FD"
              }
            ]
          },
          "customerRelationship": {
            "relationshipToOwnerType": 1
          }
        }
      ]
    },
    "customerAddressList": {
      "customerAddressPrimaryResidence": [
        {
          "currentPropertyIntendedActionType": 1,
          "annualHeatingAmount": 1500,
          "annualTaxAmount": 2560,
          "refkeyAddress": "address-402175",
          "customerReference": [
            {
              "refkeyCustomer": "borrower-112109"
            }
          ],
          "customerCurrentAddressTimeAt": [
            {
              "fromDate": "2021-02-01",
              "refkeyCustomer": "borrower-112109"
            }
          ],
          "customerLiabilityRealEstate": [
            {
              "refkeyLiability": "property-48853-1",
              "customerReference": {
                "refkeyCustomer": "borrower-112109"
              }
            }
          ],
          "addressOccupancyPartialOwnerOccupied": {
            "refkeyAsset": "property-48853",
            "rentalDetails": {
              "annualGrossRentalIncome": 15000,
              "hydro": 1500,
              "rentalOffset": 65,
              "rentalCalcType": 2
            }
          }
        },
        {
          "currentPropertyIntendedActionType": 1,
          "annualHeatingAmount": 1500,
          "annualTaxAmount": 2560,
          "refkeyAddress": "address-402175",
          "customerReference": [
            {
              "refkeyCustomer": "borrower-112110"
            }
          ],
          "customerCurrentAddressTimeAt": [
            {
              "fromDate": "2017-01-01",
              "refkeyCustomer": "borrower-112110"
            }
          ],
          "addressOccupancyPartialOwnerOccupied": {
            "refkeyAsset": "property-48853",
            "rentalDetails": {
              "annualGrossRentalIncome": 15000,
              "hydro": 1500,
              "rentalOffset": 65,
              "rentalCalcType": 2
            }
          }
        }
      ],
      "customerAddressCorrespondence": [
        {
          "refkeyAddress": "address-402176",
          "customerReference": [
            {
              "refkeyCustomer": "borrower-112109"
            }
          ],
          "addressOccupancyNone": {}
        }
      ]
    },
    "customerAssetList": [
      {
        "refkeyAsset": "asset-40788",
        "customerReference": {
          "refkeyCustomer": "borrower-112109"
        }
      },
      {
        "refkeyAsset": "asset-40783",
        "customerReference": {
          "refkeyCustomer": "borrower-112110"
        }
      }
    ],
    "customerLiabilityList": [
      {
        "refkeyLiability": "liability-42362",
        "customerReference": {
          "refkeyCustomer": "borrower-112109"
        }
      }
    ]
  },
  "mortgageApplication": {
    "posApplicationNumber": "VXDTB-70014",
    "fundingDate": "2022-11-08",
    "loanPurposeType": 5,
    "purchasePriceEstimatedValue": 600000,
    "typeOfBuyer": 20,
    "additionalPurpose": "Switch and Transfer",
    "subjectProperty": {
      "occupancyPurpose": 4,
      "mlsListed": true,
      "mlsNumber": "4891256",
      "heatingType": 2,
      "parkingType": 1,
      "yearBuilt": 2001,
      "waterSupplyType": 10,
      "waterWasteType": 10,
      "propertySize": 2222,
      "propertySizeUnits": 1,
      "lotSize": 2222,
      "lotSizeUnits": 1,
      "environmentalHazardIndicator": false,
      "annualHeatingAmount": 1800,
      "numberOfUnitsTotal": 1,
      "propertyType": 99,
      "propertyDescriptionType": 6,
      "propertyUsageType": 90,
      "propertyZoningType": 1,
      "newPropertyIndicator": false,
      "subjectPropertyOccupancyOwnerOccupied": {},
      "legalAddress": {
        "details": "6 Toronto",
        "pin": "777"
      },
      "condo": {
        "annualCondoFees": 4200
      },
      "propertyTax": {
        "annualTaxAmount": 3500,
        "taxesPaidBy": 1
      },
      "subjectPropertyAddress": {
        "refkeyAddress": "address-402174"
      }
    },
    "loan": {
      "loanAmount": 0,
      "chargeType": 1,
      "termMonths": 6,
      "amortizationMonths": 188,
      "netRate": 3.33,
      "qualifyingRate": 3.75,
      "maturityDate": "2023-05-08",
      "firstPaymentDate": "2022-12-08",
      "interestAdjustmentDate": "2022-11-08",
      "requestedPayment": 2733.58,
      "paymentAmount": 2733.58,
      "paymentFrequency": 12,
      "repaymentType": 2,
      "lenderCode": 9011,
      "customProduct": {
        "productCode": "LL5000",
        "productName": "5 Year Fixed EST",
        "rateType": 0,
        "rateCompoundFrequency": 12,
        "postedRate": 3.33,
        "productTerm": 6
      }
    },
    "downpaymentList": {
      "downpayment": [
        {
          "downpaymentSourceType": 9,
          "description": "Property - 311 Aurora Drive, Calgary, Alberta",
          "amount": 200000
        }
      ]
    },
    "firm": {
      "firmId": "XDTB",
      "externalPoSFirm": [
        {
          "posSystemId": 50,
          "firmId": "XDTB"
        }
      ]
    },
    "submittingAgent": {
      "firstName": "Aleesha",
      "lastName": "Ashraf",
      "emailAddress": "aleesha.ashraf@newton.ca",
      "mortgageLicenseNumber": "9988889",
      "externalPoSUser": [
        {
          "posSystemId": 50,
          "firmId": "XDTB",
          "userId": "112233"
        }
      ]
    },
    "originatingAgent": {
      "firstName": "Karen",
      "lastName": "Poulin",
      "emailAddress": "karen.poulin@mscanada.com",
      "mortgageLicenseNumber": "B7403",
      "externalPoSUser": [
        {
          "posSystemId": 50,
          "firmId": "XDTB",
          "userId": "11246"
        }
      ],
      "addressCanada": {
        "cityTown": "Vancouver",
        "provinceCode": 10,
        "postalCode": "V6H3V3",
        "postalAddressStreetAddress": {
          "unitNumber": "550",
          "streetNumber": "2608",
          "streetName": "Granville",
          "streetType": 490,
          "streetDirection": 6
        }
      }
    },
    "broker": {
      "firstName": "Aleesha",
      "lastName": "Ashraf",
      "emailAddress": "aleesha.ashraf@newton.ca",
      "mortgageLicenseNumber": "9988889",
      "externalPoSUser": [
        {
          "posSystemId": 50,
          "firmId": "XDTB",
          "userId": "112233"
        }
      ]
    }
  }
}
Name In Type Description
body Request
SubmitApplication

Request

SubmitApplication

Responses

Sample Response

200 Response

{
  "validationRule": [
    {
      "ruleId": "417",
      "ruleDescription": "Loan Amount must be greater than 0"
    },
    {
      "ruleId": "443",
      "ruleDescription": "The sum of downpayments and amount requested are less than purchase price plus improvements"
    }
  ],
  "status": "ok"
}
Status Schema
200 OK ValidateApplication > Response

Response

ValidateApplication

Name Type Description
error nullable array(ServiceError) List of errors
status required ResponseStatus
Enums
validationRule nullable array(ValidationRule)
ValidateApplication > Response
 [Validation rule]

ValidationRule

ValidateApplication > Response

Name Type Description
ruleId nullable string
ruleDescription nullable string

Submit Document

POST https://api-link.newton.ca/v1/application/documents

The Submit Document operation electronically submits a document to the lender for a given application. Additionally the document being submitted may be associated with a condition type.

Parameters

Sample Request

{
  "mortgageApplication": {
    "document": {
      "conditionType": 50,
      "fileName": "Proof of Employment.pdf",
      "documentContents": {
        "value": "DQoxIDAgb2JqDQo8PA0KL1R5cGUgL0NhdGFs...ZWYNCjE1NTENCiUlRU9GDQo="
      }
    }
  },
  "unitId": "XDTB",
  "posSystem": "100"
}
Name In Type Description
body Request
SubmitDocument

Request

SubmitDocument

Name Type Description
unitId required string min-length(1) Unit Id (see Authorization)
posSystem required string min-length(1) max-length(10) PoS System (see Authorization)
mortgageApplication required MortgageApplication
SubmitDocument > Request
 Mortgage Application

MortgageApplication

SubmitDocument > Request

Name Type Description
applicationNumber required string max-length(12) ^[A-Z][0-9]{9}$ Application number
document required Document
SubmitDocument > Request
 Document

Document

SubmitDocument > Request

Name Type Description
conditionType DocumentConditionType
Enums
 Document condition type
documentType DocumentType
Enums
 Document type
fileName required string min-length(1) max-length(40) Document filename
documentContents DocumentContents
SubmitDocument > Request

DocumentContents

SubmitDocument > Request

Name Type Description
value nullable string Base64 encoded document contents

Responses

Sample Response

200 Response

{
  "document": {
    "documentId": "0edddd596528ce4ebd51f27b9ef101bc"
  },
  "status": "ok"
}
Status Schema
200 OK SubmitDocument > Response

Response

SubmitDocument

Name Type Description
error nullable array(ServiceError) List of errors
status required ResponseStatus
Enums
document Document
SubmitDocument > Response
 Document details

Document

SubmitDocument > Response

Name Type Description
documentId required string min-length(32) max-length(32) Document Id

Pending Applications

GET https://api-link.newton.ca/v1/pending-applications

Gets a list of all pending applications

Parameters

Name In Type Description
unitId query string (see Authorization)
posSystemId query string (see Authorization)

Responses

Sample Response

200 Response

{
  "mortgageApplication": [
    {
      "applicationNumber": "M101338314",
      "decision": [
        {
          "lenderCode": 9011,
          "decisionDateTime": "2022-05-27T11:16:52",
          "seqNo": 3
        },
        {
          "lenderCode": 9011,
          "decisionDateTime": "2022-05-27T11:16:52",
          "seqNo": 3
        }
      ]
    },
    {
      "applicationNumber": "M101338327",
      "decision": [
        {
          "lenderCode": 6012,
          "decisionDateTime": "2022-05-27T17:34:16",
          "seqNo": 1
        }
      ]
    }
  ],
  "status": "ok"
}
Status Schema
200 OK GetPendingApplications > Response

Response

GetPendingApplications

Name Type Description
error nullable array(ServiceError) List of errors
status required ResponseStatus
Enums
mortgageApplication nullable array(MortgageApplication)
GetPendingApplications > Response
 List of Mortgage Applications

MortgageApplication

GetPendingApplications > Response

Name Type Description
applicationNumber required string max-length(12) ^[A-Z][0-9]{9}$ Application number
decision nullable array(Decision)
GetPendingApplications > Response

Decision

GetPendingApplications > Response

Name Type Description
lenderCode required integer(int32) range(1000,9999) Lender code
decisionDateTime required string(date-time) Decision timestamp
seqNo required integer(int32) range(1,999) Decision sequence number

Application Decision

POST https://api-link.newton.ca/v1/application-decisions/search

After an application is submitted and receives a decision through a lender response, a call to search the application-decision is made. Once found through search, this operation is made to acknowledge the application decision.

Parameters

Sample Request

{
  "mortgageApplication": [
    {
      "applicationNumber": "M101338314",
      "decision": {
        "lenderCode": 9011,
        "decisionDateTime": "2022-05-27T11:16:52",
        "seqNo": 3
      }
    }
  ],
  "unitId": "XDTB",
  "posSystem": "100"
}
Name In Type Description
body Request
GetApplicationDecision

Request

GetApplicationDecision

Name Type Description
unitId required string min-length(1) Unit Id (see Authorization)
posSystem required string min-length(1) max-length(10) PoS System (see Authorization)
mortgageApplication nullable array(MortgageApplication)
GetApplicationDecision > Request
 List of Mortgage applications

MortgageApplication

GetApplicationDecision > Request

Name Type Description
applicationNumber required string max-length(12) ^[A-Z][0-9]{9}$ Application number
decision Decision
GetApplicationDecision > Request
 Application decision

Decision

GetApplicationDecision > Request

Name Type Description
lenderCode required integer(int32) range(1000,9999) Lender code
decisionDateTime required string(date-time) Decision timestamp
seqNo required integer(int32) range(1,999) Decision sequence number

Responses

Sample Response

200 Response

{
  "mortgageApplication": [
    {
      "applicationNumber": "M101338314",
      "decision": [
        {
          "lenderCode": 9011,
          "decisionDateTime": "2022-05-27T11:16:52",
          "applicationStatus": 40,
          "seqNo": 3,
          "condition": [
            {
              "name": "Income",
              "type": "Income",
              "status": "Required",
              "description": "Current paystub confirming income is required"
            },
            {
              "name": "Solicitor",
              "type": "Solicitor",
              "status": "Required",
              "description": "Solicitor Name and Address including telephone number required"
            }
          ],
          "document": [
            {
              "name": "Commitment Letter.pdf",
              "documentContents": "JVBERi0xLjcNCiW1tbW1DQ...xNTYwMDYNCiUlRU9G"
            }
          ]
        }
      ]
    }
  ],
  "status": "ok"
}
Status Schema
200 OK GetApplicationDecision > Response

Response

GetApplicationDecision

Name Type Description
error nullable array(ServiceError) List of errors
status required ResponseStatus
Enums
mortgageApplication nullable array(MortgageApplication)
GetApplicationDecision > Response
 List of Mortgage applications

MortgageApplication

GetApplicationDecision > Response

Name Type Description
applicationNumber required string max-length(12) ^[A-Z][0-9]{9}$ Application number
lenderRefNumber nullable string min-length(1) max-length(50) Lender reference number
decision nullable array(Decision)
GetApplicationDecision > Response
 List of Application decisions

Decision

GetApplicationDecision > Response

Name Type Description
lenderCode required integer(int32) range(1000,9999) Lender code
decisionDateTime required string(date-time) Decision timestamp
applicationStatus required ApplicationStatus
Enums
 Application status
seqNo required integer(int32) minimum(0) Decision sequence number
isAcknowledged nullable boolean Is decision acknowledged?
condition nullable array(Condition)
GetApplicationDecision > Response
 List of Conditions
document nullable array(Document)
GetApplicationDecision > Response
 List of Application decision documents
note nullable string Lender note

Condition

GetApplicationDecision > Response

Name Type Description
name required string Condition name
type required ConditionType
Enums
 Condition type
status required ConditionStatus
Enums
 Condition status
description required string Condition description

Document

GetApplicationDecision > Response

Name Type Description
name required string Document name
documentContents required string Document contents

Ack Application Decision

POST https://api-link.newton.ca/v1/application-decisions/acknowledgement

After an application is submitted and receives a decision through a lender response, a call to search the application-decision is made. Once found through search, this operation is made to acknowledge the application decision.

Parameters

Sample Request

{
  "mortgageApplication": [
    {
      "applicationNumber": "M101338314",
      "decision": {
        "lenderCode": 9011,
        "decisionDateTime": "2022-05-27T11:16:52",
        "seqNo": 3
      }
    }
  ],
  "unitId": "XDTB",
  "posSystem": "100"
}
Name In Type Description
body Request
AckApplicationDecision

Request

AckApplicationDecision

Name Type Description
unitId required string min-length(1) Unit Id (see Authorization)
posSystem required string min-length(1) max-length(10) PoS System (see Authorization)
mortgageApplication nullable array(MortgageApplication)
AckApplicationDecision > Request
 List of Mortgage applications

MortgageApplication

AckApplicationDecision > Request

Name Type Description
applicationNumber required string max-length(12) ^[A-Z][0-9]{9}$ Application number
decision Decision
AckApplicationDecision > Request
 Application decision

Decision

AckApplicationDecision > Request

Name Type Description
lenderCode required integer(int32) range(1000,9999) Lender code
decisionDateTime nullable string(date-time) Decision timestamp
seqNo required integer(int32) range(1,999) Decision sequence number

Responses

Sample Response

200 Response

{
  "status": "ok"
}
Status Schema
200 OK AckApplicationDecision > Response

Response

AckApplicationDecision

Name Type Description
error nullable array(ServiceError) List of errors
status required ResponseStatus
Enums

ServiceError

Name Type Description
code nullable string
message nullable string
path nullable string
type ServiceErrorType
Enums

Update Application Status

POST https://api-link.newton.ca/v1/application/updatestatus

Update deal status with PoS Application Status value and verify/record the Funding Date if necessary

Parameters

Sample Request

{
  "applicationStatus": {
    "applicationNumber": "M101338314",
    "applicationStatus": 40,
    "fundingDate": "2023-02-01",
    "posUserId": "otester"
  },
  "unitId": "XDTB",
  "posSystem": "100"
}
Name In Type Description
body Request
UpdateApplicationStatus

Request

UpdateApplicationStatus

Name Type Description
unitId required string min-length(1) Unit Id (see Authorization)
posSystem required string min-length(1) max-length(10) PoS System (see Authorization)
applicationStatus required TypeApplicationStatus
UpdateApplicationStatus > Request
 Aplication status

TypeApplicationStatus

UpdateApplicationStatus > Request

Name Type Description
applicationNumber required string max-length(12) ^[A-Z][0-9]{9}$ PoS application number
applicationStatus required PoSApplicationStatus
Enums
 PoS application status
fundingDate nullable string(date) Funding Date
posUserId nullable string max-length(100) PoS user Id

Responses

Sample Response

200 Response

{
  "status": "ok"
}
Status Schema
200 OK UpdateApplicationStatus > Response

Response

UpdateApplicationStatus

Name Type Description
error nullable array(ServiceError) List of errors
status required ResponseStatus
Enums

Update Compliance Status

POST https://api-link.newton.ca/v1/application/updatecompliancestatus

Update the compliance status with new PoS Compliance Status value

Parameters

Sample Request

{
  "complianceStatus": {
    "applicationNumber": "M101338314",
    "status": 3,
    "complianceUpdatedAt": "2023-02-01T12:59:59",
    "confirmed": true,
    "ready": true,
    "paymentReceivedAt": "2023-02-02T10:00:00",
    "mortgageType": 0,
    "posUserId": "otester"
  },
  "unitId": "XDTB",
  "posSystem": "100"
}
Name In Type Description
body Request
UpdateComplianceStatus

Request

UpdateComplianceStatus

Name Type Description
unitId required string min-length(1) Unit Id (see Authorization)
posSystem required string min-length(1) max-length(10) PoS System (see Authorization)
complianceStatus required ComplianceStatus
UpdateComplianceStatus > Request
 Compliance status

ComplianceStatus

UpdateComplianceStatus > Request

Name Type Description
applicationNumber required string max-length(12) ^[A-Z][0-9]{9}$ Application number
status required PoSComplianceStatus
Enums
 Compliance status
complianceUpdatedAt nullable string(date-time) Compliance Updated At Date/Time
confirmed nullable boolean Compliance Confirmed Indicator
ready nullable boolean Compliance Ready Indicator
paymentReceivedAt nullable string(date-time) Payment Received At Date/Time
mortgageType MortgageType
Enums
 Mortgage type
posUserId nullable string max-length(100) PoS user Id

Responses

Sample Response

200 Response

{
  "status": "ok"
}
Status Schema
200 OK UpdateComplianceStatus > Response

Response

UpdateComplianceStatus

Name Type Description
error nullable array(ServiceError) List of errors
status required ResponseStatus
Enums

Credit Bureau (Equifax)

POST https://api-link.newton.ca/v1/credit-bureau/equifax

Creates a credit bureau report (for Equifax)

Parameters

Sample Request

{
  "customer": {
    "dateBirth": "1980-01-03",
    "lastName": "LANE",
    "firstName": "GARY",
    "address": {
      "streetNumber": "103",
      "streetName": "KING ST N",
      "streetType": 490,
      "streetDirection": 2,
      "cityTown": "HARRISTON",
      "provinceCode": 50,
      "postalCode": "N0G1Z0",
      "countryCode": 1
    }
  },
  "credentials": {
    "memberNumber": "9999999999",
    "securityCode": "99",
    "customerCode": "X999"
  },
  "unitId": "XDTB",
  "posSystem": "100"
}
Name In Type Description
body Request
GetCreditBureauEquifax

Request

GetCreditBureauEquifax

Name Type Description
unitId required string min-length(1) Unit Id (see Authorization)
posSystem required string min-length(1) max-length(10) PoS System (see Authorization)
bureauLanguage Language
Enums
 Language
clientReference nullable string max-length(12) ^[\s\S]*\S[\s\S]*$ Client reference
requestorName nullable string max-length(50) ^[\s\S]*\S[\s\S]*$ Requestor name
customer required Customer
GetCreditBureauEquifax > Request
 Customer
credentials required Credentials
GetCreditBureauEquifax > Request
 Equifax credentials

Customer

GetCreditBureauEquifax > Request

Name Type Description
dateBirth nullable string(date) Date of birth
lastName required string min-length(1) max-length(40) Last name
firstName required string min-length(1) max-length(30) First name
middleName nullable string max-length(15) ^[\s\S]*\S[\s\S]*$ Middle name
suffix nullable string max-length(2) ^[\s\S]*\S[\s\S]*$ Suffix
sin nullable string max-length(9) ^[\s\S]*\S[\s\S]*$ Social insurance number
address required Address
GetCreditBureauEquifax > Request
 Address (Canada)

Address

GetCreditBureauEquifax > Request

Name Type Description
unitNumber nullable string max-length(10) Unit number
streetNumber nullable string max-length(10) Street number
streetName nullable string max-length(26) Street name
streetType StreetTypeCode
Enums
 Street type code
streetDirection StreetDirectionCode
Enums
 Street direction code
poBoxRRNumber nullable string max-length(40) PO box/RR number
cityTown required string min-length(1) max-length(40) City/town (municipality)
provinceCode ProvinceStateCodeCanada
Enums
 Province code (Canada)
postalCode required string max-length(10) Postal code
countryCode required CountryCode
Enums
 Country code

Credentials

GetCreditBureauEquifax > Request

Name Type Description
memberNumber required string min-length(1) max-length(10) Member number
securityCode required string min-length(1) max-length(2) Security code
customerCode required string min-length(1) max-length(4) Customer code

Responses

Sample Response

200 Response

{
  "report": {
    "rawData": {
      "reportDate": "2022-07-12T10:43:14",
      "format": "FFF",
      "creditScore": 695,
      "value": "FULL0027261387  9999999999033EIE  1030320000403202207152022LANE..."
    },
    "text": "USER REF. UTESTER           THIS FORM PRODUCED BY EQUIFAX C.I.S.       P   1...",
    "xmlData": "<?xml version=\"1.0\" encoding=\"UTF-8\"?><EfxTransmit><EfxReport requestNumber=\"1\" reportId=\"CNCONSUMERCREDITFILE\"><CNConsumerCreditReports>...</CNConsumerCreditReports></EfxReport></EfxTransmit>"
  },
  "status": "ok"
}
Status Schema
200 OK GetCreditBureauEquifax > Response

Response

GetCreditBureauEquifax

Name Type Description
error nullable array(ServiceError) List of errors
status required ResponseStatus
Enums
report Report
GetCreditBureauEquifax > Response
 Credit bureau report (Equifax)

Report

GetCreditBureauEquifax > Response

Name Type Description
rawData RawData
GetCreditBureauEquifax > Response
 Raw Data
text nullable string ^[\s\S]*\S[\s\S]*$ Text report
xmlData nullable string ^[\s\S]*\S[\s\S]*$ XML data (with PDF)

RawData

GetCreditBureauEquifax > Response

Name Type Description
reportDate nullable string(date-time) Report date
format CreditReportRawDataFormat
Enums
 Credit report raw data format
noHit nullable boolean No hit?
creditScore nullable integer(int32) Credit score
value nullable string Credit report text

Credit Bureau (TransUnion)

POST https://api-link.newton.ca/v1/credit-bureau/transunion

Creates a credit bureau report (for TransUnion)

Parameters

Sample Request

{
  "unitId": "string",
  "posSystem": "string",
  "clientReference": "string",
  "requestorName": "string",
  "customer": {
    "dateBirth": "2019-08-24",
    "lastName": "string",
    "firstName": "string",
    "middleName": "string",
    "suffix": "st",
    "sin": "string",
    "address": {
      "unitNumber": "string",
      "streetNumber": "string",
      "streetName": "string",
      "poBoxRRNumber": "string",
      "cityTown": "string",
      "postalCode": "string"
    }
  },
  "credentials": {
    "memberCode": "string",
    "password": "string"
  }
}
Name In Type Description
body Request
GetCreditBureauTransUnion

Request

GetCreditBureauTransUnion

Name Type Description
unitId required string min-length(1) Unit Id (see Authorization)
posSystem required string min-length(1) max-length(10) PoS System (see Authorization)
bureauLanguage Language
Enums
 Language
clientReference nullable string max-length(12) ^[\s\S]*\S[\s\S]*$ Client reference
requestorName nullable string max-length(50) ^[\s\S]*\S[\s\S]*$ Requestor name
customer required Customer
GetCreditBureauTransUnion > Request
 Primary customer
credentials required Credentials
GetCreditBureauTransUnion > Request
 TransUnion credentials

Customer

GetCreditBureauTransUnion > Request

Name Type Description
dateBirth nullable string(date) Date of birth
lastName required string min-length(1) max-length(40) Last name
firstName required string min-length(1) max-length(30) First name
middleName nullable string max-length(15) ^[\s\S]*\S[\s\S]*$ Middle name
suffix nullable string max-length(2) ^[\s\S]*\S[\s\S]*$ Suffix
sin nullable string max-length(9) ^[\s\S]*\S[\s\S]*$ Social insurance number
address required Address
GetCreditBureauTransUnion > Request
 Address (Canada)

Address

GetCreditBureauTransUnion > Request

Name Type Description
unitNumber nullable string max-length(10) Unit number
streetNumber nullable string max-length(10) Street number
streetName nullable string max-length(26) Street name
streetType StreetTypeCode
Enums
 Street type code
streetDirection StreetDirectionCode
Enums
 Street direction code
poBoxRRNumber nullable string max-length(40) PO box/RR number
cityTown required string min-length(1) max-length(40) City/town (municipality)
provinceCode ProvinceStateCodeCanada
Enums
 Province code (Canada)
postalCode required string ^[A-Za-z][0-9][A-Za-z][ ]?[0-9][A-Za-z][0-9]$ Postal code
countryCode required CountryCode
Enums
 Country code

Credentials

GetCreditBureauTransUnion > Request

Name Type Description
memberCode required string min-length(1) max-length(100) Member code
password required string min-length(1) max-length(100) Password

Responses

Sample Response

{}
Status Schema
200 OK GetCreditBureauTransUnion > Response

Response

GetCreditBureauTransUnion

Name Type Description
error nullable array(ServiceError) List of errors
status required ResponseStatus
Enums
report Report
GetCreditBureauTransUnion > Response
 Credit bureau report (TransUnion)

Report

GetCreditBureauTransUnion > Response

Name Type Description
rawData RawData
GetCreditBureauTransUnion > Response
 Raw Data
text nullable string ^[\s\S]*\S[\s\S]*$ Text report

RawData

GetCreditBureauTransUnion > Response

Name Type Description
reportDate nullable string(date-time) Report date
format CreditReportRawDataFormat
Enums
 Credit report raw data format
noHit nullable boolean No hit?
creditScore nullable integer(int32) Credit score
value nullable string Credit report text

Submit Life Insurance

POST https://api-link.newton.ca/v1/life-insurance

Submit Life Insraunce allows the submission of a Life Insurance request to MPP.

Parameters

Sample Request

{
  "commonData": {
    "addressList": {
      "applicationAddressCanada": [
        {
          "key": "address-1",
          "cityTown": "Toronto",
          "provinceCode": 50,
          "postalCode": "M5J2S2",
          "countryCode": 1,
          "streetNumber": "77",
          "streetName": "Harbour",
          "streetType": 490
        },
        {
          "key": "address-2",
          "cityTown": "Ancaster",
          "provinceCode": 50,
          "postalCode": "L9G3Z8",
          "countryCode": 1,
          "streetNumber": "65",
          "streetName": "Terrence Park",
          "streetType": 190
        }
      ]
    }
  },
  "customerData": {
    "customerList": {
      "customerPrimaryBorrower": {
        "key": "borrower-1",
        "correspondenceLanguage": 1,
        "dateOfBirth": "1960-09-09",
        "lastName": "Merit",
        "firstName": "Kyle",
        "emailAddress": "merit.kyle@gmail.com"
      }
    },
    "customerAddressList": [
      {
        "type": "CustomerAddressPrimaryResidence",
        "customerReference": [
          {
            "refkeyCustomer": "borrower-1"
          }
        ],
        "refkeyAddress": "address-1",
        "addressOccupancyTenant": {}
      }
    ]
  },
  "mortgageApplication": {
    "subjectProperty": {
      "subjectPropertyOccupancyOwnerOccupied": {},
      "propertyTax": {
        "annualTaxAmount": 2500
      },
      "subjectPropertyAddress": {
        "refkeyAddress": "address-2"
      }
    },
    "loan": {
      "loanAmount": 400000,
      "loanType": 0,
      "chargeType": 1,
      "termMonths": 48,
      "amortizationMonths": 300,
      "netRate": 4.36,
      "acceleratedPayment": false,
      "paymentAmount": 2182.87,
      "paymentFrequency": 12,
      "lenderName": "Newton Leading Edge II"
    },
    "isPreapproval": false,
    "fundingDate": "2022-09-23",
    "applicationNumber": "VXDTB32622"
  },
  "lifeInsurerApplication": {
    "lifeInsurerCompany": 3,
    "quoteOnly": false
  },
  "firm": {
    "firmId": "XDTB",
    "name": "Test Brokerage"
  },
  "agent": {
    "userId": "kpoulin100",
    "firstName": "Karen",
    "lastName": "Poulin",
    "emailAddress": "karen.poulin@newton.ca"
  },
  "unitId": "XDTB",
  "posSystem": "100"
}
Name In Type Description
body Request
SubmitLifeInsurance

Request

SubmitLifeInsurance

Name Type Description
unitId required string min-length(1) Unit Id (see Authorization)
posSystem required string min-length(1) max-length(10) PoS System (see Authorization)
commonData required CommonData
SubmitLifeInsurance > Request
 Common date
customerData required CustomerData
SubmitLifeInsurance > Request
 Customer data
mortgageApplication required MortgageApplication
SubmitLifeInsurance > Request
 Mortgage application
lifeInsurerApplication required LifeInsurerApplication
SubmitLifeInsurance > Request
 Life insurer application
firm required Firm
SubmitLifeInsurance > Request
 Firm
agent required Agent
SubmitLifeInsurance > Request
 Agent

CommonData

SubmitLifeInsurance > Request

Name Type Description
addressList AddressList
SubmitLifeInsurance > Request
 Address list

AddressList

SubmitLifeInsurance > Request

Name Type Description
applicationAddressCanada nullable array(ApplicationAddressCanada)
SubmitLifeInsurance > Request
 Application address (Canada)
applicationAddressUSA nullable array(ApplicationAddressUSA)
SubmitLifeInsurance > Request
 Application address (USA)

ApplicationAddressCanada

SubmitLifeInsurance > Request

Name Type Description
unitNumber nullable string max-length(10) Unit number
streetNumber nullable string max-length(10) Street number
streetName nullable string max-length(26) Street name
streetType StreetTypeCode
Enums
 Street type code
streetDirection StreetDirectionCode
Enums
 Street direction code
cityTown nullable string max-length(40) City/town (municipality)
provinceCode ProvinceStateCode
Enums
 Province state code
postalCode nullable string max-length(10) Postal code
countryCode CountryCode
Enums
 Country code
key nullable string max-length(255) Address key (see Refkeys)

ApplicationAddressUSA

SubmitLifeInsurance > Request

Name Type Description
unitNumber nullable string max-length(10) Unit number
streetNumber nullable string max-length(10) Street number
streetName nullable string max-length(26) Street name
streetType StreetTypeCode
Enums
 Street type code
streetDirection StreetDirectionCode
Enums
 Street direction code
cityTown nullable string max-length(40) City/town (municipality)
provinceCode ProvinceStateCode
Enums
 Province state code
postalCode nullable string max-length(10) Postal code
countryCode CountryCode
Enums
 Country code
key nullable string max-length(255) Address key (see Refkeys)

CustomerData

SubmitLifeInsurance > Request

Name Type Description
customerList CustomerList
SubmitLifeInsurance > Request
 Customer list
customerAddressList nullable array(CustomerAddressPrimaryResidence)
SubmitLifeInsurance > Request
 Customer address list

CustomerList

SubmitLifeInsurance > Request

Name Type Description
customerPrimaryBorrower Customer
SubmitLifeInsurance > Request
 Customer
customerBorrower nullable array(Customer) max-items(4)
SubmitLifeInsurance > Request
 Customer borrower
customerGuarantor nullable array(Customer) max-items(4)
SubmitLifeInsurance > Request
 Customer guarantor

Customer

SubmitLifeInsurance > Request

Name Type Description
customerTelephoneNumberList nullable array(CustomerTelephoneNumber)
SubmitLifeInsurance > Request
 [Customer telephone number]
customerRelationship CustomerRelationship
SubmitLifeInsurance > Request
 Customer relationship
key nullable string max-length(255)
correspondenceLanguage CorrespondenceLangugageType
Enums
 Correspondence langugage type
dateOfBirth nullable string(date)
honorific HonorificType
Enums
 Title
lastName required string min-length(1) max-length(40)
firstName required string min-length(1) max-length(30)
middleName nullable string max-length(30)
emailAddress nullable string

CustomerTelephoneNumber

SubmitLifeInsurance > Request

Name Type Description
telephoneNumber TelephoneNumber
SubmitLifeInsurance > Request
 Telephone number
usage TelephoneUsageType
Enums
 Telephone usage type

TelephoneNumber

SubmitLifeInsurance > Request

Name Type Description
countryCode nullable string max-length(1) Country code
areaCode nullable string max-length(5) Area code
phoneNumber nullable string max-length(30) Phone number
phoneExtension nullable string max-length(8) Phone extension

CustomerRelationship

SubmitLifeInsurance > Request

Name Type Description
relationshipToOwnerType ApplicantRelationship
Enums
 Applicant relationship

CustomerAddressPrimaryResidence

SubmitLifeInsurance > Request

Name Type Description
type nullable string Type
customerReference nullable array(CustomerReference)
SubmitLifeInsurance > Request
 Customer reference
refkeyAddress nullable string max-length(255) Address key (see Refkeys)
addressOccupancyNone Empty object Address occupancy - None
addressOccupancyOwnerOccupied Empty object Address occupancy - Owner occupied
addressOccupancyPartialOwnerOccupied Empty object Address occupancy - Partial owner occupied
addressOccupancyRental Empty object Address occupancy - Rental
addressOccupancyTenant Empty object Address occupancy - Tenant

CustomerReference

SubmitLifeInsurance > Request

Name Type Description
refkeyCustomer nullable string max-length(255) Customer key (see Refkeys)

MortgageApplication

SubmitLifeInsurance > Request

Name Type Description
applicationNumber nullable string Application number
brokerRefNumber nullable string Broker reference number
subjectProperty SubjectProperty
SubmitLifeInsurance > Request
 Subject property
loan Loan
SubmitLifeInsurance > Request
 Loan
isPreapproval boolean Is pre-approval?
fundingDate nullable string(date) Funding date

SubjectProperty

SubmitLifeInsurance > Request

Remarks

  • Only one of subjectPropertyOccupancyOwnerOccupied, subjectPropertyOccupancyPartialOwnerOccupied, subjectPropertyOccupancyRental or subjectPropertyOccupancySecondHome may be provided
Name Type Description
subjectPropertyOccupancyOwnerOccupied Empty object Subject property occupancy - Owner Occuped
subjectPropertyOccupancyPartialOwnerOccupied Empty object Subject property occupancy - Partial Owner Occupied
subjectPropertyOccupancyRental Empty object Subject property occupancy - Rental
propertyTax PropertyTax
SubmitLifeInsurance > Request
 Property tax
subjectPropertyAddress SubjectPropertyAddress
SubmitLifeInsurance > Request
 Subject property address

PropertyTax

SubmitLifeInsurance > Request

Name Type Description
annualTaxAmount nullable number(double) range(0,999999999.99) Annual tax amount
taxesPaidBy PropertyTaxPayor
Enums
 Property tax payor

SubjectPropertyAddress

SubmitLifeInsurance > Request

Name Type Description
refkeyAddress nullable string max-length(255) Address key (see Refkeys)

Loan

SubmitLifeInsurance > Request

Name Type Description
product Product
SubmitLifeInsurance > Request
 Product
loanAmount nullable number(double) range(0,9999999.99) Loan amount
loanType LoanType
Enums
 Loan type
chargeType ChargeType
Enums
 Charge type
termMonths nullable integer(int32) Term (months)
amortizationMonths nullable integer(int32) Amortization (months)
netRate nullable number(double) Net rate
acceleratedPayment boolean Accelerated payment
paymentAmount nullable number(double) range(0,999999.99) Payment amount
paymentFrequency PaymentFrequency
Enums
 Payment frequency
lenderName nullable string Lender name

Product

SubmitLifeInsurance > Request

Name Type Description
adjustment nullable number(double) range(-999.99,999.99) Adjustment
buydown nullable number(double) range(-999.99,999.99) Buydown
postedRate nullable number(double) range(0,999.99) Posted rate
rateType RateType
Enums
 Rate type

LifeInsurerApplication

SubmitLifeInsurance > Request

Name Type Description
lifeInsurerCompany required LifeInsurerCompany
Enums
 Life insurer company
quoteOnly nullable boolean Quote only?

Firm

SubmitLifeInsurance > Request

Name Type Description
firmId required string min-length(1) max-length(50) Firm Id
name nullable string Firm name

Agent

SubmitLifeInsurance > Request

Name Type Description
userId required string min-length(1) max-length(10) User Id
firstName nullable string First name
lastName nullable string Last name
emailAddress nullable string Email address

Responses

Sample Response

200 Response

{
  "lifeInsuranceApplication": [
    {
      "customer": [
        {
          "quote": {
            "premiumPaymentFrequency": 26,
            "lifeInsurancePremium": 161.19,
            "disabilityInsurancePremium": 104.23
          },
          "order": 1,
          "eligibleForLifeInsurance": true,
          "eligibleForDisabilityInsurance": true,
          "totalDIBenefitMonthly": 2391.2,
          "firstName": "Kyle",
          "lastName": "Merit",
          "birthDate": "1960-09-09"
        }
      ],
      "referenceNumber": "1D113K29KH5M1"
    }
  ],
  "status": "ok"
}
Status Schema
200 OK SubmitLifeInsurance > Response

Response

SubmitLifeInsurance

Name Type Description
error nullable array(ServiceError) List of errors
status required ResponseStatus
Enums
lifeInsuranceApplication nullable array(LifeInsuranceApplication)
SubmitLifeInsurance > Response
 Life insurance application list
document Document
SubmitLifeInsurance > Response
 Document
info nullable array(Info)
SubmitLifeInsurance > Response
 Informational messages

LifeInsuranceApplication

SubmitLifeInsurance > Response

Name Type Description
customer nullable array(Customer)
SubmitLifeInsurance > Response
 List of customers
referenceNumber nullable string Reference number
onlineLink nullable string Online link

Customer

SubmitLifeInsurance > Response

Name Type Description
quote Quote
SubmitLifeInsurance > Response
 Quote
eSign ESign
SubmitLifeInsurance > Response
 ESign
order nullable integer(int32) Order
eligibleForLifeInsurance nullable boolean Eligible for life insurance
eligibleForDisabilityInsurance nullable boolean Eligible for disability insurance
totalDIBenefitMonthly nullable number(double) Total DI benefit monthly
firstName nullable string First name
lastName nullable string Last name
birthDate nullable string(date) Date of birth

Quote

SubmitLifeInsurance > Response

Name Type Description
premiumPaymentFrequency PaymentFrequency
Enums
 Payment frequency
lifeInsurancePremium nullable number(double) Life insurance premium
disabilityInsurancePremium nullable number(double) Disability insurance premium

ESign

SubmitLifeInsurance > Response

Name Type Description
signature nullable array(Signature)
SubmitLifeInsurance > Response
 Signature placeholders
initials nullable array(Initials)
SubmitLifeInsurance > Response
 Initials placeholders
date nullable array(Date)
SubmitLifeInsurance > Response
 Date placeholders
text nullable array(Text)
SubmitLifeInsurance > Response
 Text placeholders
checkbox nullable array(Checkbox)
SubmitLifeInsurance > Response
 Checkbox placeholders
radioGroup nullable array(RadioGroup)
SubmitLifeInsurance > Response
 Radio group placeholders

Signature

SubmitLifeInsurance > Response

Name Type Description
id nullable string Placeholder identifier
page nullable integer(int32) Page
topLeftX nullable integer(int32) Top left X
topLeftY nullable integer(int32) Top left Y
bottomRightX nullable integer(int32) Bottom right X
bottomRightY nullable integer(int32) Bottom right Y

Initials

SubmitLifeInsurance > Response

Name Type Description
id nullable string Placeholder identifier
page nullable integer(int32) Page
topLeftX nullable integer(int32) Top left X
topLeftY nullable integer(int32) Top left Y
bottomRightX nullable integer(int32) Bottom right X
bottomRightY nullable integer(int32) Bottom right Y
group nullable string Initials group
optional nullable boolean Initials optional flag

Date

SubmitLifeInsurance > Response

Name Type Description
id nullable string Placeholder identifier
page nullable integer(int32) Page
topLeftX nullable integer(int32) Top left X
topLeftY nullable integer(int32) Top left Y
bottomRightX nullable integer(int32) Bottom right X
bottomRightY nullable integer(int32) Bottom right Y

Text

SubmitLifeInsurance > Response

Name Type Description
id nullable string Placeholder identifier
page nullable integer(int32) Page
topLeftX nullable integer(int32) Top left X
topLeftY nullable integer(int32) Top left Y
bottomRightX nullable integer(int32) Bottom right X
bottomRightY nullable integer(int32) Bottom right Y

Checkbox

SubmitLifeInsurance > Response

Name Type Description
id nullable string Placeholder identifier
page nullable integer(int32) Page
topLeftX nullable integer(int32) Top left X
topLeftY nullable integer(int32) Top left Y
bottomRightX nullable integer(int32) Bottom right X
bottomRightY nullable integer(int32) Bottom right Y

RadioGroup

SubmitLifeInsurance > Response

Name Type Description
id nullable string Placeholder identifier
page nullable integer(int32) Page
topLeftX nullable integer(int32) Top left X
topLeftY nullable integer(int32) Top left Y
bottomRightX nullable integer(int32) Bottom right X
bottomRightY nullable integer(int32) Bottom right Y
group nullable string Radio group name

Document

SubmitLifeInsurance > Response

Name Type Description
contents nullable string Contents
dimensions Dimensions
SubmitLifeInsurance > Response
 Dimensions
formId nullable string Form Id
fileName nullable string File name
encoding nullable string Encoding
mimeType nullable string Mime type

Dimensions

SubmitLifeInsurance > Response

Name Type Description
width nullable integer(int32) Width
height nullable integer(int32) Height

Info

SubmitLifeInsurance > Response

Name Type Description
code nullable string Code
message nullable string Message

Get Life Insurance Status

POST https://api-link.newton.ca/v1/life-insurance-status

Gets a list of unackowndleged life insurer application statuses.

Parameters

Sample Request

{
  "lifeInsurerApplication": {
    "lifeInsurerCompany": 3,
    "referenceNumber": "1D113K29KH5M1"
  },
  "firm": {
    "firmId": "XDTB",
    "name": "Test Brokerage"
  },
  "unitId": "XDTB",
  "posSystem": "100"
}
Name In Type Description
body Request
GetLifeInsuranceStatus

Request

GetLifeInsuranceStatus

Name Type Description
unitId required string min-length(1) Unit Id (see Authorization)
posSystem required string min-length(1) max-length(10) PoS System (see Authorization)
mortgageApplication MortgageApplication
GetLifeInsuranceStatus > Request
 Mortgage application
lifeInsurerApplication LifeInsurerApplication
GetLifeInsuranceStatus > Request
 Life insurer application
firm Firm
GetLifeInsuranceStatus > Request
 Firm

MortgageApplication

GetLifeInsuranceStatus > Request

Name Type Description
loan Loan
GetLifeInsuranceStatus > Request
 Loan
applicationNumber nullable string

Loan

GetLifeInsuranceStatus > Request

Name Type Description
loanType LoanType
Enums
 Loan type
chargeType ChargeType
Enums
 Charge type

LifeInsurerApplication

GetLifeInsuranceStatus > Request

Name Type Description
lifeInsurerCompany required LifeInsurerCompany
Enums
 Life insurer company
referenceNumber nullable string

Firm

GetLifeInsuranceStatus > Request

Name Type Description
firmId nullable string
name nullable string

Responses

Sample Response

200 Response

{
  "lifeInsuranceApplication": [
    {
      "lifeInsurerCompany": 3,
      "referenceNumber": "1D113K29KH5M1",
      "status": "Waived",
      "statusDate": "2022-05-27T11:16:52"
    },
    {
      "lifeInsurerCompany": 3,
      "referenceNumber": "2M143D29LH9A2",
      "status": "Waived",
      "statusDate": "2022-05-29T17:44:02"
    }
  ],
  "status": "ok"
}
Status Schema
200 OK GetLifeInsuranceStatus > Response

Response

GetLifeInsuranceStatus

Name Type Description
error nullable array(ServiceError) List of errors
status required ResponseStatus
Enums
lifeInsuranceApplication nullable array(LifeInsuranceApplication)
GetLifeInsuranceStatus > Response

LifeInsuranceApplication

GetLifeInsuranceStatus > Response

Name Type Description
indemnificationCertificate nullable string
lifeInsurerCompany LifeInsurerCompany
Enums
 Life insurer company
referenceNumber nullable string
status nullable string
statusDate nullable string(date-time)

Ack Life Insurance Status

POST https://api-link.newton.ca/v1/life-insurance-status/acknowledgement

After an application is sent to life insurer and status of the application is retrieved, this operation is made to acknowledge the application status.

Parameters

Sample Request

{
  "lifeInsuranceApplication": [
    {
      "lifeInsurerCompany": 3,
      "referenceNumber": "1D113K29KH5M1",
      "statusDate": "2022-05-27T11:16:52"
    }
  ],
  "firm": {
    "firmId": "XDTB",
    "name": "Test Brokerage"
  },
  "unitId": "XDTB",
  "posSystem": "100"
}
Name In Type Description
body Request
AckLifeInsuranceStatus

Request

AckLifeInsuranceStatus

Name Type Description
unitId required string min-length(1) Unit Id (see Authorization)
posSystem required string min-length(1) max-length(10) PoS System (see Authorization)
lifeInsuranceApplication nullable array(LifeInsuranceApplication)
AckLifeInsuranceStatus > Request
 [Life insurance application]
firm Firm
AckLifeInsuranceStatus > Request
 Firm

LifeInsuranceApplication

AckLifeInsuranceStatus > Request

Name Type Description
lifeInsurerCompany required LifeInsurerCompany
Enums
 Life insurer company
referenceNumber nullable string
statusDate nullable string(date-time)

Firm

AckLifeInsuranceStatus > Request

Name Type Description
firmId nullable string
name nullable string

Responses

Sample Response

200 Response

{
  "status": "ok"
}
Status Schema
200 OK AckLifeInsuranceStatus > Response

Response

AckLifeInsuranceStatus

Name Type Description
error nullable array(ServiceError) List of errors
status required ResponseStatus
Enums

Property Valuation

POST https://api-link.newton.ca/v1/valuations

Provides a various operations for a given property address:

Parameters

Sample Request

{
  "propertyAddress": {
    "streetNumber": "175",
    "street": "Main",
    "streetType": 490,
    "streetDirection": 8,
    "cityTown": "Toronto",
    "provinceCode": 50,
    "postalCode": "A1A1A1"
  },
  "requestor": {
    "brokerageFirm": "Tester Brokerage",
    "brokerName": "Unit Tester"
  },
  "unitId": "XDTB",
  "posSystem": "100"
}
Name In Type Description
body Request
PropertyValuation

Request

PropertyValuation

Name Type Description
unitId required string min-length(1) Unit Id (see Authorization)
posSystem required string min-length(1) max-length(10) PoS System (see Authorization)
propertyAddress PropertyAddress
PropertyValuation > Request
 Address details
requestor Requestor
PropertyValuation > Request
applicant Applicant
PropertyValuation > Request
 Details of a primary applicant. (Insurance referral only)
policy Policy
PropertyValuation > Request
 Policy. (Insurance referral only)
constructionFeaturesResidential ConstructionFeaturesResidential
PropertyValuation > Request
 Construction features of residential building, ie. house. (Insurance referral only)
constructionFeaturesMultiResidential ConstructionFeaturesMultiResidential
PropertyValuation > Request
 Construction features of multi-residential building, ie. condominimum. (Insurance referral only)
posUserId nullable string User Id (PoS user)
requestId nullable string Request Id
valuation nullable boolean Valuation? If true, the residential market value for the property is requested
prefill nullable boolean Prefill? If true, residential property information is requested
search nullable boolean Search? If true, address search is performed
imagery nullable boolean Imagery? If true, building imagery is requested
report nullable boolean Report? If true, URL of a PDF report with financial residential property information is requested. If used along with "Estimate" flag, the PDF will contain market value information also.
estimate nullable boolean Estimate? If true, Estimate for a market value of a given property is requested
insuranceReferral nullable boolean Insurance referral? If true, insurance referral is submitted
(Important: cannot be combined with any other operations)

PropertyAddress

PropertyValuation > Request

Name Type Description
addressId nullable string Address Id
optaAddressKey nullable string Opta address key
streetNumber nullable string max-length(10) Street number
street nullable string max-length(200) Street Name (100-char) or Full Street Address (200-char)
The value will be treated as a Full Street Address only if all four other related attributes are not specified:
UnitNumber, StreetNumber, StreetType, StreetDirection
streetType StreetTypeCode
Enums
 Street type code
streetDirection StreetDirectionCode
Enums
 Street direction code
unitNumber nullable string max-length(10) Unit number
cityTown nullable string max-length(100) City/town
provinceCode ProvinceStateCodeCanada
Enums
 Province code (Canada)
postalCode nullable string ^[A-Za-z][0-9][A-Za-z][ ]?[0-9][A-Za-z][0-9]$ Postal code

Requestor

PropertyValuation > Request

Name Type Description
brokerageFirm nullable string Brokerage firm name
brokerName nullable string Broker/Agent Name
dealNumber nullable string Deal(Mortage Application) Number related to this transaction
If specified for "Report" operation, the value will be presented on the generated PDF report

Applicant

PropertyValuation > Request

Name Type Description
firstName nullable string First name
lastName nullable string Last name
birthDate nullable string(date) Date of birth
gender Sex
Enums
 Sex
maritalStatus MaritalStatusType
Enums
 Marital status type
mailingAddress MailingAddress
PropertyValuation > Request
 Address details
contact Contact
PropertyValuation > Request

MailingAddress

PropertyValuation > Request

Name Type Description
addressId nullable string AddressId. If provided, the same value will be returned in response
optaAddressKey nullable string Opta address key
streetNumber nullable string max-length(10) Street number
street nullable string max-length(200) Street Name (100-char) or Full Street Address (200-char)
The value will be treated as a Full Street Address only if all four other related attributes are not specified:
UnitNumber, StreetNumber, StreetType, StreetDirection
streetType StreetTypeCode
Enums
 Street type code
streetDirection StreetDirectionCode
Enums
 Street direction code
unitNumber nullable string max-length(10) Unit number in a building
cityTown nullable string max-length(100) City/town
provinceCode ProvinceStateCode
Enums
 Province state code
postalCode nullable string *^([A-Za-z][0-9][A-Za-z][ ]?[0-9][A-Za-z][0-9]) ([0-9]{5}([-][0-9]{4})?)$*

Contact

PropertyValuation > Request

Name Type Description
phoneWork nullable string Work phone
phoneCell nullable string Mobile phone
phoneHome nullable string Home phone
email nullable string Email
preferredContactMethod PreferredContactMethod
PropertyValuation > Enums

Policy

PropertyValuation > Request

Name Type Description
consentInsurance nullable boolean Insurance consent?
consentInsuranceDate nullable string(date) Insurance consent given date
occupancyType OccupancyType
PropertyValuation > Enums
existingMortgages nullable boolean True, if other existing mortgages are still outstanding agaist the Property
fundingDate nullable string(date) Funding (closing) date on the deal
vacantHome nullable boolean Vacant home?
commercialActivity nullable boolean Commercial activity?
historicalHome nullable boolean Historical home?
underConstruction nullable boolean Under construction?
currentInsuranceCoverage nullable boolean Current insurance coverage exists?
currentInsuranceRenewalDate nullable string(date) Current insurance renewal date

ConstructionFeaturesResidential

PropertyValuation > Request

Name Type Description
yearBuilt nullable string ^\d{4}$ Year built
squareFootage nullable integer(int32) range(0,999999999999) The above grade area of the house (in square feet)
foundationType FoundationType
PropertyValuation > Enums
architecturalStyleType ArchitecturalStyleType
PropertyValuation > EnumsHouse
storeyCount StoreyCountType
PropertyValuation > EnumsHouse
kitchenCount ResidentialKitchenCountType
PropertyValuation > Enums
bathroomCount ResidentialBathroomCountType
PropertyValuation > Enums
exteriorWallType ExteriorWallType
PropertyValuation > EnumsHouse
roofSurfaceType RoofSurfaceType
PropertyValuation > EnumsHouse
finishedBasement nullable boolean Finished basement?
garageType GarageType
PropertyValuation > Enums
garageNumberOfCars GarageNumberOfCarsType
PropertyValuation > Enums
swimmingPoolType SwimmingPoolType
PropertyValuation > Enums
primaryHeatingType PrimaryHeatingType
PropertyValuation > EnumsHouse
auxiliaryHeatingType AuxiliaryHeatingType
PropertyValuation > Enums
plumbingType PlumbingType
PropertyValuation > EnumsHouse
commercialIndicator nullable boolean Commercial usage?
outbuildingPresent BooleanWithUnknownType
PropertyValuation > Enums
numberOfBedrooms nullable integer(int32) range(0,999999999999) Number of bedrooms
lotSize nullable integer(int32) range(0,999999999999) Lot size (in square feet)
sewageType SewageType
PropertyValuation > Enums
waterType WaterType
PropertyValuation > Enums

ConstructionFeaturesMultiResidential

PropertyValuation > Request

Name Type Description
propertyType PropertyTypeMultiResidential
PropertyValuation > EnumsCondo
yearBuilt nullable string ^\d{4}$ Year built
squareFootage nullable integer(int32) range(0,999999999999) The total floor area (in square feet)
architecturalStyleType ArchitecturalStyleTypeMultiResidential
PropertyValuation > EnumsCondo
storeyCount nullable integer(int32) range(0,999999999999) Number of building storeys in multi-residential building
kitchenCount ResidentialKitchenCountType
PropertyValuation > Enums
bathroomCount ResidentialBathroomCountType
PropertyValuation > Enums
exteriorWallType ExteriorWallTypeMultiResidential
PropertyValuation > EnumsCondo
roofSurfaceType RoofSurfaceTypeMultiResidential
PropertyValuation > EnumsCondo
garageNumberOfCars GarageNumberOfCarsType
PropertyValuation > Enums
primaryHeatingType PrimaryHeatingTypeMultiResidential
PropertyValuation > EnumsCondo
plumbingType PlumbingTypeMultiResidential
PropertyValuation > EnumsCondo
commercialIndicator nullable boolean Commercial usage?
numberOfBedrooms nullable integer(int32) range(0,999999999999) Number of bedrooms
sewageType SewageType
PropertyValuation > Enums
waterType WaterType
PropertyValuation > Enums
numberOfDens nullable integer(int32) range(0,999999999999) Number of dens
parkingType ParkingType
PropertyValuation > Enums
floorLevel nullable integer(int32) range(0,999999999999) Floor level of multi-residential unit

Responses

Sample Response

200 Response

{
  "address": {
    "optaAddressKey": "0d10cdffc001080a",
    "streetNumber": "175",
    "streetName": "Main",
    "streetType": 490,
    "streetDirection": 8,
    "cityTown": "Toronto",
    "provinceCode": 50,
    "postalCode": "A1A1A1"
  },
  "constructionFeatures": {
    "propertyType": "Condominium",
    "yearBuilt": "2015",
    "squareFootage": 875,
    "architecturalStyleType": "High Rise",
    "storeyCount": "11",
    "kitchenCount": "1",
    "bathroomCount": "1",
    "exteriorWallType": "Unknown",
    "garageNumberOfCars": "0",
    "primaryHeatingType": "Unknown",
    "plumbingType": "Unknown",
    "commercialIndicator": true,
    "numberOfBedrooms": 2,
    "sewageType": "Municipal",
    "waterType": "Municipal",
    "numberOfDens": 1,
    "parkingType": "Unknown"
  },
  "report": {
    "reportURL": "https://pdf.optaservice.com/175_Main_St_W_Toronto_ON_A1A1A1_2022-07-18_06:20:20.174508.pdf",
    "expiryDate": "2022-07-18",
    "description": "iClarify Condo Report"
  },
  "status": "ok"
}
Status Schema
200 OK PropertyValuation > Response

Response

PropertyValuation

Name Type Description
error nullable array(ServiceError) List of errors
status required ResponseStatus
Enums
address Address
PropertyValuation > Response
 Parsed address details for the property to which the rest of response data related to.
This is NOT applicable for "search" operation.
search nullable array(Address)
PropertyValuation > Response
 List of addresses returned by "search" operation.
This is applicable for "search" operation only
valuation Valuation
PropertyValuation > Response
 Property valuation informaation
This is applicable for "valuation" operation only
constructionFeatures ConstructionFeatures
PropertyValuation > Response
 Construction features details of the property
This is applicable for "prefill" operation only
imagery nullable array(Image)
PropertyValuation > Response
 List of Imagery information for the property
This is applicable for "imagery" operation only
report ReportType
PropertyValuation > Response
 Generated report for the property
This is applicable for "report" operation only
marketValue MarketValue
PropertyValuation > Response
 Estimated Market Value
This is applicable for "estimate" and "report" operations only
insuranceReferral InsuranceReferral
PropertyValuation > Response
 Insurance Referral response information
This is applicable for "insuranceReferral" operation only
requestId nullable string Request Id
In case of "report" operation RequestId may contain Requestor.DealNumber from corresponding request (if was specified there)

Address

PropertyValuation > Response

Name Type Description
legalDescription LegalDescription
PropertyValuation > Response
 Legal description of property address.
addressId nullable string Address Id (Not applicable to "search" operation)
propertyIdentificationNumber nullable string Property identification number - Unique provincial property identification number, e.g. PID in BC
optaAddressKey nullable string Opta address key
streetNumber nullable string Street number
streetName nullable string Streetn name of parsed address or full street address is the system was not able to parse it
If Full Street Address is returned here, all four other related attributes are not specified:
UnitNumber, StreetNumber, StreetType, StreetDirection
streetType nullable integer(int32) Street type
streetDirection nullable integer(int32) Street direction
unitNumber nullable string Unit number
cityTown nullable string City/town
provinceCode nullable integer(int32) Province code
postalCode nullable string Postal code

LegalDescription

PropertyValuation > Response

Name Type Description
unformattedLegalDescription nullable string Unformatted legal description - free formatted test string containing plan, block, lot, dominion land survey
quarter nullable string Quarter
section nullable string Section
township nullable string Township
range nullable string Range
meridian nullable string Meridian

Valuation

PropertyValuation > Response

Name Type Description
confidenceRating ConfidenceRating
PropertyValuation > Enums
valuationAmount nullable number(double) Valuation amount
valuationDate nullable string(date) Valuation date

ConstructionFeatures

PropertyValuation > Response

Name Type Description
propertyType PropertyType
PropertyValuation > Enums
yearBuilt nullable string Year built
squareFootage nullable integer(int32) Total Area of the property (in square feet)
For residential - The above grade area of the building
For multi-residential - The total floor area
foundationType FoundationType
PropertyValuation > Enums
architecturalStyleType ArchitecturalStyleType
PropertyValuation > Enums
storeyCount nullable string Number of building storeys.
For residential - Applicable options:

1
1.5
2
2.5
3
3.5
4
BiLevel
TriLevel
For multi-residential - any integer number
kitchenCount ResidentialKitchenCountType
PropertyValuation > Enums
bathroomCount ResidentialBathroomCountType
PropertyValuation > Enums
exteriorWallType ExteriorWallType
PropertyValuation > Enums
roofSurfaceType RoofSurfaceType
PropertyValuation > Enums
finishedBasement nullable boolean Presence of a finished basement. (Not applicable for multi-residential building)
garageType GarageType
PropertyValuation > Enums
garageNumberOfCars GarageNumberOfCarsType
PropertyValuation > Enums
swimmingPoolType SwimmingPoolType
PropertyValuation > Enums
primaryHeatingType PrimaryHeatingType
PropertyValuation > Enums
auxiliaryHeatingType AuxiliaryHeatingType
PropertyValuation > Enums
plumbingType PlumbingType
PropertyValuation > Enums
commercialIndicator nullable boolean Commercial usage?
outbuildingPresent BooleanWithUnknownType
PropertyValuation > Enums
numberOfBedrooms nullable integer(int32) Number of bedrooms
lotSize nullable integer(int32) Lot Size (in square feet). (Not applicable for multi-residential building)
sewageType SewageType
PropertyValuation > Enums
waterType WaterType
PropertyValuation > Enums
numberOfDens nullable integer(int32) Number of dens. (Applicable for multi-residential building only)
parkingType ParkingType
PropertyValuation > Enums
floorLevel nullable integer(int32) Floor level of multi-residential unit. (Applicable for multi-residential building only)

Image

PropertyValuation > Response

Name Type Description
id nullable string Image Id
imageExpiryDate nullable string(date-time) Image expiry date
imageURL nullable string Image URL
displayOrder nullable integer(int32) Suggested display order among list of images returned
imageTypeCode ResidentialImageryCode
PropertyValuation > Enums
providerCode ResidentialImageryProvider
PropertyValuation > Enums
bestPhoto nullable boolean Best photo?

ReportType

PropertyValuation > Response

Name Type Description
reportURL nullable string Report URL
expiryDate nullable string(date) Expiry date for a given report URL
description nullable string Additional description if applicable

MarketValue

PropertyValuation > Response

Name Type Description
lowRangeValue nullable integer(int32) Estimated Low Range Market Value
highRangeValue nullable integer(int32) Estimated High Range Market Value
date nullable string Date when the estimate was done

InsuranceReferral

PropertyValuation > Response

Name Type Description
referenceNumber nullable string Reference number for the submitted insurance referral

Enumerations

Enums.ApplicantRelationship

Applicant relationship

Values Description
1 Spouse
3 Unmarried Partner
4 Parent
6 Sibling
8 Child
10 Grandparent
12 Grandchild
14 Related Family Member
99 Other

Enums.ApplicationStatus

Application status

Values Description
10 New Application
15 New Quotation
20 Submitted
25 Partially Submitted
30 Decision Pending
40 Approved
45 Partially Approved
50 Cancelled
60 Declined
65 Partially Declined
70 Funded
75 Partially Funded
99 Archived

Enums.AreaMeasurementType

Area measurement type

Values Description
1 Square Feet
2 Square Metres

Enums.AssetOtherType

Asset other type

Values Description
10 Bank Account
20 Insurance Policy
30 RRSP
40 Vehicle
60 Investments
70 Mutual Fund/Stock/Bonds
71 Deposit on Purchase
72 Gift
73 Household Goods
99 Other

Enums.BuildingConstructionType

Building construction type

Values Description
10 Brick/Stone
20 Insulbrick
30 Stucco
40 Aluminum Siding
50 Vinyl Siding
99 Other

Enums.BusinessType

Business type

Values Description
10 Prime
20 Alternative

Enums.CanadaGuarantyServiceType

Canada Guaranty service type

Values Description
10 Basic
20 Full
99 Other

Enums.ChargeType

Charge type

Values Description
1 First Charge
2 Second Charge
3 Third Charge
4 Fourth Charge
99 Bridge

Enums.CMHCServiceType

CMHC service type

Values Description
10 Basic
20 Full
30 Basic - EE Rebate
40 Full - EE Rebate
50 Low Ratio
51 GVS
99 Other

Enums.ConditionStatus

Condition status

Values
Required
Received
Accepted
Unacceptable
Waived
Updated
Complete
Incomplete

Enums.ConditionType

Condition type

Values
Standard
Special
Lender
Lender Task
Documents
Down Payment
Fees
Income
Miscellaneous
Property
Special Conditions
Standard Terms & Conditions
Terms
Solicitor

Enums.ContactTelephoneUsageType

Contact telephone usage type

Values Description
10 Work
20 Fax
30 Home
40 Cell

Enums.CorrespondenceLangugageType

Correspondence langugage type

Values Description
1 English
2 French

Enums.CountryCode

Country code

Values Description
1 Canada
2 United States
99 Other

Enums.CreditCardType

Credit card type

Values Description
10 Visa
20 Mastercard
30 Amex
40 Store Cards
99 Other

Enums.CreditReportDataFormat

Credit report data format

Values
0H

Enums.CreditReportProvider

Credit report provider

Values
Equifax
TransUnion

Enums.CreditReportRawDataFormat

Credit report raw data format

Values
FFF
XML

Enums.CurrentPropertyIntendedAction

Current property intended action

Values Description
1 Selling
2 Not Selling
3 Not Selling - Renting

Enums.DocumentConditionType

Document condition type

Values Description
10 Standard
20 Special
30 Lender
50 Documents
60 Down Payment
70 Fees
80 Income
90 Miscellaneous
100 Property
110 Special Conditions
120 Standard Terms & Conditions
130 Terms
140 Solicitor
999 Other

Enums.DocumentType

Document type

Values Description
10 Pay Stub
20 Letter of Employment
30 T1 General
40 T 4
50 NOA
60 Stated Income Declaration
70 BFS Financials
80 Marital Agreements
90 Gift Letter
100 Bank Statements
110 Purchase Agreement
120 Costs
130 Mortgage Statement
140 Property Assessment
150 MLS Listing
160 Strata Form B
170 Strata/Condo Status Documents
180 Lease Agreement
190 Appraisal
200 Rental Worksheet
210 Property Tax
220 Opta Validation
230 Provincial Disclosures
240 PAD / Void Cheque
250 Commitment
260 Consent
270 Solicitor
999 Other

Enums.DownpaymentSourceType

Downpayment source type

Values Description
1 Cash from own Resources
2 RRSP
3 Borrowed against Liquid Assets
4 Gift
5 Sale of Other Property
8 Government Grant
9 Equity
10 Sweat Equity
11 Secondary Financing
99 Other

Enums.EarlyPayout

Early payout

Values Description
10 Open
20 Closed
30 Convertible

Enums.EarlyPayoutOptionType

Early payout option type

Values Description
10 Open
20 Closed
30 Convertible

Enums.EarnedIncomeType

Earned income type

Values Description
1 Basic Income
2 Overtime Income
3 Bonus
4 Commission
5 Interest/Dividends
6 Government Pension
7 Private Pension
8 Self-Employed
9 Salary
10 Hourly
11 Hourly + Commission
99 Other

Enums.EmploymentIndustryType

Employment industry type

Values Description
1 Construction
2 Government
3 Health
4 Education
5 Hi Tech
6 Retail Sales
7 Leisure/Entertainment
8 Banking/Finance
9 Transport
10 Services
11 Manufacturing
12 Farm/Natural Resources
99 Other

Enums.EmploymentOccupationType

Employment occupation type

Values Description
1 Manager
2 Clerical
3 Labourer/Tradesperson
4 Retired
5 Professional
6 Self-Employed
99 Other

Enums.EmploymentStatus

Employment status

Values Description
10 Employed
20 Self-Employed
30 Commission Sales
40 Hourly Wages
70 Retired
80 Homemaker
99 Other

Enums.EmploymentType

Employment type

Values Description
1 Permanent full time
2 Permanent part time
3 Temporary full time
4 Temporary part time
5 Permanent - Seasonal
6 Temporary - Seasonal
7 Not applicable

Enums.GEServiceType

GE service type

Values Description
10 Basic
20 Full
99 Other

Enums.HeatingType

Heating type

Values Description
1 Electric baseboard
2 Force Air/Gas/Oil/Electric
3 Hot Water
4 Other

Enums.HonorificType

Title

Values Description
1 Mr
2 Mrs
3 Miss
4 Ms
5 Dr
6 Company
99 Other

Enums.HumanReadableReportType

Human readable report type

Values
Text

Enums.Language

Language

Values Description
1 English
2 French

Enums.LenderType

Lender type

Values Description
1 Bank
2 Credit Union
3 Insurance Company
4 Mortgage Investment Corporation
5 Private Lender
6 Self Funding
7 Trust Company
8 Monoline
99 Other

Enums.LiabilityType

Liability type

Values Description
1 Personal Loan
2 Secured Loan
3 Car Loan
4 Lease Agreement
6 Credit Card
7 Line Of Credit
8 Child Support
9 Alimony
10 Student Loan
11 Wage Garnishment
12 Income Tax
99 Other

Enums.LifeInsurerCompany

Life insurer company

Values Description
3 MPP

Enums.LineOfBusiness

Line of business

Values Description
1 Residential A
11 Residential B
40 Residential C

Enums.LoanPurposeType

Loan purpose type

Values Description
1 Refinance
2 Equity Take Out
3 House Purchase
4 Transfer
5 Increase Transfer
13 Port

Enums.LoanRedemptionStatus

Loan redemption status

Values Description
1 Remaining
2 Free and clear
3 To be paid
4 Paid with proceeds
7 To be Ported

Enums.LoanRepaymentType

Loan repayment type

Values Description
1 Interest Only
2 Blended P and I

Enums.LoanType

Loan type

Values Description
0 Mortgage
1 Line of Credit - Secured

Enums.LoCRepaymentType

LoC repayment type

Values Description
1 5/20
2 10/15
3 N/A

Enums.MaritalStatusType

Marital status type

Values Description
1 Single
2 Married
3 Widowed
4 Separated
5 Divorced
6 Common-Law
99 Other

Enums.MortgageClassification

Mortgage classification

Values Description
10 Commercial
20 Construction
30 Reverse
40 Sub Prime
50 HELOC

Enums.MortgageInsurerType

Mortgage insurer type

Values Description
10 CMHC
20 Genworth
30 AIG
40 PMI
99 Other

Enums.MortgageType

Mortgage type

Values Description
0 Conventional
1 Subprime
2 Private

Enums.OtherServiceType

Other mortgage insurer service type

Values Description
10 Basic
20 Full
99 Other

Enums.ParkingType

Parking type

Values Description
1 Single Attached Garage
2 Single Detached Garage
3 Double Attached Garage
4 Double Detached Garage
5 Triple Attached Garage
6 Triple Detached Garage
7 None

Enums.PaymentFrequency

Payment frequency

Values Description
1 Annually
2 Semi-annually
4 Quarterly
12 Monthly
24 Semi-monthly
26 Bi-weekly
52 Weekly

Enums.PayoffType

Payoff type

Values Description
1 Prior to Advance
2 From Proceeds

Enums.PoSApplicationStatus

PoS application status

Values Description
10 New
20 Submitted
40 Approved
47 Accepted
50 Cancelled
55 Parked
60 Declined
67 Waiting To Close
70 Funded & Awaiting Payment
80 Complete

Enums.PoSComplianceStatus

Compliance status

Values Description
0 Not Ready
1 Ready
2 Not Compliant
3 Compliant

Enums.PoSSystemType

PoS system type

Values Description
0 Link
20 Scarlett
30 Item 30
40 Velocity
50 Expert
51 CIBC Expert
60 Lendesk
70 Doorr
80 Boss
90 Finmo
100 Item 100
110 Item 110
120 Item 120
130 Item 130
140 Infin 8
150 Pineapple
160 Lender Key
170 Unison

Enums.PrePaymentOption

Prepayment option

Values Description
0 Open
5 5%
10 10%
15 15%
20 20%
25 25%
100 None

Enums.PrePaymentOptionPercentType

Pre-payment option percent type

Values Description
0 None
5 5%
10 10%
15 15%
20 20%
25 25%
100 Open

Enums.PropertyDescriptionType

Property description type

Values Description
1 Detached
2 Semi-detached
3 Duplex
4 Triplex
5 Fourplex
6 Apartment
7 Townhouse
8 Strip
9 High Rise
10 Stacked
11 Row
12 Mobile
13 Modular Home
14 Co-op
15 Fiveplex
16 Sixplex
99 Other

Enums.PropertyTaxPayor

Property tax payor

Values Description
1 Borrower
2 Lender

Enums.PropertyType

Property type

Values Description
1 One Storey
2 Bi-Level
3 Two Storey
4 Split Level
5 One and Half Storey
6 Three Storey
99 Other

Enums.PropertyUsageType

Property usage type

Values Description
1 Single Family
5 Multiple with unit
6 Apts with Stores
7 Retail
8 Office Building
9 Industrial
10 Hotel/Motel
11 Recreational
12 Land/Farm
90 Other

Enums.PropertyZoningType

Property zoning type

Values Description
1 Major Urban Residential
2 Urban Residential
3 Rural Residential
4 Agricultural
5 Agricultural land reserve
6 Recreational / Cottage
7 Commercial
8 Commercial / Residential
99 Other

Enums.ProvinceStateCode

Province state code

Values Description
10 British Columbia
20 Alberta
30 Saskatchewan
40 Manitoba
50 Ontario
60 Quebec
70 New Brunswick
80 Nova Scotia
90 Newfoundland and Labrador
100 Prince Edward Island
110 Yukon
120 North West Territories
130 Nunavut
200 Alabama
210 Alaska
220 American Samoa
230 Arizona
240 Arkansas
250 California
260 Colorado
270 Connecticut
280 Delaware
290 District Of Columbia
300 Federated States Of Micronesia
310 Florida
320 Georgia
330 Guam
340 Hawaii
350 Idaho
360 Illinois
370 Indiana
380 Iowa
390 Kansas
400 Kentucky
410 Louisiana
420 Maine
430 Marshall Islands
440 Maryland
450 Massachusetts
460 Michigan
470 Minnesota
480 Mississippi
490 Missouri
500 Montana
510 Nebraska
520 Nevada
530 New Hampshire
540 New Jersey
550 New Mexico
560 New York
570 North carolina
580 North Dakota
590 Northern Mariana Islands
600 Ohio
610 Oklahoma
620 Oregon
630 Palau
640 Pennsylvania
650 Puerto Rico
660 Rhode Island
670 South Carolina
680 South Dakota
690 Tennessee
700 Texas
710 Utah
720 Vermont
730 Virgin Islands
740 Virginia
750 Washington
760 West Virginia
770 Wisconsin
780 Wyoming
99999 Other or None

Enums.ProvinceStateCodeCanada

Province code (Canada)

Values Description
10 British Columbia
20 Alberta
30 Saskatchewan
40 Manitoba
50 Ontario
60 Quebec
70 New Brunswick
80 Nova Scotia
90 Newfoundland and Labrador
100 Prince Edward Island
110 Yukon
120 North West Territories
130 Nunavut

Enums.ProvinceStateCodeUSA

State Code (USA)

Values Description
200 Alabama
210 Alaska
220 American Samoa
230 Arizona
240 Arkansas
250 California
260 Colorado
270 Connecticut
280 Delaware
290 District Of Columbia
300 Federated States Of Micronesia
310 Florida
320 Georgia
330 Guam
340 Hawaii
350 Idaho
360 Illinois
370 Indiana
380 Iowa
390 Kansas
400 Kentucky
410 Louisiana
420 Maine
430 Marshall Islands
440 Maryland
450 Massachusetts
460 Michigan
470 Minnesota
480 Mississippi
490 Missouri
500 Montana
510 Nebraska
520 Nevada
530 New Hampshire
540 New Jersey
550 New Mexico
560 New York
570 North carolina
580 North Dakota
590 Northern Mariana Islands
600 Ohio
610 Oklahoma
620 Oregon
630 Palau
640 Pennsylvania
650 Puerto Rico
660 Rhode Island
670 South Carolina
680 South Dakota
690 Tennessee
700 Texas
710 Utah
720 Vermont
730 Virgin Islands
740 Virginia
750 Washington
760 West Virginia
770 Wisconsin
780 Wyoming

Enums.RateCompoundFrequency

Rate compound frequency

Values Description
1 Annual
2 Semi-Annual
4 Quarterly
12 Monthly

Enums.RateType

Rate type

Values Description
0 Fixed
2 ARM
12 Monthly change
99 Floating rate

Enums.RentalCalcType

Rental calc type

Values Description
1 Rental Offset
2 Rental Add Back

Enums.RentalOffset

Rental offset

Values Description
0 0%
5 5%
10 10%
15 15%
20 20%
25 25%
30 30%
33 33.3%
35 35%
40 40%
45 45%
50 50%
55 55%
60 60%
65 65%
66 66.6%
70 70%
75 75%
80 80%
85 85%
90 90%
95 95%
100 100%

Enums.Resident

Resident

Values Description
10 Canadian Citizen
20 Permanent Resident
30 Work Visa
99 Other

Enums.ResponseStatus

Values
ok
partial
error

Enums.SagenServiceType

Sagen service type

Values Description
10 Basic
20 Full
99 Other

Enums.ServiceErrorType

Values Description
1 Business
2 System
3 Vendor

Enums.Sex

Sex

Values Description
1 Male
2 Female

Enums.StreetDirectionCode

Street direction code

Values Description
1 East
2 North
3 Northeast
4 Northwest
5 South
6 Southeast
7 Southwest
8 West

Enums.StreetTypeCode

Street type code

Values Description
10 Alley
20 Autoroute
30 Avenue
40 Bay
50 Beach
60 Bend
70 Boulevard
80 Centre
90 Chase
100 Circle
110 Close
120 Concession
130 Court
140 Cove
150 Crescent
160 Cul-du-sac
170 Corners
180 Dale
190 Drive
200 End
210 Esplanade
220 Expressway
230 Gardens
240 Gate
250 Glen
260 Grove
270 Heights
280 Hill
290 Hollow
300 Landing
310 Lane
320 Mall
330 Mews
340 Pararade
350 Park
360 Parkway
370 Passage
380 Place
390 Plaza
400 Port
410 Promenade
420 Quay
430 Range
440 Ridge
450 Road
460 Route
470 Row
480 Square
490 Street
500 Terrace
510 Townline
520 Trail
530 View
540 Vista
550 Walk
560 Way
570 Wharf
590 Abbey
600 Acres
610 Allée
620 By-pass
630 Byway
640 Campus
650 Cape
660 Carré
670 Carrefour
680 Cercle
690 Circuit
700 Common
710 Côte
720 Cour
730 Cours
740 Croissant
750 Crossing
760 Dell
770 Diversion
780 Downs
790 Échangeur
800 Estates
810 Extension
820 Farm
830 Field
840 Forest
850 Freeway
860 Front
870 Glade
880 Green
890 Grounds
900 Harbour
910 Heath
920 Highlands
930 Highway
940 Île
950 Impasse
960 Inlet
970 Island
980 Key
990 Knoll
1000 Limits
1010 Line
1020 Link
1030 Lookout
1040 Loop
1050 Manor
1060 Maze
1070 Meadow
1080 Montée
1090 Moor
1100 Mount
1110 Mountain
1120 Orchard
1130 Parc
1140 Path
1150 Pathway
1160 Pines
1170 Plateau
1180 Point
1190 Pointe
1200 Private
1210 Ramp
1220 Rang
1230 Rise
1240 Rond-point
1250 Rue
1260 Ruelle
1270 Run
1280 Sentier
1290 Subdivision
1300 Terrasse
1310 Thicket
1320 Towers
1330 Turnabout
1340 Vale
1350 Via
1360 Village
1370 Villas
1380 Voie
1390 Wood
1400 Wynd
1410 Chemin
1420 Quai
1430 Reach
1440 Union
1450 Access
1460 Acre
1470 Aire
1480 Baie
1490 Barage
1500 Bloc
1510 Block
1520 Bluff
1530 Bluffs
1540 Branch
1550 Bretelle
1560 Barrage
1570 Bridge
1580 Brook
1590 Burrow
1600 Cap
1610 Crest
1620 Croft
1630 Crossroads
1640 Curve
1650 Desserte
1660 Driveway
1670 Droit de passage
1680 Gateway
1690 Haven
1700 Height
1710 Laneway
1720 Mikan
1730 Peak
1740 Right of way
1750 Rive
1760 Ruisseau
1770 Section
1780 Side Road
1790 Stroll
1800 Summit
1810 Tili
1820 Trace
1830 Trunk

Enums.SubjectPropertyOccupancyPurpose

Subject property occupancy purpose

Values Description
1 Primary Residence
4 Additional Current
5 Recreational

Enums.SuffixType

Suffix

Values Description
1 Junior
2 Senior

Enums.TelephoneUsageType

Telephone usage type

Values Description
1 Home
2 Work
3 Mobile
4 Fax

Enums.TenancyType

Tenancy type

Values Description
10 Lease Home/Apartment
20 Living with Parents/Relatives
30 Hotel/Boarding Room
40 Other

Enums.TypeOfBuyer

Type of buyer

Values Description
10 First Time
20 Repeat

Enums.UnearnedIncomeType

Unearned income type

Values Description
1 Pension
2 Investments
3 Alimony
4 Car Allowance
5 Canada Child Benefit
6 Canada Pension Plan
7 Child Support
8 Interest Income
9 Old Age Pension
10 Survivor Benefits Pension
99 Other

Enums.WaterSupplyType

Water supply type

Values Description
10 Municipal
20 Private Well
30 Shared Well
40 Cistern
99 Other

Enums.WaterWasteType

Water waste type

Values Description
10 Sewer
20 Septic
30 Holding Tank
99 Other

PropertyValuation.Enums.ArchitecturalStyleType

Values
Detached
End Row
In Row
Semi Detached
Duplex
Triplex
Fourplex
Fiveplex
Sixplex
High Rise
Low Rise
Unknown

PropertyValuation.Enums.AuxiliaryHeatingType

Values
Fireplace
Woodstove
Wood Furnace
Pellet Stove
Electric
None
Unknown

PropertyValuation.Enums.BooleanWithUnknownType

Values
true
false
Unknown

PropertyValuation.Enums.ConfidenceRating

Values
High
Medium
Low

PropertyValuation.Enums.ExteriorWallType

Values
Aggregate
Aluminum
Aluminum Siding
Brick
Brick Veneer
Brick / Masonry Veneer
Ceramic
Concrete
Concrete Block
Glass
Fibreboard
Logs
Metal
Metal Siding
Steel
Stone
Stone Veneer
Stucco
Vinyl Siding
Wood
Wood Siding
Other
Unknown

PropertyValuation.Enums.FoundationType

Values
Basement
Crawlspace
Pier
Slab on Grade
Walkout Basement

PropertyValuation.Enums.GarageNumberOfCarsType

Values
0
1
2
3

PropertyValuation.Enums.GarageType

Values
None
Attached Garage
Built-in Garage
Basement Garage

PropertyValuation.Enums.OccupancyType

Values
Primary
SecondarySeasonal
SecondaryNonSeasonal
Rental

PropertyValuation.Enums.ParkingType

Values
Above Ground
Parking Garage
Underground
Unknown
None

PropertyValuation.Enums.PlumbingType

Values
Copper
Galvanized
Iron
PVC
ABS
PEX
Lead
Plastic
POLY-B
Other
Unknown

PropertyValuation.Enums.PreferredContactMethod

Values
Email
Cellular
Work
Home

PropertyValuation.Enums.PrimaryHeatingType

Values
Geothermal
Radiant
Radiant Ceiling
Radiant Floor
Electric
Electric Furnace
Fireplace
Floor Furnace
Furnace (Central)
Furnace (Central) with Add-On Woodburning Unit
Wall Furnace
Natural Gas Forced Air
Oil
Water
Hot Water / Steam / Boiler Unit
Wood
ACORN Stove / Box / Franklin / Pot Belly Stove
Baseboard Heater
Bi-Energy Combination
Combined
Pellet Stove
Slow Wood Burning / Air Tight Stove
Solar Panels
Solid Fuel Heating Unit
Space Heater
Other
Partially Unheated
None
Unknown

PropertyValuation.Enums.PropertyType

Values
Apartment
Condominium
Commercial
Residential
Industrial
Institutional
Special Purpose
Agricultural
Construction

PropertyValuation.Enums.ResidentialBathroomCountType

Values
1
1.5
2
2.5
3
3.5
4
4.5
5 or More

PropertyValuation.Enums.ResidentialImageryCode

Values
Street
Satellite
StaticSatelliteHigh
StaticSatelliteLow
PanoramicStreetView

PropertyValuation.Enums.ResidentialImageryProvider

Values
ILookAbout
Google
WIES

PropertyValuation.Enums.ResidentialKitchenCountType

Values
1
2
3
More than 3

PropertyValuation.Enums.RoofSurfaceType

Values
Asphalt
Clay Tile
Concrete
Copper
Rubber
Slate Tile
Steel
Tar and Gravel
Tin
Wood Shingles
Aluminum
Asphalt Roll
Asphalt Shingles
Concrete Tile
Corrugated Steel
Green Roof
Laminated Shingles
Metal Tile
Mineral Fiber Shakes
Plastic
Rubber Membrane
Other
Unknown

PropertyValuation.Enums.SewageType

Values
Municipal
SepticSystem
Unknown

PropertyValuation.Enums.SwimmingPoolType

Values
Inground Concrete
Inground Fibre Glass
Inground Vinyl
Above Ground
Above Ground Fibre Glass
None
Unknown

PropertyValuation.Enums.WaterType

Values
Municipal
Private
Unknown

PropertyValuation.EnumsCondo.ArchitecturalStyleTypeMultiResidential

Values
High Rise
Low Rise
Unknown

PropertyValuation.EnumsCondo.ExteriorWallTypeMultiResidential

Values
Aggregate
Aluminum
Aluminum Siding
Brick
Brick / Masonry Veneer
Ceramic
Concrete
Concrete Block
Glass
Metal
Metal Siding
Steel
Stone
Stucco
Vinyl Siding
Wood
Other
Unknown

PropertyValuation.EnumsCondo.PlumbingTypeMultiResidential

Values
ABS
Copper
Galvanized
Lead
Other
PEX
Plastic
POLY-B
PVC
Unknown

PropertyValuation.EnumsCondo.PrimaryHeatingTypeMultiResidential

Values
ACORN Stove / Box / Franklin / Pot Belly Stove
Baseboard Heater
Bi-Energy Combination
Combined
Electric Furnace
Fireplace
Floor Furnace
Furnace (Central)
Furnace (Central) with Add-On Woodburning Unit
Geothermal
Hot Water / Steam / Boiler Unit
Pellet Stove
Radiant Ceiling
Radiant Floor
Slow Wood Burning / Air Tight Stove
Solar Panels
Solid Fuel Heating Unit
Space Heater
Wall Furnace
Other
Partially Unheated
None
Unknown

PropertyValuation.EnumsCondo.PropertyTypeMultiResidential

Values
Apartment
Condominium

PropertyValuation.EnumsCondo.RoofSurfaceTypeMultiResidential

Values
Aluminum
Asphalt Roll
Asphalt Shingles
Clay Tile
Concrete Tile
Corrugated Steel
Green Roof
Laminated Shingles
Metal Tile
Mineral Fiber Shakes
Plastic
Rubber Membrane
Slate Tile
Tar and Gravel
Wood Shingles
Other
Unknown

PropertyValuation.EnumsHouse.ArchitecturalStyleType

Values
Detached
End Row
In Row
Semi Detached
Duplex
Triplex
Fourplex
Fiveplex
Sixplex

PropertyValuation.EnumsHouse.ExteriorWallType

Values
Brick
Brick Veneer
Concrete
Fibreboard
Logs
Stone
Stone Veneer
Stucco
Vinyl Siding
Wood

PropertyValuation.EnumsHouse.PlumbingType

Values
Copper
Galvanized
Iron
PVC
ABS
PEX
Unknown

PropertyValuation.EnumsHouse.PrimaryHeatingType

Values
Geothermal
Radiant
Electric
Natural Gas Forced Air
Oil
Water
Wood
None
Unknown

PropertyValuation.EnumsHouse.RoofSurfaceType

Values
Asphalt
Clay Tile
Concrete
Copper
Rubber
Slate Tile
Steel
Tar and Gravel
Tin
Wood Shingles

PropertyValuation.EnumsHouse.StoreyCountType

Values
1
1.5
2
2.5
3
3.5
4
BiLevel
TriLevel