Skip to main content
POST
/
Cleansing
/
International
/
Batch
/
v1.10
/
json6.ws
cURL
curl --request POST \
  --url https://api.addressy.com/Cleansing/International/Batch/v1.10/json6.ws \
  --header 'Content-Type: application/json' \
  --data '{
  "Key": "<string>",
  "GeoCode": false,
  "Addresses": [
    {
      "Latitude": "",
      "Longitude": "",
      "Address": "",
      "Address1": "",
      "Address2": "",
      "Address3": "",
      "Address4": "",
      "Address5": "",
      "Address6": "",
      "Address7": "",
      "Address8": "",
      "DeliveryAddress": "",
      "DeliveryAddress1": "",
      "DeliveryAddress2": "",
      "DeliveryAddress3": "",
      "DeliveryAddress4": "",
      "DeliveryAddress5": "",
      "DeliveryAddress6": "",
      "DeliveryAddress7": "",
      "DeliveryAddress8": "",
      "Id": "",
      "SuperAdministrativeArea": "",
      "AdministrativeArea": "",
      "SubAdministrativeArea": "",
      "Locality": "",
      "DependentLocality": "",
      "DoubleDependentLocality": "",
      "Thoroughfare": "",
      "DependentThoroughfare": "",
      "Building": "",
      "Premise": "",
      "SubBuilding": "",
      "SubBuildingFloor": "",
      "PostalCode": "",
      "Organization": "",
      "PostBox": "",
      "Country": "",
      "Contact": "",
      "Function": "",
      "Department": ""
    }
  ],
  "Options": {
    "ServerOptions": {
      "CassAvcEnable": "YES",
      "CassUrbFirst": "YES",
      "CassZipFields": "YES",
      "CassCityAbbreviation": "YES",
      "MaxResults": "",
      "MinimumMatchscore": "0",
      "MinimumVerificationLevel": "0",
      "AddressLineSeparator": "<br>",
      "MinimumSimilarity": "70",
      "SuppressAddressFields": "",
      "SuppressAdditionFields": "",
      "SuppressFields": "",
      "CombinedSearchMethods": "YES",
      "MinimumGeoAccuracyLevel": "0",
      "MaximumGeoDistance": "-1",
      "OutputScript": "Latn",
      "OutputCasing": "Title",
      "EnhancedCountryTool": "ON",
      "CertifiedCountryList": "",
      "DefaultCountry": "",
      "CountryFields": "Country",
      "FieldNameWeight": "",
      "ForceCountry": "",
      "MatchScoreAbsoluteThreshold": "60",
      "MatchScoreThresholdFactor": "95",
      "OutputAddressFormat": "YES",
      "TransliterationIgnoreFields": "ID,ISO3166-2,ISO3166-3,_L,Latitude,Longitude,GeoAccuracy,GeoDistance,AVC",
      "ToolInfo": "YES",
      "UseSymbolicTransliteration": "YES",
      "DuplicateHandlingMask": "",
      "NativeAddressLineReverse": "",
      "SimpleParse": "YES",
      "ReturnVerifiedFieldsOnly": "No",
      "FieldStatus": "true",
      "IgnoreUnmatched": "YES",
      "MinimumPostcode": "0",
      "SuppressUnmatched": "ON",
      "OutputSortType": "Alphabetical",
      "RangeDecompose": "Match",
      "PreferPrimaryValidAlias": "YES",
      "ReferenceDatasetCacheSize": "5"
    },
    "Version": false,
    "Certify": false,
    "Enhance": false,
    "Process": "Verify"
  }
}'
[
  {
    "Input": {
      "Latitude": "<string>",
      "Longitude": "<string>",
      "Address": "<string>",
      "Address1": "<string>",
      "Address2": "<string>",
      "Address3": "<string>",
      "Address4": "<string>",
      "Address5": "<string>",
      "Address6": "<string>",
      "Address7": "<string>",
      "Address8": "<string>",
      "DeliveryAddress": "<string>",
      "DeliveryAddress1": "<string>",
      "DeliveryAddress2": "<string>",
      "DeliveryAddress3": "<string>",
      "DeliveryAddress4": "<string>",
      "DeliveryAddress5": "<string>",
      "DeliveryAddress6": "<string>",
      "DeliveryAddress7": "<string>",
      "DeliveryAddress8": "<string>",
      "Id": "<string>",
      "SuperAdministrativeArea": "<string>",
      "AdministrativeArea": "<string>",
      "SubAdministrativeArea": "<string>",
      "Locality": "<string>",
      "DependentLocality": "<string>",
      "DoubleDependentLocality": "<string>",
      "Thoroughfare": "<string>",
      "DependentThoroughfare": "<string>",
      "Building": "<string>",
      "Premise": "<string>",
      "SubBuilding": "<string>",
      "SubBuildingFloor": "<string>",
      "PostalCode": "<string>",
      "Organization": "<string>",
      "PostBox": "<string>",
      "Country": "<string>",
      "Contact": "<string>",
      "Function": "<string>",
      "Department": "<string>"
    },
    "Matches": [
      "<any>"
    ],
    "Version": "<string>"
  }
]
To enable the best customer experience, the recommendation is to send batches of less than 100 records which are homogenous in terms of the location. Grouping the requests into countries enables the Verify engine to manage its resources more effectively.
We don’t support API connections using HTTP - all calls should use HTTPS.

Body

application/json
​
Addresses
object[]
required

An array of addresses that you want to verify. The country field must contain a valid ISO2 or ISO3 country code. We recommend that you use the structured fields (i.e. building/thoroughfare etc) over the address line input fields if the data you are cleansing is already structured. The list of available input address fields are the 'Primary Address Fields' listed here.

​
Key
string
default:AA11-AA11-AA11-AA11
required

The key you want to use to authenticate with the service (you can request we create one for you or create one in your account section.

​
GeoCode
boolean
default:false

Whether you want geo-coordinates to be appended to your results (if available). There is an additional cost associated with enabling this option.

​
Options
object

Used to specify various options and override processes.

Response

Success

​
Input
object
​
Matches
object[] | null
​
Version
string | null