Share via


Service Objects (Preview)

Cleanse, validate, and enhance contact data. Our tools validate and cross-verify a contact's name, location, phone, email address and device against hundreds of authoritative data sources.

This connector is available in the following products and regions:

Service Class Regions
Logic Apps Standard All Logic Apps regions except the following:
     -   Azure Government regions
     -   Azure China regions
     -   US Department of Defense (DoD)
Power Automate Premium All Power Automate regions except the following:
     -   US Government (GCC)
     -   US Government (GCC High)
     -   China Cloud operated by 21Vianet
     -   US Department of Defense (DoD)
Power Apps Premium All Power Apps regions except the following:
     -   US Government (GCC)
     -   US Government (GCC High)
     -   China Cloud operated by 21Vianet
     -   US Department of Defense (DoD)
Contact
Name Service Objects Support
URL https://www.serviceobjects.com/
Email support@serviceobjects.com
Connector Metadata
Publisher Service Objects
Website https://www.serviceobjects.com/
Privacy policy https://www.serviceobjects.com/privacy
Categories Sales and CRM;Data

Prerequisites

Test drive as many of our real-time services as you like. Start by selecting a product and sign up for a FREE API key. Includes 500 test transactions and our dedicated 24/7 customer support.

Product Page: https://www.serviceobjects.com/products

How to get credentials

Let our data quality advisors help you select the right service for your business needs.

Give us a call at: 1-800-694-6269

Contact Us - https://www.serviceobjects.com/contact-us

Getting started with your connector

To get started, first sign up for a license key. After that you can leverage the Service Objects connector to validate your data in real time. Choose a data source, select the relevant service from the Action menu, map the inputs into the connector, and leverage the outputs to make better business decisions.

Creating a connection

The connector supports the following authentication types:

Default Parameters for creating connection. All regions Not shareable

Default

Applicable: All regions

Parameters for creating connection.

This is not shareable connection. If the power app is shared with another user, another user will be prompted to create new connection explicitly.

Name Type Description Required
API Key securestring The API Key for this api True
Environment string The API environment to use; either production or trial True

Throttling Limits

Name Calls Renewal Period
API calls per connection 100 60 seconds

Actions

DOTS Address Geocode International - PlaceSearch

The PlaceSearch operation returns the latitude and longitude for a given International Address, along with additional address and location information. It will attempt to geocode addresses at the property level, which is often a rooftop coordinate for some properties and then cascade to the next best available resolution such as the street, neighborhood, postal code, locality and so on. For non-address places such as streets, cities and postal codes, the coordinates will return a coordinate point that is commonly associated with the location or a centroid for the area.

DOTS Address Geocode International - ReverseSearch

The ReverseSearch operation returns the address or place information for a given set of coordinates, along with additional address and location information. It will attempt to reverse geocode coordinates and return international addresses at the property level, which is often at the premise level resolution for some properties and then cascade to the next best available resolution such as the street, neighborhood, postal code, locality and so on. For non-address places such as streets, cities and postal codes returned by the service, the coordinates output in the response body will represent a coordinate point that is commonly associated with the location or a centroid for the area.

DOTS Address Validation International - GetAddressInfo

Our real-time International Address Validation API service verifies and corrects global mailing addresses to the unique requirements of each countrys postal address formats and cultural idiosyncrasies. With continual updates from country-specific postal authorities, our data is always up-to-date with genuine and accurate addresses.

DOTS Address Validation USA 3- GetBestMatches

Returns parsed and validated address elements including Delivery Point Validation (DPV), Residential Delivery Indicator (RDI), and Suite data. GetBestMatches will attempt to validate the input address against a CASS approved engine, and make corrections where possible. Multiple address candidates may be returned if a definitive decision cannot be made by the service.

DOTS IP Address Validation - GetLocationByIP_V4

Returns geographic location, proxy, host name and US region information for a given IP address.

DOTS Lead Validation International - ValidateLeadInternational

DOTS Lead Validation International (LVI) evaluates international lead data and scores the data quality into pass/fail/review categories. By evaluating the information quality of a contact, online marketers can more effectively weed-out fraudulent contacts.Online fraudsters are more likely to provide inaccurate contact information because the address and phone number can be easily traced. Unlike other validation services that perform simple data checks on single variables, Service Objects Lead Validation solution is able to cross-validate that a contact's name, address, phone numbers, e-mail and IP address are all matched each other and are related to the consumer.

DOTS Phone Exchange International - GetInternationalExchangeInfo

Our international Phone Exchange service validates and formats phone numbers for international direct dialing, while returning line type, country code and geocoding information.

DOTS Address Geocode International - PlaceSearch

The PlaceSearch operation returns the latitude and longitude for a given International Address, along with additional address and location information. It will attempt to geocode addresses at the property level, which is often a rooftop coordinate for some properties and then cascade to the next best available resolution such as the street, neighborhood, postal code, locality and so on. For non-address places such as streets, cities and postal codes, the coordinates will return a coordinate point that is commonly associated with the location or a centroid for the area.

Parameters

Name Key Required Type Description
SingleLine
SingleLine string

The full address on one line.

Address1
Address1 string

Address Line 1 of the International Address

Address2
Address2 string

Address Line 2 of the International Address

Address3
Address3 string

Address Line 3 of the International Address

Address4
Address4 string

Address Line 4 of the International Address

Address5
Address5 string

Address Line 5 of the International Address

Locality
Locality string

The name of the distinct population cluster

AdministrativeArea
AdministrativeArea string

The name of the administrative division

PostalCode
PostalCode string

The postal code of the international address

Country
Country string

The preferred name of the country

Boundaries
Boundaries string

*Coming soon, not currently used

MaxResults
MaxResults string

Sets the maximum number of results the operation is allowed to return

SearchType
SearchType string

The name of the type of search you want to perform

Extras
Extras string

A comma-delimited list of the extra features that you would like to enable

Returns

Name Path Type Description
Status
SearchInfo.Status string

Indicates if the service found one or more results or if it encountered an error when processing the query.

NumberOfLocations
SearchInfo.NumberOfLocations integer

Indicates the number of locations found for the query that will be listed in LocationInfo array Locations. The default maximum number of location returned by the service is 10; however, a lower value can be set in the 'MaxResults' input.

Notes
SearchInfo.Notes string

Comma-separated list of descriptive note codes about the query.

NotesDesc
SearchInfo.NotesDesc string

Comma-separated list of descriptions that correspond to the Notes output.

Warnings
SearchInfo.Warnings string

Comma-separated list of warning codes about the query.

WarningsDesc
SearchInfo.WarningsDesc string

Comma-separated list of descriptions that correspond to the Warnings output.

Locations
Locations array of object

Contains a list of LocationInfo objects.

PrecisionLevel
Locations.PrecisionLevel integer

Indicates how precise the coordinates are. Levels range from 1 - 16. The higher the number the higher the precision.

Type
Locations.Type string

Indicates what type of location the coordinates are for. For example, the location may be for an address, thoroughfare, locality or postal code.

Latitude
Locations.Latitude string

The latitude of the location. A decimal number up to 10 digits with a max precision of up to 7 places after the decimal point.

Longitude
Locations.Longitude string

The longitude of the location. A decimal number up to 10 digits with a max precision of up to 7 places after the decimal point.

PremiseNumber
Locations.AddressComponents.PremiseNumber string

The number associated with the property. Also known as the Address, Street or House number.

Thoroughfare
Locations.AddressComponents.Thoroughfare string

The name of the thoroughfare. Also known as a street, road, highway, etc.

DoubleDependentLocality
Locations.AddressComponents.DoubleDependentLocality string

The name of the double dependent locality.

DependentLocality
Locations.AddressComponents.DependentLocality string

The name of the dependent locality.

Locality
Locations.AddressComponents.Locality string

The preferred English name of the locality, such as a City, Town or other type of Municipality.

AdministrativeArea4
Locations.AddressComponents.AdministrativeArea4 string

The name of the fourth level administrative division, such as a Ward or Quarter.

AdministrativeArea4Abbreviation
Locations.AddressComponents.AdministrativeArea4Abbreviation string

The abbreviated name of the quaternary administrative area.

AdministrativeArea3
Locations.AddressComponents.AdministrativeArea3 string

The name of the third level administrative division, such as a Borough or District.

AdministrativeArea3Abbreviation
Locations.AddressComponents.AdministrativeArea3Abbreviation string

The abbreviated name of the tertiary administrative area.

AdministrativeArea2
Locations.AddressComponents.AdministrativeArea2 string

The name of the secondary administrative division, such as a County or Region.

AdministrativeArea2Abbreviation
Locations.AddressComponents.AdministrativeArea2Abbreviation string

The abbreviated name of the secondary administrative area.

AdministrativeArea1
Locations.AddressComponents.AdministrativeArea1 string

The name of the primary administrative division, such as a State, Region, Province, County, Territory or Prefecture.

AdministrativeArea1Abbreviation
Locations.AddressComponents.AdministrativeArea1Abbreviation string

The abbreviated name of the primary administrative area.

PostalCode
Locations.AddressComponents.PostalCode string

The postal code of the international address.

Country
Locations.AddressComponents.Country string

The country.

CountryISO2
Locations.AddressComponents.CountryISO2 string

The 2-letter country abbreviation.

CountryISO3
Locations.AddressComponents.CountryISO3 string

The 3-letter country abbreviation.

BingMapsURL
Locations.AddressComponents.BingMapsURL string

Bing Maps URL with the coordinates to the location.

GoogleMapsURL
Locations.AddressComponents.GoogleMapsURL string

Google Maps URL with the coordinates to the location.

MapQuestURL
Locations.AddressComponents.MapQuestURL string

Map Quest URL with the coordinates to the location.

PlaceName
Locations.AddressComponents.PlaceName string

The name of the place that the coordinates are associated with. Most commonly the name of a municipality, city, town, village or community.

IsUnincorporated
Locations.AddressComponents.IsUnincorporated string

Indicates if the coordinates are for an unincorporated area. Only appears for street level property matches (S).

StateFIPS
Locations.AddressComponents.StateFIPS string

State FIPS (Federal Information Processing Standard) code; used to uniquely identity states.

CountyFIPS
Locations.AddressComponents.CountyFIPS string

County FIPS (Federal Information Processing Standard) code; used to uniquely identify counties across the US.

CensusTract
Locations.AddressComponents.CensusTract string

The census tract of the given address. A census tract is a statistical subdivision of a county.

CensusBlock
Locations.AddressComponents.CensusBlock string

The census block of the given address.A block is the smallest geographic unit used by the US Census.

CensusGeoID
Locations.AddressComponents.CensusGeoID string

A Census based geographic identification code that uniquely identifies a geographic statistical area.

ClassFP
Locations.AddressComponents.ClassFP string

A code that defines the current class of the geographic US location.

CongressCode
Locations.AddressComponents.CongressCode string

The congressional district number.

SLDUST
Locations.AddressComponents.SLDUST string

Current state legislative district upper (senate) chamber code.

SLDLST
Locations.AddressComponents.SLDLST string

Current state legislative district lower (house) chamber code

TimeZone_UTC
Locations.AddressComponents.TimeZone_UTC string

The time zone in UTC offset format.

Type
Error.Type string

Type

TypeCode
Error.TypeCode string

TypeCode

Desc
Error.Desc string

Desc

DescCode
Error.DescCode string

DescCode

Debug
Debug string

Debug

DOTS Address Geocode International - ReverseSearch

The ReverseSearch operation returns the address or place information for a given set of coordinates, along with additional address and location information. It will attempt to reverse geocode coordinates and return international addresses at the property level, which is often at the premise level resolution for some properties and then cascade to the next best available resolution such as the street, neighborhood, postal code, locality and so on. For non-address places such as streets, cities and postal codes returned by the service, the coordinates output in the response body will represent a coordinate point that is commonly associated with the location or a centroid for the area.

Parameters

Name Key Required Type Description
Latitude
Latitude string

The latitude of the location

Longitude
Longitude string

The longitude of the location

SearchRadius
SearchRadius string

The maximum search radius distance set in kilometers

Country
Country string

The preferred name of the country

MaxResults
MaxResults string

Sets the maximum number of results the operation

SearchType
SearchType string

The name of the type of search you want to perform

Returns

Name Path Type Description
Status
SearchInfo.Status string

Indicates if the service found one or more results or if it encountered an error when processing the query.

NumberOfLocations
SearchInfo.NumberOfLocations integer

Indicates the number of locations found for the query that will be listed in LocationInfo array Locations. The default maximum number of location returned by the service is 10

Notes
SearchInfo.Notes string

Comma-separated list of descriptive note codes about the query.

NotesDesc
SearchInfo.NotesDesc string

Comma-separated list of descriptions that correspond to the Notes output.

Warnings
SearchInfo.Warnings string

Comma-separated list of warning codes about the query.

WarningsDesc
SearchInfo.WarningsDesc string

Comma-separated list of descriptions that correspond to the Warnings output.

Locations
Locations array of object

Contains a list of LocationInfo objects.

PrecisionLevel
Locations.PrecisionLevel integer

Indicates how precise the coordinates are. Levels range from 1 - 16. The higher the number the higher the precision.

Type
Locations.Type string

Indicates what type of location the coordinates are for. For example, the location may be for an address, thoroughfare, locality or postal code.

Latitude
Locations.Latitude string

The latitude of the location. A decimal number up to 10 digits with a max precision of up to 7 places after the decimal point.

Longitude
Locations.Longitude string

The longitude of the location. A decimal number up to 10 digits with a max precision of up to 7 places after the decimal point.

PremiseNumber
Locations.AddressComponents.PremiseNumber string

The number associated with the property. Also known as the Address, Street or House number.

Thoroughfare
Locations.AddressComponents.Thoroughfare string

The name of the thoroughfare. Also known as a street, road, highway, etc.

DoubleDependentLocality
Locations.AddressComponents.DoubleDependentLocality string

The name of the double dependent locality.

DependentLocality
Locations.AddressComponents.DependentLocality string

The name of the dependent locality

Locality
Locations.AddressComponents.Locality string

The preferred English name of the locality, such as a City, Town or other type of Municipality.

AdministrativeArea4
Locations.AddressComponents.AdministrativeArea4 string

The name of the fourth level administrative division, such as a Ward or Quarter.

AdministrativeArea4Abbreviation
Locations.AddressComponents.AdministrativeArea4Abbreviation string

The abbreviated name of the quaternary administrative area.

AdministrativeArea3
Locations.AddressComponents.AdministrativeArea3 string

The name of the third level administrative division, such as a Borough or District.

AdministrativeArea3Abbreviation
Locations.AddressComponents.AdministrativeArea3Abbreviation string

The abbreviated name of the tertiary administrative area.

AdministrativeArea2
Locations.AddressComponents.AdministrativeArea2 string

The name of the secondary administrative division, such as a County or Region.

AdministrativeArea2Abbreviation
Locations.AddressComponents.AdministrativeArea2Abbreviation string

The abbreviated name of the secondary administrative area.

AdministrativeArea1
Locations.AddressComponents.AdministrativeArea1 string

The name of the primary administrative division, such as a State, Region, Province, County, Territory or Prefecture.

AdministrativeArea1Abbreviation
Locations.AddressComponents.AdministrativeArea1Abbreviation string

The abbreviated name of the primary administrative area.

PostalCode
Locations.AddressComponents.PostalCode string

The postal code of the international address.

Country
Locations.AddressComponents.Country string

The country.

CountryISO2
Locations.AddressComponents.CountryISO2 string

The 2-letter country abbreviation.

CountryISO3
Locations.AddressComponents.CountryISO3 string

The 3-letter country abbreviation.

BingMapsURL
Locations.AddressComponents.BingMapsURL string

Bing Maps URL with the coordinates to the location.

GoogleMapsURL
Locations.AddressComponents.GoogleMapsURL string

Google Maps URL with the coordinates to the location.

MapQuestURL
Locations.AddressComponents.MapQuestURL string

Map Quest URL with the coordinates to the location.

PlaceName
Locations.AddressComponents.PlaceName string

The name of the place that the coordinates are associated with. Most commonly the name of a municipality, city, town, village or community.

IsUnincorporated
Locations.AddressComponents.IsUnincorporated string

Indicates if the coordinates are for an unincorporated area. Only appears for street level property matches (S).

StateFIPS
Locations.AddressComponents.StateFIPS string

State FIPS (Federal Information Processing Standard) code; used to uniquely identity states.

CountyFIPS
Locations.AddressComponents.CountyFIPS string

County FIPS (Federal Information Processing Standard) code; used to uniquely identify counties across the US.

CensusTract
Locations.AddressComponents.CensusTract string

The census tract of the given address. A census tract is a statistical subdivision of a county.

CensusBlock
Locations.AddressComponents.CensusBlock string

The census block of the given address.A block is the smallest geographic unit used by the US Census.

CensusGeoID
Locations.AddressComponents.CensusGeoID string

A Census based geographic identification code that uniquely identifies a geographic statistical area.

ClassFP
Locations.AddressComponents.ClassFP string

A code that defines the current class of the geographic US location.

CongressCode
Locations.AddressComponents.CongressCode string

The congressional district number.

SLDUST
Locations.AddressComponents.SLDUST string

Current state legislative district upper (senate) chamber code.

SLDLST
Locations.AddressComponents.SLDLST string

Current state legislative district lower (house) chamber code.

TimeZone_UTC
Locations.AddressComponents.TimeZone_UTC string

The time zone in UTC offset format.

Type
Error.Type string

Type

TypeCode
Error.TypeCode string

TypeCode

Desc
Error.Desc string

Desc

DescCode
Error.DescCode string

DescCode

Debug
Debug string

Debug

DOTS Address Validation International - GetAddressInfo

Our real-time International Address Validation API service verifies and corrects global mailing addresses to the unique requirements of each countrys postal address formats and cultural idiosyncrasies. With continual updates from country-specific postal authorities, our data is always up-to-date with genuine and accurate addresses.

Parameters

Name Key Required Type Description
Address1
Address1 string

Address Line 1 of the International Address

Address2
Address2 string

Address Line 2 of the International Address

Address3
Address3 string

Address Line 3 of the International Address

Address4
Address4 string

Address Line 4 of the International Address

Address5
Address5 string

Address Line 5 of the International Address

Locality
Locality string

The name of the distinct population cluster.

AdministrativeArea
AdministrativeArea string

The name of the administrative division.

PostalCode
PostalCode string

The postal code of the international address.

Country
Country string

The preferred name of the country or the ISO 3166-1 Alpha-2 Country Code or the Alpha-3 Country Code.

OutputLanguage
OutputLanguage string

The output language.

Returns

Name Path Type Description
Status
AddressInfo.Status string

Indicates the validity of the input address. Unless an error is returned this field will always be returned.

ResolutionLevel
AddressInfo.ResolutionLevel string

Indicates the level of accuracy to which the input address could be resolved.

Address1
AddressInfo.Address1 string

The formatted Address 1 line of the input address.

Address2
AddressInfo.Address2 string

The formatted Address 2 line of the input address.

Address3
AddressInfo.Address3 string

The formatted Address 3 line of the input address.

Address4
AddressInfo.Address4 string

The formatted Address 4 line of the input address.

Address5
AddressInfo.Address5 string

The formatted Address 5 line of the input address.

Address6
AddressInfo.Address6 string

The formatted Address 6 line of the input address.

Address7
AddressInfo.Address7 string

The formatted Address 7 line of the input address.

Address8
AddressInfo.Address8 string

The formatted Address 8 line of the input address.

Locality
AddressInfo.Locality string

The preferred English name of the locality, such as a City, Town or other type of Municipality. Can also be an AdministrativeArea.

AdministrativeArea
AddressInfo.AdministrativeArea string

The preferred English name of the administrative division of the country, such as a State, Region, Province, County, Territory or Prefecture.

PostalCode
AddressInfo.PostalCode string

Represents the standardized postal code.

Country
AddressInfo.Country string

The preferred english name of the country. This field will always be returned unless an error is returned.

CountryISO2
AddressInfo.CountryISO2 string

Represents the ISO 3166-1 Alpha-2 Country Code. This field will always be returned unless an error is returned.

CountryISO3
AddressInfo.CountryISO3 string

Represents the ISO 3166-1 Alpha-3 Country Code. This field will always be returned unless an error is returned.

InformationComponents
AddressInfo.InformationComponents array of object

An array of key value pairs that contain additional fields and information not defined in the original output schema of the API.

Name
AddressInfo.InformationComponents.Name string

Name

Value
AddressInfo.InformationComponents.Value string

Value

Type
Error.Type string

Type

TypeCode
Error.TypeCode string

TypeCode

Desc
Error.Desc string

Desc

DescCode
Error.DescCode string

DescCode

Debug
Debug string

Debug

DOTS Address Validation USA 3- GetBestMatches

Returns parsed and validated address elements including Delivery Point Validation (DPV), Residential Delivery Indicator (RDI), and Suite data. GetBestMatches will attempt to validate the input address against a CASS approved engine, and make corrections where possible. Multiple address candidates may be returned if a definitive decision cannot be made by the service.

Parameters

Name Key Required Type Description
BusinessName
BusinessName string

Name of business associated with this address

Address
Address string

Address line of the address to validate

Address2
Address2 string

This line is for address information that does not contribute to DPV coding an address

City
City string

The city of the address to validate

State
State string

The state of the address to validate

PostalCode
PostalCode string

The zip code of the address to validate

Returns

Name Path Type Description
Addresses
Addresses array of object

The corrected address candidates.

Address1
Addresses.Address1 string

The corrected address line 1.

Address2
Addresses.Address2 string

The corrected address line 2.

City
Addresses.City string

The corrected city name.

State
Addresses.State string

The corrected state name.

Zip
Addresses.Zip string

The corrected zip code + 4.

IsResidential
Addresses.IsResidential string

Indicates if the address is for a residence.

DPV
Addresses.DPV string

Number that correlates to a DPV(Delivery Point Validation) result. An indicator displaying whether or not the address is recognized as deliverable by the USPS

DPVDesc
Addresses.DPVDesc string

Explains DPV result.

DPVNotes
Addresses.DPVNotes string

DPVNoNumber that correlates to DPV notes description. Service Objects may add or change Note descriptions, but will never modify existing codes.tes

DPVNotesDesc
Addresses.DPVNotesDesc string

Details about the DPV result. Service Objects may add or change Note descriptions, but will never modify existing codes.

Corrections
Addresses.Corrections string

Number that correlates to a Corrections Description. Service Objects may add or change Correction descriptions, but will never modify existing codes.

CorrectionsDesc
Addresses.CorrectionsDesc string

Description of what was corrected in an address. Service Objects may add or change Correction descriptions, but will never modify existing codes.

BarcodeDigits
Addresses.BarcodeDigits string

The post office delivery barcode digits

CarrierRoute
Addresses.CarrierRoute string

4 chars: 1 for the route type, 3 for the route code. Identifies a group of addresses when prepended by 5-digit Zip.

CongressCode
Addresses.CongressCode string

The congress code is the congressional district number.

CountyCode
Addresses.CountyCode string

The county code of the given address.

CountyName
Addresses.CountyName string

The name of the county in which the given address lies.

FragmentHouse
Addresses.FragmentHouse string

The parsed house number of the given address.

FragmentPreDir
Addresses.FragmentPreDir string

The parsed pre-directional of the address's street.

FragmentStreet
Addresses.FragmentStreet string

The parsed name of the streen in the given address.

FragmentSuffix
Addresses.FragmentSuffix string

The parsed suffix of the street in the given address

FragmentPostDir
Addresses.FragmentPostDir string

The parsed post-directional of teh address's street.

FragmentUnit
Addresses.FragmentUnit string

The parsed unit type (e.g. 'Apt' or 'Ste')

Fragment
Addresses.Fragment string

The parsed 'Fragment' box, apartment or unit number.

FragmentPMBPrefix
Addresses.FragmentPMBPrefix string

The parsd type of the apartment, box, unit, etc.

FragmentPMBNumber
Addresses.FragmentPMBNumber string

The parsed apartment, box, unit, etc number of the given address.

Type
Error.Type string

Type

TypeCode
Error.TypeCode string

TypeCode

Desc
Error.Desc string

Desc

DescCode
Error.DescCode string

DescCode

IsCASS
IsCASS boolean

Indicates if the unaltered input address is CASS certified. See “What is CASS?” below for more information.

DOTS IP Address Validation - GetLocationByIP_V4

Returns geographic location, proxy, host name and US region information for a given IP address.

Parameters

Name Key Required Type Description
IPAddress
IPAddress string

IP address to look up

Returns

Name Path Type Description
Desc
Error.Desc string

Desc

Location
Error.Location string

Location

Number
Error.Number string

Number

Certainty
Certainty integer

Rating of how accurate the outputs are likely to be.

City
City string

The city location of the IP address.

Region
Region string

The state location of the IP address.

Country
Country string

The country location of the IP address.

CountryISO3
CountryISO3 string

The 3-letter country abbreviation.

CountryISO2
CountryISO2 string

The 2-letter country abbreviation.

PostalCode
PostalCode string

The US postal code of the IP address.

MetroCode
MetroCode string

The numerical metropolitan code for the DMA of the IP address' location.

DMA
DMA string

The Designated Market Area for the location of the IP address.

StateFIPS
StateFIPS string

The state Federal Information Processing Standards code for the IP address. This code is used to uniquely identify states.

CountyFIPS
CountyFIPS string

The County Federal Information Processing Standards code for the location of the IP address. This code is used to uniquely identify counties throughout the US.

Latitude
Latitude number

The latitude coordinate for the IP address.

Longitude
Longitude number

The longitude coordinate for the IP address.

IsProxy
IsProxy string

Indicates whether the IP address is a known proxy.

ProxyType
ProxyType string

Indicates the type of proxy.

PossibleMobileDevice
PossibleMobileDevice string

Indicates if the IP address is believed to be used by mobile devices.

ISP
ISP string

The ISP which assigns the IP address.

NetblockOwner
NetblockOwner string

The network owner to which the IP address is allocated

HostNames
HostNames string

The host name associated with the IP address. If more than one host name is found then the names will be returned a comma delimited list. Will return if no host names are found.

IPNoteCodes
IPNoteCodes string

Displays additional notes about the IP that were found during the validation process. Returns zero or more numerical note codes in a comma-separated list.

IPNotes
IPNotes string

Contains the note flag(s) that corresponds to the Notes Codes. Returns zero or more notes flags in a comma-separated list.

Debug
Debug string

Debug

DOTS Lead Validation International - ValidateLeadInternational

DOTS Lead Validation International (LVI) evaluates international lead data and scores the data quality into pass/fail/review categories. By evaluating the information quality of a contact, online marketers can more effectively weed-out fraudulent contacts.Online fraudsters are more likely to provide inaccurate contact information because the address and phone number can be easily traced. Unlike other validation services that perform simple data checks on single variables, Service Objects Lead Validation solution is able to cross-validate that a contact's name, address, phone numbers, e-mail and IP address are all matched each other and are related to the consumer.

Parameters

Name Key Required Type Description
FullName
FullName string

The contact's full name

Salutation
Salutation string

Salutation of the contact

FirstName
FirstName string

First name of the contact

LastName
LastName string

Last name of the contact

BusinessName
BusinessName string

The contacts company

BusinessDomain
BusinessDomain string

Website domain associated with the business

BusinessEIN
BusinessEIN string

Represents the Company Tax Number

Address1
Address1 string

The address 1 of the contact or business address

Address2
Address2 string

The address 2 of the contact or business address

Address3
Address3 string

The address 3 of the contact or business address

Address4
Address4 string

The address 4 of the contact or business address

Address5
Address5 string

The address 5 of the contact or business address

Locality
Locality string

The city of the contact's postal address

AdminArea
AdminArea string

The state of the contact's postal address

PostalCode
PostalCode string

The zip code of the contact's postal address

Country
Country string

The Country to be validated using provided phone number

Phone1
Phone1 string

The contact's primary phone number

Phone2
Phone2 string

The contact's secondary phone number

Email
Email string

The contact's email address

IPAddress
IPAddress string

The contact's IP address in IPv4

Gender
Gender string

Male, Female or Neutral

DateOfBirth
DateOfBirth string

The contact's date of birth

UTCCaptureTime
UTCCaptureTime string

The time the lead was submitted

OutputLanguage
OutputLanguage string

The language some of the output information will be

TestType
TestType string

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

Returns

Name Path Type Description
OverallCertainty
OverallCertainty string

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

OverallQuality
OverallQuality string

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

LeadType
LeadType string

Indicates the classification that the service made for the lead.

LeadCountry
LeadCountry string

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

NoteCodes
NoteCodes string

Enumerated list of descriptive notes.

NoteDesc
NoteDesc string

Descriptions that correspond to the NoteCodes section.

NameCertainty
NameCertainty string

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

NameQuality
NameQuality string

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

FirstNameLatin
FirstNameLatin string

The first name of the lead without diacritic characters.

LastNameLatin
LastNameLatin string

The last name of the lead without diacritic characters.

FirstName
FirstName string

The first name with diacritic characters.

LastName
LastName string

The last name with diacritic characters.

NameNoteCodes
NameNoteCodes string

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

NameNoteDesc
NameNoteDesc string

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

AddressCertainty
AddressCertainty string

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

AddressQuality
AddressQuality string

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

AddressResolutionLevel
AddressResolutionLevel string

The resolution of the address.

AddressLine1
AddressLine1 string

The validated Address line 1.

AddressLine2
AddressLine2 string

The validated Address line 2.

AddressLine3
AddressLine3 string

The validated Address line 3.

AddressLine4
AddressLine4 string

The validated Address line 4.

AddressLine5
AddressLine5 string

The validated Address line 5.

AddressLocality
AddressLocality string

The locality associated with the given input address. Usually corresponds to the city.

AddressAdminArea
AddressAdminArea string

The Admin Area tied with the input address. Usually corresponds to the State or Province.

AddressPostalCode
AddressPostalCode string

The Postal Code tied to the given input address.

AddressCountry
AddressCountry string

2 Character ISO code for the country.

AddressNoteCodes
AddressNoteCodes string

Enumerated list of codes indicating additional information about the given address.

AddressNoteDesc
AddressNoteDesc string

Enumerated list of descriptive notes that are associated with the AddressNoteCodes field.

EmailCertainty
EmailCertainty string

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

EmailQuality
EmailQuality string

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

EmailCorrected
EmailCorrected string

The email used for testing including any corrections that were made.

EmailNoteCodes
EmailNoteCodes string

Enumerated list of codes indicating additional information about the given email address.

EmailNoteDesc
EmailNoteDesc string

List of descriptions associated with the EmailNoteCodes field.

IPCertainty
IPCertainty string

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

IPQuality
IPQuality string

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

IPLocality
IPLocality string

The locality associated with the given IP address.

IPAdminArea
IPAdminArea string

Administrative area associated with the given IP address.

IPCountry
IPCountry string

Country ISO 2 code associated with the given IP address.

IPNoteCodes
IPNoteCodes string

Enumerated list of codes indicating additional information about the given IP address.

IPNoteDesc
IPNoteDesc string

Descriptions associated with the IPNoteCodes that indicate additional information about a given IP address.

Phone1Certainty
Phone1Certainty string

Score between 0 and 100 that indicates the validity of the phone number in the Phone1 field.

Phone1Quality
Phone1Quality string

A field indicating whether the Phone1 input should be rejected, reviewed or accepted.

Phone1Locality
Phone1Locality string

Locality associated with the given phone number.

Phone1AdminArea
Phone1AdminArea string

The administrative area associated with the given phone number.

Phone1Country
Phone1Country string

The Country ISO 2 code associated with the given phone number in the Phone1 field.

Phone1NoteCodes
Phone1NoteCodes string

Enumerated list of codes indicating additional information about the given phone 1.

Phone1NoteDesc
Phone1NoteDesc string

Descriptions that correlate with the codes given in the Note Codes field.

Phone2Certainty
Phone2Certainty string

Score between 0 and 100 that indicates the validity of the number given in the Phone2 field.

Phone2Quality
Phone2Quality string

A field indicating whether the Phone2 input should be rejected, reviewed or accepted.

Phone2Locality
Phone2Locality string

Locality associated with the given Phone Number.

Phone2AdminArea
Phone2AdminArea string

The administrative area associated with the given phone number.

Phone2Country
Phone2Country string

The Country ISO 2 code associated with the given phone number in the Phone2 field.

Phone2NoteCodes
Phone2NoteCodes string

Enumerated list of codes indicating additional information about the given phone 2.

Phone2NoteDesc
Phone2NoteDesc string

Descriptions that correlate with the codes given in the Note Codes field.

Name
PhoneContact.Name string

The contact's full name.

Address
PhoneContact.Address string

The contact's postal address.

City
PhoneContact.City string

The city of the contact's postal address.

State
PhoneContact.State string

The state of the contact's postal address.

Zip
PhoneContact.Zip string

The zip code of the contact's postal address.

Type
PhoneContact.Type string

The contacts phone type.

BusinessCertainty
BusinessCertainty string

Score between 0 and 100 that indicates the validity of the BusinessName.

BusinessQuality
BusinessQuality string

A field indicating whether the Business Name input should be rejected, reviewed or accepted.

BusinessName
BusinessName string

The provided business name.

BusinessDomain
BusinessDomain string

The website domain associated with the business.

BusinessEmail
BusinessEmail string

The business email.

BusinessNoteCodes
BusinessNoteCodes string

Enumerated list of codes indicating additional information about the given Business Name.

BusinessNoteDesc
BusinessNoteDesc string

Descriptions that correlate with the codes given in the note codes field.

InformationComponents
InformationComponents array of object

An array of key value pairs that contain additional fields and information not defined in the original output schema of the API.

Name
InformationComponents.Name string

Name

Value
InformationComponents.Value string

Value

Type
Error.Type string

Type

TypeCode
Error.TypeCode string

TypeCode

Desc
Error.Desc string

Desc

DescCode
Error.DescCode string

DescCode

DEBUG
DEBUG string

DEBUG

DOTS Phone Exchange International - GetInternationalExchangeInfo

Our international Phone Exchange service validates and formats phone numbers for international direct dialing, while returning line type, country code and geocoding information.

Parameters

Name Key Required Type Description
PhoneNumber
PhoneNumber string

The phone number to be parsed, validated and formatted

Country
Country string

The Country to be validated using provided phone number

Returns

Name Path Type Description
NumberIn
InternationalExchangeInfo.NumberIn string

The phone number that was provided as input.

CountryCode
InternationalExchangeInfo.CountryCode string

The country code of the provided phone number.

FormatNational
InternationalExchangeInfo.FormatNational string

The provided phone number in a national format.

Extension
InternationalExchangeInfo.Extension string

The parsed extension from the provided phone number.

Locality
InternationalExchangeInfo.Locality string

The locality from where the phone number belongs. The locality format is generally Locale/Region, Region or Country.

LocalityMatchLevel
InternationalExchangeInfo.LocalityMatchLevel string

The match level that was determined from the locality that was found. Possible values include (Locale/Region, Region, Country) match.

TimeZone
InternationalExchangeInfo.TimeZone string

The Time Zone of the validated phone number.

Latitude
InternationalExchangeInfo.Latitude string

The latitude of the locality determined from the phone number.

Longitude
InternationalExchangeInfo.Longitude string

The longitude of the locality determined from the phone number.

Country
InternationalExchangeInfo.Country string

The country to which the validated phone number belongs.

CountryISO2
InternationalExchangeInfo.CountryISO2 string

The ISO 2 character country designation for a validated phone number.

CountryISO3
InternationalExchangeInfo.CountryISO3 string

The ISO 3 character country designation for a validated phone number.

FormatInternational
InternationalExchangeInfo.FormatInternational string

The provided phone number in international format.

FormatE164
InternationalExchangeInfo.FormatE164 string

The provided phone number in E.164 format.

Carrier
InternationalExchangeInfo.Carrier string

the carrier determined for the phone number.

LineType
InternationalExchangeInfo.LineType string

The linetype determined for the phone number. See InternationalExchangeInfo LineType table below.

SMSAddress
InternationalExchangeInfo.SMSAddress string

The SMS gateway address for the provided mobile number.

MMSAddress
InternationalExchangeInfo.MMSAddress string

The MMS gateway address for the provided mobile number.

IsValid
InternationalExchangeInfo.IsValid boolean

A boolean response type determining whether the phone number is a valid phone number.

IsValidForRegion
InternationalExchangeInfo.IsValidForRegion boolean

A boolean response type determining whether the phone number is a valid phone number for the provided Country.

NoteCodes
InternationalExchangeInfo.NoteCodes string

The corresponding codes which match NoteDescriptions. These values vary from 1 to 6 based on test results.

NoteDescriptions
InternationalExchangeInfo.NoteDescriptions string

The corresponding descriptions which match NoteCodes. These values vary based on NoteCodes.

Type
Error.Type string

Type

TypeCode
Error.TypeCode string

TypeCode

Desc
Error.Desc string

Desc

DescCode
Error.DescCode string

DescCode

Debug
Debug array of string

Debug