Enrichment
Get
Gets enriched address suggestions.
|
|
Parameters
Name | Type | Description |
---|---|---|
criteria | EnrichedAddressGetCriteria | Criterial for available search parameters. |
Returns
Promise.<Array.<EnrichedAddress>>
Examples
|
|
Get
Gets enriched profile data.
|
|
Parameters
Name | Type | Description |
---|---|---|
string |
Email address associated with the profile. |
Returns
Promise.<EnrichedProfile>
Examples
|
|
Types
EnrichedAddress
Properties
Property | Type | Description |
---|---|---|
addressLine1 | string |
|
addressLine2 | string |
|
city | string |
|
stateOrProvince | string |
|
postalCode | string |
|
entries | number |
EnrichedAddressGetCriteria
Properties
Property | Type | Description |
---|---|---|
search | string |
Partial or complete address to search. |
maxResults | number |
Optional Maximum number of results to return. |
includeCities | string |
Optional Limits results to a list of given cities. Example: “chicago;honolulu;portland” |
includeStates | string |
Optional Limits results to a list of given states. Example: “illinois;hawaii;oregon” |
includeZipcodes | string |
Optional Limits results to a list of given zipcodes. Example: “60412;96818;97209” |
excludeStates | string |
Optional Exclude list of states from results. No include pararmeters may be used with this parameter. Example: “AZ;WA;SC” |
preferCities | string |
Optional Display results with the listed cities at the top. Example: “denver;aurora;omaha” |
preferStates | string |
Optional Display results with the listed states at the top. Example: “CO;MN;WI” |
preferZipcodes | string |
Optional Display results with the listed zipcodes at the top. Example: “60412;96818;97209” |
preferRatio | number |
Optional Specifies the percentage of address suggestions that should be preferred and will appear at the top of the results. |
preferGeolocation | none , city |
Optional If omitted or set to city it uses the sender’s IP address to determine location, then automatically adds the city and state to the preferCities value. This parameter takes precedence over other include or exclude parameters meaning that if it is not set to none you may see addresses from areas you do not wish to see. Example: “city” |
selected | string |
Optional Useful for narrowing results with addressLine2 suggestions such as Apt (denotes an apartment building with multiple residences). Example: “Apt” |
source | all , postal |
Optional Include results from alternate data sources. Allowed values are – all (non-postal addresses) or postal (postal addresses only). |
EnrichedProfile
Properties
Property | Type | Description |
---|---|---|
individual | EnrichedIndividualProfile | Describes a person |
business | EnrichedBusinessProfile | Describes a company |
EnrichedBusinessProfile
Properties
Property | Type | Description |
---|---|---|
legalBusinessName | string |
|
address | EnrichedProfileAddress | |
string |
||
phone | EnrichedProfilePhone | |
industryCodes | EnrichedProfileIndustry | Describes industry specific identifiers |
website | string |
EnrichedIndividualProfile
Properties
Property | Type | Description |
---|---|---|
name | EnrichedProfileName | |
string |
||
address | EnrichedProfileAddress |
EnrichedProfileAddress
Properties
Property | Type | Description |
---|---|---|
addressLine1 | string |
|
addressLine2 | string |
|
city | string |
|
stateOrProvince | string |
|
postalCode | string |
|
country | string |
EnrichedProfileIndustry
Properties
Property | Type | Description |
---|---|---|
naics | string |
|
sic | string |
EnrichedProfileName
Properties
Property | Type | Description |
---|---|---|
firstName | string |
|
middleName | string |
|
lastName | string |
|
suffix | string |
EnrichedProfilePhone
Properties
Property | Type | Description |
---|---|---|
number | string |
|
countryCode | string |