Semarchy xDM Plug-in Reference Guide

Input Filter

No

String

Transformation

Yes

String

Synonyms Separator

No

String

Input Text

Yes

String

Transformed Text

String

Filtered and transformed text.

Secondary Transformed Text

String

Secondary transformed text. This text may contain transformation resulting from a Beidermorse or Double Metaphone transformation. See Other Transformations for more information.

Cache Lookup Data

No

String

Custom SQL

No

String

Datasource

No

String

Fallback Behavior

No

String

Fallback Value

No

String

Lookup Column

No

String

Mapping Table

No

String

Output Columns

No

String

Lookup Value

Yes

String

Output Value<N>

String

Nth Value returned by the lookup.

Application Name

Yes

String

Google Key

Yes

String

Input Text

Yes

String

Source Language

No

String

Target Language

Yes

String

Translated Text

String

Translated Text.

Surname Position

Yes

String

Case Transformation

Yes

String

Input Name

Yes

String

Source Country Code

Yes

String

Full Name

String

The reconstructed full name, with the surname positioned according to the Surname Position parameter.

Gender

String

The gender of the Matched Given Name. One of MALE, FEMALE, UNISEX, UNKNOWN.

Gender Score

String

Confidence with which for Most Frequent Gender can be used [0-100].

Given Name

String

The part identified as Given Name in the input name.

Matched Given Name

String

Given name matched in the given name database.

Most Frequent Gender

String

The more frequent gender of the Matched Given Name for the given country. One of MALE, FEMALE, UNKNOWN.

Names Parsing Score

String

Names Parsing confidence [0-100]

Surname

String

The part identified as Surname in the input name.

Surname Position

String

Position at which the surname was detected.

Input Phone Number

Yes

String

Region Code

No

String

Enriched Phone Format

No

String

Region of Origin

No

String

Enriched Phone Number

String

Phone number returned by the enricher in the format specified in the Enriched Phone Format input. This string is null if the enricher was not able to process the input phone number. The Status Code and Status Text value help troubleshooting such issues.

Geocoding Data

String

Geocoding data computed for a given number and country. Depending on the country and phone number, this value includes the country, region/state and city information. This string is null if the enricher was not able to process the input phone number. The Status Code and Status Text value help troubleshooting such issues.

Status Code

String

Return code for the phone number processing. More details about the Status Codes.

Status Text

String

Text explaining the status code.

International Phone Prefix

String

International Phone Prefix for worldwide dialing.

National Number

String

National number part of a phone number in International format. It is often the International number without the Country Prefix.

Extension

String

Extension part of the phone number.

Country Code Source

String

Explains how the Country Code was retrieved. Possible values are FROM_NUMBER_WITH_PLUS_SIGN, FROM_NUMBER_WITH_IDD, FROM_NUMBER_WITHOUT_PLUS_SIGN and FROM_DEFAULT_COUNTRY.

Leading Zero

String

Returns 0 or 1 to specify if leading zero is mandatory for foreign calls.

Possible Phone Number

String

Returns 0 or 1 to indicate whether a phone number is a possible number, and the region where the number could be dialed from.

Possible Phone Number Reason

String

Detailed explanation of why a phone number is a possible number or not. Possible values are INVALID_COUNTRY_CODE, IS_POSSIBLE, TOO_LONG and TOO_SHORT.

Valid Phone Number

String

Returns 0 or 1 to indicate whether a phone number matches a valid pattern.

Valid Phone Number For Region

String

Returns 0 or 1 to indicate that a phone number is valid for the specified Region Code.

Phone Line Type

String

Provides the line type of a phone number. Possible values are : FIXED_LINE, FIXED_LINE_OR_MOBILE, MOBILE, PAGER, PERSONAL_NUMBER, PREMIUM_RATE, SHARED_COST, TOLL_FREE, UAN, UNKNOWN and VOIP

Region Code

String

Returns the region code for the Phone Number. See this link for the list of codes.

International Phone Number

String

Phone number formatted for international dialing.

Time Zones

String

List of corresponding time zones for a given number. For example: Europe/Paris. If the timezone is unknown, returns Etc/Unknown

First Time Zone

String

First time zone from the list of corresponding time zones for a given number.

Carrier Name

String

Name of the carrier for the phone number.

Matching Leniency

No

String

Extraction Format

No

String

List Separator

No

String

Maximum Invalid Numbers

No

String

Input Text

Yes

String

Accepted Region

No

String

Extracted Phone List

String

List of phone numbers extracted.

Phone 1 to Phone 5

String

First, second… extracted phone number in the list.

Validation Leniency

No

String

Input Phone Number

Yes

String

Country Code

No

String

Datasource

No

String

Lowercase User Name

No

String

Offline Mode

No

String

Processing Mode

No

String

Input Email Address

Yes

String

Cleansed Email Address

String

Cleansed email address returned by the enricher. This address may be valid or not. The syntactic validity or domain name validity of the email address is indicated in the other plug-in outputs.

Valid Domain

String

Flag (0 or 1) indicating whether the domain name is valid or not (based on syntax and MX records lookup) in the cleansed email address. In Offline mode, this parameter returns 1 or 0 if the domain name appears in the local domain cache as valid or invalid. It returns null if the domain name does not exist in the cache and the MX Lookup was not issued.

Valid Domain Syntax

String

Flag (0 or 1) indicating whether the domain name syntax is valid or not in the cleansed email address.

Valid Email Syntax

String

Flag (0 or 1) indicating whether the cleansed email address is syntactically valid or not.

Valid Username Syntax

String

Flag (0 or 1) indicating whether the local-part (user name) syntax is valid or not in the cleansed email address.

Valid Input Domain

String

Flag (0 or 1) indicating whether the domain name is valid or not (based on syntax and MX records lookup) in the input email address. In Offline mode, this parameter returns 1 or 0 if the domain name appears in the local domain cache as valid of invalid. It returns null if the domain name does not exist in the cache and the MX Lookup was not issued.

Valid Input Domain Syntax

String

Flag (0 or 1) indicating whether the domain name syntax is valid or not in the input email address.

Valid Input Email Syntax

String

Flag (0 or 1) indicating whether the input email address is syntactically valid or not.

Valid Input Username Syntax

String

Flag (0 or 1) indicating whether the local-part (user name) syntax is valid or not in the input email address.

Accepted Domains

No

String

Offline Mode

No

String

Processing Mode

No

String

Input Email Address

Yes

String

Input email address to check.

License String

Yes

String

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

Delivery Lines

No

Boolean

The options allows you to specify if the Address Lines 1-8 should contain just the delivery address or the entire address

Line Separator

No

String

Possible values: SemiColon, Pipe, CR, LF, CRLF, Tab, BR. This is the line separator used for the FormattedAddress result.

Output Script

No

String

Possible values: NoChange, Latn, Native. This is the script type used for all applicable fields.

Country Of Origin

No

String

Must contain a valid ISO-3166-1Alpha-2, ISO-3166-1 Alpha-3, or ISO-3166-1 Numeric code. This is used to determine whether or not to include the country name as the last line in FormattedAddress

SSL Connection

No

Boolean

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

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.

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.

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.

AddressLine3
…​
AddressLine8

No

String

The input field for the address. This should contain the delivery address information (house number, thoroughfare, building, suite, etc.) but should not contain locality information (locality, administrative area, postal code, etc.) which have their own inputs.

DependentLocality

No

String

The smaller population center data element. This depends on the Locality element.

DoubleDependentLocality

No

String

The smallest population center data element. This depends on the Locality and DependentLocality elements.

Locality

No

String

The most common population center data element.

PostalCode

No

String

The postal code.

SubAdministrativeArea

No

String

The smallest geographic data element.

SubNationalArea

No

String

The administrative region within a country on an arbitrary level below that of the sovereign state.

Country

No

String

The country.

AddressKey

String

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

AddressLine1
…​
AddressLine8

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.

AddressType

String

Returns the Address Type for US and Canada

AdministrativeArea

String

The most common geographic data element.

Building

String

Descriptive name identifying an individual location. This is a string value that is the parsed Building element from the output.

CountryISO3166_1_Alpha2

String

ISO 3166 2-character country code.

CountryISO3166_1_Alpha3

String

ISO 3166 3-character country code.

CountryISO3166_1_Numeric

String

ISO 3166 3-digit numeric country code.

CountryName

String

Returns the country name for the record.

DependentLocality

String

A dependent locality is a logical area unit that is smaller than a locality but larger than a double dependent locality or thoroughfare. It can often be associated with a neighborhood or sector. Great Britain is an example of a country that uses double dependent locality. In the United States, this would correspond to Urbanization, which is used only in Puerto Rico.

DependentThoroughfare

String

Block data element or dependent street. This is used when there are more than one thoroughfares with the same name in one locality. An adjoining thoroughfare is used to uniquely identify the target thoroughfare. This is rarely used.

DependentThoroughfareLeadingType

String

Thoroughfare type at the beginning of the dependent thoroughfare. The leading type is parsed from the dependentThoroughfare parameter. For example, if the dependent thoroughfare is "St. Hickory E," the dependent thoroughfare leading type would be "St.

DependentThoroughfareName

String

Dependent thoroughfare name parsed from the dependentThoroughfare parameter. For example, if the dependent thoroughfare is "E Hickory Ln," the dependent thoroughfare name would be "Hickory.

DependentThoroughfarePostDirection

String

Cardinal directional at the end of the dependent thoroughfare. The postfix directional is parsed from the dependentThoroughfare parameter. For example, if the dependent thoroughfare is "Hickory Ln N," the dependent thoroughfare post direction would be "N.

DependentThoroughfarePreDirection

String

Cardinal directional at the beginning of the dependent thoroughfare. The prefix directional is parsed from the dependentThoroughfare parameter. For example, if the dependent thoroughfare is "W Hickory Ln," the dependent thoroughfare pre direction would be "W.

DependentThoroughfareTrailingType

String

Thoroughfare type at the end of the dependent thoroughfare. The trailing type is parsed from the dependentThoroughfare parameter. For example, if the dependent thoroughfare is "W Hickory Ln," the dependent thoroughfare trailing type would be "Ln.

DoubleDependentLocality

String

A double dependent locality is a logical area unit that is smaller than a dependent locality but bigger than a thoroughfare. This field is very rarely used. Great Britain is an example of a country that uses double dependent locality.

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.

Latitude

String

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

Locality

String

This is the most common geographic area and used by virtually all countries. This is usually the value that is written on a mailing label and referred to by terms like City, Town, Postal Town, etc.

Longitude

String

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

Organization

String

This is a string value that matches the Organization request element. It is not modified or populated by the service.

PostBox

String

Post box information for a particular delivery point.

PostalCode

String

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

PremisesNumber

String

Alphanumeric indicator within premises field. Parsed from the premises parameter.

PremisesType

String

Leading premise type indicator within premises field. Parsed from the premises parameter.

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.

SubAdministrativeArea

String

The smallest geographic data element.

SubNationalArea

String

A sub-national area is a logical area unit that is larger than an administrative area but smaller than the country itself. It is extremely rarely used.

SubPremises

String

Alphanumeric code identifying an individual location. More specific than premises.

SubPremisesNumber

String

Sub premises number indicator within premises field. Parsed from the subPremises parameter.

SubPremisesType

String

Sub premises type indicator within premises field. Parsed from the subPremises parameter.

Thoroughfare

String

This value is a part of the address lines and contains all the sub-elements of the thoroughfare like trailing type, thoroughfare name, pre direction, post direction, etc.

ThoroughfareLeadingType

String

Leading thoroughfare type indicator parsed from the thoroughfare parameter. A leading type is a thoroughfare type that is placed before the thoroughfare. This value is a part of the Thoroughfare field. For example, the thoroughfare type of "Rue" in Canada and France is placed before the thoroughfare, making it a leading type.

ThoroughfareName

String

Name indicator parsed from the thoroughfare parameter.

ThoroughfarePostDirection

String

Postfix directional parsed from the thoroughfare parameter.

ThoroughfarePreDirection

String

Prefix directional parsed from the thoroughfare parameter.

ThoroughfareTrailingType

String

Trailing thoroughfare type indicator parsed from the thoroughfare parameter. A trailing type is a thoroughfare type that is placed after the thoroughfare. This value is a part of the Thoroughfare field. For example, the thoroughfare type of "Avenue" in the US is placed after the thoroughfare, making it a trailing type.

TransmissionResults

String

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

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.

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.

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.

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.

LastLine

No

String

The city, state, and ZIP.

LastName

No

String

The family (last) name.

Phone

No

String

The phone number.

PostalCode

No

String

The postal code.

State

No

String

The US state.

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.

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.

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.

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.

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.

Latitude

String

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

Longitude

String

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

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.

PhoneAreaCode

String

Returns the parsed area code 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.

PostalCode

String

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

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 time zone of the requested record. All Melissa products express time zones 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.

Client ID or API Key

No

String

Channel

No

String

Default Language

No

String

Private Key

No

String

Request per Second

No

Integer

Address Line

Yes

String

Postal Code

No

String

City

No

String

Country

No

String

Language

No

String

Address Types

String

Comma-separated list of address types (See Address Types for more information.).

Administrative Area Level 1*

String

First-order civil entity below the country level. Within the United States, these administrative levels are states. Not all countries exhibit these administrative levels.

Administrative Area Level 2*

String

Second-order civil entity below the country level. Within the United States, these administrative levels are counties. Not all countries exhibit these administrative levels.

Administrative Area Level 3*

String

Third-order civil entity below the country level. Not all countries exhibit these administrative levels.

Airport

String

Indicates an airport. NOTE: This output is deprecated.

Country*

String

The national political entity.

East Bound Longitude

String

Bounding box eastern limit.

Floor*

String

Indicates the floor of a building address.

Formatted Address

String

Human-readable version of the geocoded address.

Intersection

String

Major intersection, usually of two major roads. NOTE: This output is deprecated.

Latitude

String

Latitude of the address.

Locality*

String

Incorporated city or town political entity.

Longitude

String

Longitude of the address.

Natural Feature*

String

Prominent natural feature.

Neighborhood*

String

Named neighborhood.

North Bound Latitude

String

Bounding box northern limit.

Park*

String

Named park.

Point of Interest*

String

Named point of interest.

Post Box*

String

Specific postal box.

Postal Code*

String

Postal code as used to address postal mail within the country.

Premise*

String

Named location, usually a building or collection of buildings with a common name.

Quality

String

The value of an Address Quality element defines the granularity of the location described by an address. Should return a value that expresses this quality between 0 and 100 (100 being the best quality)

Room*

String

The room of a building address.

Route*

String

Named route (such as US 401).

South Bound Latitude

String

Bounding box southern limit.

Status

String

Status of the request. OK indicates that no error occurred and the address was geocoded. ZERO_RESULTS indicates that no error occurred but the address was not geocoded. See the API documentation for a list of status and error codes

Street Address

String

Precise street address. NOTE: This output is deprecated.

Street Number*

String

Precise street number.

Sub-Locality*

String

First-order civil entity below a locality.

Sub-Premise*

String

First-order entity below a named location, usually a singular building within a collection of buildings with a common name.

West Bound Longitude

String

Bounding box western limit.

OpenStreetMap URL

Yes

String

Address Line

Yes

String

Postal Code

No

String

City

No

String

Country

No

String

Address

String

Complete address of the location.

City

String

City of the location.

Country

String

Country of the location.

Country Code

String

Country code of the location.

County

String

County of the location.

Latitude

String

Latitude of the location.

Longitude

String

Longitude of the location.

Postal Code

String

Postal code of the location.

Process Code

String

Code that indicates the result status of the address processing.

State

String

State of the Location.

Street Number

String

Street number of the location.

Street Name

String

Street name of the location.

Bing Maps Key

Yes

String

Bing Location URL

Yes

String

Address Line

Yes

String

Postal Code

No

String

City

No

String

Country

No

String

Administrative District

String

The subdivision name within the country or region for an address, such as the abbreviation of a US state.

Administrative District 2

String

The subdivision name within the administrative district for an address.

Confidence

String

Defines the confidence of the location match found by the geocoding service. Possible values: High, Medium, Low.

Country or Region

String

The country or region name of the address.

Formatted Address

String

A string specifying the complete address. This address may not include the country or region.

Status Code

String

The HTTP Status code for the request.

Status Description

String

A description of the HTTP status code.

Latitude

String

Latitude of the location.

Locality

String

The locality, such as the primary city, that corresponds to an address.

Longitude

String

Longitude of the address.

Match Code

String

Defines the geocoding level of the location match found by the geocoder. One or more of the following values: Good, Ambiguous, UpHierarchy

Postal Code

String

The city or neighborhood that corresponds to the postal code.

Process Code

String

Code that indicates the result status of the process.

HOST_NAME

Domain name. e.g. "gmail.com"

PREFIX

2 first letters of the domain name. e.g. "gm"

SUFFIX

2 last letters of the domain name. e.g. "om"

HIT_COUNT

Number of times this host name was processed by the enricher. This value is automatically incremented by the enricher.

SEED_DATA

Indicates whether this record was part of the seeded data, of created by the enricher. The value is 1 for seeded data, 0 otherwise.

VALID

Indicates whether the domain name is valid 1 or invalid 0. The value is N/A if the validity is unknown (for example, when a new domain is added in the cache in offline mode).

SUGGESTION

Latest correction found for an invalid domain.

FIRST_INVALID_DATE
LAST_INVALID_DATE
LAST_VALID_DATE

Additional date information used to reconsider a domain validity after a certain period of time.