Personator Consumer:Response: Difference between revisions
Jump to navigation
Jump to search
m Admin moved page Personator:Response to Personator Consumer:Response |
No edit summary |
||
| Line 311: | Line 311: | ||
: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. | ||
:For a complete list of error codes, see [[Result Code Details#Personator|Personator Result Codes]]. | :For a complete list of error codes, see [[Result Code Details#Personator Consumer|Personator Consumer Result Codes]]. | ||
:{| class="alternate01" | :{| class="alternate01" | ||
| Line 549: | Line 549: | ||
<h3 style="background-color:rgb(240,240,240);">AddressTypeCode</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 Consumer|Result Code Details]] for the list of possible codes. | ||
:{| class="alternate01" | :{| class="alternate01" | ||
| Line 2,327: | Line 2,327: | ||
:This is a string value with comma delimited status, error codes, and change codes for the record. | :This is a string value with comma delimited status, error codes, and change codes for the record. | ||
:For a complete list of codes, see [[Result Code Details#Personator|Personator Result Codes]]. | :For a complete list of codes, see [[Result Code Details#Personator Consumer|Personator Consumer Result Codes]]. | ||
:{| class="alternate01" | :{| class="alternate01" | ||
Revision as of 23:06, 25 July 2019
| Personator Consumer Navigation | ||||||||
|---|---|---|---|---|---|---|---|---|
| ||||||||
| ||||||||
| ||||||||
| ||||||||
| 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 | |
| DistanceAddressToIP | DistanceAddressToIP | |
| DomainName | DomainName | |
| Education | Education | |
| ElementarySchoolDistrictCode | ElementarySchoolDistrictCode | |
| ElementarySchoolDistrictName | ElementarySchoolDistrictName | |
| EmailAddress | EmailAddress | |
| EstimatedHomeValue | EstimatedHomeValue | |
| EthnicCode | EthnicCode | |
| EthnicGroup | EthnicGroup | |
| Gender | Gender | |
| Gender2 | Gender2 | |
| HouseholdIncome | HouseholdIncome | |
| HouseholdSize | HouseholdSize | |
| IPAddress | IPAddress | |
| IPCity | IPCity | |
| IPConnectionSpeed | IPConnectionSpeed | |
| IPConnectionType | IPConnectionType | |
| IPContinent | IPContinent | |
| IPCountryAbbreviation | IPCountryAbbreviation | |
| IPCountryName | IPCountryName | |
| IPDomainName | IPDomainName | |
| IPISPName | IPISPName | |
| IPLatitude | IPLatitude | |
| IPLongitude | IPLongitude | |
| IPPostalCode | IPPostalCode | |
| IPProxyDescription | IPProxyDescription | |
| IPProxyType | IPProxyType | |
| IPRegion | IPRegion | |
| IPUTC | IPUTC | |
| 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 Consumer 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>
DistanceAddressToIP
- This is the distance in miles between the latitude and longitude of the physical location of the IP Addressn and the latitude and longitude of the input Address.
Protocol Syntax JSON "DistanceAddressToIP":"string"SOAP/XML <DistanceAddressToIP>string</DistanceAddressToIP>
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>
EstimatedHomeValue
- The estimated value of the home, given in U.S. Dollars.
Protocol Syntax JSON "EstimatedHomeValue":"string"SOAP/XML <EstimatedHomeValue>string</EstimatedHomeValue>
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.
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
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.
Value Blank 1 2 3 4 5 6 7 8 9
Protocol Syntax JSON "HouseholdSize":"string"SOAP/XML <HouseholdSize>string</HouseholdSize>
IPAddress
- The IP address being looked up.
Protocol Syntax JSON "IPAddress":"string"SOAP/XML <IPAddress>string</IPAddress>
IPCity
- The city where the IP address is located.
Protocol Syntax JSON "IPCity":"string"SOAP/XML <IPCity>string</IPCity>
IPConnectionSpeed
- The connection speed associated with this IP address.
Value dialup broadband ultra broadband
Protocol Syntax JSON "IPConnectionSpeed":"string"SOAP/XML <IPConnectionSpeed>string</IPConnectionSpeed>
IPConnectionType
- The type of connection used by this IP address.
Value dialup wired wifi mobile satellite
Protocol Syntax JSON "IPConnectionType":"string"SOAP/XML <IPConnectionType>string</IPConnectionType>
IPContinent
- The continent where the IP address is located.
Protocol Syntax JSON "IPContinent":"string"SOAP/XML <IPContinent>string</IPContinent>
IPCountryAbbreviation
- The ISO 3166-1 alpha-2 country code of the country where the IP address is located.
Protocol Syntax JSON "IPCountryAbbreviation":"string"SOAP/XML <IPCountryAbbreviation>string</IPCountryAbbreviation>
IPCountryName
- The full name of the country where the IP address is located.
Protocol Syntax JSON "IPCountryName":"string"SOAP/XML <IPCountryName>string</IPCountryName>
IPDomainName
- The domain name associated with this IP address.
Protocol Syntax JSON "IPDomainName":"string"SOAP/XML <IPDomainName>string</IPDomainName>
IPISPName
- The name of the Internet Service Provider associated with the IP Address.
Protocol Syntax JSON "IPISPName":"string"SOAP/XML <IPISPName>string</IPISPName>
IPLatitude
- The latitude for the IP address. This usually points to the IP Address's postal code.
Protocol Syntax JSON "IPLatitude":"string"SOAP/XML <IPLatitude>string</IPLatitude>
IPLongitude
- The longitude for the IP address. This usually points to the IP Address's postal code.
Protocol Syntax JSON "IPLongitude":"string"SOAP/XML <IPLongitude>string</IPLongitude>
IPPostalCode
- The postal code where the IP Address is located.
Protocol Syntax JSON "IPPostalCode":"string"SOAP/XML <IPPostalCode>string</IPPostalCode>
IPProxyDescription
- Additional Details for the Proxy Type returned.
Value Tor-exit Tor-relay AOL Cloud DNS VPN Web-Browser
Protocol Syntax JSON "IPProxyDescription":"string"SOAP/XML <IPProxyDescription>string</IPProxyDescription>
IPProxyType
- The type of proxy for an IP Address.
Value Definition Anonymous The IP address is a proxy and the actual IP address of the end user is not available. Transparent The IP address is a proxy, but the originating IP address of the end user can be detected by inspecting the HTTP headers, however, this can easily be spoofed Hosting The IP address belongs to a hosting facility or cloud provider and may be used as a proxy because an end user is not typically located in a hosting facility. These IP addresses may be rented per service agreement with the hosting facility and easily disposed. Corporate The IP address is registered to a specific location with end users sharing a single IP address. A typical example is of end users behind a router using Network Address Translation. Each user will appear to the world as coming from the same IP address Public The address is a known public proxy allowing multiple users to proxy their data from a location allowing public Internet access. Edu The IP address is from a known educational institution. AOL The IP address is an AOL proxy. Blank Not a known proxy.
Protocol Syntax JSON "IPProxyType":"string"SOAP/XML <IPProxyType>string</IPProxyType>
IPRegion
- The region where the IP address is located, specific meaning varies from country to country. For IPs in the US this field returns the state that the IP is located within.
Protocol Syntax JSON "IPRegion":"string"SOAP/XML <IPRegion>string</IPRegion>
IPUTC
- The GMT offset for the area where the IP address is located.
Protocol Syntax JSON "IPUTC":"string"SOAP/XML <IPUTC>string</IPUTC>
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 Consumer 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>