Reference Guide

Introduction

Personator™ Cloud Service provides CASS/DPV certified address verification and optionally leverages comprehensive Consumer data for all-in-one email, phone, name checking, name to address verification, move update, and appending missing information, demographics, enrichments.

Base URL

https://personator.melissadata.net

Licensing

The License Key is a software key required to use the web service. You will receive your license key from your Melissa representative. If you don’t have a license key, contact the Melissa sales team by Requesting a Demo or by calling 800-MELISSA ext. 3 (800-635-4772 ext. 3). Without a license key, Personator Consumer will not function.

To set the license key, use the id/CustomerID property in your requests.

Endpoints

/V3/WEB/ContactVerify/doContactVerify

The Personator Consumer doContactVerify endpoint does all the contact verification you need by choosing the actions and options you need.

Try It Now

Note

Make sure to replace {{customerId}} with your license key.

Get it here!

• GET JSON
• POST JSON
• GET XML
• POST XML

curl -X GET "https://personator.melissadata.net/v3/WEB/ContactVerify/doContactVerify?\
&act=Append\
&cols=\
&id={{customerId}}\
&opt=Append:blank\
&t=Test\
&a1=22382%20Avenida%20Empresa\
&a2=\
&bday=\
&bmo=\
&byr=\
&city=Rancho%20Santa%20Margarita\
&comp=\
&ctry=\
&email=\
&ff=\
&first=\
&format=JSON\
&full=\
&ip=\
&last=\
&lastline=\
&mak=\
&phone=\
&postal=\
&ss=\
&state=California" \
-H "Content-Type: application/json" \
-H "Accept: application/json"

curl -X POST "https://personator.melissadata.net/v3/WEB/ContactVerify/doContactVerify" \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{
       "Actions": "Append",
       "Columns": "",
       "CustomerID": "{{customerId}}",
       "Options": "Append:blank",
       "Records":
       [{
          "AddressLine1": "22382 Avenida Empresa",
          "AddressLine2": "",
          "BirthDay": "",
          "BirthMonth": "",
          "BirthYear": "",
          "City": "Rancho Santa Margarita",
          "CompanyName": "",
          "Country": "",
          "EmailAddress": "",
          "FirstName": "",
          "Format": "JSON",
          "FreeForm": "",
          "FullName": "",
          "IPAddress": "",
          "LastLine": "",
          "LastName": "",
          "MelissaAddressKey": "",
          "MIK": "",
          "PhoneNumber": "",
          "PostalCode": "",
          "RecordID": "1",
          "SocialSecurity": "",
          "State": "California"
       },{
          "AddressLine1": "",
          "AddressLine2": "",
          "BirthDay": "",
          "BirthMonth": "",
          "BirthYear": "",
          "City": "",
          "CompanyName": "",
          "Country": "",
          "EmailAddress": "",
          "FirstName": "",
          "Format": "JSON",
          "FreeForm": "",
          "FullName": "",
          "IPAddress": "",
          "LastLine": "",
          "LastName": "",
          "MelissaAddressKey": "",
          "MIK": "",
          "PhoneNumber": "",
          "PostalCode": "",
          "RecordID": "2",
          "SocialSecurity": "",
          "State": ""
       }],
       "TransmissionReference": "Test"
    }'

curl -X GET "https://personator.melissadata.net/v3/WEB/ContactVerify/doContactVerify?\
&act=Append\
&cols=\
&id={{customerId}}\
&opt=Append:blank\
&t=Test\
&a1=22382%20Avenida%20Empresa\
&a2=\
&bday=\
&bmo=\
&byr=\
&city=Rancho%20Santa%20Margarita\
&comp=\
&ctry=\
&email=\
&ff=\
&first=\
&format=XML\
&full=\
&ip=\
&last=\
&lastline=\
&mak=\
&phone=\
&postal=\
&ss=\
&state=California" \
-H "Content-Type: application/xml" \
-H "Accept: application/xml"

curl -X POST "https://personator.melissadata.net/v3/WEB/ContactVerify/doContactVerify" \
-H "Content-Type: application/xml" \
-H "Accept: */*" \
-d '<Request>
       <Actions>Append</Actions>
       <Columns></Columns>
       <CustomerID>{{customerId}}</CustomerID>
       <Options>Append:blank</Options>
       <Records>
          <RequestRecord>
             <AddressLine1>22382 Avenida Empresa</AddressLine1>
             <AddressLine2></AddressLine2>
             <BirthDay></BirthDay>
             <BirthMonth></BirthMonth>
             <BirthYear></BirthYear>
             <City>Rancho Santa Margarita</City>
             <CompanyName></CompanyName>
             <Country></Country>
             <EmailAddress></EmailAddress>
             <FirstName></FirstName>
             <FreeForm></FreeForm>
             <FullName></FullName>
             <IPAddress></IPAddress>
             <LastLine></LastLine>
             <LastName></LastName>
             <MelissaAddressKey></MelissaAddressKey>
             <PhoneNumber></PhoneNumber>
             <PostalCode></PostalCode>
             <RecordID>1</RecordID>
             <SocialSecurity></SocialSecurity>
             <State>California</State>
          </RequestRecord>
          <RequestRecord>
             <AddressLine1></AddressLine1>
             <AddressLine2></AddressLine2>
             <BirthDay></BirthDay>
             <BirthMonth></BirthMonth>
             <BirthYear></BirthYear>
             <City></City>
             <CompanyName></CompanyName>
             <Country></Country>
             <EmailAddress></EmailAddress>
             <FirstName></FirstName>
             <FreeForm></FreeForm>
             <FullName></FullName>
             <IPAddress></IPAddress>
             <LastLine></LastLine>
             <LastName></LastName>
             <MelissaAddressKey></MelissaAddressKey>
             <PhoneNumber></PhoneNumber>
             <PostalCode></PostalCode>
             <RecordID>2</RecordID>
             <SocialSecurity></SocialSecurity>
             <State></State>
          </RequestRecord>
       </Records>
       <TransmissionReference>Test</TransmissionReference>
    </Request>'

Request Parameters

Note

For more information on things like the minimum input requirements, see the FAQs.

• GET JSON
• POST JSON
• GET XML
• POST XML

Code	Description
Request Level Parameters
act	Required. The action to take. See Actions for more information.
cols	The column names or groups to be output. See Columns for more information.
id	The License Key issued by Melissa.
opt	Set Options AdvancedAddressCorrection AdvancedAddressType AliasMode Append CentricHint CorrectFirstName CorrectSyntax DatabaseLookup DecennialCensusKey Demographics Diacritics FuzzyLookup GenderAggression GenderPopulation LongAddressFormat MiddleNameLogic NameHint SalutationFormat StandardizeCasing StandardizeCompany UpdateDomain UsePreferredCity
t	This is a string value that serves as a unique identifier for this set of records. It is returned as sent.
Record Level Parameters
a1	The input field for the address line 1.
a2	The input field for the address line 2.
ageapprox	Optional. Filter results to return individuals who are within a year of the provided age.
agegt	Optional. Filter results to return individuals who’s age is greater than the provided age.
agelt	Optional. Filter results to return individuals who’s age is less than the provided age.
bday	The birth day of the contact record in DD format.
bmo	The birth month of the contact record in MM format.
byr	The birth year of the contact record in YYYY format.
city	The city name.
comp	The company name.
ctry	The country. This can only take in variations of US or Canada. All other countries will return AS09 (Foreign Address). Invalid or blank inputs will default to US and Canada.
email	The email address.
first	The given (first) name.
format	The format of the response.
ff	The delimited or undelimited free form input that will be parsed by the service.
full	The full name. Name parsing will only happen if the first name and last name fields are blank.
ip	The IP Address for the record.
lastline	The city, state, and ZIP.
last	The family (last) name.
mak	A proprietary unique key identifier for an address.
mik	The input field for the Melissa Identity Key, a unique number for each individual.
phone	The phone number.
postal	The postal code.
ss	The Social Security Number for the record, accepts the full number or the last 4 digits.
state	The US state.

Code	Description
Request Level Parameters
Actions	Required. The action to take. See Actions for more information.
Columns	The column names or groups to be output. See Columns for more information.
CustomerID	The License Key issued by Melissa.
Options	Set Options AdvancedAddressCorrection AdvancedAddressType AliasMode Append CentricHint CorrectFirstName CorrectSyntax DatabaseLookup DecennialCensusKey Demographics Diacritics FuzzyLookup GenderAggression GenderPopulation LongAddressFormat MiddleNameLogic NameHint SalutationFormat StandardizeCasing StandardizeCompany UpdateDomain UsePreferredCity
TransmissionReference	This is a string value that serves as a unique identifier for this set of records. It is returned as sent.
Record Level Parameters
AddressLine1	The input field for the address line 1.
AddressLine2	The input field for the address line 2.
AgeApproximate	Optional. Filter results to return individuals who are within a year of the provided age.
AgeGreaterThan	Optional. Filter results to return individuals who’s age is greater than the provided age.
AgeLessThan	Optional. Filter results to return individuals who’s age is less than the provided age.
BirthDay	The birth day of the contact record in DD format.
BirthMonth	The birth month of the contact record in MM format.
BirthYear	The birth year of the contact record in YYYY format.
City	The city name.
CompanyName	The company name.
Country	The country. This can only take in variations of US or Canada. All other countries will return AS09 (Foreign Address). Invalid or blank inputs will default to US and Canada.
EmailAddress	The email address.
FirstName	The given (first) name.
Format	The format of the response.
FreeForm	The delimited or undelimited free form input that will be parsed by the service.
FullName	The full name. Name parsing will only happen if the first name and last name fields are blank.
IPAddress	The IP Address for the record.
LastLine	The city, state, and ZIP.
LastName	The family (last) name.
MelissaAddressKey	A proprietary unique key identifier for an address.
MIK	The input field for the Melissa Identity Key, a unique number for each individual.
PhoneNumber	The phone number.
PostalCode	The postal code.
RecordID	A unique identifier for the current record.
SocialSecurity	The Social Security Number for the record, accepts the full number or the last 4 digits.
State	The US state.

Code	Description
Request Level Parameters
act	Required. The action to take. See Actions for more information.
cols	The column names or groups to be output. See Columns for more information.
id	The License Key issued by Melissa.
opt	Set Options AdvancedAddressCorrection AdvancedAddressType AliasMode Append CentricHint CorrectFirstName CorrectSyntax DatabaseLookup DecennialCensusKey Demographics Diacritics FuzzyLookup GenderAggression GenderPopulation LongAddressFormat MiddleNameLogic NameHint SalutationFormat StandardizeCasing StandardizeCompany UpdateDomain UsePreferredCity
t	This is a string value that serves as a unique identifier for this set of records. It is returned as sent.
Record Level Parameters
a1	The input field for the address line 1.
a2	The input field for the address line 2.
ageapprox	Optional. Filter results to return individuals who are within a year of the provided age.
agegt	Optional. Filter results to return individuals who’s age is greater than the provided age.
agelt	Optional. Filter results to return individuals who’s age is less than the provided age.
bday	The birth day of the contact record in DD format.
bmo	The birth month of the contact record in MM format.
byr	The birth year of the contact record in YYYY format.
city	The city name.
comp	The company name.
ctry	The country. This can only take in variations of US or Canada. All other countries will return AS09 (Foreign Address). Invalid or blank inputs will default to US and Canada.
email	The email address.
first	The given (first) name.
format	The format of the response.
ff	The delimited or undelimited free form input that will be parsed by the service.
full	The full name. Name parsing will only happen if the first name and last name fields are blank.
ip	The IP Address for the record.
lastline	The city, state, and ZIP.
last	The family (last) name.
mak	A proprietary unique key identifier for an address.
mik	The input field for the Melissa Identity Key, a unique number for each individual.
phone	The phone number.
postal	The postal code.
ss	The Social Security Number for the record, accepts the full number or the last 4 digits.
state	The US state.

Code	Description
Request Level Parameters
Actions	Required. The action to take. See Actions for more information.
Columns	The column names or groups to be output. See Columns for more information.
CustomerID	The License Key issued by Melissa.
Options	Set Options AdvancedAddressCorrection AdvancedAddressType AliasMode Append CentricHint CorrectFirstName CorrectSyntax DatabaseLookup DecennialCensusKey Demographics Diacritics FuzzyLookup GenderAggression GenderPopulation LongAddressFormat MiddleNameLogic NameHint SalutationFormat StandardizeCasing StandardizeCompany UpdateDomain UsePreferredCity
TransmissionReference	This is a string value that serves as a unique identifier for this set of records. It is returned as sent.
Record Level Parameters
AddressLine1	The input field for the address line 1.
AddressLine2	The input field for the address line 2.
AgeApproximate	Optional. Filter results to return individuals who are within a year of the provided age.
AgeGreaterThan	Optional. Filter results to return individuals who’s age is greater than the provided age.
AgeLessThan	Optional. Filter results to return individuals who’s age is less than the provided age.
BirthDay	The birth day of the contact record in DD format.
BirthMonth	The birth month of the contact record in MM format.
BirthYear	The birth year of the contact record in YYYY format.
City	The city name.
CompanyName	The company name.
Country	The country. This can only take in variations of US or Canada. All other countries will return AS09 (Foreign Address). Invalid or blank inputs will default to US and Canada.
EmailAddress	The email address.
FirstName	The given (first) name.
Format	The format of the response.
FreeForm	The delimited or undelimited free form input that will be parsed by the service.
FullName	The full name. Name parsing will only happen if the first name and last name fields are blank.
IPAddress	The IP Address for the record.
LastLine	The city, state, and ZIP.
LastName	The family (last) name.
MelissaAddressKey	A proprietary unique key identifier for an address.
MIK	The input field for the Melissa Identity Key, a unique number for each individual.
PhoneNumber	The phone number.
PostalCode	The postal code.
RecordID	A unique identifier for the current record.
SocialSecurity	The Social Security Number for the record, accepts the full number or the last 4 digits.
State	The US state.

Actions

Delimit multiple actions with a ,.

Code	Description
Check	Basic Validates and corrects individual input data. For more details, see Check.
Verify	Addon Returns the relationships between different input data. For more details, see Verify.
Append	Addon Returns elements based on the selected point of centricity. For more details, see Append.
Move	Addon Returns the latest address for an individual or business. For more details, see Move.

Check

Basic US and Canada Only. The Check action will validate the individual input data pieces for validity and correct them if possible. If the data is correctable, additional information will often be appended as well.

Check Type	Description
Check(Address)	US and Canada only. Check (Address) will only be processed if the following is true: AddressLine1 is not empty Both City and State are not empty or PostalCode is not empty. Type Description AddressLine1 and AddressLine2 Request AddressLine1 and AddressLine2 may each contain a full address. If both addresses are verified as valid, both are returned as inputted. If AddressLine1 has an invalid address and AddressLine2 has a valid address, the return order is switched. This returns the valid address previously in AddressLine2 into AddressLine1. Conversely, the invalid address in AddressLine1 will be returned in AddressLine2. Alternatively, AddressLine2 may contain a suite number for AddressLine1. The suite information will be cleared from AddressLine2 and placed under its own field in the output. Geocode If an address is verifiable, you can choose to geocode it. You will have the geocoding information appended (depending on your license). Geocoding is available for US and Canada. To use Geocode, you must have the geocode columns on: GrpCensus or GrpGeocode. Geodetic System The GeoCoder Object uses WGS 84 standard, an Earth-centered, Earth-fixed terrestrial reference system and geodetic datum. Geocode level Your license will determine what geocode level you are allowed. License Feature Description Address Checking Geocode to 5 digits. GeoCode Geocode to 9 digits. GeoPoints Geocode to 11 digits. Geocode requires the results returned from the Web service.
Check (Phone)	US and Canada only. Check (Phone) will only be processed if the PhoneNumber input has a value.
Check (Email)	US and Canada only. Check (Email) will only be processed if the EmailAddress input has a value.
Check (Name)	US and Canada only. Check (FullName) will only be processed if the FullName or FirstName input has a value.

Verify

Addon The Verify action will return to you the relationships between your different input data pieces. It can show you if your name, address, email, and phone number are correlated (belonging to the same person) or not.

Verify Type	Description
Verify (Address, Phone, Email)	The type of search performed is dependent upon your defined centric piece of information.

Append

Addon The Append action will return elements based on the selected point of centricity which can either be the address, email or phone.

For example, an address centric Append will return the name, company, phone and email associated with the given address.

This action isn’t allowed for a credit license and will return a GE29 error code.

Append Type	Description
Append (Address, Phone, Email)	The appended information is dependent upon your defined centric piece of information.

Move

Addon The Move action will return the latest address for an individual or business if a previous address was entered. Move requires either a Name and Address, or a Business/Company Name and Address as inputs.

Move also returns results codes that help identify which addresses were updated with a move.

This action isn’t allowed for a credit license and will return a GE29 error code.

Columns

Entering the column name will return the column. Specifying a group name will return all columns in the group.

Delimit multiple columns with a ,.

Group Name	Included Fields
[DEFAULT] Always return in the output structure.	AddressExtras Basic AddressKey Basic AddressLine1 Basic AddressLine2 Basic City Basic CompanyName Basic EmailAddress Basic MelissaAddressKey Basic MelissaAddressKeyBase Basic NameFull Basic PhoneNumber Basic PostalCode Basic RecordID Basic Records Results Basic State Basic TotalRecords TransmissionReference TransmissionResults Version
[No Group] - These fields have no group and have to be requested by the field name.	DateLastConfirmed Addon EstimatedHomeValue Addon No Credit MelissaIdentityKey Basic MoveDate Addon Occupation Addon No Credit OwnRent Addon No Credit PhoneCountryCode Basic PhoneCountryName Basic Plus4 Basic PrivateMailBox Basic Suite Basic
GrpAddressDetails - Address Details	AddressTypeCode Basic CarrierRoute Basic CityAbbreviation Basic CountryCode Basic CountryName Basic DeliveryIndicator Basic DeliveryPointCheckDigit Basic DeliveryPointCode Basic StateName Basic UrbanizationName Basic UTC Basic
GrpCensus - Census Details	CBSACode Basic CBSADivisionCode Basic CBSADivisionLevel Basic CBSADivisionTitle Basic CBSALevel Basic CBSATitle Basic CensusBlock Basic CensusTract Basic CongressionalDistrict Basic CountyFIPS Basic CountyName Basic PlaceCode Basic PlaceName Basic
GrpCensus2 - Additional Census Details	CensusKey Basic CountySubdivisionCode Basic CountySubdivisionName Basic ElementarySchoolDistrictCode Basic ElementarySchoolDistrictName Basic SecondarySchoolDistrictCode Basic SecondarySchoolDistrictName Basic StateDistrictLower Basic StateDistrictUpper Basic UnifiedSchoolDistrictCode Basic UnifiedSchoolDistrictName Basic
GrpGeocode - Geocode Details	Latitude Basic Longitude Basic
GrpDemographicBasic - Basic Demographics	ChildrenAgeRange Addon No Credit CreditCardUser Addon No Credit DateOfBirth No Credit DateOfDeath No Credit DemographicsGender No Credit DemographicsResults Addon Education Addon No Credit EthnicCode Addon No Credit EthnicGroup Addon No Credit HouseholdIncome Addon No Credit HouseholdSize Addon No Credit LengthOfResidence Addon No Credit MaritalStatus Addon No Credit PoliticalParty Addon No Credit PresenceOfChildren Addon No Credit PresenceOfSenior Addon No Credit
GrpIPAddress - IP Address Details	DistanceAddressToIP Addon IPAddress Addon IPCity Addon IPConnectionSpeed Addon IPConnectionType Addon IPContinent Addon IPCountryAbbreviation Addon IPCountryName Addon IPDomainName Addon IPISPName Addon IPLatitude Addon IPLongitude Addon IPPostalCode Addon IPProxyDescription Addon IPProxyType Addon IPRegion Addon IPUTC Addon
GrpNameDetails - Name Details	Gender Basic Gender2 Basic NameFirst Basic NameFirst2 Basic NameLast Basic NameLast2 Basic NameMiddle Basic NameMiddle2 Basic NamePrefix Basic NamePrefix2 Basic NameSuffix Basic NameSuffix2 Basic Salutation Basic
GrpParsedAddress - Parsed Address Details	AddressDeliveryInstallation Basic AddressHouseNumber Basic AddressLockBox Basic AddressPostDirection Basic AddressPreDirection Basic AddressPrivateMailboxName Basic AddressPrivateMailboxRange Basic AddressRouteService Basic AddressStreetName Basic AddressStreetSuffix Basic AddressSuiteName Basic AddressSuiteNumber Basic
GrpParsedEmail - Parsed Email Details	DomainName Basic MailboxName Basic TopLevelDomain Basic
GrpParsedPhone - Parsed Phone Details	AreaCode Basic NewAreaCode Basic PhoneExtension Basic PhonePrefix Basic PhoneSuffix Basic

Options

List options in the following format, with multiple options delimited with a ;.

OptionName:Parameter;OptionName:Parameter

AdvancedAddressCorrection

Check(Address)

Uses the name input to perform more advanced address corrections. This can correct or append house numbers, street names, cities, states, and ZIP codes.

Parameter	Description
off	Default. No advanced address corrections will occur.
on	Will use name input to perform advanced address corrections.

AdvancedAddressType

Check(Address)

This option allows you to select whether to return the simplified address type codes or the advanced and more complete address type codes.

See Address Type codes for the full list of possible codes. There are different codes available depending on AdvancedAddressType being set to either on or off.

Parameter	Description
off	Default. Only Default Address Types are returned (S, G, M, P, R, and U).
on	All possible address type codes are returned (US Address Type, Canadian Address Type).

AliasMode

Check(Address)

Option to convert an address to the USPS preferred street name or preserve the original address.

Parameter	Description
ConvertAlias	Default. The street address alias is converted to the USPS preferred street name.
PreserveAlias	The street address alias is preserved and returned as sent.

Append

Append(Address, Phone, Email)

Setting this option to Blank will cause the service to return information only when the input address, phone, email, name or company is blank.

Setting this option to CheckError will cause the service to return information when there are errors to either the address, phone, email, name or company. What an error entails are defined as follows:

• Address Error: If the input address was not found in the database, was not at the least partially verified, or could not be corrected. (does not contain AS01, AS02, or AS03).

• Phone Error: If the input phone number was not matched to either the 10 digit or 7 digit level at the least. (does not contain PS01 or PS02).

• Email Error: If the input email address was not found in the database, or if the email is unconfirmed. (does not contain ES01 or ES03).

• Name Error: If the input name did not parse successfully (does not contain NS01)

• Company Error: If the input company was blank.

Setting the Append option to Always will cause the service to return information all the time, regardless of whether the input address, phone, email, name or company is blank or incorrect.

Parameter	Description
blank	Default. Returns information when the input field is blank.
checkerror	Returns information when there are errors.
always	Always returns information.

CentricHint

Verify(Address, Phone, Email)

When set to Auto, it first uses Address if available, followed by Phone if no Address is available, and lastly Email if neither Address nor Phone are available. Use this to tell the service which piece of information to use as the primary pivot when verifying information.

Parameter	Description
auto	Default. Will use Address, Phone, then Email as a primary pivot.
address	Will use Address as a primary pivot.
phone	Will use Phone as a primary pivot.
email	Will use Email as a primary pivot.

CorrectFirstName

Check(Name)

If set to on, allows common spelling corrections for the FirstName field.

Parameter	Description
on	Default. Will perform spelling corrections on the FirstName field.
off	No spelling corrections will occur.

CorrectSyntax

Check(Email)

If set to on, corrects the syntax of the Email field.

Parameter	Description
on	Default. Will correct the syntax of the Email field.
off	No corrections will occur.

DatabaseLookup

Check(Email)

If set to on, verification of domain names will be attempted using a database of valid domains.

Parameter	Description
on	Default. Will attempt to verify domain names.
off	No verification will occur.

DecennialCensusKey

Check(Address)

Set the preferred Census information returned, whether the latest one or the decennial version.

Parameter	Description
off	Default. Return the latest Census information available.
2020	Return the 2020 static decennial census database released.
2010	Return the 2010 static decennial census database released.

Demographics

Determines the data masking of demographics columns.

• Yes: No data masking will be performed. All selected output columns will be returned.

• Mask: Demographic columns’ data will be ‘masked’; it will be replaced with the ‘Y’ character if the column returns non-blank data. All selected output columns will be returned. This will return fields normally restricted for a credit license.

• MaskOnly: Demographic columns’ data will be ‘masked’; it will be replaced with the ‘Y’ character if the column returns non-blank data. All other requested columns will be in the response structure but will be blank. This will return fields normally restricted for a credit license.

• ValueOnly: All data in the demographics columns will be returned. All other requested columns will be in the response structure but will be blank.

Parameter	Description
yes	Default. Returns the requested demographics with other other check columns.
mask	Returns the requested masked demographics with other check columns.
maskonly	Returns only the requested masked demographics.
valueonly	Returns only the requested demographics.

Diacritics

Check(Address)

Determines whether or not French language characters are returned. If set to auto, those characters are only returned if they are in the input.

Parameter	Description
auto	Default. Diacritics only returned if in the input.
on	Will return diacritics.
off	No diacritics returned.

FuzzyLookup

Check(Email)

If set to on, the API will attempt to to apply fuzzy matching algorithms to the input domain for correction.

Parameter	Description
on	Default. Will apply fuzzy matching correction to the domain.
off	No corrections will occur.

GenderAggression

Check(Name)

Sets how aggressive genderization is for neutral first names.

Parameter	Description
neutral	Default. Gender agression is neutral.
conservative	Gender aggression is conservative.
aggressive	Gender aggression is aggressive.

GenderPopulation

Check(Name)

Sets the gender balance of the source data, either predominantly male, female, or mixed (evenly split).

Parameter	Description
mixed	Default. Sets source data gender balance to mixed.
male	Sets source data gender balance to predominantly male.
female	Sets source data gender balance to predominantly female.

LongAddressFormat

Check(Address)

This function controls how Personator handles the abbreviations of suffixes and directionals when standardizing a street address. Setting this option to on will spell out any suffix and directional abbreviations (Ave to Avenue). Setting this option to auto will preserve the suffix and directional as they were entered. In auto mode, if a spelled out “avenue” is entered, we will keep the suffix spelled out and vice versa.

Parameter	Description
off	Default. Will abbreviate suffixes and directionals.
on	Will spell out suffixes and directional abbreviations.
auto	Will preserve suffixes and directionals as entered.

MiddleNameLogic

Check(Name)

Determines the handling of middle names.

• ParseLogic: Middle names that are typically last names are considered to be part of a hyphenated last name.

• HypenatedLast: The middle word is assumed to be part of the last name. For Example: “Matthew Edward Jones” is treated as “Matthew Edward-Jones.”

• MiddleName: The middle word is assumed to be a middle name. For example: “Matthew Svensson Jones.” “Svensson” would be considered a middle name instead of part of the last name.

Parameter	Description
parselogic	Default. Middle name typically a last name is assumed to be a hypenated last name.
hyphenatedlast	Middle word assumed to be part of the last name.
middlename	Middle word assumed to be a middle name.

NameHint

Check(Name)

Sets the name hint for the input name.

Parameter	Description
varying	Default. If necessary, statistical logic will be employed to determine name order, with no bias toward either name order.
definitelyfull	Name will always be treated as normal name order, regardless of formatting or punctuation.
verylikelyfull	Name will be treated as normal name order unless inverse order is clearly indicated by formatting or punctuation.
probablyfull	If necessary, statistical logic will be employed to determine name order, with a bias toward normal name order.
probablyinverse	If necessary, statistical logic will be employed to determine name order, with a bias toward inverse name order.
verylikelyinverse	Name will be treated as inverse name order unless normal order is clearly indicated by formatting or punctuation.
definitelyinverse	Name will always be treated as inverse name order, regardless of formatting or punctuation.
mixedfirstname	Name field is expected to only contain prefixes, first, and middle names.
mixedlastname	Name field is expected to only contain last names and suffixes.

SalutationFormat

Check(Name)

Sets the salutation format for the response.

• Formal: Dear Mr. Smith

• Informal: Dear John

• First/Last: Dear John Smith

Parameter	Description
formal	Default. Sets the salutation format to formal.
informal	Sets the salutation format to informal.
firstlast	Sets the salutation format to first/last.

StandardizeCasing

Check(Email)

If set to on, changes all letters in the Email field to lower case before any checking occurs.

Parameter	Description
on	Default. Will standardize all letters to lower case.
off	No case changes will occur.

StandardizeCompany

Check(Name)

If set to on, the CompanyName field will be returned with standard abbreviation, capitalization, and punctuation rules applied.

Parameter	Description
on	Default. Will perform standard abbreviation, capitalization, and punctuation on the CompanyName field.
off	No changes will occur.

UpdateDomain

Check(Email)

If set to on, determines whether the domain name is out of date and updates it.

Parameter	Description
on	Default. Will update the domain if it is out of date.
off	No updates will occur.

UsePreferredCity

Check(Address)

For every city in the United States, there is an official name that is preferred by the U.S. Postal Service. There may be one or more unofficial or “vanity” names in use. Normally, Personator allows you to verify addresses using known vanity names. If the usePreferredCity is set to on, Personator will substitute the preferred city name for all vanity names when it verifies an address.

Parameter	Description
off	Default. No substitution will occur.
on	Will substitute the preferred city name for all vanity names.

Headers

• GET JSON
• POST JSON
• GET XML
• POST XML

Content-Type: application/json; charset=utf-8
Accept: application/json

Content-Type: application/json; charset=utf-8
Accept: application/json

Content-Type: application/xml; charset=utf-8
Accept: application/xml

Content-Type: application/xml; charset=utf-8
Accept: application/xml

Response

• GET JSON
• POST JSON
• GET XML
• POST XML

{
   "Records":
   [{
      "AddressExtras": " ",
      "AddressKey": "92688211282",
      "AddressLine1": "22382 Avenida Empresa",
      "AddressLine2": " ",
      "City": "Rancho Santa Margarita",
      "CompanyName": " ",
      "EmailAddress": " ",
      "MelissaAddressKey": "8008006245",
      "MelissaAddressKeyBase": " ",
      "NameFull": " ",
      "PhoneNumber": " ",
      "PostalCode": "92688-2112",
      "RecordExtras": " ",
      "RecordID": "1",
      "Reserved": " ",
      "Results": "AC02,AC03,AS01",
      "State": "CA"
   }],
   "TotalRecords": "1",
   "TransmissionReference": " ",
   "TransmissionResults": " ",
   "Version": "5.6.13"
}

{
   "Records":
   [{
      "AddressExtras": " ",
      "AddressKey": "92688211282",
      "AddressLine1": "22382 Avenida Empresa",
      "AddressLine2": " ",
      "City": "Rancho Santa Margarita",
      "CompanyName": " ",
      "EmailAddress": " ",
      "MelissaAddressKey": "8008006245",
      "MelissaAddressKeyBase": " ",
      "NameFull": " ",
      "PhoneNumber": " ",
      "PostalCode": "92688-2112",
      "RecordExtras": " ",
      "RecordID": "1",
      "Reserved": " ",
      "Results": "AC02,AC03,AS01",
      "State": "CA"
   },{
      "AddressExtras": " ",
      "AddressKey": " ",
      "AddressLine1": " ",
      "AddressLine2": " ",
      "City": " ",
      "CompanyName": " ",
      "EmailAddress": " ",
      "MelissaAddressKey": " ",
      "MelissaAddressKeyBase": " ",
      "NameFull": " ",
      "PhoneNumber": " ",
      "PostalCode": " ",
      "RecordExtras": " ",
      "RecordID": "2",
      "Reserved": " ",
      "Results": " ",
      "State": " "
   }],
   "TotalRecords": "2",
   "TransmissionReference": " ",
   "TransmissionResults": " ",
   "Version": "5.6.13"
}

<Response xmlns="http://schemas.datacontract.org/2004/07/WcfServiceMD.mdContactVerify" xmlns:i="http://www.w3.org/2001/          XMLSchema-instance">
   <Records>
      <ResponseRecord>
         <AddressDeliveryInstallation />
         <AddressExtras />
         <AddressHouseNumber />
         <AddressKey>92688211282</AddressKey>
         <AddressLine1>22382 Avenida Empresa</AddressLine1>
         <AddressLine2 />
         <AddressLockBox />
         <AddressPostDirection />
         <AddressPreDirection />
         <AddressPrivateMailboxName />
         <AddressPrivateMailboxRange />
         <AddressRouteService />
         <AddressStreetName />
         <AddressStreetSuffix />
         <AddressSuiteName />
         <AddressSuiteNumber />
         <AddressTypeCode />
         <AreaCode />
         <CBSACode />
         <CBSADivisionCode />
         <CBSADivisionLevel />
         <CBSADivisionTitle />
         <CBSALevel />
         <CBSATitle />
         <CarrierRoute />
         <CensusBlock />
         <CensusKey />
         <CensusTract />
         <ChildrenAgeRange />
         <City>Rancho Santa Margarita</City>
         <CityAbbreviation />
         <CompanyName />
         <CongressionalDistrict />
         <CountryCode />
         <CountryName />
         <CountyFIPS />
         <CountyName />
         <CountySubdivisionCode />
         <CountySubdivisionName />
         <CreditCardUser />
         <DateOfBirth />
         <DateOfDeath />
         <DeliveryIndicator />
         <DeliveryPointCheckDigit />
         <DeliveryPointCode />
         <DemographicsGender />
         <DemographicsResults />
         <DistanceAddressToIP />
         <DomainName />
         <Education />
         <ElementarySchoolDistrictCode />
         <ElementarySchoolDistrictName />
         <EmailAddress />
         <Gender />
         <Gender2 />
         <HouseholdIncome />
         <HouseholdSize />
         <IPAddress />
         <IPCity />
         <IPConnectionSpeed />
         <IPConnectionType />
         <IPContinent />
         <IPCountryAbbreviation />
         <IPCountryName />
         <IPDomainName />
         <IPISPName />
         <IPLatitude />
         <IPLongitude />
         <IPPostalCode />
         <IPProxyDescription />
         <IPProxyType />
         <IPRegion />
         <IPUTC />
         <Latitude />
         <LengthOfResidence />
         <Longitude />
         <MailboxName />
         <MaritalStatus />
         <MelissaAddressKey>8008006245</MelissaAddressKey>
         <MelissaAddressKeyBase />
         <MoveDate />
         <NameFirst />
         <NameFirst2 />
         <NameFull />
         <NameLast />
         <NameLast2 />
         <NameMiddle />
         <NameMiddle2 />
         <NamePrefix />
         <NamePrefix2 />
         <NameSuffix />
         <NameSuffix2 />
         <NewAreaCode />
         <Occupation />
         <OwnRent />
         <PhoneCountryCode />
         <PhoneCountryName />
         <PhoneExtension />
         <PhoneNumber />
         <PhonePrefix />
         <PhoneSuffix />
         <PlaceCode />
         <PlaceName />
         <Plus4 />
         <PoliticalParty />
         <PostalCode>92688-2112</PostalCode>
         <PresenceOfChildren />
         <PresenceOfSenior />
         <PrivateMailBox />
         <RecordExtras />
         <RecordID>1</RecordID>
         <Reserved />
         <Results>AC02,AC03,AS01</Results>
         <Salutation />
         <SecondarySchoolDistrictCode />
         <SecondarySchoolDistrictName />
         <State>CA</State>
         <StateDistrictLower />
         <StateDistrictUpper />
         <StateName />
         <Suite />
         <TopLevelDomain />
         <TypesOfVehicles />
         <UTC />
         <UnifiedSchoolDistrictCode />
         <UnifiedSchoolDistrictName />
         <UrbanizationName />
      </ResponseRecord>
   </Records>
   <TotalRecords>1</TotalRecords>
   <TransmissionReference />
   <TransmissionResults />
   <Version>5.6.13</Version>
</Response>

<Response xmlns="http://schemas.datacontract.org/2004/07/WcfServiceMD.mdContactVerify" xmlns:i="http://www.w3.org/2001/          XMLSchema-instance">
   <Records>
      <ResponseRecord>
         <AddressDeliveryInstallation />
         <AddressExtras />
         <AddressHouseNumber />
         <AddressKey>92688211282</AddressKey>
         <AddressLine1>22382 Avenida Empresa</AddressLine1>
         <AddressLine2 />
         <AddressLockBox />
         <AddressPostDirection />
         <AddressPreDirection />
         <AddressPrivateMailboxName />
         <AddressPrivateMailboxRange />
         <AddressRouteService />
         <AddressStreetName />
         <AddressStreetSuffix />
         <AddressSuiteName />
         <AddressSuiteNumber />
         <AddressTypeCode />
         <AreaCode />
         <CBSACode />
         <CBSADivisionCode />
         <CBSADivisionLevel />
         <CBSADivisionTitle />
         <CBSALevel />
         <CBSATitle />
         <CarrierRoute />
         <CensusBlock />
         <CensusKey />
         <CensusTract />
         <ChildrenAgeRange />
         <City>Rancho Santa Margarita</City>
         <CityAbbreviation />
         <CompanyName />
         <CongressionalDistrict />
         <CountryCode />
         <CountryName />
         <CountyFIPS />
         <CountyName />
         <CountySubdivisionCode />
         <CountySubdivisionName />
         <CreditCardUser />
         <DateOfBirth />
         <DateOfDeath />
         <DeliveryIndicator />
         <DeliveryPointCheckDigit />
         <DeliveryPointCode />
         <DemographicsGender />
         <DemographicsResults />
         <DistanceAddressToIP />
         <DomainName />
         <Education />
         <ElementarySchoolDistrictCode />
         <ElementarySchoolDistrictName />
         <EmailAddress />
         <Gender />
         <Gender2 />
         <HouseholdIncome />
         <HouseholdSize />
         <IPAddress />
         <IPCity />
         <IPConnectionSpeed />
         <IPConnectionType />
         <IPContinent />
         <IPCountryAbbreviation />
         <IPCountryName />
         <IPDomainName />
         <IPISPName />
         <IPLatitude />
         <IPLongitude />
         <IPPostalCode />
         <IPProxyDescription />
         <IPProxyType />
         <IPRegion />
         <IPUTC />
         <Latitude />
         <LengthOfResidence />
         <Longitude />
         <MailboxName />
         <MaritalStatus />
         <MelissaAddressKey>8008006245</MelissaAddressKey>
         <MelissaAddressKeyBase />
         <MoveDate />
         <NameFirst />
         <NameFirst2 />
         <NameFull />
         <NameLast />
         <NameLast2 />
         <NameMiddle />
         <NameMiddle2 />
         <NamePrefix />
         <NamePrefix2 />
         <NameSuffix />
         <NameSuffix2 />
         <NewAreaCode />
         <Occupation />
         <OwnRent />
         <PhoneCountryCode />
         <PhoneCountryName />
         <PhoneExtension />
         <PhoneNumber />
         <PhonePrefix />
         <PhoneSuffix />
         <PlaceCode />
         <PlaceName />
         <Plus4 />
         <PoliticalParty />
         <PostalCode>92688-2112</PostalCode>
         <PresenceOfChildren />
         <PresenceOfSenior />
         <PrivateMailBox />
         <RecordExtras />
         <RecordID>1</RecordID>
         <Reserved />
         <Results>AC02,AC03,AS01</Results>
         <Salutation />
         <SecondarySchoolDistrictCode />
         <SecondarySchoolDistrictName />
         <State>CA</State>
         <StateDistrictLower />
         <StateDistrictUpper />
         <StateName />
         <Suite />
         <TopLevelDomain />
         <TypesOfVehicles />
         <UTC />
         <UnifiedSchoolDistrictCode />
         <UnifiedSchoolDistrictName />
         <UrbanizationName />
      </ResponseRecord>
      <ResponseRecord>
         <AddressDeliveryInstallation />
         <AddressExtras />
         <AddressHouseNumber />
         <AddressKey />
         <AddressLine1 />
         <AddressLine2 />
         <AddressLockBox />
         <AddressPostDirection />
         <AddressPreDirection />
         <AddressPrivateMailboxName />
         <AddressPrivateMailboxRange />
         <AddressRouteService />
         <AddressStreetName />
         <AddressStreetSuffix />
         <AddressSuiteName />
         <AddressSuiteNumber />
         <AddressTypeCode />
         <AreaCode />
         <CBSACode />
         <CBSADivisionCode />
         <CBSADivisionLevel />
         <CBSADivisionTitle />
         <CBSALevel />
         <CBSATitle />
         <CarrierRoute />
         <CensusBlock />
         <CensusKey />
         <CensusTract />
         <ChildrenAgeRange />
         <City />
         <CityAbbreviation />
         <CompanyName />
         <CongressionalDistrict />
         <CountryCode />
         <CountryName />
         <CountyFIPS />
         <CountyName />
         <CountySubdivisionCode />
         <CountySubdivisionName />
         <CreditCardUser />
         <DateOfBirth />
         <DateOfDeath />
         <DeliveryIndicator />
         <DeliveryPointCheckDigit />
         <DeliveryPointCode />
         <DemographicsGender />
         <DemographicsResults />
         <DistanceAddressToIP />
         <DomainName />
         <Education />
         <ElementarySchoolDistrictCode />
         <ElementarySchoolDistrictName />
         <EmailAddress />
         <Gender />
         <Gender2 />
         <HouseholdIncome />
         <HouseholdSize />
         <IPAddress />
         <IPCity />
         <IPConnectionSpeed />
         <IPConnectionType />
         <IPContinent />
         <IPCountryAbbreviation />
         <IPCountryName />
         <IPDomainName />
         <IPISPName />
         <IPLatitude />
         <IPLongitude />
         <IPPostalCode />
         <IPProxyDescription />
         <IPProxyType />
         <IPRegion />
         <IPUTC />
         <Latitude />
         <LengthOfResidence />
         <Longitude />
         <MailboxName />
         <MaritalStatus />
         <MelissaAddressKey />
         <MelissaAddressKeyBase />
         <MoveDate />
         <NameFirst />
         <NameFirst2 />
         <NameFull />
         <NameLast />
         <NameLast2 />
         <NameMiddle />
         <NameMiddle2 />
         <NamePrefix />
         <NamePrefix2 />
         <NameSuffix />
         <NameSuffix2 />
         <NewAreaCode />
         <Occupation />
         <OwnRent />
         <PhoneCountryCode />
         <PhoneCountryName />
         <PhoneExtension />
         <PhoneNumber />
         <PhonePrefix />
         <PhoneSuffix />
         <PlaceCode />
         <PlaceName />
         <Plus4 />
         <PoliticalParty />
         <PostalCode />
         <PresenceOfChildren />
         <PresenceOfSenior />
         <PrivateMailBox />
         <RecordExtras />
         <RecordID>2</RecordID>
         <Reserved />
         <Results />
         <Salutation />
         <SecondarySchoolDistrictCode />
         <SecondarySchoolDistrictName />
         <State />
         <StateDistrictLower />
         <StateDistrictUpper />
         <StateName />
         <Suite />
         <TopLevelDomain />
         <TypesOfVehicles />
         <UTC />
         <UnifiedSchoolDistrictCode />
         <UnifiedSchoolDistrictName />
         <UrbanizationName />
      </ResponseRecord>
   </Records>
   <TotalRecords>2</TotalRecords>
   <TransmissionReference />
   <TransmissionResults />
   <Version>5.6.13</Version>
</Response>

Service Level Response Fields

Output Name	Description
TotalRecords	Total number of records.
TransmissionReference	Optional. Serves as a unique request identifier.
TransmissionResults	Lists error codes from any errors caused by the most recent request as a whole.
Version	The current service version number.

Record Level Response Fields

[Default]

Output Name	Description
AddressExtras	Basic Any extra information that does not fit in the AddressLine fields.
AddressKey	Basic Returns a unique identifier for an address. This key can be used with other current and future Melissa services.
AddressLine1	Basic 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.
AddressLine2	Basic 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.
City	Basic Returns the city entered in the City field.
CompanyName	Basic Returns the company name.
EmailAddress	Basic Returns the email address entered in the Email field.
MelissaAddressKey	Basic Returns a unique key associated with an address.
MelissaAddressKeyBase	Basic Returns a unique key associated with a building containing multiple suites/apartments.
NameFull	Basic Returns the full name for the record.
PhoneNumber	Basic Returns the standardized phone number for the record.
PostalCode	Basic Returns the 9-digit postal code for U.S. addresses and 6-digit postal code for Canadian addresses.
RecordID	Basic 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.
Results	Basic This is a string value with comma delimited status, error codes, and change codes for the record.
State	Basic Returns the state for the record.

[No Group]

Output Name	Description
DateLastConfirmed	Addon Returns the date this record was last seen updated from one of Personator’s Data Sources.
EstimatedHomeValue*	Addon No Credit The estimated value of the home, given in U.S. Dollars. *Credit Licenses Note.
MelissaIdentityKey	Basic Returns a unique key associated with an individual. In order to retrieve the MelissaIdentityKey, the Check and Verify Actions must both be enabled: "Actions":"Check,Verify"
MoveDate	Addon Returns the date associated with the move address.
Occupation*	Addon No Credit Returns the category for the individual’s occupation. Record Level Product Codes has a list of occupation product codes. *Credit Licenses Note.
OwnRent*	Addon No Credit Returns the individual’s status as owner or renter of the property. Record Level Product Codes has a list of own/rent product codes. *Credit Licenses Note.
PhoneCountryCode	Basic Returns the 2 character country code for the phone number entered in the Phone field.
PhoneCountryName	Basic Returns the full country name for the phone number entered in the Phone field.
Plus4	Basic 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.
PrivateMailBox	Basic 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.
Suite	Basic 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.

GrpAddressDetails

Output Name	Description
AddressTypeCode	Basic Returns a code for the address type in the AddressLine field. Please see the Result Code Details for the list of possible codes.
CarrierRoute	Basic Returns a 4-character code defining the carrier route for this record.
CityAbbreviation	Basic Returns an abbreviation for the city entered in the City field, if any.
CountryCode	Basic Returns the country code for the country in the Country field.
CountryName	Basic Returns the country name for the record.
DeliveryIndicator	Basic Returns an indicator of whether an address is a business address or residential address. Record Level Product Codes has a list of delivery indicator product codes.
DeliveryPointCheckDigit	Basic Returns a string value containing the 1-digit delivery point check digit.
DeliveryPointCode	Basic Returns a string value containing the 2-digit delivery point code.
StateName	Basic Returns the full name of the state entered in the State field.
UrbanizationName	Basic Returns the urbanization name for the address entered in the AddressLine field. Usually only used if the address is in Puerto Rico.
UTC	Basic Returns the time zone of the requested record. All Melissa Data products express time zones in UTC (Coordinated Universal Time).

GrpCensus

Output Name	Description
CBSACode	Basic Census Bureau’s Core Based Statistical Area (CBSA). Returns the 5-digit code for the CBSA associated with the requested record.
CBSADivisionCode	Basic Returns the code for a division associated with the requested record, if any.
CBSADivisionLevel	Basic Returns whether the CBSA division, if any, is metropolitan or micropolitan.
CBSADivisionTitle	Basic Returns the title for the CBSA division, if any.
CBSALevel	Basic Returns whether the CBSA is metropolitan or micropolitan.
CBSATitle	Basic Returns the title for the CBSA.
CensusBlock	Basic Returns a 4-digit string containing the census block number associated with the requested record.
CensusTract	Basic 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.
CongressionalDistrict	Basic Returns the 2-digit congressional district that belongs to the requested record.
CountyFIPS	Basic Returns the FIPS code for the county in the County field.
CountyName	Basic Returns the county name.
PlaceCode	Basic 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.
PlaceName	Basic 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.

GrpCensus2

Output Name	Description
CensusKey	Basic Returns a 15 digit string containing the concatenated County FIPS, Census Tract and Census Block.
CountySubdivisionCode	Basic Returns a 5 digit string representing the County Subdivision Code for the requested record.
CountySubdivisionName	Basic Returns the County Subdivision Name for the requested record.
ElementarySchoolDistrictCode	Basic Returns a 5 digit string representing the Elementary School District Code for the requested record.
ElementarySchoolDistrictName	Basic Returns the Elementary School District Name for the requested record.
SecondarySchoolDistrictCode	Basic Returns a 5 digit string representing the Secondary School District Code for the requested record.
SecondarySchoolDistrictName	Basic Returns the Secondary School District Name for the requested record.
StateDistrictLower	Basic Returns a 3 digit string representing the Lower State District Code for the requested record.
StateDistrictUpper	Basic Returns a 3 digit string representing the Upper State District Code for the requested record.
UnifiedSchoolDistrictCode	Basic Returns a 5 digit string representing the Unified School District Code for the requested record.
UnifiedSchoolDistrictName	Basic Returns the Secondary Unified District Name for the requested record.

GrpGeocode

Output Name	Description
Latitude	Basic Returns the geocoded latitude for the address entered in the AddressLine field.
Longitude	Basic Returns the geocoded longitude for the address entered in the AddressLine field.

Important

The following fields will not return for credit licenses and will instead return a GE29 error code (see Credit Licenses for more information.):

Field Name
ChildrenAgeRange
CreditCardUser
DateOfBirth
DateOfDeath
DemographicsGender
Education
EstimatedHomeValue
EthnicCode
EthnicGroup
HouseholdIncome
HouseholdSize
LengthOfResidence
MaritalStatus
Occupation
OwnRent
PoliticalParty
PresenceOfChildren
PresenceOfSenior

GrpDemographicBasic

Personator Demographics is part of a premium package. Requesting for GrpDemographicBasic will result in outputting multiple demographic columns, which may incur unnecessary charges. To avoid this, please request only for specific demographic columns when not using all the demographics included in this group.

These Fields Will NOT Return on a Credit License. The GrpDemographicBasic fields will not return while using a credit license. If you try to use these fields with a credit license, you will instead have a GE29 error code returned.

Output Name	Description
ChildrenAgeRange*	Addon No Credit Returns the age range of children present in the household. Record Level Product Codes has a list of child age range product codes. *Credit Licenses Note.
CreditCardUser*	Addon No Credit Returns whether the user has a credit card or not. *Credit Licenses Note.
DateOfBirth*	No Credit Returns the date of birth in the format YYYYMM. Accuracy is only to the month. *Credit Licenses Note.
DateOfDeath*	No Credit Returns the full date of death in the format YYYYMMDD. *Credit Licenses Note.
DemographicsGender*	No Credit Returns gender based on demographics data. Record Level Product Codes has a list of demographics gender product codes. *Credit Licenses Note.
DemographicsResults	Addon If any demographics are enabled, Demographics Results will return a comma delimited string containing all the results of the demographics combined.
Education*	Addon No Credit Returns the highest level of education completed by an individual. Record Level Product Codes has a list of education product codes. *Credit Licenses Note.
EthnicCode*	Addon No Credit Returns an individual’s specific ethnicity. Record Level Product Codes has a list of ethnicity product codes. *Credit Licenses Note.
EthnicGroup*	Addon No Credit Returns the grouped category for a person’s ethnicity. This is a more generalized grouping compared to Ethnic Codes. Record Level Product Codes has a list of ethnic group product codes. *Credit Licenses Note.
HouseholdIncome*	Addon No Credit Returns the range of the income of the returned individual for the household. *Credit Licenses Note.
HouseholdSize*	Addon No Credit Returns the number of occupants in the household. *Credit Licenses Note.
LengthOfResidence*	Addon No Credit Returns the range of the individual’s length of residency in their current address. Record Level Product Codes has a list of length of residence product codes. *Credit Licenses Note.
MaritalStatus*	Addon No Credit Returns the individual’s marital status. *Credit Licenses Note.
PoliticalParty*	Addon No Credit Returns an individual’s political affiliation. Record Level Product Codes has a list of political party product codes. *Credit Licenses Note.
PresenceOfChildren*	Addon No Credit Returns the presence of children in the household. *Credit Licenses Note.
PresenceOfSenior*	Addon No Credit Returns the presence of senior/s in the household that are 55 and above. Record Level Product Codes has a list of presence of senior product codes. *Credit Licenses Note.

GrpIPAddress

Output Name	Description
DistanceAddressToIP	Addon This is the distance in miles between the latitude and longitude of the physical location of the IP Address and the latitude and longitude of the input Address.
IPAddress	Addon The IP address being looked up.
IPCity	Addon The city where the IP address is located.
IPConnectionSpeed	Addon The connection speed associated with this IP address. Record Level Product Codes has a list of ip connection speed product codes.
IPConnectionType	Addon The type of connection used by this IP address. Record Level Product Codes has a list of ip connection type product codes.
IPContinent	Addon The continent where the IP address is located.
IPCountryAbbreviation	Addon The ISO 3166-1 alpha-2 country code of the country where the IP address is located.
IPCountryName	Addon The full name of the country where the IP address is located.
IPDomainName	Addon The domain name associated with this IP address.
IPISPName	Addon The name of the Internet Service Provider associated with the IP Address.
IPLatitude	Addon The latitude for the IP address. This usually points to the IP Address’s postal code.
IPLongitude	Addon The longitude for the IP address. This usually points to the IP Address’s postal code.
IPPostalCode	Addon The postal code where the IP Address is located.
IPProxyDescription	Addon Additional Details for the Proxy Type returned. Record Level Product Codes has a list of ip proxy description product codes.
IPProxyType	Addon The type of proxy for an IP Address. Record Level Product Codes has a list of ip proxy type product codes.
IPRegion	Addon 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.
IPUTC	Addon The GMT offset for the area where the IP address is located.

GrpNameDetails

Output Name	Description
Gender	Basic Returns a gender for the name in the FullName field.
Gender2	Basic Only used if 2 names are in the FullName field. Returns a gender for the second name in the FullName field.
NameFirst	Basic Returns the first name in the FullName field.
NameFirst2	Basic Only used if 2 names are in the FullName field. Returns the second name in the FullName field.
NameLast	Basic Returns the last name in the FullName field.
NameLast2	Basic Only used if 2 names are in the FullName field. Returns a last name for the second name in the FullName field.
NameMiddle	Basic Returns a middle name for the name in the FullName field.
NameMiddle2	Basic Only used if 2 names are in the FullName field. Returns a middle name for the second name in the FullName field.
NamePrefix	Basic Returns a prefix for the name in the FullName field.
NamePrefix2	Basic Only used if 2 names are in the FullName field. Returns a prefix for the second name in the FullName field.
NameSuffix	Basic Returns a suffix for the name in the FullName field.
NameSuffix2	Basic Only used if 2 names are in the FullName field. Returns a suffix for the second name in the FullName field.
Salutation	Basic Returns a salutation for the name in the FullName field.

GrpParsedAddress

Output Name	Description
AddressDeliveryInstallation	Basic Canada Only. Returns the parsed delivery installation for the address entered in the AddressLine field.
AddressHouseNumber	Basic Returns the parsed house number for the address entered in the AddressLine field.
AddressLockBox	Basic Canada Only. Returns the parsed lock box number for the address entered in the AddressLine field.
AddressPostDirection	Basic Returns the parsed post-direction for the address entered in the AddressLine field.
AddressPreDirection	Basic Returns the parsed pre-direction for the address entered in the AddressLine field.
AddressPrivateMailboxName	Basic Returns the parsed private mailbox name for the address entered in the AddressLine field.
AddressPrivateMailboxRange	Basic Returns the parsed private mailbox range for the address entered in the AddressLine field.
AddressRouteService	Basic Canada Only. Returns the parsed route service number for the address entered in the AddressLine field.
AddressStreetName	Basic Returns the parsed street name for the address entered in the AddressLine field.
AddressStreetSuffix	Basic Returns the parsed street suffix for the address entered in the AddressLine field.
AddressSuiteName	Basic Returns the parsed suite name for the address entered in the AddressLine field.
AddressSuiteNumber	Basic Returns the parsed suite number for the address entered in the AddressLine field.

GrpParsedEmail

Output Name	Description
DomainName	Basic Returns the parsed domain name for the email entered in the Email field.
MailboxName	Basic Returns the parsed mailbox name for the email entered in the Email field.
TopLevelDomain	Basic Returns the parsed top-level domain name for the email entered in the Email field.

GrpParsedPhone

Output Name	Description
AreaCode	Basic Returns the parsed area code for the phone number entered in the Phone field.
NewAreaCode	Basic Returns the parsed new area code for the phone number entered in the Phone field.
PhoneExtension	Basic Returns the parsed extension for the phone number entered in the Phone field.
PhonePrefix	Basic Returns the parsed prefix for the phone number entered in the Phone field.
PhoneSuffix	Basic Returns the parsed suffix for the phone number entered in the Phone field.

Subscription and Credit Differences

There are multiple types of license you can have for Personator Consumer.

Basic Subscription

Basic Fields labelled with this badge are only available with the basic check and verify subscription.

Addon

Addon Fields labelled with this badge are only available as an addon to your subscription.

Geocode Addons

There are available addons at three accuracy levels:

1. ZIP Centroid - The least accurate geocoding level and is available with the basic subscription.

2. Street Level - A street level geocoding level available with the Geocode addon.

3. Rooftop Level - The most accurate geocode rooftop level available with the GeoPoints addon.

Credit Licenses

No Credit Fields labelled with this badge will not return for credit licenses and will instead return a GE29 error code. They are also listed below:

Field Name
ChildrenAgeRange
CreditCardUser
DateOfBirth
DateOfDeath
DemographicsGender
Education
EstimatedHomeValue
EthnicCode
EthnicGroup
HouseholdIncome
HouseholdSize
LengthOfResidence
MaritalStatus
Occupation
OwnRent
PoliticalParty
PresenceOfChildren
PresenceOfSenior

Input Best Practices

This service can deal with multiple languages and scripts. It expects UTF-8 encoding. Be on the lookout for question marks (?), squares (▖) or other unwanted characters like �. They may be an indication of encoding issues and may result in data loss. Bad encoding or character loss is not something our service can correct for you.

Result Codes

Interpreting Results

The Personator API and other Melissa APIs will have a Results Output. Several different Result Codes may be returned by the service in order to give you detailed information about the status of the record submitted.

It is important to understand these result codes in order for you to make a determination of good vs bad data and how you would want to use it.

The following shows you the indicators for the different results:

Code	Description	Quality Indicator
AS01	Address verified at the unit level	Good Data
AS02	Address verified at the building level	Good Data
AS03	Valid non-USPS address	Good Data
PS01	Valid phone number	Good Data
ES01	Valid email address	Good Data
NS01	Name successfully parsed	Good Data
AE**	Results that begin with AE are an indication of address errors	Bad Data
PE**	Results that begin with PE are an indication of phone errors	Bad Data
EE**	Results that begin with EE are an indication of email errors	Bad Data
NE**	Results that begin with NE are an indication of name errors	Bad Data
GS05	Rooftop level accuracy for Lat/Long	High Accuracy GeoCoding
GS06	Interpolated rooftop level accuracy for Lat/Long	High Accuracy GeoCoding
GS01	Street level accuracy for Lat/Long	Medium Accuracy GeoCoding

For the full list of all possible result codes, please visit here.

SE## and GE## Codes

The SE## and GE## codes (Transmission Service Error and General Transmission Error) are used to signify more general errors, and are returned under the key TransmissionResults in the outermost level of our responses.

Personator Consumer Result Codes