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 at Sales@Melissa.com or 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#

  • 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#

  • 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

SSNCascade

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

SSNCascade

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

SSNCascade

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

SSNCascade

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.

ssn

Will use Social Security Number 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.

SSNCascade#

Verify(SSN)

If set to on, cascading logic for SSN for SSN Verification and append. The cascading logic is as follows:

  1. First try to verify Full Name and Full SSN

  2. If there is no match, then verify the Last Name and Full SSN

  3. If there is no match, then verify the Full Name and Last 4 SSN

Parameter

Description

off

Default. No cascading will occur.

on

The cascading verification logic for SSN and Name will be applied.

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.

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 Addressn 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#

Result codes yield more granular information about a given record. They are returned as a comma-delimited string of 4-character alpha-numeric codes, e.g. AC02,AS01 or AE01.

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.

Service Level Result Codes#

Code

Short Description

Long Description

Transmission Service Error

SE01

Cloud Service Internal Error

The cloud service experienced an internal error.

General Transmission Error

GE01

Empty Request Structure

The SOAP, JSON, or XML request structure is empty. Not to be confused with the GE01 GeoCode result code.

GE02

Empty Request Record Structure

The SOAP, JSON, or XML request record structure is empty. Not to be confused with the GE02 GeoCode result code.

GE03

Records Per Request Exceeded

The counted records sent more than the number of records allowed per request.

GE04

Empty License Key

The License Key is empty.

GE05

Invalid License Key

The License Key is invalid.

GE06

Disabled License Key

The License Key is disabled.

GE07

Invalid Request

The SOAP, JSON, or XML request is invalid.

GE08

Product/Level Not Enabled

The License Key is invalid for this product or level.

GE09

Customer Does Not Exist

The Customer ID is not in our system.

GE10

Customer License Disabled

The encrypted license is on the ban list.

GE11

Customer Disabled

The Customer ID is disabled.

GE12

IP Blacklisted

The IP Address is on the global ban list.

GE13

IP Not Whitelisted

The IP Address is not on the customer’s whitelist.

GE14

Out of Credits

The account has ran out of credits. Add more credits to continue using the service.

GE20

Verify Not Activated

The Verify package was requested but is not active for the License Key.

GE21

Append Not Activated

The Append package was requested but is not active for the License Key.

GE22

Move Not Activated

The Move package was requested but is not active for the License Key.

GE23

No Valid Action Requested

No valid action was requested by the service. The request must include at least one of the following actions: Check, Verify, Append, or Move.

GE24

Demographics Not Activated

The Demographics package was requested but is not active for the License Key.

GE27

IP Columns Not Activated

IP Columns requested but not active for the customer ID.

GE28

SSN Verification Not Activated

SSN Verification requested but not active for the customer ID.

GE29

Not Available for Credit License

The requested fields were not available for a credit license. To have access to the demographics fields, please upgrade your license to a subscription.

General Transmission Warning

GW01

Expiring License

Your License Key is expiring soon. Please contact your sales representative for a new License Key.

GW11

Option Name Error

The option name is either misspelled or incorrect.

GW12

Option Value Error

The option value is misspelled or incorrectly formatted.

Personator Status

SP01

No Action

A record was sent in, but the service did not have enough information to modify the record.

Record Level Result Codes#

Code

Short Description

Long Description

AC - Address Change

AC01

Postal Code Change

The postal code was changed or added.

AC02

Administrative Area Change

The administrative area (state, province) was added or changed.

AC03

Locality Change

The locality (city, municipality) name was added or changed.

AC04

Alternate to Base Change

US Only. The address was found to be an alternate record and changed to the base (preferred) version.

AC05

Alias Name Change

US Only. An alias is a common abbreviation for a long street name, such as “MLK Blvd” for “Martin Luther King Blvd.” This change code indicates that the full street name (preferred) has been substituted for the alias.

AC06

Address1/Address2 Swap

Address1 was swapped with Address2 because Address1 could not be verified and Address2 could be verified.

AC07

Address1 & Company Swapped

Address1 was swapped with Company because only Company had a valid address.

AC08

Plus4 Change

US Only. A non-empty plus4 was changed.

AC09

Dependent Locality Change

The dependent locality (urbanization) was changed.

AC10

Thoroughfare Name Change

The thoroughfare (street) name was added or changed due to a spelling correction.

AC11

Thoroughfare Type Change

The thoroughfare (street) leading or trailing type was added or changed, such as from “St” to “Rd.”

AC12

Thoroughfare Directional Change

The thoroughfare (street) pre-directional or post-directional was added or changed, such as from “N” to “NW.”

AC13

Sub Premise Type Change

The sub premise (suite) type was added or changed, such as from “STE” to “APT.”

AC14

Sub Premise Number Change

The sub premise (suite) unit number was added or changed.

AC20

House Number Change

The house number was changed.

AE - Address Error

AE01

General Error

The address could not be verified. This is likely due to a missing or invalid locality or postal code.

AE02

Unknown Street

Could not match the input street to a unique street name. Either no matches or too many matches found.

AE03

Component Mismatch Error

The combination of directionals (N, E, SW, etc) and the suffix (AVE, ST, BLVD) is not correct and produced multiple possible matches.

AE04

Non-Deliverable Address

US Only. A physical plot exists but is not a deliverable addresses. One example might be a railroad track or river running alongside this street, as they would prevent construction of homes in that location.

AE05

Multiple Match

The address was matched to multiple records. There is not enough information available in the address to break the tie between multiple records.

AE06

Early Warning System

US Only. This address currently cannot be verified but was identified by the Early Warning System (EWS) as belonging to a upcoming area and will likely be included in a future update.

AE07

Missing Minimum Address

Minimum requirements for the address to be verified is not met. Address must have at least one address line and also the postal code or the locality/administrative area.

AE08

Sub Premise Number Invalid

The thoroughfare (street address) was found but the sub premise (suite) was not valid.

AE09

Sub Premise Number Missing

The thoroughfare (street address) was found but the sub premise (suite) was missing.

AE10

Premise Number Invalid

The premise (house or building) number for the address is not valid.

AE11

Premise Number Missing

The premise (house or building) number for the address is missing.

AE12

Box Number Invalid

The PO (Post Office Box), RR (Rural Route), or HC (Highway Contract) Box number is invalid.

AE13

Box Number Missing

The PO (Post Office Box), RR (Rural Route), or HC (Highway Contract) Box number is missing.

AE14

PMB Number Missing

US Only. The address is a Commercial Mail Receiving Agency (CMRA) and the Private Mail Box (PMB or #) number is missing.

AE17

Sub Premise Not Required (Deprecated - See AS23)

A sub premise (suite) number was entered but the address does not have secondaries. (Deprecated - See AS23)

AE21

MAK Not Found

The input MAK was not found. This can be caused by an improperly formatted MAK (a proper MAK is 10 numerical digits long) or by requesting a MAK number that has not yet been assigned to a location.

AS - Address Status

AS01

Address Fully Verified

The address is valid and deliverable according to official postal agencies.

AS02

Valid Building Address

The building address was verified but the suite/apartment number is missing or invalid.

AS03

Non USPS Address Match

US Only. This US address is not serviced by the USPS but does exist and may receive mail through third party carriers like UPS.

AS04

Proprietary Address Format

The address uses a proprietary addressing scheme where only the format could be validated.

AS09

Foreign Address

The address is in a non-supported country.

AS10

CMRA Address

US Only. The address is a Commercial Mail Receiving Agency (CMRA) like a Mailboxes Etc. These addresses include a Private Mail Box (PMB or #) number.

AS11

PBSA Address

A PO Box formatted as a street address for package and mail delivery.

AS12

Record Move

The record moved to a new address.

AS13

Address Updated By LACS

US Only. The address has been converted by LACSLink® from a rural-style address to a city-style address.

AS14

Suite Appended

US Only. A suite was appended by SuiteLink™ using the address and company name.

AS15

Apartment Appended

An apartment number was appended by AddressPlus using the address and last name.

AS16

Vacant Address

US Only. The address has been unoccupied for more than 90 days.

AS17

No USPS Mail Delivery

This address is classified as not receiving mail by the USPS via their No-Stat flag. Delivery might still be possible by third party carriers but that cannot be counted on.

AS18

DPV Locked Out

US Only. DPV processing was terminated due to the detection of what is determined to be an artificially created address.

AS20

Deliverable only by USPS

US Only. This address can only receive mail delivered through the USPS (i.e. PO Box or a military address).

AS23

Extraneous Suite Information

Extraneous information not used in verifying the address was found. This information was returned in the suite field.

AS24

USPS Door Not Accessible

Address identified by the USPS where carriers cannot physically access a building or door for mail delivery.

AS25

Unique ZIP code

The address contains a USPS unique ZIP code which means any address may be marked as deliverable.

AS26

Unknown Data Moved to ParsedGarbage

The input contains data that could not be identified. That data is returned in the ParsedGarbage/AddressExtras field

AS27

Phantom Route address

Addresses that are assigned to a phantom route of R777 or R779.

CD - Presence of Children

CD01

No Children Present

There are no children under the age of 18 at this address.

CD02

Children Present

There are children under the age of 18 at this address.

DA - Append Results

DA00

Address Appended

An address was changed or appended.

DA01

City/State Append from Phone

A city or state was appended from a phone number wire center.

DA10

Name Appended

A full name was changed or appended.

DA20

Company Appended

A company name was changed or appended.

DA30

Phone Appended

A phone number was changed or appended.

DA40

Email Appended

An email address was changed or appended.

DD - Date of Death

DD00

Not Deceased

This person is not deceased.

DD01

Deceased

This person is deceased.

EE - Email Error

EE01

Email Syntax Error

There is a syntax error in the submitted email address.

EE02

Email Domain Not Found

A Domain of the submitted email address was not found.

EE03

Email Server Not Found

The mail server of the submitted email address was not found.

EE04

Invalid Email

An invalid mailbox was detected (i.e. noreply).

ES - Email Status

ES01

Valid Email

This email was confirmed to be a valid email.

ES02

Invalid Email

This email was confirmed to be a invalid email.

ES03

Unknown Email

This email’s status is unknown due to unknown external factors. Please try again another time.

ES04

Mobile Email Address

The domain name was identified as a mobile email address and classified as not deliverable by the FCC.

ES05

Disposable Domain

The domain name of the submitted email was identified as a disposable domain.

ES06

Spamtrap Domain

The domain name of the submitted email was identified as a spamtrap. Mailing to this domain could result in the sender being blacklisted.

ES07

Accept All Server

The mail server is an accept all server. Accept-All domains is set in a way that makes all emails seem valid.

ES08

Role Address

This Email address was created as a group, ex: sales@, support@, or postmaster@.

ES10

Syntax Changed

The syntax of the submitted email address was changed.

ES11

Top Level Domain Changed

The top level domain of the submitted email address was changed.

ES12

Domain Changed (Spelling)

The domain of the submitted email address was corrected for spelling.

ES13

Domain Changed (Update)

The domain of the submitted email address was updated due to a domain name change.

ES21

Verify (Precision: Cached Mailbox Result)

The mailbox was found to be already validated in our mailbox database.

ES36

Spamtrap Mailbox

Indicates that we predict this email address is a spamtrap mailbox. Mailing to this specific mailbox could result in the sender being blacklisted.

ES37

Breach Flag

This email has been exposed in a data breach.

GD - Demographics Gender

GD01

Male

This person is male.

GD02

Female

This person is female.

GD03

Neutral

The sex of this person cannot be determined from the first name.

GEO-GS - GeoCode Status

GS01

Geocoded to Street Level

The record was coded to the street level (Zip+4 for US, full postal code for CA).

GS03

Geocoded to Community Level

The record was coded to the community level (ZIP centroid for US, 3-digit postal code for CA).

GS05

Geocoded to Rooftop Level

The record was geocoded down to the rooftop level, meaning the point is within the property boundaries, usually the center.

GS06

Geocoded to Interpolated Rooftop Level

The record was geocoded down to the rooftop level using interpolation (educated estimations using street coordinates). The point may be in or close to the property boundaries.

GS10

Wire Center Lat/Long

The latitude and longitude are based off of the wire center of the phone number.

GEO-GE - GeoCode Error

GE01

Regional Geocode Not Found

Geocode could not be appended for the input locality or postal code.

GE02

No Geocode for Input Address

The input address did not provide enough valid information to append a geocode.

ID - Household Income

ID01

$0-$9,999

Household Income is between $0 and $9,999.

ID02

$10,000-$19,999

Household Income is between $10,000 and $19,999.

ID03

$20,000-$29,999

Household Income is between $20,000 and $29,999.

ID04

$30,000-$39,999

Household Income is between $30,000 and $39,999.

ID05

$40,000-$49,999

Household Income is between $40,000 and $49,999.

ID06

$50,000-$59,999

Household Income is between $50,000 and $59,999.

ID07

$60,000-$69,999

Household Income is between $60,000 and $69,999.

ID08

$70,000-$79,999

Household Income is between $70,000 and $79,999.

ID09

$80,000-$89,999

Household Income is between $80,000 and $89,999.

ID10

$90,000-$99,999

Household Income is between $90,000 and $99,999.

ID11

$100,000-$124,999

Household Income is between $100,000 and $124,999.

ID12

$125,000-$149,999

Household Income is between $125,000 and $149,999.

ID13

$150,000+

Household Income is above $150,000.

LD - Length of Residence

LD00

Less than 1 year

The person has lived at this address for less than 1 year.

LD01

1-2 years

The person has lived at this address for 1 to 2 years.

LD02

2-3 years

The person has lived at this address for 2 to 3 years.

LD03

3-4 years

The person has lived at this address for 3 to 4 years.

LD04

4-5 years

The person has lived at this address for 4 to 5 years.

LD05

5-6 years

The person has lived at this address for 5 to 6 years.

LD06

6-7 years

The person has lived at this address for 6 to 7 years.

LD07

7-8 years

The person has lived at this address for 7 to 8 years.

LD08

8-9 years

The person has lived at this address for 8 to 9 years.

LD09

9-10 years

The person has lived at this address for 9 to 10 years.

LD10

10-11 years

The person has lived at this address for 10 to 11 years.

LD11

11-12 years

The person has lived at this address for 11 to 12 years.

LD12

12-13 years

The person has lived at this address for 12 to 13 years.

LD13

13-14 years

The person has lived at this address for 13 to 14 years.

LD14

14-15 years

The person has lived at this address for 14 to 15 years.

LD15

15+ years

The person has lived at this address for more than 15 years.

MD - Marital Status

MD01

Definitely Single

This person is single

MD02

Inferred Single

This person is most likely single

MD03

Inferred Married

This person is most likely married

MD04

Definitely Married

This person in married

NE - Name Error

NE01

Unrecognized Format

Format of Input string was not recognized or too long to represent a valid name.

NE02

Multiple First Names Detected

Multiple first names were detected and could not be accurately genderized.

NE03

Vulgarity Detected

A vulgarity was detected in the name.

NE04

Suspicious Word Detected

The name contained words found on the list of nuisance names, such as “Mickey Mouse.”

NE05

Company Name Detected

The name contained words normally found in a company name.

NE06

Non-Alphabetic Character Detected

The name contained a non-alphabetic character.

NS - Name Status

NS01

Parsing Successful

Name parsing was successful.

NS02

Error Parsing

An error was detected. Please check for a name error code.

NS03

First Name Spelling Corrected

The spelling in the first name field was corrected.

NS04

First Name 2 Spelling Corrected

The spelling in the second first name field was corrected.

NS05

First Name 1 Found

FirstName1 was found in our census table of names. Very likely to be a real first name.

NS06

Last Name 1 Found

LastName1 was found in our census table of names. Very likely to be a real last name.

NS07

First Name 2 Found

FirstName2 was found in our census table of names. Very likely to be a real first name.

NS08

Last Name 2 Found

LastName2 was found in our census table of names. Very likely to be a real last name.

PE - Phone Error

PE01

Invalid Phone

The area code/phone number does not exist in our database or contains non-numbers.

PE02

Blank Phone

The phone number is blank.

PE03

Bad Phone

The phone number has too many or too few digits.

PE04

Multiple Match

Two or more possible area codes are available as a fix and their distance is too close to choose one over the other.

PE05

Bad Prefix/Prefix +1

The phone prefix or first 7-digits do not exist in our database.

PS - Phone Status

PS01

Valid Phone

The phone number has been verified as valid.

PS02

7-Digit Match

The first 7-digits of the phone number have been verified, but activity cannot be confirmed.

PS03

Corrected Area Code

NewAreaCode contains corrected area code that was changed according to the postal code it falls into.

PS06

Updated Area Code

The area code was changed due to an area code split. The updated code is located within NewAreaCode.

PS07

Cellular Line

On activation, the exchange type of the phone number was designated as a cellular number, but current status cannot be confirmed.

PS08

Land Line

On activation, the exchange type of the phone number was designated as a land line, but current status cannot be confirmed.

PS09

VOIP Line

On activation, the exchange type of the phone number was designated as a VOIP line, but current status cannot be confirmed.

PS10

Residential Number

The phone number belongs to a residence.

PS11

Business Number

The phone number belongs to a business.

PS12

SOHO Number

The phone number belongs to a small office or home office.

RD - Own/Rent

RD01

Definite Renter

This person is a renter.

RD02

Inferred Renter

This person is most likely a renter.

RD03

Inferred Owner

This person is most likely an owner.

RD04

Definite Owner

This person is an owner.

SN - Security Number

SN01

Invalid SSN Format or Number

The SSN had too many or too few digits.

VR - Verify Results

VR01

Individual and Address Match

The individual name and address match.

VR02

Individual and Phone Match

The individual name and phone match.

VR03

Individual and Email Match

The individual name and email match.

VR04

Address and Phone Match

The address and phone match.

VR05

Address and Email Match

The address and email match.

VR06

Phone and Email Match

The phone and email match.

VR07

Organization and Address Match

The organization name and address match.

VR08

Organization and Phone Match

The organization name and phone match.

VR09

Organization and Email Match

The organization name and email match.

VR10

Organization and Individual Match

The organization name and individual name match.

VR11

Name and SSN Match

Matched the name field to the Social Security Number.

VS - Verify Status

VS00

Address Not Found

An address was not found in the reference data.

VS01

Historical Address Match

The current address is outdated and a newer address match was found. Use the “Move” action to get the latest address.

VS02

Partial Address Match

A match was made to a partial address. This could be due to matching the street address but not to the suite.

VS12

Last Name Match

A match was made to the last name only.

VS13

First Name Match

A match was made to the first name only.

VS22

Partial Company Name Match

A match was made to a partial company name.

VS30

Phone Not Found

A phone number was not found in the reference data.

VS31

Historical Phone Match

The current phone number is outdated and a newer phone number match was found. Use the “Append” action to get the latest phone number.

VS40

Email Not Found

An email address was not found in the reference data.

VS41

Historical Email Address

The current email address is outdated and a newer email address match was found. Use the “Append” action to get the latest email address.

VS50

Last4 Only Match

The name only matched to the last 4 digits of the Social Security Number.

WD - Occupation

WD01

Physician/Dentist

Physician/Dentist

WD02

Healthcare

Healthcare

WD03

Lawyer/Judge

Lawyer/Judge

WD04

Professional/Technical

Professional/Technical

WD05

Management

Management

WD06

Teacher/Educator

Teacher/Educator

WD07

Sales/Marketing

Sales/Marketing

WD08

Clerical/Service Worker

Clerical/Service Worker

WD09

Tradesmen/Laborer

Tradesmen/Laborer

WD10

Farmer

Farmer

WD11

Student

Student

WD12

Homemaker

Homemaker

WD13

Retired

Retired

WD14

Federal Employee

Federal Employee

WD15

Military

Military

WD16

Military Retired

Military Retired

WD99

Other

Other

WD17

Business Owner

Business Owner

WD18

Religious

Religious

WD19

Self Employed

Self Employed

WD20

Financial

Financial

Record Level Product Codes#

Code

Description

Address Type US

A

Alias

F

Firm or Company

H

Highrise or Business Complex

G

General Delivery

M

Military Address

P

PO Box

R

Rural Route

S

Street or Residential

U

Unique/LVR

Address Type Canada

1

Street

2

Street Served by Route and GD

3

Lock Box

4

Route Service

5

General Delivery

B

LVR Street

C

Government Street

D

LVR Lock Box

E

Government Lock Box

L

LVR General Delivery

K

Building

Address Type Default

G

General Delivery

M

Military Address

P

PO Box

R

Rural Route

S

Street or Residential

U

Unique/LVR

Code

Description

ChildrenAgeRange

Blank

The field is blank.

0-2

The child is 0 to 2 years old.

3-5

The child is 3 to 5 years old.

6-10

The child is 6 to 10 years old.

11-15

The child is 11 to 15 years old.

16-17

The child is 16 to 17 years old.

Code

Description

DeliveryIndicator

R

Residence

B

Business

U

Unknown

DemographicsGender

Male

Female

Unknown

Neutral (Pat, Chris, etc.)

Education

Blank

High School

College

Graduate School

Vocational/Technical School

EthnicCode

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

EthnicGroup

All African American Ethnic Groups

Central & Southwest Asian

Eastern European

Far Eastern

Hispanic

Jewish

Mediterranean

Middle Eastern

Native American

Other

Polynesian

Scandinavian

Southeast Asian

Western European

IPConnectionSpeed

Dialup

Cable

Mobile

IPConnectionType

Dialup

Wired

Wifi

Mobile

Satellite

IPProxyDescription

Tor-exit

Tor-relay

AOL

Cloud

DNS

VPN

Web-Browser

Code

Description

IPProxyType

Blank

Not a known proxy.

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.

Code

Description

LengthOfResidence

Less than 1 year

The person has lived at this address for less than 1 year.

1-2 years

The person has lived at this address for 1 to 2 years.

2-3 years

The person has lived at this address for 2 to 3 years.

3-4 years

The person has lived at this address for 3 to 4 years.

4-5 years

The person has lived at this address for 4 to 5 years.

5-6 years

The person has lived at this address for 5 to 6 years.

6-7 years

The person has lived at this address for 6 to 7 years.

7-8 years

The person has lived at this address for 7 to 8 years.

8-9 years

The person has lived at this address for 8 to 9 years.

9-10 years

The person has lived at this address for 9 to 10 years.

10-11 years

The person has lived at this address for 10 to 11 years.

11-12 years

The person has lived at this address for 11 to 12 years.

12-13 years

The person has lived at this address for 12 to 13 years.

13-14 years

The person has lived at this address for 13 to 14 years.

14-15 years

The person has lived at this address for 14 to 15 years.

15+ years

The person has lived at this address for more than 15 years.

Occupation

Physician/Dentist

Healthcare

Lawyer/Judge

Professional/Technical

Management

Teacher/Educator

Sales/Marketing

Clerical/Service Worker

Tradesmen/Laborer

Farmer

Student

Homemaker

Retired

Federal Employee

Military

Military Retired

Business Owner

Religious

Self Employed

Financial

Other

Code

Description

OwnRent

Definite Renter

This person is a renter.

Inferred Renter

This person is most likely a renter.

Inferred Owner

This person is most likely an owner.

Definite Owner

This person is an owner.

PoliticalParty

Blank

No Party

Republican

Democrat

Independent

PresenceOfSenior

Blank

Yes

No