Melissa Personator enricher

The Melissa Personator enricher fixes and completes contact data for US/Canada using the Personator service.

Plug-in ID

Melissa Personator Enricher - com.semarchy.engine.plugins.melissa.PersonatorConsumerEnricher

Description

The Melissa Personator enricher fixes and completes contact data for US/Canada using the Personator Consumer service. For more details about the service, the parameters, inputs and outputs, refer to the Melissa Personator Consumer Documentation

This plug-in requires a valid license string to access the Melissa service. Contact Melissa for the license.
This plug-in is thread-safe and supports parallel execution.

Plug-in parameters

The following table lists the plug-in parameters.

Parameter name Mandatory Type Description

License String

Yes

String

Your license string. This must be valid for you to access the Melissa Service.

Action Append

No

Boolean

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. US only.

Action Check

No

Boolean

The Check Action will validate the individual input data pieces for validity and correct them if possible. If the data is correctable, additional information

Action Move

No

Boolean

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

Action Verify

No

Boolean

The Verify Action will return to you the relationships between your different input data pieces. It can show you if your name,

Advanced Address Correction

No

Boolean

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

Append Options

No

String

Possible values: blank, checkError, always. Setting the Append option to Blank will cause the service to return information only when the input address, phone, email, name or company is blank.

Centric Hint

No

String

Possible values: auto, address, phone, email. Default value is Auto. 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 point of reference when appending or verifying data.

Columns

No

String

By default requested columns are restricted to mapped outputs, this parameter allow to specifies (force) which column(s) to be requested, see Melissa documentation

Diacritics

No

String

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

Failure Error Codes

No

String

Comma-separated list of codes (AE01, AE02) or code families (AE). When this result code is returned by the API, the enrichment is failed.

SSL Connection

No

Boolean

Default is true. Set to false if you don’t wish to use a secure connection.

Use Preferred City

No

Boolean

There is an official name that is preferred by the U.S.PS and there may be one or more unofficial "vanity" names in use. Normally, Personator allows you to verify addresses using known vanity names. Setting this to true, will return the prefered city.

Requests Limit

No

Number

When set, this numeric value limits the number of requests made to the Melissa API and the number of enriched records. Records after this limit are not enriched and the plugin returns blank outputs. This parameter is intended for tests purposes only.

Plug-in inputs

The following table lists the plug-in inputs.

Input name Mandatory Type Description

AddressLine1

No

String

The input field for the address line 1. This should contain the delivery address information (house number, street, building, suite, etc.) but should not contain locality information (city, state, postal code, etc.) which have their own inputs.

AddressLine2

No

String

The input field for the address line 2. This can be a continuation of AddressLine1 (ex: suite) or another address.

BirthDay

No

String

The birth day of the contact record in DD format.

BirthMonth

No

String

The birth month of the contact record in MM format.

BirthYear

No

String

The birth year of the contact record in YYYY format.

City

No

String

The city.

CompanyName

No

String

The company name.

Country

No

String

The country.

Email

No

String

The email address.

FirstName

No

String

The given (first) name.

Format

No

String

Sets the format of the response.

FreeForm

No

String

Single line contact information. Address, phone, email could be all in a single field and they will be parsed out. Please don’t map any other fields if using FreeForm.

FullName

No

String

This field can contain a full name. The API will parse and check Names only if the First Name and Last Name fields are left blank.

IPAddress

No

String

An IP Address for the record.

LastLine

No

String

The city, state, and ZIP.

LastName

No

String

The family (last) name.

MelissaAddressKey

No

String

A proprietary unique key identifier for an address.

Phone

No

String

The phone number.

PostalCode

No

String

The postal code.

RecordID

No

String

This is a string value containing a unique identifier for the current record. Use this to match the record submitted with the record returned. It will return what is inputted.

SocialSecurtiy

No

String

Social Security Number for the record. Accepts the full Social Security Number or the Last 4 digits.

State

No

String

The US state.

Plug-in outputs

The following table lists the plug-in outputs.

This enricher returns data that may be considered sensitive and personal information. Make sure to secure, manage and store this information according to regulations and standards.
Output name Type Description

AddressDeliveryInstallation

String

Returns the parsed delivery installation for the address entered in the AddressLine field.

AddressExtras

String

Any extra information that does not fit in the AddressLine fields.

AddressHouseNumber

String

Returns the parsed house number for the address entered in the AddressLine field.

AddressKey

String

Returns a unique identifier for an address. This key can be used with other current and future Melissa services.

AddressLine1

String

These are the string values that will return the standardized or corrected contents of the input address. These lines will include the entire address including the locality, administrative area, and postal code.

AddressLine2

String

These are the string values that will return the standardized or corrected contents of the input address. These lines will include the entire address including the locality, administrative area, and postal code.

AddressLockBox

String

Returns the parsed lock box number for the address entered in the AddressLine field.

AddressPostDirection

String

Returns the parsed post-direction for the address entered in the AddressLine field.

AddressPreDirection

String

Returns the parsed pre-direction for the address entered in the AddressLine field.

AddressPrivateMailboxName

String

Returns the parsed private mailbox name for the address entered in the AddressLine field.

AddressPrivateMailboxRange

String

Returns the parsed private mailbox range for the address entered in the AddressLine field.

AddressRouteService

String

Returns the parsed route service number for the address entered in the AddressLine field.

AddressStreetName

String

Returns the parsed street name for the address entered in the AddressLine field.

AddressStreetSuffix

String

Returns the parsed street suffix for the address entered in the AddressLine field.

AddressSuiteName

String

Returns the parsed suite name for the address entered in the AddressLine field.

AddressSuiteNumber

String

Returns the parsed suite number for the address entered in the AddressLine field.

AddressTypeCode

String

Returns a code for the address type in the AddressLine field.

CBSACode

String

Census Bureau’s Core Based Statistical Area (CBSA). Returns the 5-digit code for the CBSA associated with the requested record.

CBSADivisionCode

String

Returns the code for a division associated with the requested record, if any.

CBSADivisionLevel

String

Returns whether the CBSA division, if any, is metropolitan or micropolitan.

CBSADivisionTitle

String

Returns the title for the CBSA division, if any.

CBSALevel

String

Returns whether the CBSA is metropolitan or micropolitan.

CBSATitle

String

Returns the title for the CBSA.

CarrierRoute

String

Returns a 4-character code defining the carrier route for this record.

CensusBlock

String

Returns a 4-digit string containing the census block number associated with the requested record.

CensusTract

String

Returns a 4-to 6-digit string containing the census tract number associated with the requested record.

ChildrenAgeRange

String

Returns the age range of children present in the household.

City

String

Returns the city entered in the City field.

CityAbbreviation

String

Returns an abbreviation for the city entered in the City field, if any.

CompanyName

String

Returns the company name.

CongressionalDistrict

String

Returns the 2-digit congressional district that belongs to the requested record.

CountryCode

String

Returns the country code for the country in the Country field.

CountryName

String

Returns the country name for the record.

CountyName

String

Returns the county name.

DateOfBirth

String

Returns the date of birth in the format YYYYMM. Accuracy is only to the month.

DateOfDeath

String

Returns the full date of death in the format YYYYMMDD.

CreditCardUser

String

Returns whether the user has a credit card or not.

DeliveryIndicator

String

Returns an indicator of whether an address is a business address or residential address.

DeliveryPointCheckDigit

String

Returns a string value containing the 1-digit delivery point check digit.

DeliveryPointCode

String

Returns a string value containing the 2-digit delivery point code.

DemographicsGender

String

Returns gender based on demographics data.

DemographicsResults

String

If any demographics are enabled, Demographics Results will return a comma delimited string containing all the results of the demographics combined.

Education

String

Returns the highest level of education completed by an individual.

EmailAddress

String

Returns the email address entered in the Email field.

EmailDomainName

String

Returns the parsed domain name for the email entered in the Email field.

EmailMailboxName

String

Returns the parsed mailbox name for the email entered in the Email field.

EmailTopLevelDomain

String

Returns the parsed top-level domain name for the email entered in the Email field.

EthnicCode

String

Returns an individual’s specific ethnicity.

EthnicGroup

String

Returns the grouped category for a person’s ethnicity. This is a more generalized grouping compared to Ethnic Codes.

FormattedAddress

String

Mailing address. The full mailing address in the preferred format for the country of the address. This includes the Organization as the first line, one or more lines in the origin country’s format, and the destination country (if required). Separate lines will be delimited by what is specified in the option.

Gender

String

Returns a gender for the name in the FullName field.

Gender2

String

Only used if 2 names are in the FullName field. Returns a gender for the second name in the FullName field.

HouseholdIncome

String

Returns the range of the household’s income.

HouseholdSize

String

Returns the number of occupants in the household.

Latitude

String

Returns the geocoded latitude for the address entered in the AddressLine field.

LengthOfResidence

String

Returns the range of the individual’s length of residency in their current address.

Longitude

String

Returns the geocoded longitude for the address entered in the AddressLine field.

MaritalStatus

String

Returns the individual’s marital status.

MoveDate

String

Returns the date associated with the move address.

NameFirst

String

Returns the first name in the FullName field.

NameFirst2

String

Only used if 2 names are in the FullName field. Returns the second name in the FullName field.

NameFull

String

Returns the full name for the record.

NameLast

String

Returns the last name in the FullName field.

NameLast2

String

Only used if 2 names are in the FullName field. Returns a last name for the second name in the FullName field.

NameMiddle

String

Returns a middle name for the name in the FullName field.

NameMiddle2

String

Only used if 2 names are in the FullName field. Returns a middle name for the second name in the FullName field.

NamePrefix

String

empty

NamePrefix2

String

Returns a prefix for the name in the FullName field.

NameSuffix

String

Returns a suffix for the name in the FullName field.

NameSuffix2

String

Only used if 2 names are in the FullName field. Returns a suffix for the second name in the FullName field.

Occupation

String

Returns the category for the individual’s occupation.

OwnRent

String

Returns the individual’s status as owner or renter of the property.

PhoneAreaCode

String

Returns the parsed area code for the phone number entered in the Phone field.

PhoneCountryCode

String

Returns the 2 character country code for the phone number entered in the Phone field.

PhoneCountryName

String

Returns the full country name for the phone number entered in the Phone field.

PhoneExtension

String

Returns the parsed extension for the phone number entered in the Phone field.

PhoneNewAreaCode

String

Returns the parsed new area code for the phone number entered in the Phone field.

PhoneNumber

String

Returns the standardized phone number for the record.

PhonePrefix

String

Returns the parsed prefix for the phone number entered in the Phone field.

PhoneSuffix

String

Returns the parsed suffix for the phone number entered in the Phone field.

PlaceCode

String

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

String

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.

PoliticalParty

String

Returns an individual’s political affiliation.

PostalCode

String

Returns the 9-digit postal code for U.S. addresses and 6-digit postal code for Canadian addresses.

PresenceOfChildren

String

Returns the presence of children in the household.

PresenceOfSenior

String

Returns the presence of senior/s in the household.

Results

String

String value containing a comma-separated list of status, error codes, and change codes for the record. Refer the the Melissa documentation for more details.

Salutation

String

Returns a salutation for the name in the FullName field.

State

String

Returns the state for the record.

StateName

String

Returns the full name of the state entered in the State field.

TransmissionResults

String

This is a string value that lists error codes from any errors caused by the most recent request as a whole.

UTC

String

Returns the timezone of the requested record. All Melissa products express timezones in UTC (Coordinated Universal Time).

UrbanizationName

String

Returns the urbanization name for the address entered in the AddressLine field. Usually only used if the address is in Puerto Rico.