Property V4:LookupDeeds: Difference between revisions
No edit summary |
No edit summary |
||
Line 612: | Line 612: | ||
<h3 style="background-color:rgb(240,240,240);">RecordingDate</h3> | <h3 style="background-color:rgb(240,240,240);">RecordingDate</h3> | ||
:The official filing date with the format: YYYY-MM-DD. This is normally | :The official filing date with the format: YYYY-MM-DD. This is normally located on the document. | ||
:{| class="alternate01" | :{| class="alternate01" | ||
Line 1,290: | Line 1,290: | ||
==GrpMortgage1== | ==GrpMortgage1== | ||
<h3 style="background-color:rgb(240,240,240);">DocNumberFormatted</h3> | <h3 style="background-color:rgb(240,240,240);">DocNumberFormatted</h3> | ||
: | :The first mortgage number based on the book, page, or instrument number. | ||
:{| class="alternate01" | :{| class="alternate01" | ||
Line 1,300: | Line 1,300: | ||
<h3 style="background-color:rgb(240,240,240);">DocNumberLegacy</h3> | <h3 style="background-color:rgb(240,240,240);">DocNumberLegacy</h3> | ||
: | :The first mortgage loan instrument, book, or page number located on the first sequence trust deed. | ||
:{| class="alternate01" | :{| class="alternate01" | ||
Line 1,310: | Line 1,310: | ||
<h3 style="background-color:rgb(240,240,240);">InstrumentNumber</h3> | <h3 style="background-color:rgb(240,240,240);">InstrumentNumber</h3> | ||
: | :If the first mortgage is indexed by a recorder's reference number, this will contain that number. Usually the year will not be added to this field unless there is a regional requirement. | ||
:{| class="alternate01" | :{| class="alternate01" | ||
Line 1,320: | Line 1,320: | ||
<h3 style="background-color:rgb(240,240,240);">Book</h3> | <h3 style="background-color:rgb(240,240,240);">Book</h3> | ||
: | :The first mortgage number book. This can contain either the recorder document book or the legal description book. | ||
:{| class="alternate01" | :{| class="alternate01" | ||
Line 1,330: | Line 1,330: | ||
<h3 style="background-color:rgb(240,240,240);">Page</h3> | <h3 style="background-color:rgb(240,240,240);">Page</h3> | ||
: | :The first mortgage number page. This can contain either the recorder document page or the legal description page. | ||
:{| class="alternate01" | :{| class="alternate01" | ||
Line 1,340: | Line 1,340: | ||
<h3 style="background-color:rgb(240,240,240);">RecordingDate</h3> | <h3 style="background-color:rgb(240,240,240);">RecordingDate</h3> | ||
: | :The first mortgage official filing date with the format: YYYY-MM-DD. This is normally located on the document. | ||
:{| class="alternate01" | :{| class="alternate01" | ||
Line 1,350: | Line 1,350: | ||
<h3 style="background-color:rgb(240,240,240);">Type</h3> | <h3 style="background-color:rgb(240,240,240);">Type</h3> | ||
: | :The type of loan for the first mortgage. E.g. conventional, construction, FHA, etc. | ||
:{| class="alternate01" | :{| class="alternate01" | ||
Line 1,360: | Line 1,360: | ||
<h3 style="background-color:rgb(240,240,240);">Amount</h3> | <h3 style="background-color:rgb(240,240,240);">Amount</h3> | ||
: | :The loan amount of the first mortgage. | ||
:{| class="alternate01" | :{| class="alternate01" | ||
Line 1,370: | Line 1,370: | ||
<h3 style="background-color:rgb(240,240,240);">LenderCode</h3> | <h3 style="background-color:rgb(240,240,240);">LenderCode</h3> | ||
: | :The standard ID code of the lender for the first mortgage. | ||
:{| class="alternate01" | :{| class="alternate01" | ||
Line 1,380: | Line 1,380: | ||
<h3 style="background-color:rgb(240,240,240);">LenderFullName</h3> | <h3 style="background-color:rgb(240,240,240);">LenderFullName</h3> | ||
: | :The full standardized name of the lender for the first mortgage. | ||
:{| class="alternate01" | :{| class="alternate01" | ||
Line 1,390: | Line 1,390: | ||
<h3 style="background-color:rgb(240,240,240);">LenderFirstName</h3> | <h3 style="background-color:rgb(240,240,240);">LenderFirstName</h3> | ||
: | :The first name of the first mortgage lender. This will be the complete name if the lender is a company. | ||
:{| class="alternate01" | :{| class="alternate01" | ||
Line 1,400: | Line 1,400: | ||
<h3 style="background-color:rgb(240,240,240);">LenderLastName</h3> | <h3 style="background-color:rgb(240,240,240);">LenderLastName</h3> | ||
: | :The last name of the first mortgage lender. | ||
:{| class="alternate01" | :{| class="alternate01" | ||
Line 1,410: | Line 1,410: | ||
<h3 style="background-color:rgb(240,240,240);">LenderAddress</h3> | <h3 style="background-color:rgb(240,240,240);">LenderAddress</h3> | ||
: | :The address of the first mortgage lender. | ||
:{| class="alternate01" | :{| class="alternate01" | ||
Line 1,420: | Line 1,420: | ||
<h3 style="background-color:rgb(240,240,240);">LenderCity</h3> | <h3 style="background-color:rgb(240,240,240);">LenderCity</h3> | ||
: | :The city of the first mortgage lender. | ||
:{| class="alternate01" | :{| class="alternate01" | ||
Line 1,430: | Line 1,430: | ||
<h3 style="background-color:rgb(240,240,240);">LenderState</h3> | <h3 style="background-color:rgb(240,240,240);">LenderState</h3> | ||
: | :The state of the first mortgage lender. | ||
:{| class="alternate01" | :{| class="alternate01" | ||
Line 1,440: | Line 1,440: | ||
<h3 style="background-color:rgb(240,240,240);">LenderZip</h3> | <h3 style="background-color:rgb(240,240,240);">LenderZip</h3> | ||
: | :The Zip code of the first mortgage lender. | ||
:{| class="alternate01" | :{| class="alternate01" | ||
Line 1,450: | Line 1,450: | ||
<h3 style="background-color:rgb(240,240,240);">LenderType</h3> | <h3 style="background-color:rgb(240,240,240);">LenderType</h3> | ||
: | :The lender type for the first mortgage. | ||
:{| class="alternate01" | :{| class="alternate01" | ||
Line 1,460: | Line 1,460: | ||
<h3 style="background-color:rgb(240,240,240);">IsLenderSeller</h3> | <h3 style="background-color:rgb(240,240,240);">IsLenderSeller</h3> | ||
: | :Specifies if the lender is also the seller for the first mortgage. | ||
:{| class="alternate01" | :{| class="alternate01" | ||
Line 1,470: | Line 1,470: | ||
<h3 style="background-color:rgb(240,240,240);">Term</h3> | <h3 style="background-color:rgb(240,240,240);">Term</h3> | ||
: | :The duration of the first mortgage. See the associated '''TermType''' to know the unit of measurement. | ||
:{| class="alternate01" | :{| class="alternate01" | ||
Line 1,480: | Line 1,480: | ||
<h3 style="background-color:rgb(240,240,240);">TermType</h3> | <h3 style="background-color:rgb(240,240,240);">TermType</h3> | ||
: | :The duration unit of measurement (month, year) for the first mortgage. See the associated '''Term''' to know the duration. | ||
:{| class="alternate01" | :{| class="alternate01" | ||
Line 1,490: | Line 1,490: | ||
<h3 style="background-color:rgb(240,240,240);">TermDate</h3> | <h3 style="background-color:rgb(240,240,240);">TermDate</h3> | ||
: | :The due date of the first mortage. | ||
:{| class="alternate01" | :{| class="alternate01" | ||
Line 1,500: | Line 1,500: | ||
<h3 style="background-color:rgb(240,240,240);">PrepaymentPenaltyFlag</h3> | <h3 style="background-color:rgb(240,240,240);">PrepaymentPenaltyFlag</h3> | ||
: | :Specifies if the first mortgage has a pre-payment penalty. | ||
:{| class="alternate01" | :{| class="alternate01" | ||
Line 1,510: | Line 1,510: | ||
<h3 style="background-color:rgb(240,240,240);">PrepaymentTerm</h3> | <h3 style="background-color:rgb(240,240,240);">PrepaymentTerm</h3> | ||
: | :The number of months the first mortgage must remain active. | ||
:{| class="alternate01" | :{| class="alternate01" | ||
Line 1,520: | Line 1,520: | ||
<h3 style="background-color:rgb(240,240,240);">InterestRateType</h3> | <h3 style="background-color:rgb(240,240,240);">InterestRateType</h3> | ||
: | :The interest rate type for the first mortgage. | ||
:{| class="alternate01" | :{| class="alternate01" | ||
Line 1,530: | Line 1,530: | ||
<h3 style="background-color:rgb(240,240,240);">InterestRate</h3> | <h3 style="background-color:rgb(240,240,240);">InterestRate</h3> | ||
: | :The interest rate of the first mortgage. | ||
:{| class="alternate01" | :{| class="alternate01" | ||
Line 1,540: | Line 1,540: | ||
<h3 style="background-color:rgb(240,240,240);">InterestTypeInitial</h3> | <h3 style="background-color:rgb(240,240,240);">InterestTypeInitial</h3> | ||
: | :The initial type of interest rate on the first mortgage. E.g. fixed or adjustable. | ||
:{| class="alternate01" | :{| class="alternate01" | ||
Line 1,550: | Line 1,550: | ||
<h3 style="background-color:rgb(240,240,240);">FixedStepConvRate</h3> | <h3 style="background-color:rgb(240,240,240);">FixedStepConvRate</h3> | ||
: | :The interest rate change in a fixed step conversion mortgage for the first mortgage. | ||
:{| class="alternate01" | :{| class="alternate01" | ||
Line 1,560: | Line 1,560: | ||
<h3 style="background-color:rgb(240,240,240);">InterestMargin</h3> | <h3 style="background-color:rgb(240,240,240);">InterestMargin</h3> | ||
: | :The fixed percentage rate added to an index value to determine the fully indexed interest rate of an adjustable rate mortage for the first mortgage. | ||
:{| class="alternate01" | :{| class="alternate01" | ||
Line 1,570: | Line 1,570: | ||
<h3 style="background-color:rgb(240,240,240);">InterestIndex</h3> | <h3 style="background-color:rgb(240,240,240);">InterestIndex</h3> | ||
: | :The benchmark interest rate the first mortgage's rate is based on. | ||
:{| class="alternate01" | :{| class="alternate01" | ||
Line 1,580: | Line 1,580: | ||
<h3 style="background-color:rgb(240,240,240);">InterestRateMax</h3> | <h3 style="background-color:rgb(240,240,240);">InterestRateMax</h3> | ||
: | :The maximum interest rate allowed for the first mortgage, if it is an adjustable rate. | ||
:{| class="alternate01" | :{| class="alternate01" | ||
Line 1,590: | Line 1,590: | ||
<h3 style="background-color:rgb(240,240,240);">AdjustableRateIndex</h3> | <h3 style="background-color:rgb(240,240,240);">AdjustableRateIndex</h3> | ||
: | :The benchmark interest rate the first mortgage's adjustable rate is based on. | ||
:{| class="alternate01" | :{| class="alternate01" | ||
Line 1,600: | Line 1,600: | ||
<h3 style="background-color:rgb(240,240,240);">InterestOnlyFlag</h3> | <h3 style="background-color:rgb(240,240,240);">InterestOnlyFlag</h3> | ||
: | :Specifies if the first mortgage has an interest only period. | ||
:{| class="alternate01" | :{| class="alternate01" | ||
Line 1,610: | Line 1,610: | ||
<h3 style="background-color:rgb(240,240,240);">InterestOnlyPeriod</h3> | <h3 style="background-color:rgb(240,240,240);">InterestOnlyPeriod</h3> | ||
: | :The length of the interest only period, in years. | ||
:{| class="alternate01" | :{| class="alternate01" | ||
Line 1,621: | Line 1,621: | ||
==GrpMortgage2== | ==GrpMortgage2== | ||
<h3 style="background-color:rgb(240,240,240);">DocNumberFormatted</h3> | <h3 style="background-color:rgb(240,240,240);">DocNumberFormatted</h3> | ||
: | :The second mortgage number based on the book, page, or instrument number. | ||
:{| class="alternate01" | :{| class="alternate01" | ||
Line 1,631: | Line 1,631: | ||
<h3 style="background-color:rgb(240,240,240);">DocNumberLegacy</h3> | <h3 style="background-color:rgb(240,240,240);">DocNumberLegacy</h3> | ||
: | :The second mortgage loan instrument, book, or page number located on the first sequence trust deed. | ||
:{| class="alternate01" | :{| class="alternate01" | ||
Line 1,641: | Line 1,641: | ||
<h3 style="background-color:rgb(240,240,240);">InstrumentNumber</h3> | <h3 style="background-color:rgb(240,240,240);">InstrumentNumber</h3> | ||
: | :If the second mortgage is indexed by a recorder's reference number, this will contain that number. Usually the year will not be added to this field unless there is a regional requirement. | ||
:{| class="alternate01" | :{| class="alternate01" | ||
Line 1,651: | Line 1,651: | ||
<h3 style="background-color:rgb(240,240,240);">Book</h3> | <h3 style="background-color:rgb(240,240,240);">Book</h3> | ||
: | :The second mortgage number book. This can contain either the recorder document book or the legal description book. | ||
:{| class="alternate01" | :{| class="alternate01" | ||
Line 1,661: | Line 1,661: | ||
<h3 style="background-color:rgb(240,240,240);">Page</h3> | <h3 style="background-color:rgb(240,240,240);">Page</h3> | ||
: | :The second mortgage number page. This can contain either the recorder document page or the legal description page. | ||
:{| class="alternate01" | :{| class="alternate01" | ||
Line 1,671: | Line 1,671: | ||
<h3 style="background-color:rgb(240,240,240);">RecordingDate</h3> | <h3 style="background-color:rgb(240,240,240);">RecordingDate</h3> | ||
: | :The second mortgage official filing date with the format: YYYY-MM-DD. This is normally located on the document. | ||
:{| class="alternate01" | :{| class="alternate01" | ||
Line 1,681: | Line 1,681: | ||
<h3 style="background-color:rgb(240,240,240);">Type</h3> | <h3 style="background-color:rgb(240,240,240);">Type</h3> | ||
: | :The type of loan for the second mortgage. E.g. conventional, construction, FHA, etc. | ||
:{| class="alternate01" | :{| class="alternate01" | ||
Line 1,691: | Line 1,691: | ||
<h3 style="background-color:rgb(240,240,240);">Amount</h3> | <h3 style="background-color:rgb(240,240,240);">Amount</h3> | ||
: | :The loan amount of the second mortgage. | ||
:{| class="alternate01" | :{| class="alternate01" | ||
Line 1,701: | Line 1,701: | ||
<h3 style="background-color:rgb(240,240,240);">LenderCode</h3> | <h3 style="background-color:rgb(240,240,240);">LenderCode</h3> | ||
: | :The standard ID code of the lender for the second mortgage. | ||
:{| class="alternate01" | :{| class="alternate01" | ||
Line 1,711: | Line 1,711: | ||
<h3 style="background-color:rgb(240,240,240);">LenderFullName</h3> | <h3 style="background-color:rgb(240,240,240);">LenderFullName</h3> | ||
: | :The full standardized name of the lender for the second mortgage. | ||
:{| class="alternate01" | :{| class="alternate01" | ||
Line 1,721: | Line 1,721: | ||
<h3 style="background-color:rgb(240,240,240);">LenderFirstName</h3> | <h3 style="background-color:rgb(240,240,240);">LenderFirstName</h3> | ||
: | :The first name of the second mortgage lender. This will be the complete name if the lender is a company. | ||
:{| class="alternate01" | :{| class="alternate01" | ||
Line 1,731: | Line 1,731: | ||
<h3 style="background-color:rgb(240,240,240);">LenderLastName</h3> | <h3 style="background-color:rgb(240,240,240);">LenderLastName</h3> | ||
: | :The last name of the second mortgage lender. | ||
:{| class="alternate01" | :{| class="alternate01" | ||
Line 1,741: | Line 1,741: | ||
<h3 style="background-color:rgb(240,240,240);">LenderAddress</h3> | <h3 style="background-color:rgb(240,240,240);">LenderAddress</h3> | ||
: | :The address of the second mortgage lender. | ||
:{| class="alternate01" | :{| class="alternate01" | ||
Line 1,751: | Line 1,751: | ||
<h3 style="background-color:rgb(240,240,240);">LenderCity</h3> | <h3 style="background-color:rgb(240,240,240);">LenderCity</h3> | ||
: | :The city of the second mortgage lender. | ||
:{| class="alternate01" | :{| class="alternate01" | ||
Line 1,761: | Line 1,761: | ||
<h3 style="background-color:rgb(240,240,240);">LenderState</h3> | <h3 style="background-color:rgb(240,240,240);">LenderState</h3> | ||
: | :The state of the second mortgage lender. | ||
:{| class="alternate01" | :{| class="alternate01" | ||
Line 1,771: | Line 1,771: | ||
<h3 style="background-color:rgb(240,240,240);">LenderZip</h3> | <h3 style="background-color:rgb(240,240,240);">LenderZip</h3> | ||
: | :The Zip code of the second mortgage lender. | ||
:{| class="alternate01" | :{| class="alternate01" | ||
Line 1,781: | Line 1,781: | ||
<h3 style="background-color:rgb(240,240,240);">LenderType</h3> | <h3 style="background-color:rgb(240,240,240);">LenderType</h3> | ||
: | :The lender type for the second mortgage. | ||
:{| class="alternate01" | :{| class="alternate01" | ||
Line 1,791: | Line 1,791: | ||
<h3 style="background-color:rgb(240,240,240);">IsLenderSeller</h3> | <h3 style="background-color:rgb(240,240,240);">IsLenderSeller</h3> | ||
: | :Specifies if the lender is also the seller for the second mortgage. | ||
:{| class="alternate01" | :{| class="alternate01" | ||
Line 1,801: | Line 1,801: | ||
<h3 style="background-color:rgb(240,240,240);">Term</h3> | <h3 style="background-color:rgb(240,240,240);">Term</h3> | ||
: | :The duration of the second mortgage. See the associated '''TermType''' to know the unit of measurement. | ||
:{| class="alternate01" | :{| class="alternate01" | ||
Line 1,811: | Line 1,811: | ||
<h3 style="background-color:rgb(240,240,240);">TermType</h3> | <h3 style="background-color:rgb(240,240,240);">TermType</h3> | ||
: | :The duration unit of measurement (month, year) for the second mortgage. See the associated '''Term''' to know the duration. | ||
:{| class="alternate01" | :{| class="alternate01" | ||
Line 1,821: | Line 1,821: | ||
<h3 style="background-color:rgb(240,240,240);">TermDate</h3> | <h3 style="background-color:rgb(240,240,240);">TermDate</h3> | ||
: | :The due date of the second mortage. | ||
:{| class="alternate01" | :{| class="alternate01" | ||
Line 1,831: | Line 1,831: | ||
<h3 style="background-color:rgb(240,240,240);">PrepaymentPenaltyFlag</h3> | <h3 style="background-color:rgb(240,240,240);">PrepaymentPenaltyFlag</h3> | ||
: | :Specifies if the second mortgage has a pre-payment penalty. | ||
:{| class="alternate01" | :{| class="alternate01" | ||
Line 1,841: | Line 1,841: | ||
<h3 style="background-color:rgb(240,240,240);">PrepaymentTerm</h3> | <h3 style="background-color:rgb(240,240,240);">PrepaymentTerm</h3> | ||
: | :The number of months the second mortgage must remain active. | ||
:{| class="alternate01" | :{| class="alternate01" | ||
Line 1,851: | Line 1,851: | ||
<h3 style="background-color:rgb(240,240,240);">InterestRateType</h3> | <h3 style="background-color:rgb(240,240,240);">InterestRateType</h3> | ||
: | :The interest rate type for the second mortgage. | ||
:{| class="alternate01" | :{| class="alternate01" | ||
Line 1,861: | Line 1,861: | ||
<h3 style="background-color:rgb(240,240,240);">InterestRate</h3> | <h3 style="background-color:rgb(240,240,240);">InterestRate</h3> | ||
: | :The interest rate of the second mortgage. | ||
:{| class="alternate01" | :{| class="alternate01" | ||
Line 1,871: | Line 1,871: | ||
<h3 style="background-color:rgb(240,240,240);">InterestTypeInitial</h3> | <h3 style="background-color:rgb(240,240,240);">InterestTypeInitial</h3> | ||
: | :The initial type of interest rate on the second mortgage. E.g. fixed or adjustable. | ||
:{| class="alternate01" | :{| class="alternate01" | ||
Line 1,881: | Line 1,881: | ||
<h3 style="background-color:rgb(240,240,240);">FixedStepConvRate</h3> | <h3 style="background-color:rgb(240,240,240);">FixedStepConvRate</h3> | ||
: | :The interest rate change in a fixed step conversion mortgage for the second mortgage. | ||
:{| class="alternate01" | :{| class="alternate01" | ||
Line 1,891: | Line 1,891: | ||
<h3 style="background-color:rgb(240,240,240);">InterestMargin</h3> | <h3 style="background-color:rgb(240,240,240);">InterestMargin</h3> | ||
: | :The fixed percentage rate added to an index value to determine the fully indexed interest rate of an adjustable rate mortage for the second mortgage. | ||
:{| class="alternate01" | :{| class="alternate01" | ||
Line 1,901: | Line 1,901: | ||
<h3 style="background-color:rgb(240,240,240);">InterestIndex</h3> | <h3 style="background-color:rgb(240,240,240);">InterestIndex</h3> | ||
: | :The benchmark interest rate the second mortgage's rate is based on. | ||
:{| class="alternate01" | :{| class="alternate01" | ||
Line 1,911: | Line 1,911: | ||
<h3 style="background-color:rgb(240,240,240);">InterestRateMax</h3> | <h3 style="background-color:rgb(240,240,240);">InterestRateMax</h3> | ||
: | :The maximum interest rate allowed for the second mortgage, if it is an adjustable rate. | ||
:{| class="alternate01" | :{| class="alternate01" | ||
Line 1,921: | Line 1,921: | ||
<h3 style="background-color:rgb(240,240,240);">AdjustableRateIndex</h3> | <h3 style="background-color:rgb(240,240,240);">AdjustableRateIndex</h3> | ||
: | :The benchmark interest rate the second mortgage's adjustable rate is based on. | ||
:{| class="alternate01" | :{| class="alternate01" | ||
Line 1,931: | Line 1,931: | ||
<h3 style="background-color:rgb(240,240,240);">InterestOnlyFlag</h3> | <h3 style="background-color:rgb(240,240,240);">InterestOnlyFlag</h3> | ||
: | :Specifies if the second mortgage has an interest only period. | ||
:{| class="alternate01" | :{| class="alternate01" | ||
Line 1,941: | Line 1,941: | ||
<h3 style="background-color:rgb(240,240,240);">InterestOnlyPeriod</h3> | <h3 style="background-color:rgb(240,240,240);">InterestOnlyPeriod</h3> | ||
: | :The length of the interest only period, in years. | ||
:{| class="alternate01" | :{| class="alternate01" | ||
Line 1,952: | Line 1,952: | ||
==GrpValuation== | ==GrpValuation== | ||
<h3 style="background-color:rgb(240,240,240);">EstDownPayment</h3> | <h3 style="background-color:rgb(240,240,240);">EstDownPayment</h3> | ||
: | :The estimated down payment made at the time of purchase. | ||
:{| class="alternate01" | :{| class="alternate01" | ||
Line 1,962: | Line 1,962: | ||
<h3 style="background-color:rgb(240,240,240);">EstLTV</h3> | <h3 style="background-color:rgb(240,240,240);">EstLTV</h3> | ||
: | :The estimated loan to value at the time of purchase. | ||
:{| class="alternate01" | :{| class="alternate01" |
Revision as of 02:03, 16 December 2017
Property Navigation | |||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| |||||||||||||
| |||||||||||||
| |||||||||||||
| |||||||||||||
Sample Code |
The LookupDeeds endpoint returns an array of deeds and/or transactions from the recorder table when given either a deed transaction ID or the FIPs and APN.
Request
A request consists of a protocol to make a call to the service, detailing desired elements. Your License Key is required.
Property V4 supports the REST protocol to access the service.
Field Names
This is a list of the request field names and their protocol naming conventions.
Field Name | Level | REST |
---|---|---|
Transmission Reference | Request | t |
License Key | id | |
Columns | cols | |
Format | format | |
Property MAK | Record | mak |
FreeForm | ff | |
FIPS | fips | |
APN | apn | |
Transaction ID | txid |
Minimum Inputs
The following are the possible minimum input requirements.
- FIPS & APN
- Property MAK
- Transaction ID
- FreeForm
Request Elements
The following elements set the basic options for each request. These apply to the entire request, not the individual records.
Transmission Reference
- Optional.
- This is a string value that serves as a unique identifier for this set of records. It is returned as sent.
Protocol Syntax REST ?t = string
License Key
- Required.
- This is a string value containing the License Key issued to the customer by Melissa for Property V4.
- If this element is absent, the Web Service will return an error. To receive a License Key, please contact your Melissa sales representative at 1-800-MELISSA.
Protocol Syntax REST &id = string
Columns
- Optional.
- This string value specifies which column(s) to be output as a comma delimited string.
Protocol Syntax REST &cols = string
- Entering the column name will return the column. Specifying a group name will return all columns in the group.
- List multiple columns in the following format, with multiple options delimited with a ",".
Syntax ColumnName,ColumnName,ColumnName
Format
- Optional.
- The desired format of the response. Possible values are json or xml.
Protocol Syntax REST &format = string
Request Record Elements
REST will only contain the Records element.
Protocol | Definition |
---|---|
REST | The REST interface only allows a single record per request. |
Property MAK
- Optional.
- A propietary unique key identifier for an address. This is derived from Address Checking.
Protocol Syntax REST &mak = string
Free Form
- Optional.
- The free form address.
Protocol Syntax REST &ff = string
FIPS
- Optional.
- Federal Information Processing Standard (FIPS) code for the property.
Protocol Syntax REST &fips = string
APN
- Optional.
- Assessor's Parcel Number for the property.
Protocol Syntax REST &apn = string
Transaction ID
- Optional.
- Specific transaction ID to specify one deed or transaction.
Protocol Syntax REST &txid = string
Response
A response is the result of a request. This consists of returned results codes, deed, and transaction information.
Field Names
This is a list of the response field names and their grouping.
Field Name Group Version [DEFAULT] Always return in the output structure.
TransmissionReference Results TotalRecords Records TypeCode GrpDocInfo NumberFormatted NumberLegacy InstrumentNumber Book Page InstrumentDate RecordingDate TransactionType GrpTxDefInfo TransferInfoPurchaseTypeCode ForeclosureAuctionSale TransferInfoDistressCircumstanceCode QuitclaimFlag TransferInfoMultiParcelFlag ArmsLengthFlag PartialInterest TransferAmount GrpTxAmtInfo TransferAmountInfoAccuracy TransferTaxTotal TransferTaxCounty Name1Full GrpPrimaryGrantor Name1First Name1Middle Name1Last Name1Suffix Name1ClassType Name1LegalType Name2Full Name2First Name2Middle Name2Last Name2Suffix Name2ClassType Name2LegalType Name3Full GrpSecondaryGrantor Name3First Name3Middle Name3Last Name3Suffix Name3ClassType Name4Full Name4First Name4Middle Name4Last Name4Suffix Name4ClassType Name1Full GrpPrimaryGrantee Name1First Name1Middle Name1Last Name1Suffix Name1ClassType Name1LegalType Name2Full Name2First Name2Middle Name2Last Name2Suffix Name2ClassType Name3Full GrpSecondaryGrantee Name3First Name3Middle Name3Last Name3Suffix Name3ClassType Name4Full Name4First Name4Middle Name4Last Name4Suffix Name4ClassType StandardizedCode GrpTitleCompInfo StandardizedName TitleCompanyRaw DocNumberFormatted GrpMortgage1 DocNumberLegacy InstrumentNumber Book Page RecordingDate Type Amount LenderCode LenderFullName LenderFirstName LenderLastName LenderAddress LenderCity LenderState LenderZip LenderType IsLenderSeller Term TermType TermDate PrepaymentPenaltyFlag PrepaymentTerm InterestRateType InterestRate InterestTypeInitial FixedStepConvRate InterestMargin InterestIndex InterestRateMax AdjustableRateIndex InterestOnlyFlag InterestOnlyPeriod DocNumberFormatted GrpMortgage2 DocNumberLegacy InstrumentNumber Book Page RecordingDate Type Amount LenderCode LenderFullName LenderFirstName LenderLastName LenderAddress LenderCity LenderState LenderZip LenderType IsLenderSeller Term TermType TermDate PrepaymentPenaltyFlag PrepaymentTerm InterestRateType InterestRate InterestTypeInitial FixedStepConvRate InterestMargin InterestIndex InterestRateMax AdjustableRateIndex InterestOnlyFlag InterestOnlyPeriod EstDownPayment GrpValuation EstLTV
[DEFAULT]
Version
- The current web service version.
Protocol Syntax JSON "Version":"string"
TransmissionReference
- A pass-through of the input Transmission Reference.
Protocol Syntax JSON "TransmissionReference":"string"
Results
- Returns the result/error codes. For more information, see Property V4 Result Codes.
Protocol Syntax JSON "TransmissionResults":"string"
TotalRecords
- The total number of records returned in the records array.
Protocol Syntax JSON "TotalRecords":"string"
Records
- This is the returned array of records.
Protocol Syntax JSON "Records":"string"
GrpDocInfo
TypeCode
- The type of document. E.g. grand deed, quit claim, etc.
Protocol Syntax JSON "TypeCode":"string"
NumberFormatted
- The document number based on the document book, page, or instrument number.
Protocol Syntax JSON "NumberFormatted":"string"
NumberLegacy
- The document number from a previous platform, if different than NumberFormatted.
Protocol Syntax JSON "NumberLegacy":"string"
InstrumentNumber
- If the document is indexed by a recorder's reference number, this will contain that number. Usually the year will not be added to this field unless there is a regional requirement.
Protocol Syntax JSON "InstrumentNumber":"string"
Book
- The document number book. This can contain either the recorder document book or the legal description book.
Protocol Syntax JSON "Book":"string"
Page
- The document number page. This can contain either the recorder document page or the legal description page.
Protocol Syntax JSON "Page":"string"
InstrumentDate
- The execution date with the format: YYYY-MM-DD. This pre-dates the RecordingDate and may be the notary date.
Protocol Syntax JSON "InstrumentDate":"string"
RecordingDate
- The official filing date with the format: YYYY-MM-DD. This is normally located on the document.
Protocol Syntax JSON "RecordingDate":"string"
GrpTxDefInfo
TransactionType
- The transaction type.
Protocol Syntax JSON "TransactionType":"string"
TransferInfoPurchaseTypeCode
- The type of resale transaction. E.g. construction, subdivision, etc.
Protocol Syntax JSON "TransferInfoPurchaseTypeCode":"string"
ForeclosureAuctionSale
- Specifies if the transaction was due to a foreclosure auction.
Protocol Syntax JSON "ForeclosureAuctionSale":"string"
TransferInfoDistressCircumstanceCode
- A distress scenario code.
Protocol Syntax JSON "TransferInfoDistressCircumstanceCode":"string"
QuitclaimFlag
- Specifies if the transaction is a Quit claim.
Protocol Syntax JSON "QuitclaimFlag":"string"
TransferInfoMultiParcelFlag
- Specifies if the transaction has multiple parcels.
Protocol Syntax JSON "TransferInfoMultiParcelFlag":"string"
ArmsLengthFlag
- Specifies the transfer was between two unrelated parties.
Protocol Syntax JSON "ArmsLengthFlag":"string"
PartialInterest
- Specifies what percentage of the legal ownership was transferred.
Protocol Syntax JSON "PartialInterest":"string"
GrpTxAmtInfo
TransferAmount
- The amount, in dollars, of consideration in an ownership changing transaction.
Protocol Syntax JSON "TransferAmount":"string"
TransferAmountInfoAccuracy
- The type of transaction.
Protocol Syntax JSON "TransferAmountInfoAccuracy":"string"
TransferTaxTotal
- The total of the city and county transfer tax amounts. Unique to some regions.
Protocol Syntax JSON "TransferTaxTotal":"string"
TransferTaxCounty
- This amount is a rate levied by the state per $1,000 of consideration paid in the transaction. Often this is a transfer tax stamp on the document. This may be the full sales price or only the equity transferred with any new financing, depending on the state.
Protocol Syntax JSON "TransferTaxCounty":"string"
GrpPrimaryGrantor
Name1Full
- The full name of the primary seller.
Protocol Syntax JSON "Name1Full":"string"
Name1First
- The first name of the primary seller.
Protocol Syntax JSON "Name1First":"string"
Name1Middle
- The parsed middle name or initial of the primary seller.
Protocol Syntax JSON "Name1Middle":"string"
Name1Last
- The last name of the primary seller.
Protocol Syntax JSON "Name1Last":"string"
Name1Suffix
- The suffix of the primary seller. E.g. Jr, III, etc.
Protocol Syntax JSON "Name1Suffix":"string"
Name1ClassType
- Decribes the class of the primary seller based off of the name and vesting. E.g. individual, trust, company.
Protocol Syntax JSON "Name1ClassType":"string"
Name1LegalType
- The legal ownership type of the primary seller. E.g. married, beneficiary, etc.
Protocol Syntax JSON "Name1LegalType":"string"
Name2Full
- The full name of the secondary seller.
Protocol Syntax JSON "Name2Full":"string"
Name2First
- The first name of the secondary seller.
Protocol Syntax JSON "Name2First":"string"
Name2Middle
- The parsed middle name or initial of the secondary seller.
Protocol Syntax JSON "Name2Middle":"string"
Name2Last
- The last name of the secondary seller.
Protocol Syntax JSON "Name2Last":"string"
Name2Suffix
- The suffix of the secondary seller. E.g. Jr, III, etc.
Protocol Syntax JSON "Name2Suffix":"string"
Name2ClassType
- Decribes the class of the secondary seller based off of the name and vesting. E.g. individual, trust, company.
Protocol Syntax JSON "Name2ClassType":"string"
Name2LegalType
- The legal ownership type of the secondary seller. E.g. married, beneficiary, etc.
Protocol Syntax JSON "Name2LegalType":"string"
GrpSecondaryGrantor
Name3Full
- The full name of the third seller.
Protocol Syntax JSON "Name3Full":"string"
Name3First
- The first name of the third seller.
Protocol Syntax JSON "Name3First":"string"
Name3Middle
- The parsed middle name or initial of the third seller.
Protocol Syntax JSON "Name3Middle":"string"
Name3Last
- The last name of the third seller.
Protocol Syntax JSON "Name3Last":"string"
Name3Suffix
- The suffix of the third seller. E.g. Jr, III, etc.
Protocol Syntax JSON "Name3Suffix":"string"
Name3ClassType
- Decribes the class of the third seller based off of the name and vesting. E.g. individual, trust, company.
Protocol Syntax JSON "Name3ClassType":"string"
Name4Full
- The full name of the fourth seller.
Protocol Syntax JSON "Name4Full":"string"
Name4First
- The first name of the fourth seller.
Protocol Syntax JSON "Name4First":"string"
Name4Middle
- The parsed middle name or initial of the fourth seller.
Protocol Syntax JSON "Name4Middle":"string"
Name4Last
- The last name of the fourth seller.
Protocol Syntax JSON "Name4Last":"string"
Name4Suffix
- The suffix of the fourth seller. E.g. Jr, III, etc.
Protocol Syntax JSON "Name4Suffix":"string"
Name4ClassType
- Decribes the class of the fourth seller based off of the name and vesting. E.g. individual, trust, company.
Protocol Syntax JSON "Name4ClassType":"string"
GrpPrimaryGrantee
Name1Full
- The full name of the primary buyer or borrower.
Protocol Syntax JSON "Name1Full":"string"
Name1First
- The first name of the primary buyer or borrower. This will be blank if this is not an individual.
Protocol Syntax JSON "Name1First":"string"
Name1Middle
- The parsed middle name or initial of the primary buyer or borrower.
Protocol Syntax JSON "Name1Middle":"string"
Name1Last
- The last name of the primary buyer or borrower. This will be the full name if this is not an individual.
Protocol Syntax JSON "Name1Last":"string"
Name1Suffix
- The suffix of the primary buyer or borrower. E.g. Jr, III, etc.
Protocol Syntax JSON "Name1Suffix":"string"
Name1ClassType
- Decribes the class of the primary buyer or borrower based off of the name and vesting. E.g. individual, trust, company.
Protocol Syntax JSON "Name1ClassType":"string"
Name1LegalType
- The legal ownership type of the primary buyer or borrower. E.g. married, beneficiary, etc.
Protocol Syntax JSON "Name1LegalType":"string"
Name2Full
- The full name of the secondary buyer or borrower.
Protocol Syntax JSON "Name2Full":"string"
Name2First
- The first name of the secondary buyer or borrower. This will be blank if this is not an individual.
Protocol Syntax JSON "Name2First":"string"
Name2Middle
- The parsed middle name or initial of the secondary buyer or borrower.
Protocol Syntax JSON "Name2Middle":"string"
Name2Last
- The last name of the secondary buyer or borrower. This will be the full name if this is not an individual.
Protocol Syntax JSON "Name2Last":"string"
Name2Suffix
- The suffix of the secondary buyer or borrower. E.g. Jr, III, etc.
Protocol Syntax JSON "Name2Suffix":"string"
Name2ClassType
- Decribes the class of the secondary buyer or borrower based off of the name and vesting. E.g. individual, trust, company.
Protocol Syntax JSON "Name2ClassType":"string"
GrpSecondaryGrantee
Name3Full
- The full name of the third buyer or borrower.
Protocol Syntax JSON "Name3Full":"string"
Name3First
- The first name of the third buyer or borrower. This will be blank if this is not an individual.
Protocol Syntax JSON "Name3First":"string"
Name3Middle
- The parsed middle name or initial of the third buyer or borrower.
Protocol Syntax JSON "Name3Middle":"string"
Name3Last
- The last name of the third buyer or borrower. This will be the full name if this is not an individual.
Protocol Syntax JSON "Name3Last":"string"
Name3Suffix
- The suffix of the third buyer or borrower. E.g. Jr, III, etc.
Protocol Syntax JSON "Name3Suffix":"string"
Name3ClassType
- Decribes the class of the third buyer or borrower based off of the name and vesting. E.g. individual, trust, company.
Protocol Syntax JSON "Name3ClassType":"string"
Name4Full
- The full name of the fourth buyer or borrower.
Protocol Syntax JSON "Name4Full":"string"
Name4First
- The first name of the fourth buyer or borrower. This will be blank if this is not an individual.
Protocol Syntax JSON "Name4First":"string"
Name4Middle
- The parsed middle name or initial of the fourth buyer or borrower.
Protocol Syntax JSON "Name4Middle":"string"
Name4Last
- The last name of the fourth buyer or borrower. This will be the full name if this is not an individual.
Protocol Syntax JSON "Name4Last":"string"
Name4Suffix
- The suffix of the fourth buyer or borrower. E.g. Jr, III, etc.
Protocol Syntax JSON "Name4Suffix":"string"
Name4ClassType
- Decribes the class of the fourth buyer or borrower based off of the name and vesting. E.g. individual, trust, company.
Protocol Syntax JSON "Name4ClassType":"string"
GrpTitleCompInfo
StandardizedCode
- The standard code identifying the title company.
Protocol Syntax JSON "StandardizedCode":"string"
StandardizedName
- The standardized name of the title company.
Protocol Syntax JSON "StandardizedName":"string"
TitleCompanyRaw
- The entered name of the title company. This is not standardized.
Protocol Syntax JSON "TitleCompanyRaw":"string"
GrpMortgage1
DocNumberFormatted
- The first mortgage number based on the book, page, or instrument number.
Protocol Syntax JSON "DocNumberFormatted":"string"
DocNumberLegacy
- The first mortgage loan instrument, book, or page number located on the first sequence trust deed.
Protocol Syntax JSON "DocNumberLegacy":"string"
InstrumentNumber
- If the first mortgage is indexed by a recorder's reference number, this will contain that number. Usually the year will not be added to this field unless there is a regional requirement.
Protocol Syntax JSON "InstrumentNumber":"string"
Book
- The first mortgage number book. This can contain either the recorder document book or the legal description book.
Protocol Syntax JSON "Book":"string"
Page
- The first mortgage number page. This can contain either the recorder document page or the legal description page.
Protocol Syntax JSON "Page":"string"
RecordingDate
- The first mortgage official filing date with the format: YYYY-MM-DD. This is normally located on the document.
Protocol Syntax JSON "RecordingDate":"string"
Type
- The type of loan for the first mortgage. E.g. conventional, construction, FHA, etc.
Protocol Syntax JSON "Type":"string"
Amount
- The loan amount of the first mortgage.
Protocol Syntax JSON "Amount":"string"
LenderCode
- The standard ID code of the lender for the first mortgage.
Protocol Syntax JSON "LenderCode":"string"
LenderFullName
- The full standardized name of the lender for the first mortgage.
Protocol Syntax JSON "LenderFullName":"string"
LenderFirstName
- The first name of the first mortgage lender. This will be the complete name if the lender is a company.
Protocol Syntax JSON "LenderFirstName":"string"
LenderLastName
- The last name of the first mortgage lender.
Protocol Syntax JSON "LenderLastName":"string"
LenderAddress
- The address of the first mortgage lender.
Protocol Syntax JSON "LenderAddress":"string"
LenderCity
- The city of the first mortgage lender.
Protocol Syntax JSON "LenderCity":"string"
LenderState
- The state of the first mortgage lender.
Protocol Syntax JSON "LenderState":"string"
LenderZip
- The Zip code of the first mortgage lender.
Protocol Syntax JSON "LenderZip":"string"
LenderType
- The lender type for the first mortgage.
Protocol Syntax JSON "LenderType":"string"
IsLenderSeller
- Specifies if the lender is also the seller for the first mortgage.
Protocol Syntax JSON "IsLenderSeller":"string"
Term
- The duration of the first mortgage. See the associated TermType to know the unit of measurement.
Protocol Syntax JSON "Term":"string"
TermType
- The duration unit of measurement (month, year) for the first mortgage. See the associated Term to know the duration.
Protocol Syntax JSON "TermType":"string"
TermDate
- The due date of the first mortage.
Protocol Syntax JSON "TermDate":"string"
PrepaymentPenaltyFlag
- Specifies if the first mortgage has a pre-payment penalty.
Protocol Syntax JSON "PrepaymentPenaltyFlag":"string"
PrepaymentTerm
- The number of months the first mortgage must remain active.
Protocol Syntax JSON "PrepaymentTerm":"string"
InterestRateType
- The interest rate type for the first mortgage.
Protocol Syntax JSON "InterestRateType":"string"
InterestRate
- The interest rate of the first mortgage.
Protocol Syntax JSON "InterestRate":"string"
InterestTypeInitial
- The initial type of interest rate on the first mortgage. E.g. fixed or adjustable.
Protocol Syntax JSON "InterestTypeInitial":"string"
FixedStepConvRate
- The interest rate change in a fixed step conversion mortgage for the first mortgage.
Protocol Syntax JSON "FixedStepConvRate":"string"
InterestMargin
- The fixed percentage rate added to an index value to determine the fully indexed interest rate of an adjustable rate mortage for the first mortgage.
Protocol Syntax JSON "InterestMargin":"string"
InterestIndex
- The benchmark interest rate the first mortgage's rate is based on.
Protocol Syntax JSON "InterestIndex":"string"
InterestRateMax
- The maximum interest rate allowed for the first mortgage, if it is an adjustable rate.
Protocol Syntax JSON "InterestRateMax":"string"
AdjustableRateIndex
- The benchmark interest rate the first mortgage's adjustable rate is based on.
Protocol Syntax JSON "AdjustableRateIndex":"string"
InterestOnlyFlag
- Specifies if the first mortgage has an interest only period.
Protocol Syntax JSON "InterestOnlyFlag":"string"
InterestOnlyPeriod
- The length of the interest only period, in years.
Protocol Syntax JSON "InterestOnlyPeriod":"string"
GrpMortgage2
DocNumberFormatted
- The second mortgage number based on the book, page, or instrument number.
Protocol Syntax JSON "DocNumberFormatted":"string"
DocNumberLegacy
- The second mortgage loan instrument, book, or page number located on the first sequence trust deed.
Protocol Syntax JSON "DocNumberLegacy":"string"
InstrumentNumber
- If the second mortgage is indexed by a recorder's reference number, this will contain that number. Usually the year will not be added to this field unless there is a regional requirement.
Protocol Syntax JSON "InstrumentNumber":"string"
Book
- The second mortgage number book. This can contain either the recorder document book or the legal description book.
Protocol Syntax JSON "Book":"string"
Page
- The second mortgage number page. This can contain either the recorder document page or the legal description page.
Protocol Syntax JSON "Page":"string"
RecordingDate
- The second mortgage official filing date with the format: YYYY-MM-DD. This is normally located on the document.
Protocol Syntax JSON "RecordingDate":"string"
Type
- The type of loan for the second mortgage. E.g. conventional, construction, FHA, etc.
Protocol Syntax JSON "Type":"string"
Amount
- The loan amount of the second mortgage.
Protocol Syntax JSON "Amount":"string"
LenderCode
- The standard ID code of the lender for the second mortgage.
Protocol Syntax JSON "LenderCode":"string"
LenderFullName
- The full standardized name of the lender for the second mortgage.
Protocol Syntax JSON "LenderFullName":"string"
LenderFirstName
- The first name of the second mortgage lender. This will be the complete name if the lender is a company.
Protocol Syntax JSON "LenderFirstName":"string"
LenderLastName
- The last name of the second mortgage lender.
Protocol Syntax JSON "LenderLastName":"string"
LenderAddress
- The address of the second mortgage lender.
Protocol Syntax JSON "LenderAddress":"string"
LenderCity
- The city of the second mortgage lender.
Protocol Syntax JSON "LenderCity":"string"
LenderState
- The state of the second mortgage lender.
Protocol Syntax JSON "LenderState":"string"
LenderZip
- The Zip code of the second mortgage lender.
Protocol Syntax JSON "LenderZip":"string"
LenderType
- The lender type for the second mortgage.
Protocol Syntax JSON "LenderType":"string"
IsLenderSeller
- Specifies if the lender is also the seller for the second mortgage.
Protocol Syntax JSON "IsLenderSeller":"string"
Term
- The duration of the second mortgage. See the associated TermType to know the unit of measurement.
Protocol Syntax JSON "Term":"string"
TermType
- The duration unit of measurement (month, year) for the second mortgage. See the associated Term to know the duration.
Protocol Syntax JSON "TermType":"string"
TermDate
- The due date of the second mortage.
Protocol Syntax JSON "TermDate":"string"
PrepaymentPenaltyFlag
- Specifies if the second mortgage has a pre-payment penalty.
Protocol Syntax JSON "PrepaymentPenaltyFlag":"string"
PrepaymentTerm
- The number of months the second mortgage must remain active.
Protocol Syntax JSON "PrepaymentTerm":"string"
InterestRateType
- The interest rate type for the second mortgage.
Protocol Syntax JSON "InterestRateType":"string"
InterestRate
- The interest rate of the second mortgage.
Protocol Syntax JSON "InterestRate":"string"
InterestTypeInitial
- The initial type of interest rate on the second mortgage. E.g. fixed or adjustable.
Protocol Syntax JSON "InterestTypeInitial":"string"
FixedStepConvRate
- The interest rate change in a fixed step conversion mortgage for the second mortgage.
Protocol Syntax JSON "FixedStepConvRate":"string"
InterestMargin
- The fixed percentage rate added to an index value to determine the fully indexed interest rate of an adjustable rate mortage for the second mortgage.
Protocol Syntax JSON "InterestMargin":"string"
InterestIndex
- The benchmark interest rate the second mortgage's rate is based on.
Protocol Syntax JSON "InterestIndex":"string"
InterestRateMax
- The maximum interest rate allowed for the second mortgage, if it is an adjustable rate.
Protocol Syntax JSON "InterestRateMax":"string"
AdjustableRateIndex
- The benchmark interest rate the second mortgage's adjustable rate is based on.
Protocol Syntax JSON "AdjustableRateIndex":"string"
InterestOnlyFlag
- Specifies if the second mortgage has an interest only period.
Protocol Syntax JSON "InterestOnlyFlag":"string"
InterestOnlyPeriod
- The length of the interest only period, in years.
Protocol Syntax JSON "InterestOnlyPeriod":"string"
GrpValuation
EstDownPayment
- The estimated down payment made at the time of purchase.
Protocol Syntax JSON "EstDownPayment":"string"
EstLTV
- The estimated loan to value at the time of purchase.
Protocol Syntax JSON "EstLTV":"string"