Personator Consumer:Response: Difference between revisions

From Melissa Data Wiki
Jump to navigation Jump to search
← Older editNewer edit →
No edit summary
No edit summary
Line 25: Line 25:
|Total Records||TotalRecords
|Total Records||TotalRecords
|-
|-
|AddressDeliveryInstallation||rowspan="110" valign="center"|Record||AddressDeliveryInstallation
|AddressDeliveryInstallation||rowspan="116" valign="center"|Record||AddressDeliveryInstallation
|-
|-
|AddressExtras||AddressExtras
|AddressExtras||AddressExtras
Line 80: Line 80:
|-
|-
|CensusTract||CensusTract
|CensusTract||CensusTract
|-
|ChildrenAgeRange||ChildrenAgeRange
|-
|-
|City||City
|City||City
Line 100: Line 102:
|-
|-
|CountySubdivisionName||CountySubdivisionName
|CountySubdivisionName||CountySubdivisionName
|-
|CreditCardUser||CreditCardUser
|-
|-
|DateOfBirth||DateOfBirth
|DateOfBirth||DateOfBirth
Line 124: Line 128:
|-
|-
|EmailAddress||EmailAddress
|EmailAddress||EmailAddress
|-
|EthnicCode||EthnicCode
|-
|EthnicGroup||EthnicGroup
|-
|-
|Gender||Gender
|Gender||Gender
Line 194: Line 202:
|-
|-
|Plus4||Plus4
|Plus4||Plus4
|-
|PoliticalParty||PoliticalParty
|-
|-
|PostalCode||PostalCode
|PostalCode||PostalCode
|-
|-
|PresenceOfChildren||PresenceOfChildren
|PresenceOfChildren||PresenceOfChildren
|-
|PresenceOfSenior||PresenceOfSenior
|-
|-
|PrivateMailBox||PrivateMailBox
|PrivateMailBox||PrivateMailBox
Line 248: Line 260:




<h3 style="background-color:rgb(240,240,240);">Transmission Reference</h3>
<h3 style="background-color:rgb(240,240,240);">TransmissionReference</h3>
:This is a string value that serves as a unique identifier for this set of records. It is returned as sent by the Request Array, allowing you to match the Response to the Request.
:This is a string value that serves as a unique identifier for this set of records. It is returned as sent by the Request Array, allowing you to match the Response to the Request.


Line 260: Line 272:




<h3 style="background-color:rgb(240,240,240);">Transmission Results</h3>
<h3 style="background-color:rgb(240,240,240);">TransmissionResults</h3>
:This is a string value that lists error codes from any errors caused by the most recent request as a whole.
:This is a string value that lists error codes from any errors caused by the most recent request as a whole.


Line 274: Line 286:




<h3 style="background-color:rgb(240,240,240);">Total Records</h3>
<h3 style="background-color:rgb(240,240,240);">TotalRecords</h3>
:Displays the total number of records returned.
:Displays the total number of records returned.


Line 302: Line 314:




<h3 style="background-color:rgb(240,240,240);">Address Delivery Installation</h3>
<h3 style="background-color:rgb(240,240,240);">AddressDeliveryInstallation</h3>
:Canada Only.
:Canada Only.


Line 316: Line 328:




<h3 style="background-color:rgb(240,240,240);">Address Extras</h3>
<h3 style="background-color:rgb(240,240,240);">AddressExtras</h3>
:Any extra information that does not fit in the AddressLine fields.
:Any extra information that does not fit in the AddressLine fields.


Line 328: Line 340:




<h3 style="background-color:rgb(240,240,240);">Address House Number</h3>
<h3 style="background-color:rgb(240,240,240);">AddressHouseNumber</h3>
:Returns the parsed house number for the address entered in the AddressLine field.
:Returns the parsed house number for the address entered in the AddressLine field.


Line 340: Line 352:




<h3 style="background-color:rgb(240,240,240);">Address Key</h3>
<h3 style="background-color:rgb(240,240,240);">AddressKey</h3>
:Returns a unique identifier for an address. This key can be used with other current and future Melissa services.
:Returns a unique identifier for an address. This key can be used with other current and future Melissa services.


Line 352: Line 364:




<h3 style="background-color:rgb(240,240,240);">Address Line 1</h3>
<h3 style="background-color:rgb(240,240,240);">AddressLine1</h3>
:Returns the address entered in the AddressLine field. If two addresses were entered and only one is valid, the valid address is returned instead. This includes the suite and private mailbox.
:Returns the address entered in the AddressLine field. If two addresses were entered and only one is valid, the valid address is returned instead. This includes the suite and private mailbox.


Line 364: Line 376:




<h3 style="background-color:rgb(240,240,240);">Address Line 2</h3>
<h3 style="background-color:rgb(240,240,240);">AddressLine2</h3>
:If two addresses are passed into the AddressLine field, the second address is returned here. If only one of two addresses is valid, the valid address will be returned in Address Line 1.
:If two addresses are passed into the AddressLine field, the second address is returned here. If only one of two addresses is valid, the valid address will be returned in Address Line 1.


Line 376: Line 388:




<h3 style="background-color:rgb(240,240,240);">Address Lock Box</h3>
<h3 style="background-color:rgb(240,240,240);">AddressLockBox</h3>
:Canada Only.
:Canada Only.


Line 390: Line 402:




<h3 style="background-color:rgb(240,240,240);">Address Post Direction</h3>
<h3 style="background-color:rgb(240,240,240);">AddressPostDirection</h3>
:Returns the parsed post-direction for the address entered in the AddressLine field.
:Returns the parsed post-direction for the address entered in the AddressLine field.


Line 402: Line 414:




<h3 style="background-color:rgb(240,240,240);">Address Pre Direction</h3>
<h3 style="background-color:rgb(240,240,240);">AddressPreDirection</h3>
:Returns the parsed pre-direction for the address entered in the AddressLine field.
:Returns the parsed pre-direction for the address entered in the AddressLine field.


Line 414: Line 426:




<h3 style="background-color:rgb(240,240,240);">Address Private Mailbox Name</h3>
<h3 style="background-color:rgb(240,240,240);">AddressPrivateMailboxName</h3>
:Returns the parsed private mailbox name for the address entered in the AddressLine field.
:Returns the parsed private mailbox name for the address entered in the AddressLine field.


Line 426: Line 438:




<h3 style="background-color:rgb(240,240,240);">Address Private Mailbox Range</h3>
<h3 style="background-color:rgb(240,240,240);">AddressPrivateMailboxRange</h3>
:Returns the parsed private mailbox range for the address entered in the AddressLine field.
:Returns the parsed private mailbox range for the address entered in the AddressLine field.


Line 438: Line 450:




<h3 style="background-color:rgb(240,240,240);">Address Route Service</h3>
<h3 style="background-color:rgb(240,240,240);">AddressRouteService</h3>
:Canada Only.
:Canada Only.


Line 452: Line 464:




<h3 style="background-color:rgb(240,240,240);">Address Street Name</h3>
<h3 style="background-color:rgb(240,240,240);">AddressStreetName</h3>
:Returns the parsed street name for the address entered in the AddressLine field.
:Returns the parsed street name for the address entered in the AddressLine field.


Line 464: Line 476:




<h3 style="background-color:rgb(240,240,240);">Address Street Suffix</h3>
<h3 style="background-color:rgb(240,240,240);">AddressStreetSuffix</h3>
:Returns the parsed street suffix for the address entered in the AddressLine field.
:Returns the parsed street suffix for the address entered in the AddressLine field.


Line 476: Line 488:




<h3 style="background-color:rgb(240,240,240);">Address Suite Name</h3>
<h3 style="background-color:rgb(240,240,240);">AddressSuiteName</h3>
:Returns the parsed suite name for the address entered in the AddressLine field.
:Returns the parsed suite name for the address entered in the AddressLine field.


Line 488: Line 500:




<h3 style="background-color:rgb(240,240,240);">Address Suite Number</h3>
<h3 style="background-color:rgb(240,240,240);">AddressSuiteNumber</h3>
:Returns the parsed suite number for the address entered in the AddressLine field.
:Returns the parsed suite number for the address entered in the AddressLine field.


Line 500: Line 512:




<h3 style="background-color:rgb(240,240,240);">Address Type Code</h3>
<h3 style="background-color:rgb(240,240,240);">AddressTypeCode</h3>
:Returns a code for the address type in the AddressLine field. Please see the [[Result Code Details#Personator|Result Code Details]] for the list of possible codes.
:Returns a code for the address type in the AddressLine field. Please see the [[Result Code Details#Personator|Result Code Details]] for the list of possible codes.


Line 512: Line 524:




<h3 style="background-color:rgb(240,240,240);">Area Code</h3>
<h3 style="background-color:rgb(240,240,240);">AreaCode</h3>
:Returns the parsed area code for the phone number entered in the Phone field.
:Returns the parsed area code for the phone number entered in the Phone field.


Line 524: Line 536:




<h3 style="background-color:rgb(240,240,240);">CBSA Code</h3>
<h3 style="background-color:rgb(240,240,240);">CBSACode</h3>
:Census Bureau’s Core Based Statistical Area (CBSA). Returns the 5-digit code for the CBSA associated with the requested record.
:Census Bureau’s Core Based Statistical Area (CBSA). Returns the 5-digit code for the CBSA associated with the requested record.


Line 536: Line 548:




<h3 style="background-color:rgb(240,240,240);">CBSA Division Code</h3>
<h3 style="background-color:rgb(240,240,240);">CBSADivisionCode</h3>
:Returns the code for a division associated with the requested record, if any.
:Returns the code for a division associated with the requested record, if any.


Line 548: Line 560:




<h3 style="background-color:rgb(240,240,240);">CBSA Division Level</h3>
<h3 style="background-color:rgb(240,240,240);">CBSADivisionLevel</h3>
:Returns whether the CBSA division, if any, is metropolitan or micropolitan.
:Returns whether the CBSA division, if any, is metropolitan or micropolitan.


Line 560: Line 572:




<h3 style="background-color:rgb(240,240,240);">CBSA Division Title</h3>
<h3 style="background-color:rgb(240,240,240);">CBSADivisionTitle</h3>
:Returns the title for the CBSA division, if any.
:Returns the title for the CBSA division, if any.


Line 572: Line 584:




<h3 style="background-color:rgb(240,240,240);">CBSA Level</h3>
<h3 style="background-color:rgb(240,240,240);">CBSALevel</h3>
:Returns whether the CBSA is metropolitan or micropolitan.
:Returns whether the CBSA is metropolitan or micropolitan.


Line 584: Line 596:




<h3 style="background-color:rgb(240,240,240);">CBSA Title</h3>
<h3 style="background-color:rgb(240,240,240);">CBSATitle</h3>
:Returns the title for the CBSA.
:Returns the title for the CBSA.


Line 596: Line 608:




<h3 style="background-color:rgb(240,240,240);">Carrier Route</h3>
<h3 style="background-color:rgb(240,240,240);">CarrierRoute</h3>
:Returns a 4-character code defining the carrier route for this record.
:Returns a 4-character code defining the carrier route for this record.


Line 608: Line 620:




<h3 style="background-color:rgb(240,240,240);">Census Block</h3>
<h3 style="background-color:rgb(240,240,240);">CensusBlock</h3>
:Returns a 4-digit string containing the census block number associated with the requested record.
:Returns a 4-digit string containing the census block number associated with the requested record.


Line 620: Line 632:




<h3 style="background-color:rgb(240,240,240);">Census Key</h3>
<h3 style="background-color:rgb(240,240,240);">CensusKey</h3>
:Returns a 15 digit string containing the concatenated County FIPS, Census Tract and Census Block.
:Returns a 15 digit string containing the concatenated County FIPS, Census Tract and Census Block.


Line 632: Line 644:




<h3 style="background-color:rgb(240,240,240);">Census Tract</h3>
<h3 style="background-color:rgb(240,240,240);">CensusTract</h3>
:Returns a 4-to 6-digit string containing the census tract number associated with the requested record.
:Returns a 4-to 6-digit string containing the census tract number associated with the requested record.


Line 643: Line 655:
|-
|-
|SOAP/XML||<code><CensusTract>'''''string'''''</CensusTract></code>
|SOAP/XML||<code><CensusTract>'''''string'''''</CensusTract></code>
|}
<h3 style="background-color:rgb(240,240,240);">ChildrenAgeRange</h3>
:Returns the age range of children present in the household.
:{| class="alternate01"
!Value
|-
|Blank
|-
|0-2
|-
|3-5
|-
|6-10
|-
|11-15
|-
|16-17
|}
:{| class="alternate01"
!Protocol !! Syntax
|-
|JSON||<code>"ChildrenAgeRange":"'''''string'''''"</code>
|-
|SOAP/XML||<code><ChildrenAgeRange>'''''string'''''</ChildrenAgeRange></code>
|}
|}


Line 658: Line 698:




<h3 style="background-color:rgb(240,240,240);">City Abbreviation</h3>
<h3 style="background-color:rgb(240,240,240);">CityAbbreviation</h3>
:Returns an abbreviation for the city entered in the City field, if any.
:Returns an abbreviation for the city entered in the City field, if any.


Line 670: Line 710:




<h3 style="background-color:rgb(240,240,240);">Company Name</h3>
<h3 style="background-color:rgb(240,240,240);">CompanyName</h3>
:Returns the company name.
:Returns the company name.


Line 682: Line 722:




<h3 style="background-color:rgb(240,240,240);">Congressional District</h3>
<h3 style="background-color:rgb(240,240,240);">CongressionalDistrict</h3>
:Returns the 2-digit congressional district that belongs to the requested record.
:Returns the 2-digit congressional district that belongs to the requested record.


Line 694: Line 734:




<h3 style="background-color:rgb(240,240,240);">Country Code</h3>
<h3 style="background-color:rgb(240,240,240);">CountryCode</h3>
:Returns the country code for the country in the Country field.
:Returns the country code for the country in the Country field.


Line 706: Line 746:




<h3 style="background-color:rgb(240,240,240);">Country Name</h3>
<h3 style="background-color:rgb(240,240,240);">CountryName</h3>
:Returns the country name for the record.
:Returns the country name for the record.


Line 718: Line 758:




<h3 style="background-color:rgb(240,240,240);">County FIPS</h3>
<h3 style="background-color:rgb(240,240,240);">CountyFIPS</h3>
:Returns the FIPS code for the county in the County field.
:Returns the FIPS code for the county in the County field.


Line 730: Line 770:




<h3 style="background-color:rgb(240,240,240);">County Name</h3>
<h3 style="background-color:rgb(240,240,240);">CountyName</h3>
:Returns the county name.
:Returns the county name.


Line 742: Line 782:




<h3 style="background-color:rgb(240,240,240);">County Subdivision Code</h3>
<h3 style="background-color:rgb(240,240,240);">CountySubdivisionCode</h3>
:Returns a 5 digit string representing the County Subdivision Code for the requested record.
:Returns a 5 digit string representing the County Subdivision Code for the requested record.


Line 754: Line 794:




<h3 style="background-color:rgb(240,240,240);">County Subdivision Name</h3>
<h3 style="background-color:rgb(240,240,240);">CountySubdivisionName</h3>
:Returns the County Subdivision Name for the requested record.
:Returns the County Subdivision Name for the requested record.


Line 766: Line 806:




<h3 style="background-color:rgb(240,240,240);">Date Of Birth</h3>
<h3 style="background-color:rgb(240,240,240);">CreditCardUser</h3>
:Returns the date of birth in the format YYYYMM. Accuracy is only to the month.
:Returns whether the user has a credit card or not.


:{| class="alternate01"
:{| class="alternate01"
!Protocol !! Syntax
!Value
|-
|-
|JSON||<code>"DateOfBirth":"'''''string'''''"</code>
|Blank
|-
|Yes
|-
|No
|}
 
:{| class="alternate01"
!Protocol !! Syntax
|-
|JSON||<code>"CreditCardUser":"'''''string'''''"</code>
|-
|SOAP/XML||<code><CreditCardUser>'''''string'''''</CreditCardUser></code>
|}
 
 
<h3 style="background-color:rgb(240,240,240);">DateOfBirth</h3>
:Returns the date of birth in the format YYYYMM. Accuracy is only to the month.
 
:{| class="alternate01"
!Protocol !! Syntax
|-
|JSON||<code>"DateOfBirth":"'''''string'''''"</code>
|-
|-
|SOAP/XML||<code><DateOfBirth>'''''string'''''</DateOfBirth></code>
|SOAP/XML||<code><DateOfBirth>'''''string'''''</DateOfBirth></code>
Line 778: Line 840:




<h3 style="background-color:rgb(240,240,240);">Date Of Death</h3>
<h3 style="background-color:rgb(240,240,240);">DateOfDeath</h3>
:Returns the full date of death in the format YYYYMMDD.
:Returns the full date of death in the format YYYYMMDD.


Line 790: Line 852:




<h3 style="background-color:rgb(240,240,240);">Delivery Indicator</h3>
<h3 style="background-color:rgb(240,240,240);">DeliveryIndicator</h3>
:Returns an indicator of whether an address is a business address or residential address.
:Returns an indicator of whether an address is a business address or residential address.


Line 802: Line 864:




<h3 style="background-color:rgb(240,240,240);">Delivery Point Check Digit</h3>
<h3 style="background-color:rgb(240,240,240);">DeliveryPointCheckDigit</h3>
:Returns a string value containing the 1-digit delivery point check digit.
:Returns a string value containing the 1-digit delivery point check digit.


Line 814: Line 876:




<h3 style="background-color:rgb(240,240,240);">Delivery Point Code</h3>
<h3 style="background-color:rgb(240,240,240);">DeliveryPointCode</h3>
:Returns a string value containing the 2-digit delivery point code.
:Returns a string value containing the 2-digit delivery point code.


Line 826: Line 888:




<h3 style="background-color:rgb(240,240,240);">Demographics Gender</h3>
<h3 style="background-color:rgb(240,240,240);">DemographicsGender</h3>
:Returns gender based on demographics data.
:Returns gender based on demographics data.


Line 850: Line 912:




<h3 style="background-color:rgb(240,240,240);">Demographics Results</h3>
<h3 style="background-color:rgb(240,240,240);">DemographicsResults</h3>
:If any demographics are enabled, Demographics Results will return a comma delimited string containing all the results of the demographics combined.
:If any demographics are enabled, Demographics Results will return a comma delimited string containing all the results of the demographics combined.


Line 862: Line 924:




<h3 style="background-color:rgb(240,240,240);">Domain Name</h3>
<h3 style="background-color:rgb(240,240,240);">DomainName</h3>
:Returns the parsed domain name for the email entered in the Email field.
:Returns the parsed domain name for the email entered in the Email field.


Line 875: Line 937:


<h3 style="background-color:rgb(240,240,240);">Education</h3>
<h3 style="background-color:rgb(240,240,240);">Education</h3>
:Returns the education level for the requested record.
:Returns the highest level of education completed by an individual.
 
:{| class="alternate01"
!Value
|-
|Blank
|-
|High School
|-
|College
|-
|Graduate School
|-
|Vocational/Technical School
|}


:{| class="alternate01"
:{| class="alternate01"
Line 886: Line 962:




<h3 style="background-color:rgb(240,240,240);">Elementary School District Code</h3>
<h3 style="background-color:rgb(240,240,240);">ElementarySchoolDistrictCode</h3>
:Returns a 5 digit string representing the Elementary School District Code for the requested record.
:Returns a 5 digit string representing the Elementary School District Code for the requested record.


Line 898: Line 974:




<h3 style="background-color:rgb(240,240,240);">Elementary School District Name</h3>
<h3 style="background-color:rgb(240,240,240);">ElementarySchoolDistrictName</h3>
:Returns the Elementary School District Name for the requested record.
:Returns the Elementary School District Name for the requested record.


Line 910: Line 986:




<h3 style="background-color:rgb(240,240,240);">Email Address</h3>
<h3 style="background-color:rgb(240,240,240);">EmailAddress</h3>
:Returns the email address entered in the Email field.
:Returns the email address entered in the Email field.


Line 922: Line 998:




<h3 style="background-color:rgb(240,240,240);">Gender</h3>
<h3 style="background-color:rgb(240,240,240);">EthnicCode</h3>
:Returns a gender for the name in the FullName field.
:Returns an individual’s specific ethnicity.


:{| class="alternate01"
:{| class="alternate01"
!Protocol !! Syntax
!Value
|-
|-
|JSON||<code>"Gender":"'''''string'''''"</code>
|Afghan
|-
|-
|SOAP/XML||<code><Gender>'''''string'''''</Gender></code>
|African-American
|}
 
 
<h3 style="background-color:rgb(240,240,240);">Gender 2</h3>
:Only used if 2 names are in the FullName field. Returns a gender for the second name in the FullName field.
 
:{| class="alternate01"
!Protocol !! Syntax
|-
|-
|JSON||<code>"Gender2":"'''''string'''''"</code>
|Albanian
|-
|-
|SOAP/XML||<code><Gender2>'''''string'''''</Gender2></code>
|Aleutian
|}
 
 
<h3 style="background-color:rgb(240,240,240);">Household Income</h3>
:Returns the range of the household's income.
 
:{| class="alternate01"
!Protocol !! Syntax
|-
|-
|JSON||<code>"HouseholdIncome":"'''''string'''''"</code>
|Algerian
|-
|-
|SOAP/XML||<code><HouseholdIncome>'''''string'''''</HouseholdIncome></code>
|American Indian
|}
 
 
<h3 style="background-color:rgb(240,240,240);">Household Size</h3>
:Returns the household size for the requested record.
 
:{| class="alternate01"
!Protocol !! Syntax
|-
|-
|JSON||<code>"HouseholdSize":"'''''string'''''"</code>
|Arabian
|-
|-
|SOAP/XML||<code><HouseholdSize>'''''string'''''</HouseholdSize></code>
|Armenian
|}
 
 
<h3 style="background-color:rgb(240,240,240);">Latitude</h3>
:Returns the geocoded latitude for the address entered in the AddressLine field.
 
:{| class="alternate01"
!Protocol !! Syntax
|-
|-
|JSON||<code>"Latitude":"'''''string'''''"</code>
|Ashanti
|-
|-
|SOAP/XML||<code><Latitude>'''''string'''''</Latitude></code>
|Australian
|}
 
 
<h3 style="background-color:rgb(240,240,240);">Length of Residence</h3>
::Returns the range of the individual's length of residency in their current address.
 
:{| class="alternate01"
!Value
|-
|-
|Less than 1 year
|Austrian
|-
|-
|1-2 years
|Azerbaijani
|-
|-
|2-3 years
|Bahrain
|-
|-
|3-4 years
|Bangladesh
|-
|-
|4-5 years
|Basotho
|-
|-
|5-6 years
|Basque
|-
|-
|6-7 years
|Belgian
|-
|-
|7-8 years
|Belorussian
|-
|-
|8-9 years
|Beninese
|-
|Bhutanese
|-
|Black African
|-
|-
|9-10 years
|Bosnian Muslim
|-
|-
|10-11 years
|Botswanian
|-
|-
|11-12 years
|Bulgarian
|-
|-
|12-13 years
|Burkina Faso
|-
|-
|13-14 years
|Burundian
|-
|-
|14-15 years
|Cameroonian
|-
|-
|15+ years
|Caribbean African American
|-
|-
|Unknown
|Central African Republic
|}
 
:{| class="alternate01"
!Protocol !! Syntax
|-
|-
|JSON||<code>"LengthOfResidence":"'''''string'''''"</code>
|Chadian
|-
|-
|SOAP/XML||<code><LengthOfResidence>'''''string'''''</LengthOfResidence></code>
|Chechnyan
|}
 
 
<h3 style="background-color:rgb(240,240,240);">Longitude</h3>
:Returns the geocoded longitude for the address entered in the AddressLine field.
 
:{| class="alternate01"
!Protocol !! Syntax
|-
|-
|JSON||<code>"Longitude":"'''''string'''''"</code>
|Chinese
|-
|-
|SOAP/XML||<code><Longitude>'''''string'''''</Longitude></code>
|Comoros
|}
|-
 
|Congolese
 
|-
<h3 style="background-color:rgb(240,240,240);">Mailbox Name</h3>
|Croatian
:Returns the parsed mailbox name for the email entered in the Email field.
 
:{| class="alternate01"
!Protocol !! Syntax
|-
|-
|JSON||<code>"MailboxName":"'''''string'''''"</code>
|Czech
|-
|-
|SOAP/XML||<code><MailboxName>'''''string'''''</MailboxName></code>
|Danish
|}
 
 
<h3 style="background-color:rgb(240,240,240);">Marital Status</h3>
:Returns the individual's marital status.
 
:{| class="alternate01"
!Protocol !! Syntax
|-
|-
|JSON||<code>"MaritalStatus":"'''''string'''''"</code>
|Djiboutian
|-
|-
|SOAP/XML||<code><MaritalStatus>'''''string'''''</MaritalStatus></code>
|Dutch
|}
 
 
<h3 style="background-color:rgb(240,240,240);">Melissa Address Key</h3>
:Returns a unique key associated with an address.
 
:{| class="alternate01"
!Protocol !! Syntax
|-
|-
|JSON||<code>"MelissaAddressKey":"'''''string'''''"</code>
|Egyptian
|-
|-
|SOAP/XML||<code><MelissaAddressKey>'''''string'''''</MelissaAddressKey></code>
|English
|}
|-
 
|Equatorial Guinea
 
<h3 style="background-color:rgb(240,240,240);">Melissa Address Key Base</h3>
:Returns a unique key associated with a building containing multiple suites/apartments.
 
:{| class="alternate01"
!Protocol !! Syntax
|-
|-
|JSON||<code>"MelissaAddressKeyBase":"'''''string'''''"</code>
|Estonian
|-
|-
|SOAP/XML||<code><MelissaAddressKeyBase>'''''string'''''</MelissaAddressKeyBase></code>
|Ethiopian
|}
 
 
<h3 style="background-color:rgb(240,240,240);">Move Date</h3>
:Returns the date associated with the move address.
 
:{| class="alternate01"
!Protocol !! Syntax
|-
|-
|JSON||<code>"MoveDate":"'''''string'''''"</code>
|Fiji
|-
|-
|SOAP/XML||<code><MoveDate>'''''string'''''</>MoveDate</code>
|Finnish
|}
 
 
<h3 style="background-color:rgb(240,240,240);">Name First</h3>
:Returns the first name in the FullName field.
 
:{| class="alternate01"
!Protocol !! Syntax
|-
|-
|JSON||<code>"NameFirst":"'''''string'''''"</code>
|French
|-
|-
|SOAP/XML||<code><NameFirst>'''''string'''''</NameFirst></code>
|Gabon
|}
|-
 
|Gambian
 
<h3 style="background-color:rgb(240,240,240);">Name First 2</h3>
:Only used if 2 names are in the FullName field. Returns the second name in the FullName field.
 
:{| class="alternate01"
!Protocol !! Syntax
|-
|-
|JSON||<code>"NameFirst2":"'''''string'''''"</code>
|Georgian
|-
|-
|SOAP/XML||<code><NameFirst2>'''''string'''''</NameFirst2></code>
|German
|}
 
 
<h3 style="background-color:rgb(240,240,240);">Name Full</h3>
:Returns the full name for the record.
 
:{| class="alternate01"
!Protocol !! Syntax
|-
|-
|JSON||<code>"NameFull":"'''''string'''''"</code>
|Ghanaian
|-
|-
|SOAP/XML||<code><NameFull>'''''string'''''</NameFull></code>
|Greek
|}
 
 
<h3 style="background-color:rgb(240,240,240);">Name Last</h3>
:Returns the last name in the FullName field.
 
:{| class="alternate01"
!Protocol !! Syntax
|-
|-
|JSON||<code>"NameLast":"'''''string'''''"</code>
|Guinea Bissau
|-
|-
|SOAP/XML||<code><NameLast>'''''string'''''</NameLast></code>
|Guinean
|}
|-
 
|Guyanese
 
<h3 style="background-color:rgb(240,240,240);">Name Last 2</h3>
:Only used if 2 names are in the FullName field. Returns a last name for the second name in the FullName field.
 
:{| class="alternate01"
!Protocol !! Syntax
|-
|-
|JSON||<code>"NameLast2":"'''''string'''''"</code>
|Hausa
|-
|-
|SOAP/XML||<code><NameLast2>'''''string'''''</NameLast2></code>
|Hawaiian
|}
 
 
<h3 style="background-color:rgb(240,240,240);">Name Middle</h3>
:Returns a middle name for the name in the FullName field.
 
:{| class="alternate01"
!Protocol !! Syntax
|-
|-
|JSON||<code>"NameMiddle":"'''''string'''''"</code>
|Icelandic
|-
|-
|SOAP/XML||<code><NameMiddle>'''''string'''''</NameMiddle></code>
|Indian
|}
 
 
<h3 style="background-color:rgb(240,240,240);">Name Middle 2</h3>
:Only used if 2 names are in the FullName field. Returns a middle name for the second name in the FullName field.
 
:{| class="alternate01"
!Protocol !! Syntax
|-
|-
|JSON||<code>"NameMiddle2":"'''''string'''''"</code>
|Indonesian
|-
|-
|SOAP/XML||<code><NameMiddle2>'''''string'''''</NameMiddle2></code>
|Iraqi
|}
|-
 
|Irish
 
<h3 style="background-color:rgb(240,240,240);">Name Prefix</h3>
:Returns a prefix for the name in the FullName field.
 
:{| class="alternate01"
!Protocol !! Syntax
|-
|-
|JSON||<code>"NamePrefix":"'''''string'''''"</code>
|Italian
|-
|-
|SOAP/XML||<code><NamePrefix>'''''string'''''</NamePrefix></code>
|Ivorian
|}
 
 
<h3 style="background-color:rgb(240,240,240);">Name Prefix 2</h3>
:Only used if 2 names are in the FullName field. Returns a prefix for the second name in the FullName field.
 
:{| class="alternate01"
!Protocol !! Syntax
|-
|-
|JSON||<code>"NamePrefix2":"'''''string'''''"</code>
|Japanese
|-
|-
|SOAP/XML||<code><NamePrefix2>'''''string'''''</NamePrefix2></code>
|Jewish
|}
 
 
<h3 style="background-color:rgb(240,240,240);">Name Suffix</h3>
:Returns a suffix for the name in the FullName field.
 
:{| class="alternate01"
!Protocol !! Syntax
|-
|-
|JSON||<code>"NameSuffix":"'''''string'''''"</code>
|Kampuchean/Khmer(Cambodian)
|-
|-
|SOAP/XML||<code><NameSuffix>'''''string'''''</NameSuffix></code>
|Kazakhstan
|}
 
 
<h3 style="background-color:rgb(240,240,240);">Name Suffix 2</h3>
:Only used if 2 names are in the FullName field. Returns a suffix for the second name in the FullName field.
 
:{| class="alternate01"
!Protocol !! Syntax
|-
|-
|JSON||<code>"NameSuffix2":"'''''string'''''"</code>
|Kenyan
|-
|-
|SOAP/XML||<code><NameSuffix2>'''''string'''''</NameSuffix2></code>
|Kirghizia
|}
 
 
<h3 style="background-color:rgb(240,240,240);">New Area Code</h3>
:Returns the parsed new area code for the phone number entered in the Phone field.
 
:{| class="alternate01"
!Protocol !! Syntax
|-
|-
|JSON||<code>"NewAreaCode":"'''''string'''''"</code>
|Korean
|-
|-
|SOAP/XML||<code><NewAreaCode>'''''string'''''</NewAreaCode></code>
|Kurdish
|}
 
 
<h3 style="background-color:rgb(240,240,240);">Occupation</h3>
:Returns the category for the individual's occupation.
 
:{| class="alternate01"
!Value
|-
|-
|Physician/Dentist
|Kuwaiti
|-
|-
|Healthcare
|Kyrgyzstani
|-
|-
|Lawyer/Judge
|Laotian
|-
|Latvian
|-
|Lesotho
|-
|-
|Professional/Technical
|Liberian
|-
|-
|Management
|Libyan
|-
|-
|Teacher/Educator
|Liechtenstein
|-
|-
|Sales/Marketing
|Lithuanian
|-
|-
|Clerical/Service Worker
|Luxembourgian
|-
|-
|Tradesmen/Laborer
|Macedonia
|-
|-
|Farmer
|Madagascan
|-
|-
|Student
|Malawian
|-
|-
|Homemaker
|Malaysian
|-
|-
|Retired
|Maldivian & Tongan
|-
|-
|Federal Employee
|Malian
|-
|-
|Unknown
|Maltese
|-
|-
|Military
|Manx
|-
|-
|Military Retired
|Mauritanian
|-
|-
|Other
|Moldovan
|-
|-
|Business Owner
|Mongolian
|-
|-
|Religious
|Moroccan
|-
|-
|Self Employed
|Mozambican
|-
|-
|Financial
|Multi-Ethnic
|}
 
:{| class="alternate01"
!Protocol !! Syntax
|-
|-
|JSON||<code>"Occupation":"'''''string'''''"</code>
|Myanmar (Burmese)
|-
|-
|SOAP/XML||<code><Occupation>'''''string'''''</Occupation></code>
|Namibian
|}
|-
 
|Nepalese
 
<h3 style="background-color:rgb(240,240,240);">Own Rent</h3>
:Returns the individual's status as owner or renter of the property.
 
:{| class="alternate01"
!Value
|-
|-
|Unknown
|New Zealand
|-
|-
|Definite Renter
|Niger
|-
|-
|Inferred Renter
|Nigerian
|-
|-
|Inferred Owner
|Norwegian
|-
|-
|Definite Owner
|Other Oriental
|}
 
:{| class="alternate01"
!Protocol !! Syntax
|-
|-
|JSON||<code>"OwnRent":"'''''string'''''"</code>
|Pakistani
|-
|-
|SOAP/XML||<code><OwnRent>'''''string'''''</OwnRent></code>
|Papua New Guinean
|}
 
 
<h3 style="background-color:rgb(240,240,240);">Phone Country Code</h3>
:Returns the 2 character country code for the phone number entered in the Phone field.
 
:{| class="alternate01"
!Protocol !! Syntax
|-
|-
|JSON||<code>"PhoneCountryCode":"'''''string'''''"</code>
|Persian
|-
|-
|SOAP/XML||<code><PhoneCountryCode>'''''string'''''</PhoneCountryCode></code>
|Philippine
|}
|-
 
|Pili
 
<h3 style="background-color:rgb(240,240,240);">Phone Country Name</h3>
:Returns the full country name for the phone number entered in the Phone field.
 
:{| class="alternate01"
!Protocol !! Syntax
|-
|-
|JSON||<code>"PhoneCountryName":"'''''string'''''"</code>
|Polish
|-
|-
|SOAP/XML||<code><PhoneCountryName>'''''string'''''</PhoneCountryName></code>
|Portuguese
|}
 
 
<h3 style="background-color:rgb(240,240,240);">Phone Extension</h3>
:Returns the parsed extension for the phone number entered in the Phone field.
 
:{| class="alternate01"
!Protocol !! Syntax
|-
|-
|JSON||<code>"PhoneExtension":"'''''string'''''"</code>
|Qatari
|-
|-
|SOAP/XML||<code><PhoneExtension>'''''string'''''</PhoneExtension></code>
|Romanian
|}
 
 
<h3 style="background-color:rgb(240,240,240);">Phone Number</h3>
:Returns the standardized phone number for the record.
 
:{| class="alternate01"
!Protocol !! Syntax
|-
|-
|JSON||<code>"PhoneNumber":"'''''string'''''"</code>
|Russian
|-
|-
|SOAP/XML||<code><PhoneNumber>'''''string'''''</PhoneNumber></code>
|Saudi
|}
|-
 
|Scottish
 
|-
<h3 style="background-color:rgb(240,240,240);">Phone Prefix</h3>
|Senegalese
:Returns the parsed prefix for the phone number entered in the Phone field.
|-
 
|Serbian
|-
|Seychelles
|-
|Sierre Leone
|-
|Sinhalese (Sri-Lankan)
|-
|Slovakian
|-
|Slovenian
|-
|Somalian
|-
|South African
|-
|Spanish
|-
|Sudanese
|-
|Surinamese
|-
|Swedish
|-
|Swiss
|-
|Syrian
|-
|Tajik
|-
|Tajikistan
|-
|Tanzanian
|-
|Telugan
|-
|Thai
|-
|Tibetan
|-
|Togolese
|-
|Tonga
|-
|Tunisian
|-
|Turkish
|-
|Turkmenistan
|-
|Ugandan
|-
|Ukrainian
|-
|Uzbekistan
|-
|Vanuatuan
|-
|Vietnamese
|-
|Welsh
|-
|Western Samoan
|-
|Xhosa
|-
|Yemeni
|-
|Zairean
|-
|Zambian
|-
|Zimbabwean
|-
|Zulu
|}
 
:{| class="alternate01"
!Protocol !! Syntax
|-
|JSON||<code>"EthnicCode":"'''''string'''''"</code>
|-
|SOAP/XML||<code><EthnicCode>'''''string'''''</EthnicCode></code>
|}
 
 
<h3 style="background-color:rgb(240,240,240);">EthnicGroup</h3>
:Returns the grouped category for a person’s ethnicity. This is a more generalized grouping compared to Ethnic Codes.
 
:{| class="alternate01 collapsible collapsed"
!Value
|-
|Southeast Asian
|-
|Central & Southwest Asian
|-
|Eastern European
|-
|All African American Ethnic Groups
|-
|Middle Eastern
|-
|Jewish
|-
|Mediterranean
|-
|Native American
|-
|Far Eastern
|-
|Polynesian
|-
|Scandinavian
|-
|Other
|-
|Western European
|-
|Hispanic
|}
 
:{| class="alternate01"
!Protocol !! Syntax
|-
|JSON||<code>"EthnicGroup":"'''''string'''''"</code>
|-
|SOAP/XML||<code><EthnicGroup>'''''string'''''</EthnicGroup></code>
|}
 
 
<h3 style="background-color:rgb(240,240,240);">Gender</h3>
:Returns a gender for the name in the FullName field.
 
:{| class="alternate01"
!Protocol !! Syntax
|-
|JSON||<code>"Gender":"'''''string'''''"</code>
|-
|SOAP/XML||<code><Gender>'''''string'''''</Gender></code>
|}
 
 
<h3 style="background-color:rgb(240,240,240);">Gender2</h3>
:Only used if 2 names are in the FullName field. Returns a gender for the second name in the FullName field.
 
:{| class="alternate01"
!Protocol !! Syntax
|-
|JSON||<code>"Gender2":"'''''string'''''"</code>
|-
|SOAP/XML||<code><Gender2>'''''string'''''</Gender2></code>
|}
 
 
<h3 style="background-color:rgb(240,240,240);">HouseholdIncome</h3>
:Returns the range of the household's income.
 
:{| class="alternate01"
!Protocol !! Syntax
|-
|JSON||<code>"HouseholdIncome":"'''''string'''''"</code>
|-
|SOAP/XML||<code><HouseholdIncome>'''''string'''''</HouseholdIncome></code>
|}
 
 
<h3 style="background-color:rgb(240,240,240);">HouseholdSize</h3>
:Returns the number of occupants in the household.
 
:{| class="alternate01 collapsible collapsed"
!Value
|-
|Blank
|-
|1
|-
|2
|-
|3
|-
|4
|-
|5
|-
|6
|-
|7
|-
|8
|-
|9
|}
 
:{| class="alternate01"
!Protocol !! Syntax
|-
|JSON||<code>"HouseholdSize":"'''''string'''''"</code>
|-
|SOAP/XML||<code><HouseholdSize>'''''string'''''</HouseholdSize></code>
|}
 
 
<h3 style="background-color:rgb(240,240,240);">Latitude</h3>
:Returns the geocoded latitude for the address entered in the AddressLine field.
 
:{| class="alternate01"
!Protocol !! Syntax
|-
|JSON||<code>"Latitude":"'''''string'''''"</code>
|-
|SOAP/XML||<code><Latitude>'''''string'''''</Latitude></code>
|}
 
 
<h3 style="background-color:rgb(240,240,240);">Length of Residence</h3>
::Returns the range of the individual's length of residency in their current address.
 
:{| class="alternate01"
!Value
|-
|Less than 1 year
|-
|1-2 years
|-
|2-3 years
|-
|3-4 years
|-
|4-5 years
|-
|5-6 years
|-
|6-7 years
|-
|7-8 years
|-
|8-9 years
|-
|9-10 years
|-
|10-11 years
|-
|11-12 years
|-
|12-13 years
|-
|13-14 years
|-
|14-15 years
|-
|15+ years
|-
|Unknown
|}
 
:{| class="alternate01"
!Protocol !! Syntax
|-
|JSON||<code>"LengthOfResidence":"'''''string'''''"</code>
|-
|SOAP/XML||<code><LengthOfResidence>'''''string'''''</LengthOfResidence></code>
|}
 
 
<h3 style="background-color:rgb(240,240,240);">Longitude</h3>
:Returns the geocoded longitude for the address entered in the AddressLine field.
 
:{| class="alternate01"
!Protocol !! Syntax
|-
|JSON||<code>"Longitude":"'''''string'''''"</code>
|-
|SOAP/XML||<code><Longitude>'''''string'''''</Longitude></code>
|}
 
 
<h3 style="background-color:rgb(240,240,240);">MailboxName</h3>
:Returns the parsed mailbox name for the email entered in the Email field.
 
:{| class="alternate01"
!Protocol !! Syntax
|-
|JSON||<code>"MailboxName":"'''''string'''''"</code>
|-
|SOAP/XML||<code><MailboxName>'''''string'''''</MailboxName></code>
|}
 
 
<h3 style="background-color:rgb(240,240,240);">MaritalStatus</h3>
:Returns the individual's marital status.
 
:{| class="alternate01"
!Protocol !! Syntax
|-
|JSON||<code>"MaritalStatus":"'''''string'''''"</code>
|-
|SOAP/XML||<code><MaritalStatus>'''''string'''''</MaritalStatus></code>
|}
 
 
<h3 style="background-color:rgb(240,240,240);">MelissaAddressKey</h3>
:Returns a unique key associated with an address.
 
:{| class="alternate01"
!Protocol !! Syntax
|-
|JSON||<code>"MelissaAddressKey":"'''''string'''''"</code>
|-
|SOAP/XML||<code><MelissaAddressKey>'''''string'''''</MelissaAddressKey></code>
|}
 
 
<h3 style="background-color:rgb(240,240,240);">MelissaAddressKeyBase</h3>
:Returns a unique key associated with a building containing multiple suites/apartments.
 
:{| class="alternate01"
!Protocol !! Syntax
|-
|JSON||<code>"MelissaAddressKeyBase":"'''''string'''''"</code>
|-
|SOAP/XML||<code><MelissaAddressKeyBase>'''''string'''''</MelissaAddressKeyBase></code>
|}
 
 
<h3 style="background-color:rgb(240,240,240);">MoveDate</h3>
:Returns the date associated with the move address.
 
:{| class="alternate01"
!Protocol !! Syntax
|-
|JSON||<code>"MoveDate":"'''''string'''''"</code>
|-
|SOAP/XML||<code><MoveDate>'''''string'''''</>MoveDate</code>
|}
 
 
<h3 style="background-color:rgb(240,240,240);">NameFirst</h3>
:Returns the first name in the FullName field.
 
:{| class="alternate01"
!Protocol !! Syntax
|-
|JSON||<code>"NameFirst":"'''''string'''''"</code>
|-
|SOAP/XML||<code><NameFirst>'''''string'''''</NameFirst></code>
|}
 
 
<h3 style="background-color:rgb(240,240,240);">NameFirst2</h3>
:Only used if 2 names are in the FullName field. Returns the second name in the FullName field.
 
:{| class="alternate01"
!Protocol !! Syntax
|-
|JSON||<code>"NameFirst2":"'''''string'''''"</code>
|-
|SOAP/XML||<code><NameFirst2>'''''string'''''</NameFirst2></code>
|}
 
 
<h3 style="background-color:rgb(240,240,240);">NameFull</h3>
:Returns the full name for the record.
 
:{| class="alternate01"
!Protocol !! Syntax
|-
|JSON||<code>"NameFull":"'''''string'''''"</code>
|-
|SOAP/XML||<code><NameFull>'''''string'''''</NameFull></code>
|}
 
 
<h3 style="background-color:rgb(240,240,240);">NameLast</h3>
:Returns the last name in the FullName field.
 
:{| class="alternate01"
!Protocol !! Syntax
|-
|JSON||<code>"NameLast":"'''''string'''''"</code>
|-
|SOAP/XML||<code><NameLast>'''''string'''''</NameLast></code>
|}
 
 
<h3 style="background-color:rgb(240,240,240);">NameLast2</h3>
:Only used if 2 names are in the FullName field. Returns a last name for the second name in the FullName field.
 
:{| class="alternate01"
!Protocol !! Syntax
|-
|JSON||<code>"NameLast2":"'''''string'''''"</code>
|-
|SOAP/XML||<code><NameLast2>'''''string'''''</NameLast2></code>
|}
 
 
<h3 style="background-color:rgb(240,240,240);">NameMiddle</h3>
:Returns a middle name for the name in the FullName field.
 
:{| class="alternate01"
!Protocol !! Syntax
|-
|JSON||<code>"NameMiddle":"'''''string'''''"</code>
|-
|SOAP/XML||<code><NameMiddle>'''''string'''''</NameMiddle></code>
|}
 
 
<h3 style="background-color:rgb(240,240,240);">NameMiddle2</h3>
:Only used if 2 names are in the FullName field. Returns a middle name for the second name in the FullName field.
 
:{| class="alternate01"
!Protocol !! Syntax
|-
|JSON||<code>"NameMiddle2":"'''''string'''''"</code>
|-
|SOAP/XML||<code><NameMiddle2>'''''string'''''</NameMiddle2></code>
|}
 
 
<h3 style="background-color:rgb(240,240,240);">NamePrefix</h3>
:Returns a prefix for the name in the FullName field.
 
:{| class="alternate01"
!Protocol !! Syntax
|-
|JSON||<code>"NamePrefix":"'''''string'''''"</code>
|-
|SOAP/XML||<code><NamePrefix>'''''string'''''</NamePrefix></code>
|}
 
 
<h3 style="background-color:rgb(240,240,240);">NamePrefix2</h3>
:Only used if 2 names are in the FullName field. Returns a prefix for the second name in the FullName field.
 
:{| class="alternate01"
!Protocol !! Syntax
|-
|JSON||<code>"NamePrefix2":"'''''string'''''"</code>
|-
|SOAP/XML||<code><NamePrefix2>'''''string'''''</NamePrefix2></code>
|}
 
 
<h3 style="background-color:rgb(240,240,240);">NameSuffix</h3>
:Returns a suffix for the name in the FullName field.
 
:{| class="alternate01"
!Protocol !! Syntax
|-
|JSON||<code>"NameSuffix":"'''''string'''''"</code>
|-
|SOAP/XML||<code><NameSuffix>'''''string'''''</NameSuffix></code>
|}
 
 
<h3 style="background-color:rgb(240,240,240);">NameSuffix2</h3>
:Only used if 2 names are in the FullName field. Returns a suffix for the second name in the FullName field.
 
:{| class="alternate01"
!Protocol !! Syntax
|-
|JSON||<code>"NameSuffix2":"'''''string'''''"</code>
|-
|SOAP/XML||<code><NameSuffix2>'''''string'''''</NameSuffix2></code>
|}
 
 
<h3 style="background-color:rgb(240,240,240);">NewAreaCode</h3>
:Returns the parsed new area code for the phone number entered in the Phone field.
 
:{| class="alternate01"
!Protocol !! Syntax
|-
|JSON||<code>"NewAreaCode":"'''''string'''''"</code>
|-
|SOAP/XML||<code><NewAreaCode>'''''string'''''</NewAreaCode></code>
|}
 
 
<h3 style="background-color:rgb(240,240,240);">Occupation</h3>
:Returns the category for the individual's occupation.
 
:{| class="alternate01"
!Value
|-
|Physician/Dentist
|-
|Healthcare
|-
|Lawyer/Judge
|-
|Professional/Technical
|-
|Management
|-
|Teacher/Educator
|-
|Sales/Marketing
|-
|Clerical/Service Worker
|-
|Tradesmen/Laborer
|-
|Farmer
|-
|Student
|-
|Homemaker
|-
|Retired
|-
|Federal Employee
|-
|Unknown
|-
|Military
|-
|Military Retired
|-
|Other
|-
|Business Owner
|-
|Religious
|-
|Self Employed
|-
|Financial
|}
 
:{| class="alternate01"
!Protocol !! Syntax
|-
|JSON||<code>"Occupation":"'''''string'''''"</code>
|-
|SOAP/XML||<code><Occupation>'''''string'''''</Occupation></code>
|}
 
 
<h3 style="background-color:rgb(240,240,240);">OwnRent</h3>
:Returns the individual's status as owner or renter of the property.
 
:{| class="alternate01"
!Value
|-
|Unknown
|-
|Definite Renter
|-
|Inferred Renter
|-
|Inferred Owner
|-
|Definite Owner
|}
 
:{| class="alternate01"
!Protocol !! Syntax
|-
|JSON||<code>"OwnRent":"'''''string'''''"</code>
|-
|SOAP/XML||<code><OwnRent>'''''string'''''</OwnRent></code>
|}
 
 
<h3 style="background-color:rgb(240,240,240);">PhoneCountryCode</h3>
:Returns the 2 character country code for the phone number entered in the Phone field.
 
:{| class="alternate01"
!Protocol !! Syntax
|-
|JSON||<code>"PhoneCountryCode":"'''''string'''''"</code>
|-
|SOAP/XML||<code><PhoneCountryCode>'''''string'''''</PhoneCountryCode></code>
|}
 
 
<h3 style="background-color:rgb(240,240,240);">PhoneCountryName</h3>
:Returns the full country name for the phone number entered in the Phone field.
 
:{| class="alternate01"
!Protocol !! Syntax
|-
|JSON||<code>"PhoneCountryName":"'''''string'''''"</code>
|-
|SOAP/XML||<code><PhoneCountryName>'''''string'''''</PhoneCountryName></code>
|}
 
 
<h3 style="background-color:rgb(240,240,240);">PhoneExtension</h3>
:Returns the parsed extension for the phone number entered in the Phone field.
 
:{| class="alternate01"
!Protocol !! Syntax
|-
|JSON||<code>"PhoneExtension":"'''''string'''''"</code>
|-
|SOAP/XML||<code><PhoneExtension>'''''string'''''</PhoneExtension></code>
|}
 
 
<h3 style="background-color:rgb(240,240,240);">PhoneNumber</h3>
:Returns the standardized phone number for the record.
 
:{| class="alternate01"
!Protocol !! Syntax
|-
|JSON||<code>"PhoneNumber":"'''''string'''''"</code>
|-
|SOAP/XML||<code><PhoneNumber>'''''string'''''</PhoneNumber></code>
|}
 
 
<h3 style="background-color:rgb(240,240,240);">PhonePrefix</h3>
:Returns the parsed prefix for the phone number entered in the Phone field.
 
:{| class="alternate01"
!Protocol !! Syntax
|-
|JSON||<code>"PhonePrefix":"'''''string'''''"</code>
|-
|SOAP/XML||<code><PhonePrefix>'''''string'''''</PhonePrefix></code>
|}
 
 
<h3 style="background-color:rgb(240,240,240);">PhoneSuffix</h3>
:Returns the parsed suffix for the phone number entered in the Phone field.
 
:{| class="alternate01"
!Protocol !! Syntax
|-
|JSON||<code>"PhoneSuffix":"'''''string'''''"</code>
|-
|SOAP/XML||<code><PhoneSuffix>'''''string'''''</PhoneSuffix></code>
|}
 
 
<h3 style="background-color:rgb(240,240,240);">PlaceCode</h3>
:When ZIP codes overlap, the City field will always return the city that covers most of the ZIP area. If the address is located outside of that city but within the ZIP Code, Place Code will refer to that area.
 
:{| class="alternate01"
!Protocol !! Syntax
|-
|JSON||<code>"PlaceCode":"'''''string'''''"</code>
|-
|SOAP/XML||<code><PlaceCode>'''''string'''''</PlaceCode></code>
|}
 
 
<h3 style="background-color:rgb(240,240,240);">PlaceName</h3>
:When ZIP codes overlap, the City field will always return the city that covers most of the ZIP area. If the address is located outside of that city but within the ZIP Code, Place Name will refer to that area.
 
:{| class="alternate01"
!Protocol !! Syntax
|-
|JSON||<code>"PlaceName":"'''''string'''''"</code>
|-
|SOAP/XML||<code><PlaceName>'''''string'''''</PlaceName></code>
|}
 
 
<h3 style="background-color:rgb(240,240,240);">Plus4</h3>
:Returns the 4-digit plus4 for the input address. If this column is requested, the PostalCode field will only contain the 5-digit ZIP for U.S. addresses.
 
:{| class="alternate01"
!Protocol !! Syntax
|-
|JSON||<code>"Plus4":"'''''string'''''"</code>
|-
|SOAP/XML||<code><Plus4>'''''string'''''</Plus4></code>
|}
 
 
<h3 style="background-color:rgb(240,240,240);">PoliticalParty</h3>
:Returns an individual’s political affiliation.
 
:{| class="alternate01"
!Value
|-
|Blank
|-
|No Party
|-
|Republican
|-
|Democrat
|-
|Independent
|}
 
:{| class="alternate01"
!Protocol !! Syntax
|-
|JSON||<code>"PoliticalParty":"'''''string'''''"</code>
|-
|SOAP/XML||<code><PoliticalParty>'''''string'''''</PoliticalParty></code>
|}
 
 
<h3 style="background-color:rgb(240,240,240);">PostalCode</h3>
:Returns the 9-digit postal code for U.S. addresses and 6-digit postal code for Canadian addresses.
 
:{| class="alternate01"
!Protocol !! Syntax
|-
|JSON||<code>"PostalCode":"'''''string'''''"</code>
|-
|SOAP/XML||<code><PostalCode>'''''string'''''</PostalCode></code>
|}
 
 
<h3 style="background-color:rgb(240,240,240);">PresenceOfChildren</h3>
:Returns the presence of children in the household.
 
:{| class="alternate01"
:{| class="alternate01"
!Protocol !! Syntax
!Protocol !! Syntax
|-
|-
|JSON||<code>"PhonePrefix":"'''''string'''''"</code>
|JSON||<code>"PresenceOfChildren":"'''''string'''''"</code>
|-
|-
|SOAP/XML||<code><PhonePrefix>'''''string'''''</PhonePrefix></code>
|SOAP/XML||<code><PresenceOfChildren>'''''string'''''</PresenceOfChildren></code>
|}
|}




<h3 style="background-color:rgb(240,240,240);">Phone Suffix</h3>
<h3 style="background-color:rgb(240,240,240);">PresenceOfSenior</h3>
:Returns the parsed suffix for the phone number entered in the Phone field.
:Returns the presence of senior/s in the household.


:{| class="alternate01"
:{| class="alternate01"
!Protocol !! Syntax
!Value
|-
|JSON||<code>"PhoneSuffix":"'''''string'''''"</code>
|-
|SOAP/XML||<code><PhoneSuffix>'''''string'''''</PhoneSuffix></code>
|}
 
 
<h3 style="background-color:rgb(240,240,240);">Place Code</h3>
:When ZIP codes overlap, the City field will always return the city that covers most of the ZIP area. If the address is located outside of that city but within the ZIP Code, Place Code will refer to that area.
 
:{| class="alternate01"
!Protocol !! Syntax
|-
|JSON||<code>"PlaceCode":"'''''string'''''"</code>
|-
|SOAP/XML||<code><PlaceCode>'''''string'''''</PlaceCode></code>
|}
 
 
<h3 style="background-color:rgb(240,240,240);">Place Name</h3>
:When ZIP codes overlap, the City field will always return the city that covers most of the ZIP area. If the address is located outside of that city but within the ZIP Code, Place Name will refer to that area.
 
:{| class="alternate01"
!Protocol !! Syntax
|-
|JSON||<code>"PlaceName":"'''''string'''''"</code>
|-
|SOAP/XML||<code><PlaceName>'''''string'''''</PlaceName></code>
|}
 
 
<h3 style="background-color:rgb(240,240,240);">Plus 4</h3>
:Returns the 4-digit plus4 for the input address. If this column is requested, the PostalCode field will only contain the 5-digit ZIP for U.S. addresses.
 
:{| class="alternate01"
!Protocol !! Syntax
|-
|-
|JSON||<code>"Plus4":"'''''string'''''"</code>
|Blank
|-
|SOAP/XML||<code><Plus4>'''''string'''''</Plus4></code>
|}
 
 
<h3 style="background-color:rgb(240,240,240);">Postal Code</h3>
:Returns the 9-digit postal code for U.S. addresses and 6-digit postal code for Canadian addresses.
 
:{| class="alternate01"
!Protocol !! Syntax
|-
|-
|JSON||<code>"PostalCode":"'''''string'''''"</code>
|Yes
|-
|-
|SOAP/XML||<code><PostalCode>'''''string'''''</PostalCode></code>
|No
|}
|}
<h3 style="background-color:rgb(240,240,240);">Presence Of Children</h3>
:Returns the presence of children in the household.


:{| class="alternate01"
:{| class="alternate01"
!Protocol !! Syntax
!Protocol !! Syntax
|-
|-
|JSON||<code>"PresenceOfChildren":"'''''string'''''"</code>
|JSON||<code>"PresenceOfSenior":"'''''string'''''"</code>
|-
|-
|SOAP/XML||<code><PresenceOfChildren>'''''string'''''</PresenceOfChildren></code>
|SOAP/XML||<code><PresenceOfSenior>'''''string'''''</PresenceOfSenior></code>
|}
|}




<h3 style="background-color:rgb(240,240,240);">Private MailBox</h3>
<h3 style="background-color:rgb(240,240,240);">PrivateMailBox</h3>
:Returns the private mail box number for the address in the AddressLine field, if any. Private mailboxes are private mail boxes in commercial mail receiving agencies, like a UPS Store. If requested, the Private mailbox will be populated in this field instead of the Address field.
:Returns the private mail box number for the address in the AddressLine field, if any. Private mailboxes are private mail boxes in commercial mail receiving agencies, like a UPS Store. If requested, the Private mailbox will be populated in this field instead of the Address field.


Line 1,478: Line 1,998:




<h3 style="background-color:rgb(240,240,240);">Record ID</h3>
<h3 style="background-color:rgb(240,240,240);">RecordID</h3>
:This is a string value that is a unique identifier for the current record if one was sent in the request. Use this element to match a request record and the corresponding response record.
:This is a string value that is a unique identifier for the current record if one was sent in the request. Use this element to match a request record and the corresponding response record.


Line 1,516: Line 2,036:




<h3 style="background-color:rgb(240,240,240);">Secondary School District Code</h3>
<h3 style="background-color:rgb(240,240,240);">SecondarySchoolDistrictCode</h3>
:Returns a 5 digit string representing the Secondary School District Code for the requested record.
:Returns a 5 digit string representing the Secondary School District Code for the requested record.


Line 1,528: Line 2,048:




<h3 style="background-color:rgb(240,240,240);">Secondary School District Name</h3>
<h3 style="background-color:rgb(240,240,240);">SecondarySchoolDistrictName</h3>
:Returns the Secondary School District Name for the requested record.
:Returns the Secondary School District Name for the requested record.


Line 1,552: Line 2,072:




<h3 style="background-color:rgb(240,240,240);">State District Lower</h3>
<h3 style="background-color:rgb(240,240,240);">StateDistrictLower</h3>
:Returns a 3 digit string representing the Lower State District Code for the requested record.
:Returns a 3 digit string representing the Lower State District Code for the requested record.


Line 1,564: Line 2,084:




<h3 style="background-color:rgb(240,240,240);">State District Upper</h3>
<h3 style="background-color:rgb(240,240,240);">StateDistrictUpper</h3>
:Returns a 3 digit string representing the Upper State District Code for the requested record.
:Returns a 3 digit string representing the Upper State District Code for the requested record.


Line 1,576: Line 2,096:




<h3 style="background-color:rgb(240,240,240);">State Name</h3>
<h3 style="background-color:rgb(240,240,240);">StateName</h3>
:Returns the full name of the state entered in the State field.
:Returns the full name of the state entered in the State field.


Line 1,600: Line 2,120:




<h3 style="background-color:rgb(240,240,240);">Top Level Domain</h3>
<h3 style="background-color:rgb(240,240,240);">TopLevelDomain</h3>
:Returns the parsed top-level domain name for the email entered in the Email field.
:Returns the parsed top-level domain name for the email entered in the Email field.


Line 1,624: Line 2,144:




<h3 style="background-color:rgb(240,240,240);">Unified School District Code</h3>
<h3 style="background-color:rgb(240,240,240);">UnifiedSchoolDistrictCode</h3>
:Returns a 5 digit string representing the Unified School District Code for the requested record.
:Returns a 5 digit string representing the Unified School District Code for the requested record.


Line 1,636: Line 2,156:




<h3 style="background-color:rgb(240,240,240);">Unified School District Name</h3>
<h3 style="background-color:rgb(240,240,240);">UnifiedSchoolDistrictName</h3>
:Returns the Secondary Unified District Name for the requested record.
:Returns the Secondary Unified District Name for the requested record.


Revision as of 21:22, 29 August 2017

← Personator Consumer

Personator Consumer Navigation
Introduction
Basics
Licensing
Input/Output
Request Fields
Response Fields
Examples
REST JSON
REST JSONP
REST XML
JSON
Batch JSON
XML
Batch XML
Result Codes
Result Code Use
Personator Consumer Result Codes
Sample Code



A response is the result of a request. This consists of returned results codes, parsed address elements, and appended address information.

Depending on the protocol used to make the request, the response will be in a certain protocol. Personator supports the JSON, JSONP, SOAP, and XML protocols.


Field Names

This is a list of the response field names and their protocol naming conventions.

Field Name Level JSON/XML
Version Response Version
Transmission Reference TransmissionReference
Transmission Results TransmissionResults
Total Records TotalRecords
AddressDeliveryInstallation Record AddressDeliveryInstallation
AddressExtras AddressExtras
AddressHouseNumber AddressHouseNumber
AddressKey AddressKey
AddressLine1 AddressLine1
AddressLine2 AddressLine2
AddressLockBox AddressLockBox
AddressPostDirection AddressPostDirection
AddressPreDirection AddressPreDirection
AddressPrivateMailboxName AddressPrivateMailboxName
AddressPrivateMailboxRange AddressPrivateMailboxRange
AddressRouteService AddressRouteService
AddressStreetName AddressStreetName
AddressStreetSuffix AddressStreetSuffix
AddressSuiteName AddressSuiteName
AddressSuiteNumber AddressSuiteNumber
AddressTypeCode AddressTypeCode
AreaCode AreaCode
CBSACode CBSACode
CBSADivisionCode CBSADivisionCode
CBSADivisionLevel CBSADivisionLevel
CBSADivisionTitle CBSADivisionTitle
CBSALevel CBSALevel
CBSATitle CBSATitle
CarrierRoute CarrierRoute
CensusBlock CensusBlock
CensusKey CensusKey
CensusTract CensusTract
ChildrenAgeRange ChildrenAgeRange
City City
CityAbbreviation CityAbbreviation
CompanyName CompanyName
CongressionalDistrict CongressionalDistrict
CountryCode CountryCode
CountryName CountryName
CountyFIPS CountyFIPS
CountyName CountyName
CountySubdivisionCode CountySubdivisionCode
CountySubdivisionName CountySubdivisionName
CreditCardUser CreditCardUser
DateOfBirth DateOfBirth
DateOfDeath DateOfDeath
DeliveryIndicator DeliveryIndicator
DeliveryPointCheckDigit DeliveryPointCheckDigit
DeliveryPointCode DeliveryPointCode
DemographicsGender DemographicsGender
DemographicsResults DemographicsResults
DomainName DomainName
Education Education
ElementarySchoolDistrictCode ElementarySchoolDistrictCode
ElementarySchoolDistrictName ElementarySchoolDistrictName
EmailAddress EmailAddress
EthnicCode EthnicCode
EthnicGroup EthnicGroup
Gender Gender
Gender2 Gender2
HouseholdIncome HouseholdIncome
HouseholdSize HouseholdSize
Latitude Latitude
LengthOfResidence LengthOfResidence
Longitude Longitude
MailboxName MailboxName
MaritalStatus MaritalStatus
MelissaAddressKey MelissaAddressKey
MelissaAddressKeyBase MelissaAddressKeyBase
MoveDate MoveDate
NameFirst NameFirst
NameFirst2 NameFirst2
NameFull NameFull
NameLast NameLast
NameLast2 NameLast2
NameMiddle NameMiddle
NameMiddle2 NameMiddle2
NamePrefix NamePrefix
NamePrefix2 NamePrefix2
NameSuffix NameSuffix
NameSuffix2 NameSuffix2
NewAreaCode NewAreaCode
Occupation Occupation
OwnRent OwnRent
PhoneCountryCode PhoneCountryCode
PhoneCountryName PhoneCountryName
PhoneExtension PhoneExtension
PhoneNumber PhoneNumber
PhonePrefix PhonePrefix
PhoneSuffix PhoneSuffix
PlaceCode PlaceCode
PlaceName PlaceName
Plus4 Plus4
PoliticalParty PoliticalParty
PostalCode PostalCode
PresenceOfChildren PresenceOfChildren
PresenceOfSenior PresenceOfSenior
PrivateMailBox PrivateMailBox
RecordID RecordID
Results Results
Salutation Salutation
SecondarySchoolDistrictCode SecondarySchoolDistrictCode
SecondarySchoolDistrictName SecondarySchoolDistrictName
State State
StateDistrictLower StateDistrictLower
StateDistrictUpper StateDistrictUpper
StateName StateName
Suite Suite
TopLevelDomain TopLevelDomain
UTC UTC
UnifiedSchoolDistrictCode UnifiedSchoolDistrictCode
UnifiedSchoolDistrictName UnifiedSchoolDistrictName
UrbanizationName UrbanizationName


Response Elements

The following elements are the basic options for each request. These apply to the entire response, not the individual records.

Version

This is a string value that is the current revision number of Personator.
Protocol Syntax
JSON "Version":"string"
SOAP/XML <Version>string</Version>


TransmissionReference

This is a string value that serves as a unique identifier for this set of records. It is returned as sent by the Request Array, allowing you to match the Response to the Request.
Protocol Syntax
JSON "TransmissionReference":"string"
SOAP/XML <TransmissionReference>string</TransmissionReference>


TransmissionResults

This is a string value that lists error codes from any errors caused by the most recent request as a whole.
For a complete list of error codes, see Personator Result Codes.
Protocol Syntax
JSON "TransmissionResults":"string"
SOAP/XML <TransmissionResults>string</TransmissionResults>


TotalRecords

Displays the total number of records returned.
Protocol Syntax
JSON "TotalRecords":"string"
SOAP/XML <TotalRecords>string</TotalRecords>


Response Record Elements

JSON will only contain the Records element.

Protocol Definition
JSON Each record will be contained within [{}] under the Records element.
SOAP
XML

Each of the following elements are returned for each record in the Response Array.


AddressDeliveryInstallation

Canada Only.
Returns the parsed delivery installation for the address entered in the AddressLine field.
Protocol Syntax
JSON "AddressDeliveryInstallation":"string"
SOAP/XML <AddressDeliveryInstallation>string</AddressDeliveryInstallation>


AddressExtras

Any extra information that does not fit in the AddressLine fields.
Protocol Syntax
JSON "AddressExtras":"string"
SOAP/XML <AddressExtras>string</AddressExtras>


AddressHouseNumber

Returns the parsed house number for the address entered in the AddressLine field.
Protocol Syntax
JSON "AddressHouseNumber":"string"
SOAP/XML <AddressHouseNumber>string</AddressHouseNumber>


AddressKey

Returns a unique identifier for an address. This key can be used with other current and future Melissa services.
Protocol Syntax
JSON "AddressKey":"string"
SOAP/XML <AddressKey>string</AddressKey>


AddressLine1

Returns the address entered in the AddressLine field. If two addresses were entered and only one is valid, the valid address is returned instead. This includes the suite and private mailbox.
Protocol Syntax
JSON "AddressLine1":"string"
SOAP/XML <AddressLine1>string</AddressLine1>


AddressLine2

If two addresses are passed into the AddressLine field, the second address is returned here. If only one of two addresses is valid, the valid address will be returned in Address Line 1.
Protocol Syntax
JSON "AddressLine2":"string"
SOAP/XML <AddressLine2>string</AddressLine2>


AddressLockBox

Canada Only.
Returns the parsed lock box number for the address entered in the AddressLine field.
Protocol Syntax
JSON "AddressLockBox":"string"
SOAP/XML <AddressLockBox>string</AddressLockBox>


AddressPostDirection

Returns the parsed post-direction for the address entered in the AddressLine field.
Protocol Syntax
JSON "AddressPostDirection":"string"
SOAP/XML <AddressPostDirection>string</AddressPostDirection>


AddressPreDirection

Returns the parsed pre-direction for the address entered in the AddressLine field.
Protocol Syntax
JSON "AddressPreDirection":"string"
SOAP/XML <AddressPreDirection>string</AddressPreDirection>


AddressPrivateMailboxName

Returns the parsed private mailbox name for the address entered in the AddressLine field.
Protocol Syntax
JSON "AddressPrivateMailboxName":"string"
SOAP/XML <AddressPrivateMailboxName>string</AddressPrivateMailboxName>


AddressPrivateMailboxRange

Returns the parsed private mailbox range for the address entered in the AddressLine field.
Protocol Syntax
JSON "AddressPrivateMailboxRange":"string"
SOAP/XML <AddressPrivateMailboxRange>string</AddressPrivateMailboxRange>


AddressRouteService

Canada Only.
Returns the parsed route service number for the address entered in the AddressLine field.
Protocol Syntax
JSON "AddressRouteService":"string"
SOAP/XML <AddressRouteService>string</AddressRouteService>


AddressStreetName

Returns the parsed street name for the address entered in the AddressLine field.
Protocol Syntax
JSON "AddressStreetName":"string"
SOAP/XML <AddressStreetName>string</AddressStreetName>


AddressStreetSuffix

Returns the parsed street suffix for the address entered in the AddressLine field.
Protocol Syntax
JSON "AddressStreetSuffix":"string"
SOAP/XML <AddressStreetSuffix>string</AddressStreetSuffix>


AddressSuiteName

Returns the parsed suite name for the address entered in the AddressLine field.
Protocol Syntax
JSON "AddressSuiteName":"string"
SOAP/XML <AddressSuiteName>string</AddressSuiteName>


AddressSuiteNumber

Returns the parsed suite number for the address entered in the AddressLine field.
Protocol Syntax
JSON "AddressSuiteNumber":"string"
SOAP/XML <AddressSuiteNumber>string</AddressSuiteNumber>


AddressTypeCode

Returns a code for the address type in the AddressLine field. Please see the Result Code Details for the list of possible codes.
Protocol Syntax
JSON "AddressTypeCode":"string"
SOAP/XML <AddressTypeCode>string</AddressTypeCode>


AreaCode

Returns the parsed area code for the phone number entered in the Phone field.
Protocol Syntax
JSON "AreaCode":"string"
SOAP/XML <AreaCode>string</AreaCode>


CBSACode

Census Bureau’s Core Based Statistical Area (CBSA). Returns the 5-digit code for the CBSA associated with the requested record.
Protocol Syntax
JSON "CBSACode":"string"
SOAP/XML <CBSACode>string</CBSACode>


CBSADivisionCode

Returns the code for a division associated with the requested record, if any.
Protocol Syntax
JSON "CBSADivisionCode":"string"
SOAP/XML <CBSADivisionCode>string</CBSADivisionCode>


CBSADivisionLevel

Returns whether the CBSA division, if any, is metropolitan or micropolitan.
Protocol Syntax
JSON "CBSADivisionLevel":"string"
SOAP/XML <CBSADivisionLevel>string</CBSADivisionLevel>


CBSADivisionTitle

Returns the title for the CBSA division, if any.
Protocol Syntax
JSON "CBSADivisionTitle":"string"
SOAP/XML <CBSADivisionTitle>string</CBSADivisionTitle>


CBSALevel

Returns whether the CBSA is metropolitan or micropolitan.
Protocol Syntax
JSON "CBSALevel":"string"
SOAP/XML <CBSALevel>string</CBSALevel>


CBSATitle

Returns the title for the CBSA.
Protocol Syntax
JSON "CBSATitle":"string"
SOAP/XML <CBSATitle>string</CBSATitle>


CarrierRoute

Returns a 4-character code defining the carrier route for this record.
Protocol Syntax
JSON "CarrierRoute":"string"
SOAP/XML <CarrierRoute>string</CarrierRoute>


CensusBlock

Returns a 4-digit string containing the census block number associated with the requested record.
Protocol Syntax
JSON "CensusBlock":"string"
SOAP/XML <CensusBlock>string</CensusBlock>


CensusKey

Returns a 15 digit string containing the concatenated County FIPS, Census Tract and Census Block.
Protocol Syntax
JSON "CensusKey":"string"
SOAP/XML <CensusKey>string</CensusKey>


CensusTract

Returns a 4-to 6-digit string containing the census tract number associated with the requested record.
Census tracts are small subdivisions of a county.
Protocol Syntax
JSON "CensusTract":"string"
SOAP/XML <CensusTract>string</CensusTract>


ChildrenAgeRange

Returns the age range of children present in the household.
Value
Blank
0-2
3-5
6-10
11-15
16-17
Protocol Syntax
JSON "ChildrenAgeRange":"string"
SOAP/XML <ChildrenAgeRange>string</ChildrenAgeRange>


City

Returns the city entered in the City field.
Protocol Syntax
JSON "City":"string"
SOAP/XML <City>string</City>


CityAbbreviation

Returns an abbreviation for the city entered in the City field, if any.
Protocol Syntax
JSON "CityAbbreviation":"string"
SOAP/XML <CityAbbreviation>string</CityAbbreviation>


CompanyName

Returns the company name.
Protocol Syntax
JSON "CompanyName":"string"
SOAP/XML <CompanyName>string</CompanyName>


CongressionalDistrict

Returns the 2-digit congressional district that belongs to the requested record.
Protocol Syntax
JSON "CongressionalDistrict":"string"
SOAP/XML <CongressionalDistrict>string</CongressionalDistrict>


CountryCode

Returns the country code for the country in the Country field.
Protocol Syntax
JSON "CountryCode":"string"
SOAP/XML <CountryCode>string</CountryCode>


CountryName

Returns the country name for the record.
Protocol Syntax
JSON "CountryName":"string"
SOAP/XML <CountryName>string</CountryName>


CountyFIPS

Returns the FIPS code for the county in the County field.
Protocol Syntax
JSON "CountyFIPS":"string"
SOAP/XML <CountyFIPS>string</CountyFIPS>


CountyName

Returns the county name.
Protocol Syntax
JSON "CountyName":"string"
SOAP/XML <CountyName>string</CountyName>


CountySubdivisionCode

Returns a 5 digit string representing the County Subdivision Code for the requested record.
Protocol Syntax
JSON "CountySubdivisionCode":"string"
SOAP/XML <CountySubdivisionCode>string</CountySubdivisionCode>


CountySubdivisionName

Returns the County Subdivision Name for the requested record.
Protocol Syntax
JSON "CountySubdivisionName":"string"
SOAP/XML <CountySubdivisionName>string</CountySubdivisionName>


CreditCardUser

Returns whether the user has a credit card or not.
Value
Blank
Yes
No
Protocol Syntax
JSON "CreditCardUser":"string"
SOAP/XML <CreditCardUser>string</CreditCardUser>


DateOfBirth

Returns the date of birth in the format YYYYMM. Accuracy is only to the month.
Protocol Syntax
JSON "DateOfBirth":"string"
SOAP/XML <DateOfBirth>string</DateOfBirth>


DateOfDeath

Returns the full date of death in the format YYYYMMDD.
Protocol Syntax
JSON "DateOfDeath":"string"
SOAP/XML <DateOfDeath>string</DateOfDeath>


DeliveryIndicator

Returns an indicator of whether an address is a business address or residential address.
Protocol Syntax
JSON "DeliveryIndicator":"string"
SOAP/XML <DeliveryIndicator>string</DeliveryIndicator>


DeliveryPointCheckDigit

Returns a string value containing the 1-digit delivery point check digit.
Protocol Syntax
JSON "DeliveryPointCheckDigit":"string"
SOAP/XML <DeliveryPointCheckDigit>string</DeliveryPointCheckDigit>


DeliveryPointCode

Returns a string value containing the 2-digit delivery point code.
Protocol Syntax
JSON "DeliveryPointCode":"string"
SOAP/XML <DeliveryPointCode>string</DeliveryPointCode>


DemographicsGender

Returns gender based on demographics data.
Value
Unknown
Male
Female
Neutral
Protocol Syntax
JSON "DemographicsGender":"string"
SOAP/XML <DemographicsGender>string</DemographicsGender>


DemographicsResults

If any demographics are enabled, Demographics Results will return a comma delimited string containing all the results of the demographics combined.
Protocol Syntax
JSON "DemographicsResults":"string"
SOAP/XML <DemographicsResults>string</DemographicsResults>


DomainName

Returns the parsed domain name for the email entered in the Email field.
Protocol Syntax
JSON "DomainName":"string"
SOAP/XML <DomainName>string</DomainName>


Education

Returns the highest level of education completed by an individual.
Value
Blank
High School
College
Graduate School
Vocational/Technical School
Protocol Syntax
JSON "Education":"string"
SOAP/XML <Education>string</Education>


ElementarySchoolDistrictCode

Returns a 5 digit string representing the Elementary School District Code for the requested record.
Protocol Syntax
JSON "ElementarySchoolDistrictCode":"string"
SOAP/XML <ElementarySchoolDistrictCode>string</ElementarySchoolDistrictCode>


ElementarySchoolDistrictName

Returns the Elementary School District Name for the requested record.
Protocol Syntax
JSON "ElementarySchoolDistrictName":"string"
SOAP/XML <ElementarySchoolDistrictName>string</ElementarySchoolDistrictName>


EmailAddress

Returns the email address entered in the Email field.
Protocol Syntax
JSON "EmailAddress":"string"
SOAP/XML <EmailAddress>string</EmailAddress>


EthnicCode

Returns an individual’s specific ethnicity.
Value
Afghan
African-American
Albanian
Aleutian
Algerian
American Indian
Arabian
Armenian
Ashanti
Australian
Austrian
Azerbaijani
Bahrain
Bangladesh
Basotho
Basque
Belgian
Belorussian
Beninese
Bhutanese
Black African
Bosnian Muslim
Botswanian
Bulgarian
Burkina Faso
Burundian
Cameroonian
Caribbean African American
Central African Republic
Chadian
Chechnyan
Chinese
Comoros
Congolese
Croatian
Czech
Danish
Djiboutian
Dutch
Egyptian
English
Equatorial Guinea
Estonian
Ethiopian
Fiji
Finnish
French
Gabon
Gambian
Georgian
German
Ghanaian
Greek
Guinea Bissau
Guinean
Guyanese
Hausa
Hawaiian
Icelandic
Indian
Indonesian
Iraqi
Irish
Italian
Ivorian
Japanese
Jewish
Kampuchean/Khmer(Cambodian)
Kazakhstan
Kenyan
Kirghizia
Korean
Kurdish
Kuwaiti
Kyrgyzstani
Laotian
Latvian
Lesotho
Liberian
Libyan
Liechtenstein
Lithuanian
Luxembourgian
Macedonia
Madagascan
Malawian
Malaysian
Maldivian & Tongan
Malian
Maltese
Manx
Mauritanian
Moldovan
Mongolian
Moroccan
Mozambican
Multi-Ethnic
Myanmar (Burmese)
Namibian
Nepalese
New Zealand
Niger
Nigerian
Norwegian
Other Oriental
Pakistani
Papua New Guinean
Persian
Philippine
Pili
Polish
Portuguese
Qatari
Romanian
Russian
Saudi
Scottish
Senegalese
Serbian
Seychelles
Sierre Leone
Sinhalese (Sri-Lankan)
Slovakian
Slovenian
Somalian
South African
Spanish
Sudanese
Surinamese
Swedish
Swiss
Syrian
Tajik
Tajikistan
Tanzanian
Telugan
Thai
Tibetan
Togolese
Tonga
Tunisian
Turkish
Turkmenistan
Ugandan
Ukrainian
Uzbekistan
Vanuatuan
Vietnamese
Welsh
Western Samoan
Xhosa
Yemeni
Zairean
Zambian
Zimbabwean
Zulu
Protocol Syntax
JSON "EthnicCode":"string"
SOAP/XML <EthnicCode>string</EthnicCode>


EthnicGroup

Returns the grouped category for a person’s ethnicity. This is a more generalized grouping compared to Ethnic Codes.
Protocol Syntax
JSON "EthnicGroup":"string"
SOAP/XML <EthnicGroup>string</EthnicGroup>


Gender

Returns a gender for the name in the FullName field.
Protocol Syntax
JSON "Gender":"string"
SOAP/XML <Gender>string</Gender>


Gender2

Only used if 2 names are in the FullName field. Returns a gender for the second name in the FullName field.
Protocol Syntax
JSON "Gender2":"string"
SOAP/XML <Gender2>string</Gender2>


HouseholdIncome

Returns the range of the household's income.
Protocol Syntax
JSON "HouseholdIncome":"string"
SOAP/XML <HouseholdIncome>string</HouseholdIncome>


HouseholdSize

Returns the number of occupants in the household.
Protocol Syntax
JSON "HouseholdSize":"string"
SOAP/XML <HouseholdSize>string</HouseholdSize>


Latitude

Returns the geocoded latitude for the address entered in the AddressLine field.
Protocol Syntax
JSON "Latitude":"string"
SOAP/XML <Latitude>string</Latitude>


Length of Residence

Returns the range of the individual's length of residency in their current address.
Value
Less than 1 year
1-2 years
2-3 years
3-4 years
4-5 years
5-6 years
6-7 years
7-8 years
8-9 years
9-10 years
10-11 years
11-12 years
12-13 years
13-14 years
14-15 years
15+ years
Unknown
Protocol Syntax
JSON "LengthOfResidence":"string"
SOAP/XML <LengthOfResidence>string</LengthOfResidence>


Longitude

Returns the geocoded longitude for the address entered in the AddressLine field.
Protocol Syntax
JSON "Longitude":"string"
SOAP/XML <Longitude>string</Longitude>


MailboxName

Returns the parsed mailbox name for the email entered in the Email field.
Protocol Syntax
JSON "MailboxName":"string"
SOAP/XML <MailboxName>string</MailboxName>


MaritalStatus

Returns the individual's marital status.
Protocol Syntax
JSON "MaritalStatus":"string"
SOAP/XML <MaritalStatus>string</MaritalStatus>


MelissaAddressKey

Returns a unique key associated with an address.
Protocol Syntax
JSON "MelissaAddressKey":"string"
SOAP/XML <MelissaAddressKey>string</MelissaAddressKey>


MelissaAddressKeyBase

Returns a unique key associated with a building containing multiple suites/apartments.
Protocol Syntax
JSON "MelissaAddressKeyBase":"string"
SOAP/XML <MelissaAddressKeyBase>string</MelissaAddressKeyBase>


MoveDate

Returns the date associated with the move address.
Protocol Syntax
JSON "MoveDate":"string"
SOAP/XML <MoveDate>string</>MoveDate


NameFirst

Returns the first name in the FullName field.
Protocol Syntax
JSON "NameFirst":"string"
SOAP/XML <NameFirst>string</NameFirst>


NameFirst2

Only used if 2 names are in the FullName field. Returns the second name in the FullName field.
Protocol Syntax
JSON "NameFirst2":"string"
SOAP/XML <NameFirst2>string</NameFirst2>


NameFull

Returns the full name for the record.
Protocol Syntax
JSON "NameFull":"string"
SOAP/XML <NameFull>string</NameFull>


NameLast

Returns the last name in the FullName field.
Protocol Syntax
JSON "NameLast":"string"
SOAP/XML <NameLast>string</NameLast>


NameLast2

Only used if 2 names are in the FullName field. Returns a last name for the second name in the FullName field.
Protocol Syntax
JSON "NameLast2":"string"
SOAP/XML <NameLast2>string</NameLast2>


NameMiddle

Returns a middle name for the name in the FullName field.
Protocol Syntax
JSON "NameMiddle":"string"
SOAP/XML <NameMiddle>string</NameMiddle>


NameMiddle2

Only used if 2 names are in the FullName field. Returns a middle name for the second name in the FullName field.
Protocol Syntax
JSON "NameMiddle2":"string"
SOAP/XML <NameMiddle2>string</NameMiddle2>


NamePrefix

Returns a prefix for the name in the FullName field.
Protocol Syntax
JSON "NamePrefix":"string"
SOAP/XML <NamePrefix>string</NamePrefix>


NamePrefix2

Only used if 2 names are in the FullName field. Returns a prefix for the second name in the FullName field.
Protocol Syntax
JSON "NamePrefix2":"string"
SOAP/XML <NamePrefix2>string</NamePrefix2>


NameSuffix

Returns a suffix for the name in the FullName field.
Protocol Syntax
JSON "NameSuffix":"string"
SOAP/XML <NameSuffix>string</NameSuffix>


NameSuffix2

Only used if 2 names are in the FullName field. Returns a suffix for the second name in the FullName field.
Protocol Syntax
JSON "NameSuffix2":"string"
SOAP/XML <NameSuffix2>string</NameSuffix2>


NewAreaCode

Returns the parsed new area code for the phone number entered in the Phone field.
Protocol Syntax
JSON "NewAreaCode":"string"
SOAP/XML <NewAreaCode>string</NewAreaCode>


Occupation

Returns the category for the individual's occupation.
Value
Physician/Dentist
Healthcare
Lawyer/Judge
Professional/Technical
Management
Teacher/Educator
Sales/Marketing
Clerical/Service Worker
Tradesmen/Laborer
Farmer
Student
Homemaker
Retired
Federal Employee
Unknown
Military
Military Retired
Other
Business Owner
Religious
Self Employed
Financial
Protocol Syntax
JSON "Occupation":"string"
SOAP/XML <Occupation>string</Occupation>


OwnRent

Returns the individual's status as owner or renter of the property.
Value
Unknown
Definite Renter
Inferred Renter
Inferred Owner
Definite Owner
Protocol Syntax
JSON "OwnRent":"string"
SOAP/XML <OwnRent>string</OwnRent>


PhoneCountryCode

Returns the 2 character country code for the phone number entered in the Phone field.
Protocol Syntax
JSON "PhoneCountryCode":"string"
SOAP/XML <PhoneCountryCode>string</PhoneCountryCode>


PhoneCountryName

Returns the full country name for the phone number entered in the Phone field.
Protocol Syntax
JSON "PhoneCountryName":"string"
SOAP/XML <PhoneCountryName>string</PhoneCountryName>


PhoneExtension

Returns the parsed extension for the phone number entered in the Phone field.
Protocol Syntax
JSON "PhoneExtension":"string"
SOAP/XML <PhoneExtension>string</PhoneExtension>


PhoneNumber

Returns the standardized phone number for the record.
Protocol Syntax
JSON "PhoneNumber":"string"
SOAP/XML <PhoneNumber>string</PhoneNumber>


PhonePrefix

Returns the parsed prefix for the phone number entered in the Phone field.
Protocol Syntax
JSON "PhonePrefix":"string"
SOAP/XML <PhonePrefix>string</PhonePrefix>


PhoneSuffix

Returns the parsed suffix for the phone number entered in the Phone field.
Protocol Syntax
JSON "PhoneSuffix":"string"
SOAP/XML <PhoneSuffix>string</PhoneSuffix>


PlaceCode

When ZIP codes overlap, the City field will always return the city that covers most of the ZIP area. If the address is located outside of that city but within the ZIP Code, Place Code will refer to that area.
Protocol Syntax
JSON "PlaceCode":"string"
SOAP/XML <PlaceCode>string</PlaceCode>


PlaceName

When ZIP codes overlap, the City field will always return the city that covers most of the ZIP area. If the address is located outside of that city but within the ZIP Code, Place Name will refer to that area.
Protocol Syntax
JSON "PlaceName":"string"
SOAP/XML <PlaceName>string</PlaceName>


Plus4

Returns the 4-digit plus4 for the input address. If this column is requested, the PostalCode field will only contain the 5-digit ZIP for U.S. addresses.
Protocol Syntax
JSON "Plus4":"string"
SOAP/XML <Plus4>string</Plus4>


PoliticalParty

Returns an individual’s political affiliation.
Value
Blank
No Party
Republican
Democrat
Independent
Protocol Syntax
JSON "PoliticalParty":"string"
SOAP/XML <PoliticalParty>string</PoliticalParty>


PostalCode

Returns the 9-digit postal code for U.S. addresses and 6-digit postal code for Canadian addresses.
Protocol Syntax
JSON "PostalCode":"string"
SOAP/XML <PostalCode>string</PostalCode>


PresenceOfChildren

Returns the presence of children in the household.
Protocol Syntax
JSON "PresenceOfChildren":"string"
SOAP/XML <PresenceOfChildren>string</PresenceOfChildren>


PresenceOfSenior

Returns the presence of senior/s in the household.
Value
Blank
Yes
No
Protocol Syntax
JSON "PresenceOfSenior":"string"
SOAP/XML <PresenceOfSenior>string</PresenceOfSenior>


PrivateMailBox

Returns the private mail box number for the address in the AddressLine field, if any. Private mailboxes are private mail boxes in commercial mail receiving agencies, like a UPS Store. If requested, the Private mailbox will be populated in this field instead of the Address field.
Protocol Syntax
JSON "PrivateMailBox":"string"
SOAP/XML <PrivateMailBox>string</PrivateMailBox>


RecordID

This is a string value that is a unique identifier for the current record if one was sent in the request. Use this element to match a request record and the corresponding response record.
Protocol Syntax
JSON "RecordID":"string"
SOAP/XML <RecordID>string</RecordID>


Results

This is a string value with comma delimited status, error codes, and change codes for the record.
For a complete list of codes, see Personator Result Codes.
Protocol Syntax
JSON "Results":"string"
SOAP/XML <Results>string</Results>


Salutation

Returns a salutation for the name in the FullName field.
Protocol Syntax
JSON "Salutation":"string"
SOAP/XML <Salutation>string</>Salutation


SecondarySchoolDistrictCode

Returns a 5 digit string representing the Secondary School District Code for the requested record.
Protocol Syntax
JSON "SecondarySchoolDistrictCode":"string"
SOAP/XML <SecondarySchoolDistrictCode>string</SecondarySchoolDistrictCode>


SecondarySchoolDistrictName

Returns the Secondary School District Name for the requested record.
Protocol Syntax
JSON "SecondarySchoolDistrictName":"string"
SOAP/XML <SecondarySchoolDistrictName>string</SecondarySchoolDistrictName>


State

Returns the state for the record.
Protocol Syntax
JSON "State":"string"
SOAP/XML <State>string</State>


StateDistrictLower

Returns a 3 digit string representing the Lower State District Code for the requested record.
Protocol Syntax
JSON "StateDistrictLower":"string"
SOAP/XML <StateDistrictLower>string</StateDistrictLower>


StateDistrictUpper

Returns a 3 digit string representing the Upper State District Code for the requested record.
Protocol Syntax
JSON "StateDistrictUpper":"string"
SOAP/XML <StateDistrictUpper>string</StateDistrictUpper>


StateName

Returns the full name of the state entered in the State field.
Protocol Syntax
JSON "StateName":"string"
SOAP/XML <StateName>string</StateName>


Suite

Returns the suite for the address in the AddressLine field, if any. If requested, the suite will be populated in this field instead of the Address field.
Protocol Syntax
JSON "Suite":"string"
SOAP/XML <Suite>string</Suite>


TopLevelDomain

Returns the parsed top-level domain name for the email entered in the Email field.
Protocol Syntax
JSON "TopLevelDomain":"string"
SOAP/XML <TopLevelDomain>string</TopLevelDomain>


UTC

Returns the time zone of the requested record. All Melissa Data products express time zones in UTC (Coordinated Universal Time).
Protocol Syntax
JSON "UTC":"string"
SOAP/XML <UTC>string</UTC>


UnifiedSchoolDistrictCode

Returns a 5 digit string representing the Unified School District Code for the requested record.
Protocol Syntax
JSON "UnifiedSchoolDistrictCode":"string"
SOAP/XML <UnifiedSchoolDistrictCode>string</UnifiedSchoolDistrictCode>


UnifiedSchoolDistrictName

Returns the Secondary Unified District Name for the requested record.
Protocol Syntax
JSON "UnifiedSchoolDistrictName":"string"
SOAP/XML <UnifiedSchoolDistrictName>string</UnifiedSchoolDistrictName>


UrbanizationName

Returns the urbanization name for the address entered in the AddressLine field. Usually only used if the address is in Puerto Rico.
Protocol Syntax
JSON "UrbanizationName":"string"
SOAP/XML <UrbanizationName>string</UrbanizationName>
Retrieved from "http://wiki.melissadata.com/index.php?title=Personator_Consumer:Response&oldid=13265"