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



Our Lead Validation service cross-validates, corrects and scores over 130 key data points to help your business more accurately identify quality leads for US and Canada. Works with leading CRM and marketing automation platforms.


This document defines the input, output, and behavior of the web services in LV.


Important Note!
Lead Validation cannot determine the complete validity of a lead 100% of the time. Often, unlisted phone numbers, cell phone numbers, very rare names, rural or new addresses, and the like will cause either neutral or negative shifts in a lead's validity. LV provides a baseline guide of a lead's quality that must be taken with serious consideration.


URL Endpoints


JSON: 

https://trial.serviceobjects.com/lv/api.svc/JSON/ValidateLead_V3?FullName={FULLNAME}&Salutation={SALUTATION&FirstName={FIRSTNAME}&LastName={LASTNAME}&BusinessName={BUSINESSNAME}&BusinessDomain={BUSINESSDOMAIN}&BusinessEIN={BUSINESSEIN}&Address1={ADDRESS1}&Address2={ADDRESS2}&Address3={ADDRESS3}&Address4={ADDRESS4}&Address5={ADDRESS5}&Locality={LOCALITY}&AdminArea={ADMINAREA}&PostalCode={POSTALCODE}&Country={COUNTRY}&Phone1={PHONE1}&Phone2={PHONE2}&Email={EMAIL}&IPAddress={IPADDRESS}&Gender={GENDER}&DateOfBirth={DATEOFBIRTH}&UTCCaptureTime={UTCCAPTURETIME}&OutputLanguage={OUTPUTLANGUAGE}&TestType={TESTTYPE}&LicenseKey={LICENSEKEY} 


XML: 

 https://trial.serviceobjects.com/lv/api.svc/XML/ValidateLead_V3?FullName={FULLNAME}&Salutation={SALUTATION&FirstName={FIRSTNAME}&LastName={LASTNAME}&BusinessName={BUSINESSNAME}&BusinessDomain={BUSINESSDOMAIN}&BusinessEIN={BUSINESSEIN}&Address1={ADDRESS1}&Address2={ADDRESS2}&Address3={ADDRESS3}&Address4={ADDRESS4}&Address5={ADDRESS5}&Locality={LOCALITY}&AdminArea={ADMINAREA}&PostalCode={POSTALCODE}&Country={COUNTRY}&Phone1={PHONE1}&Phone2={PHONE2}&Email={EMAIL}&IPAddress={IPADDRESS}&Gender={GENDER}&DateOfBirth={DATEOFBIRTH}&UTCCaptureTime={UTCCAPTURETIME}&OutputLanguage={OUTPUTLANGUAGE}&TestType={TESTTYPE}&LicenseKey={LICENSEKEY}

ValidateLead_V3 Inputs


TestType and LicenseKey are the only required inputs, if they are missing or incorrect ValidateLead_V3 will throw an error. All other inputs are optional, but missing key data without a test type that accounts for it could cause tests to fail and potentially greatly impact the resulting score. (e.g. Omitting Name will cause all name tests to fail as well as name to email tests, name to phone tests..etc...)


Name

Type

Length

Description

FullName

String

60

The contact's full name. e.g. Jane Doe

SalutationString10Salutation of the contact. Dr, Esq, Mr, Mrs etc
FirstNameString60First name of the contact. e.g. Jane
LastNameString60Last name of the contact. e.g. Doe

BusinessName

String

60

The contacts company. e.g. Service Objects

BusinessDomainString60Website domain associated with the business. e.g. serviceobjects.com
BusinessEINString60Represents the Company Tax Number. Used for Tax exempt checks for US leads.

Address1

String

60

The address 1 of the contact or business address.

Address2

String

60

The address 2 of the contact or business address.

Address3String60The address 3 of the contact or business address.
Address4String60The address 4 of the contact or business address.
Address5String60The address 5 of the contact or business address.

Locality

String

60

The city of the contact's postal address.

AdminArea

String

60

The state of the contact's postal address.

PostalCode

String

20

The zip code of the contact's postal address.

Country

String

60

The country of the contact's postal address. e.g. United States, US or USA

Phone1

String

20

The contact's primary phone number.

Phone2

String

20

The contact's secondary phone number.

Email

String

60

The contact's email address.

IPAddress

String

45

The contact's IP address in IPv4. (IPv6 coming in a future release)

Gender

String

10

Male, Female or Neutral

DateOfBirth

String

10

The contact's date of birth

UTCCaptureTime

String

10

The time the lead was submitted

OutputLanguage

String20Language field indicating what language some of the output information will be.

String

20

The name of the type of validation you want to perform on this contact.

LicenseKey

String

20

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


ValidateLead_V3 Outputs


All of the response objects are contained within the ValidateLead_V3 object.

Name

Type

Length

Values

Description

OverallCertainty

String

3

Varies

A value that represents the overall certainty that the service provided on the lead. This value will range from 0 to 100.

OverallQuality

String

10

Reject, Review or Accept

A field indicating whether the lead should be rejected, reviewed or accepted

LeadType

String

10

Residential, Business or Unknown

Indicates the classification that the service made for the lead.

LeadCountry

String

3

Varies

The country associated with the lead, given as an ISO 2.

NoteCodes

String

-

Varies

Enumerated list of descriptive notes

NoteDesc

String

-

Varies

Descriptions that correspond to the NoteCodes section

NameCertainty

String

3

Varies

Score between 0 and 100 that indicates the probability that the given name is valid.

NameQuality

String

10

Reject, Review or Accept

A field indicating whether the given name should be rejected, reviewed or accepted.

FirstName

String

60

Varies

The first name with diacritic characters.

LastName

String

60

Varies

The last name with diacritic characters.

FirstNameClean

String

60

Varies

The first name of the lead without diacritic characters.

LastNameClean

String

60

Varies

The last name of the lead without diacritic characters.

NameNoteCodes

String

-

Varies

Enumerated list of codes indicating further information about the name field.

NameNotesDesc

String

-

Varies

Enumerated list of descriptive notes that correspond to the NameNoteCodes field.

AddressCertainty

String

3

Varies

Score between 0 and 100 that indicates the validity of the given address.

AddressQuality

String

10

Reject, Review or Accept

A field indicating whether the given address should be rejected, reviewed or accepted

Address1

String

60

Varies

The validated Address line 1

Address2

String

60

Varies

The validated Address line 2

Address3

String

60

Varies

The validated Address line 3

Address4

String

60

Varies

The validated Address line 4

Address5String60VariesThe validated Address line 5
AddressLocalityString60VariesThe locality associated with the given input address. Usually corresponds to the city.
AddressAdminAreaString60VariesThe Admin Area tied with the input address. Usually corresponds to the State or Province.
AddressPostalCodeString20VariesThe Postal Code tied to the given input address.
AddressCountryString60Varies2 Character ISO code for the country
AddressNoteCodesString-VariesEnumerated list of codes indicating additional information about the given address.
AddressNoteDescString-VariesEnumerated list of descriptive notes that are associated with the AddressNoteCodes field.
EmailCertaintyString3VariesScore between 0 and 100 that indicates the validity of a given email address
EmailQualityString10Reject, Review or AcceptA field indicating whether the given email address should be rejected, reviewed or accepted
EmailCorrectedString60VariesThe email used for testing including any corrections that were made.
EmailNoteCodesString-VariesEnumerated list of codes indicating additional information about the given email address
EmailNoteDescString-VariesList of descriptions associated with the EmailNoteCodes field.
IPAddressCertaintyString3VariesScore between 0 and 100 that indicates the validity of a given IP address.
IPAddressQualityString10Reject, Review or AcceptA field indicating whether the given IP address should be rejected, reviewed or accepted
IPCountryString60VariesCountry ISO 2 code associated with the given IP address
IPLocalityString60VariesThe locality associated with the given IP address
IPAdminAreaString-VariesAdministrative area associated with the given IP address
IPNoteCodesString-VariesEnumerated list of codes indicating additional information about the given IP address
IPNoteDescString-VariesDescriptions associated with the IPNoteCodes that indicate additional information about a given IP address
Phone1CertaintyString3VariesScore between 0 and 100 that indicates the validity of the phone number in the Phone1 field.
Phone1QualityString10Reject, Review or AcceptA field indicating whether the Phone1 input should be rejected, reviewed or accepted.
Phone1LocalityString60VariesLocality associated with the given IP address
Phone1AdminAreaString60VariesThe administrative area associated with the given phone number.
Phone1CountryString3VariesThe Country ISO 2 code associated with the given phone number in the Phone1 field.
Phone1NoteCodesString-VariesNote codes containing additional
Phone1NoteDescString-VariesDescriptions that correlate with the codes given in the Note Codes field
Phone2CertaintyString3VariesNot currently used
Phone2QualityString10Reject, Review or AcceptNot currently used 
Phone2LocalityString60VariesNot currently used 
Phone2AdminAreaString60VariesNot currently used 
Phone2CountryString3VariesNot currently used 
Phone2NoteCodesString-VariesNot currently used 
Phone2NoteDescString-VariesNot currently used 
PhoneContactPhoneContact-VariesThe contact information associated with the phone number
InformationComponentsInformationComponent[]-VariesAn array of key value pairs that contain additional fields and information not defined in the original output schema of the API.
ErrorError-VariesSee "Errors".


PhoneContact Type

Name

Type

Values

Description

Name

String

Varies

The contact's full name.

Address

String

Varies

The contact's postal address.

City

String

Varies

The city of the contact's postal address.

State

String

Varies

The state of the contact's postal address.

Zip

String

Varies

The zip code of the contact's postal address.

Type

String

RESIDENTIAL BUSINESS UNKNOWN

The contacts phone type.


InformationComponent

NameTypeValuesDescription
NameStringVariesThe component name of the Name-Value pair
ValueStringVariesThe component value of the Name-Value pair.



References

  1. ^ Customizing DOTS Lead Validation to Your Needs

  2. How Lead Validation Works

  3. Lead Validation: The Core Components



  • No labels