Address Cleansing Properties
You can use options to configure the Address Cleansing function.
Name | Description |
---|---|
loqateDefaultCountry | This is the default country for Loqate requests, as an ISO 3166-1 alpha-3 code. To find the code for a country, use the ISO Country code search. If not specified, USA is used. |
loqateLicensedCountry | This property defines a list of countries for which the customer is licensed.
|
maxAttributesCombinations | This property defines the limit of possible combinations of attribute
values to be cleansed when the allValues property is
set to true in the inputMapping section of the
cleanseConfig in metadata configuration. |
opts | This property contains a map of options that are passed to Loqate as
the opts parameter.
|
ovOnly | This property is used to send OV values for cleansing using the
ovOnly parameter in the
cleanseFunction section of the tenant configuration.
|
process | This property indicates the process involved in CASS and non-CASS
cleansing. The default process is v+g .
|
returnDataByStatus | This option is used to get cleanse attributes for all locations that
are not verified by the address cleanser. Multiple statuses are
separated using a semicolon ( ;). For example,
"returnDataByStatus": "Partially
Verified;Unverified" . |
returnUnverifiedStatus |
|
splitBuildingDeliveryAddrCheck | This property helps you control the shifting of
Address<n+1> and
DeliveryAddress<n+1> attribute values, when
Building has the same value as
Address1 or DeliveryAddress1 . It
also helps you ensure that Address1 and
DeliveryAddress1 attributes contain valid values.
|
disableAddressShifting |
When set to true, this property disables the address shifting cleanse logic, which shifts the values of Address<n+1> and DeliveryAddress<n+1> to Address<n> and DeliveryAddress<n>, if Address1 and Building attributes are the same in the cleanse response. The default value of the property is false. For example: Consider the following attributes and their values:
Note: Here
Building =Address1 =Rochester
Hills Off Plaza.
POST
Output
|
verificationStatusMapping | This property denotes the verification status from Loqate.
|
ignoreUnverifiedResults | When the value of this property is true (default), the unverified results from CASS, CASS2 and SERP are removed. If it is set to false, then the unverified results from CASS, CASS2 and SERP are not removed, so the AVC,VerificationStatus and VerificationStatusDetails attributes are added to the entity when the value of the returnUnverifiedStatus property is set to true. |
Sample Configuration
{
"cleanseFunction": "Loqate",
"options": {
"returnUnverifiedStatus": "true",
"returnDataByStatus": "Partially Verified;Unverified",
"loqateDefaultCountry": "USA",
"loqateLicensedCountry": "US;us;UNITED STATES;United States;united states;USA;usa;Canada;CA;Australia;AU",
"process": "c+g+pre",
"opts": {
"SuppressAddressFields": [
"Organization",
"Building"
],
"OutputCasing": "Upper",
"StrictReferenceMatch": "Yes"
},
"maxAttributesCombinations": 100
}
}