Property V4:LookupDeeds

From Melissa Data Wiki
Revision as of 01:26, 16 December 2017 by Admin (talk | contribs)
Jump to navigation Jump to search

← Property V4

Property V4 Navigation
Introduction
Licensing
Input/Output
LookupDeeds
  ↳  Request
  ↳  Response
  ↳  Service Codes
LookupHomesByOwner
  ↳  Request
  ↳  Response
LookupProperty
  ↳  Request
  ↳  Response
  ↳  Service Codes
  ↳  Frequencies
Examples
REST JSON
POST JSON
POST XML
Result Codes
Result Code Use
Property V4 Result Codes
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.

  1. FIPS & APN
  2. Property MAK
  3. Transaction ID
  4. 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 stamped or printed 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

Protocol Syntax
JSON "DocNumberFormatted":"string"


DocNumberLegacy

Protocol Syntax
JSON "DocNumberLegacy":"string"


InstrumentNumber

Protocol Syntax
JSON "InstrumentNumber":"string"


Book

Protocol Syntax
JSON "Book":"string"


Page

Protocol Syntax
JSON "Page":"string"


RecordingDate

Protocol Syntax
JSON "RecordingDate":"string"


Type

Protocol Syntax
JSON "Type":"string"


Amount

Protocol Syntax
JSON "Amount":"string"


LenderCode

Protocol Syntax
JSON "LenderCode":"string"


LenderFullName

Protocol Syntax
JSON "LenderFullName":"string"


LenderFirstName

Protocol Syntax
JSON "LenderFirstName":"string"


LenderLastName

Protocol Syntax
JSON "LenderLastName":"string"


LenderAddress

Protocol Syntax
JSON "LenderAddress":"string"


LenderCity

Protocol Syntax
JSON "LenderCity":"string"


LenderState

Protocol Syntax
JSON "LenderState":"string"


LenderZip

Protocol Syntax
JSON "LenderZip":"string"


LenderType

Protocol Syntax
JSON "LenderType":"string"


IsLenderSeller

Protocol Syntax
JSON "IsLenderSeller":"string"


Term

Protocol Syntax
JSON "Term":"string"


TermType

Protocol Syntax
JSON "TermType":"string"


TermDate

Protocol Syntax
JSON "TermDate":"string"


PrepaymentPenaltyFlag

Protocol Syntax
JSON "PrepaymentPenaltyFlag":"string"


PrepaymentTerm

Protocol Syntax
JSON "PrepaymentTerm":"string"


InterestRateType

Protocol Syntax
JSON "InterestRateType":"string"


InterestRate

Protocol Syntax
JSON "InterestRate":"string"


InterestTypeInitial

Protocol Syntax
JSON "InterestTypeInitial":"string"


FixedStepConvRate

Protocol Syntax
JSON "FixedStepConvRate":"string"


InterestMargin

Protocol Syntax
JSON "InterestMargin":"string"


InterestIndex

Protocol Syntax
JSON "InterestIndex":"string"


InterestRateMax

Protocol Syntax
JSON "InterestRateMax":"string"


AdjustableRateIndex

Protocol Syntax
JSON "AdjustableRateIndex":"string"


InterestOnlyFlag

Protocol Syntax
JSON "InterestOnlyFlag":"string"


InterestOnlyPeriod

Protocol Syntax
JSON "InterestOnlyPeriod":"string"


GrpMortgage2

DocNumberFormatted

Protocol Syntax
JSON "DocNumberFormatted":"string"


DocNumberLegacy

Protocol Syntax
JSON "DocNumberLegacy":"string"


InstrumentNumber

Protocol Syntax
JSON "InstrumentNumber":"string"


Book

Protocol Syntax
JSON "Book":"string"


Page

Protocol Syntax
JSON "Page":"string"


RecordingDate

Protocol Syntax
JSON "RecordingDate":"string"


Type

Protocol Syntax
JSON "Type":"string"


Amount

Protocol Syntax
JSON "Amount":"string"


LenderCode

Protocol Syntax
JSON "LenderCode":"string"


LenderFullName

Protocol Syntax
JSON "LenderFullName":"string"


LenderFirstName

Protocol Syntax
JSON "LenderFirstName":"string"


LenderLastName

Protocol Syntax
JSON "LenderLastName":"string"


LenderAddress

Protocol Syntax
JSON "LenderAddress":"string"


LenderCity

Protocol Syntax
JSON "LenderCity":"string"


LenderState

Protocol Syntax
JSON "LenderState":"string"


LenderZip

Protocol Syntax
JSON "LenderZip":"string"


LenderType

Protocol Syntax
JSON "LenderType":"string"


IsLenderSeller

Protocol Syntax
JSON "IsLenderSeller":"string"


Term

Protocol Syntax
JSON "Term":"string"


TermType

Protocol Syntax
JSON "TermType":"string"


TermDate

Protocol Syntax
JSON "TermDate":"string"


PrepaymentPenaltyFlag

Protocol Syntax
JSON "PrepaymentPenaltyFlag":"string"


PrepaymentTerm

Protocol Syntax
JSON "PrepaymentTerm":"string"


InterestRateType

Protocol Syntax
JSON "InterestRateType":"string"


InterestRate

Protocol Syntax
JSON "InterestRate":"string"


InterestTypeInitial

Protocol Syntax
JSON "InterestTypeInitial":"string"


FixedStepConvRate

Protocol Syntax
JSON "FixedStepConvRate":"string"


InterestMargin

Protocol Syntax
JSON "InterestMargin":"string"


InterestIndex

Protocol Syntax
JSON "InterestIndex":"string"


InterestRateMax

Protocol Syntax
JSON "InterestRateMax":"string"


AdjustableRateIndex

Protocol Syntax
JSON "AdjustableRateIndex":"string"


InterestOnlyFlag

Protocol Syntax
JSON "InterestOnlyFlag":"string"


InterestOnlyPeriod

Protocol Syntax
JSON "InterestOnlyPeriod":"string"


GrpValuation

EstDownPayment

Protocol Syntax
JSON "EstDownPayment":"string"


EstLTV

Protocol Syntax
JSON "EstLTV":"string"