Page tree
Skip to end of metadata
Go to start of metadata



This is the main operation for validating and enhancing leads. It will attempt to append and enhance any lead given any combination of Name, Email, Phone Number, Address, Address2, City, Region, Postal Code, Country, and/or IP Address. This operation is designed for residential leads. Business addresses will be identified as such and business phone contacts will be returned if given a phone number for a business but it is expected that the leads themselves will be primarily residential information. The name testing will not work if given a company name. A business oriented operation will likely be planned for a future release. This operation will likely involve different data sources and tests not run during residential lead testing.


URL Endpoint


XML: https://trial.serviceobjects.com/le/LeadEnhancement.asmx/EnhanceResidentialLead?Name={NAME}&Email={EMAIL}&PhoneNumber={PHONENUMBER}&Address1={ADDRESS1}&Address2={ADDRESS2}&City={CITY}&Region={REGION}&PostalCode={POSTALCODE}&Country={COUNTY}&IPAddress={IPADDRESS}&LicenseKey={LICENSEKEY}


EnhanceResidentialLead Inputs


Name

Type

Description

Name

String

The name to validate.

Email

String

The email address to validate.

PhoneNumber

String

The phone number to validate.

Address1

String

The address to validate.

Address2

String

Extra address information to include for validation.

City

String

The city to validate.

Region

String

The region to validate.

PostalCode

String

The postal code to validate.

Country

String

The country to validate.

IPAddress

String

The IP address to validate.

LicenseKey

String

Your license key to use the service.
Sign up for a free trial key at
https://www.serviceobjects.com/products/lead-validation-bundles/lead-enhancement


Important Note!
For any output fields, along with the states possible outputs in the "Values" column, expect that a blank result (empty string "") is also possible. It should never happen, but smart programming plans for potential NULL values for output fields as well.


EnhanceResidentialLead Outputs


Name

Type

Values

Description

NameIn

String

Varies

The original name.

EmailAddressIn

String

Varies

The original email.

PhoneNumberIn

String

Varies

The original number.

Address1In

String

Varies

The original address.

Address2In

String

Varies

The original address2.

CityIn

String

Varies

The original city.

RegionIn

String

Varies

The original region.

PostalCodeIn

String

Varies

The original postal code.

CountryIn

String

Varies

The original country.

IPAddressIn

String

Varies

The original IP.

FirstNameOut

String

Varies

The parsed out likely first name.

MiddleNameOut

String

Varies

The parsed out likely middle name

LastNameOut

String

Varies

The parsed out likely last name.

GenderOut

String

MALE,
PROBABLY MALE,
PROBABLY FEMALE, FEMALE, UNKNOWN

The likely gender of the lead.

FirstNameFound

String

TRUE, FALSE

The parsed out first name was identified as valid.

LastNameFound

String

TRUE, FALSE

The parsed out last name was identified as valid.

NameNotesDesc

String

See below

Extra informational notes about the name. See below for values.

NameNotesCode

String

Numerical code

A code associated with the name notes. See below for values.

Address1Out

String

Varies

The validated and standardized resulting address.

Address2Out

String

Varies

A placeholder for extra information that is not part of the standardized address.

CityOut

String

Varies

The validated and standardized city.

RegionOut

String

Varies

The validated and standardized region.

PostalCodeOut

String

Varies

The validated and standardized postal code.

CountryOut

String

Varies

The country the address is located in.

IsAddressDPV

String

TRUE, FALSE, UNKNOWN

An indicator telling if the standardized address is recognized as deliverable by the USPS.

IsAddressResidential

String

TRUE, FALSE

An indicator telling if the standardized address is recognized as residential by the USPS.

AddressNotesDesc

String

Codes, Notes, and Corrections

Informational notes about the deliverability of the standardized address.

AddressNotesCode

String

Numerical code

A code associated with the address notes.

AddressErrorDesc

String

Codes, Notes, and Corrections

A description of any errors associated with the standardized address. 

AddressErrorCode

String

Numerical code

A code associated with the error description.

PhoneNumberOut

String

Varies

A cleaned 10 digit phone number. Special characters and extension information removed.

CarrierName

String

Varies

The telephone company that owns the block of numbers designated by the first 7 digits of the number.

ExchangeCity

String

Varies

The city that the exchange (block of first 7 digits) belongs in.

ExchangeRegion

String

Varies

The region that the exchange (block of first 7 digits) belongs in.

ExchangeCountry

String

Varies3 character code

The three character country code that the exchange (block of first 7 digits) belongs in.

PhoneLineType

String

LANDLINE, WIRELESS, VOIP,
UNKNOWN

The line type of the given phone number.

PhoneNumberErrorDesc

String

Codes, Notes, and Corrections

A description of any errors associated with the given phone number.

PhoneNumberErrorCode

String

Numerical code

A numerical code associated with the error description.

EmailAddressOut

String

Varies

A corrected and cleaned email address.

IsEmailAddressFree

String

TRUE, FALSE, UNKNOWN

An indicator of whether or not the email is available to anyone freely.

IsEmailAddressGood

String

TRUE, FALSE, UNKNOWN

An indicator of whether the email is known to be bad based on testing. See FAQ for more details.

EmailNotesDesc

String

Codes, Notes, and Corrections

Noteworthy information discovered about the email.

EmailNotesCode

String

Numerical code

A numerical code associated with the note above.

EmailErrorDesc

String

Codes, Notes, and Corrections

A description of any errors associated with the email.

EmailErrorCode

String

Numerical code

A numerical code associated with the error above.

IPAddressCity

String

Varies

The city associated with the IP address.

IPAddressRegion

String

Varies

The state or province associated with the IP address.

IPAddressCountry

String

Varies

The country associated with the IP address.

IPAddressCountryISO2

String

2 character code

The two character country code associated with the IP address.

IPAddressCountryISO3

String

3 character
code

The three character country code associated with the IP address.

IPAddressCertainty

String

0-100

A certainty value for how accurate the IP address information is likely to be.

IPAddressISP

String

Varies

The ISP which assigned the IP address.

IPAddressNetblockOwner

String

Varies

The network owner to which the IP address is allocated.

IPAddressIsProxy

String

TRUE, FALSE, UNKNOWN

Indicates whether the IP address is a known proxy.

IPAddressProxyType

String

PRIVATE, PUBLIC, ANONYMOUS

Indicates the type of proxy found.

IPAddressErrorDesc

String

Codes, Notes, and Corrections

A description of any errors associated with the IP address.

IPAddressErrorCode

String

Numerical code

A numerical code associated with the error above.


References


  • No labels