Loqate

Developer API  |  Data Cleanse  |  International Batch Cleanse

International Batch Cleanse

Cleanses a batch of up to 1,000 international addresses.

Request parameters

Each request to the web service requires a number of parameters, all of which are listed below. All requests require a key which can be generated in your account.

Name Description
Key
Required
The key you want to use to autheticate with the service (you can request we create one for you or create one in your account section)
Geocode Whether you want geo-coordinates to be appended to your results (if available). There is an additional cost associated with enabling this option.
Addresses
Required
An array of up to 1,000 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.
Options
Object
Used to specify various options and override processes. Comprised of the following:
  • Process (string) - Loqate Process to run. Valid Values: Verify | Search
  • Version (boolean) - Return Loqate engine version with request.
  • Certify (boolean) - Use certified data set. AMAS (AU), CASS (US) or SERP (CA).
  • Enhance (boolean) - Use enhanced dataset. Returns enhance fields if applicable.
  • ServerOptions (object) - Properties are OptionName and value is OptionValue. More info can be found here. If status fields are required, you can set FieldStatus: true in the ServerOptions object to return them.
   

Back to top

Response Fields


Name Descrition
Input A copy of the address that you input in the request "Addresses" array.
Matches An array of matched records including:
  • AVC - See Address Verification Code.
  • AQI - See Address Quality Index.
  • Address elements - The cleansed address elements (ordered address lines and each structured address element returned for each match).
  • Latitude/Longitude - The latitude & longitude of the address (if available)
  • GeoAccuracy - See GeoAccuracy code

Back to top

Example Request

POST https://api.addressy.com/Cleansing/International/Batch/v1.00/json4.ws
Content-Type: application/json

{
    "Key": "AA11-AA11-AA11-AA11",
    "Geocode":true,
    "Addresses": [  
       {  
          "Address":"",
          "Address1":"Sageweg 27",
          "Address2":"Neuenburg",
          "Address3":"79395",
          "Address4":"",
          "Address5":"",
          "Address6":"",
          "Address7":"",
          "Address8":"",
          "Country":"DEU",
          "SuperAdministrativeArea":"",
          "AdministrativeArea":"Baden-Württemberg",
          "SubAdministrativeArea":"",
          "Locality":"",
          "DependentLocality":"",
          "DoubleDependentLocality":"",
          "Thoroughfare":"",
          "DependentThoroughfare":"",
          "Building":"",
          "Premise":"",
          "SubBuilding":"",
          "PostalCode":"79395",
          "Organization":"",
          "PostBox":""
       },
       {  
          "Address":"",
          "Address1":"Schubartstr. 111",
          "Address2":"Bietigheim-Bissingen",
          "Address3":"74321",
          "Address4":"",
          "Address5":"",
          "Address6":"",
          "Address7":"",
          "Address8":"",
          "Country":"DEU",
          "SuperAdministrativeArea":"",
          "AdministrativeArea":"Baden-Württemberg",
          "SubAdministrativeArea":"",
          "Locality":"",
          "DependentLocality":"",
          "DoubleDependentLocality":"",
          "Thoroughfare":"",
          "DependentThoroughfare":"",
          "Building":"",
          "Premise":"",
          "SubBuilding":"",
          "PostalCode":"74321",
          "Organization":"",
          "PostBox":""
       },
       {  
          "Address":"",
          "Address1":"Seckacher Strasse 23",
          "Address2":"Osterburken-Schlierstadt",
          "Address3":"74706",
          "Address4":"",
          "Address5":"",
          "Address6":"",
          "Address7":"",
          "Address8":"",
          "Country":"DEU",
          "SuperAdministrativeArea":"",
          "AdministrativeArea":"Baden-Württemberg",
          "SubAdministrativeArea":"",
          "Locality":"",
          "DependentLocality":"",
          "DoubleDependentLocality":"",
          "Thoroughfare":"",
          "DependentThoroughfare":"",
          "Building":"",
          "Premise":"",
          "SubBuilding":"",
          "PostalCode":"74706",
          "Organization":"",
          "PostBox":""
       },
       {  
          "Address":"",
          "Address1":"Anna-Selzer-Strasse 11",
          "Address2":"Angelbachtal",
          "Address3":"74918",
          "Address4":"",
          "Address5":"",
          "Address6":"",
          "Address7":"",
          "Address8":"",
          "Country":"DEU",
          "SuperAdministrativeArea":"",
          "AdministrativeArea":"Baden-Württemberg",
          "SubAdministrativeArea":"",
          "Locality":"",
          "DependentLocality":"",
          "DoubleDependentLocality":"",
          "Thoroughfare":"",
          "DependentThoroughfare":"",
          "Building":"",
          "Premise":"",
          "SubBuilding":"",
          "PostalCode":"74918",
          "Organization":"",
          "PostBox":""
       },
       {  
          "Address":"",
          "Address1":"Schillerstrasse",
          "Address2":"13",
          "Address3":"Frau",
          "Address4":"",
          "Address5":"",
          "Address6":"",
          "Address7":"",
          "Address8":"",
          "Country":"DEU",
          "SuperAdministrativeArea":"",
          "AdministrativeArea":"Baden-Württemberg",
          "SubAdministrativeArea":"",
          "Locality":"",
          "DependentLocality":"",
          "DoubleDependentLocality":"",
          "Thoroughfare":"",
          "DependentThoroughfare":"",
          "Building":"",
          "Premise":"",
          "SubBuilding":"",
          "PostalCode":"79331",
          "Organization":"",
          "PostBox":""
       },
       {  
          "Address":"",
          "Address1":"Hockenheimerstr 43",
          "Address2":"Reilingen",
          "Address3":"Baden Wurtemberg",
          "Address4":"",
          "Address5":"",
          "Address6":"",
          "Address7":"",
          "Address8":"",
          "Country":"DEU",
          "SuperAdministrativeArea":"",
          "AdministrativeArea":"Baden-Württemberg",
          "SubAdministrativeArea":"",
          "Locality":"",
          "DependentLocality":"",
          "DoubleDependentLocality":"",
          "Thoroughfare":"",
          "DependentThoroughfare":"",
          "Building":"",
          "Premise":"",
          "SubBuilding":"",
          "PostalCode":"68799",
          "Organization":"",
          "PostBox":""
       },
       {  
          "Address":"",
          "Address1":"Am Ottersberg",
          "Address2":"42",
          "Address3":"Grunkraut",
          "Address4":"",
          "Address5":"",
          "Address6":"",
          "Address7":"",
          "Address8":"",
          "Country":"DEU",
          "SuperAdministrativeArea":"",
          "AdministrativeArea":"Baden-Württemberg",
          "SubAdministrativeArea":"",
          "Locality":"",
          "DependentLocality":"",
          "DoubleDependentLocality":"",
          "Thoroughfare":"",
          "DependentThoroughfare":"",
          "Building":"",
          "Premise":"",
          "SubBuilding":"",
          "PostalCode":"88287",
          "Organization":"",
          "PostBox":""
       }
    ]
}

    

Back to top

Example Response

[
  {
    "Input": {
      "Address": "",
      "Address1": "Sageweg 27",
      "Address2": "Neuenburg",
      "Address3": "79395",
      "Address4": "",
      "Address5": "",
      "Address6": "",
      "Address7": "",
      "Address8": "",
      "Country": "DEU",
      "SuperAdministrativeArea": "",
      "AdministrativeArea": "Baden-Württemberg",
      "SubAdministrativeArea": "",
      "Locality": "",
      "DependentLocality": "",
      "DoubleDependentLocality": "",
      "Thoroughfare": "",
      "DependentThoroughfare": "",
      "Building": "",
      "Premise": "",
      "SubBuilding": "",
      "PostalCode": "79395",
      "Organization": "",
      "PostBox": ""
    },
    "Matches": [{
      "AVC": "V44-I44-P6-100",
      "AQI": "A",
      "Organization": "",
      "SubBuilding": "",
      "Premise": "27",
      "Building": "",
      "PostBox": "",
      "DependentThoroughfare": "",
      "Thoroughfare": "Sägeweg",
      "DoubleDependentLocality": "",
      "DependentLocality": "",
      "Locality": "Neuenburg A. Rhein",
      "SubAdministrativeArea": "Reg.-Bez. Freiburg",
      "AdministrativeArea": "Baden-Württemberg",
      "SuperAdministrativeArea": "",
      "PostalCode": "79395",
      "Telephone": "",
      "Country": "DEU",
      "CountryName": "Germany",
      "Latitude": "47.807820",
      "Longitude": "7.569160",
      "GeoAccuracy": "P4",
      "Address": "Sägeweg 27
79395 Neuenburg A. Rhein", "Address1": "Sageweg 27", "Address2": "Neuenburg", "Address3": "79395", "Address4": "", "Address5": "", "Address6": "", "Address7": "", "Address8": "" }] }, { "Input": { "Address": "", "Address1": "Schubartstr. 111", "Address2": "Bietigheim-Bissingen", "Address3": "74321", "Address4": "", "Address5": "", "Address6": "", "Address7": "", "Address8": "", "Country": "DEU", "SuperAdministrativeArea": "", "AdministrativeArea": "Baden-Württemberg", "SubAdministrativeArea": "", "Locality": "", "DependentLocality": "", "DoubleDependentLocality": "", "Thoroughfare": "", "DependentThoroughfare": "", "Building": "", "Premise": "", "SubBuilding": "", "PostalCode": "74321", "Organization": "", "PostBox": "" }, "Matches": [{ "AVC": "V44-I44-P6-100", "AQI": "A", "Organization": "", "SubBuilding": "", "Premise": "111", "Building": "", "PostBox": "", "DependentThoroughfare": "", "Thoroughfare": "Schubartstr.", "DoubleDependentLocality": "", "DependentLocality": "Bissingen", "Locality": "Bietigheim-Bissingen", "SubAdministrativeArea": "Reg.-Bez. Stuttgart", "AdministrativeArea": "Baden-Württemberg", "SuperAdministrativeArea": "", "PostalCode": "74321", "Telephone": "", "Country": "DEU", "CountryName": "Germany", "Latitude": "48.942220", "Longitude": "9.106600", "GeoAccuracy": "P4", "Address": "Schubartstr. 111
74321 Bietigheim-Bissingen", "Address1": "Schubartstr. 111", "Address2": "Bietigheim-Bissingen", "Address3": "74321", "Address4": "", "Address5": "", "Address6": "", "Address7": "", "Address8": "" }] }, { "Input": { "Address": "", "Address1": "Seckacher Strasse 23", "Address2": "Osterburken-Schlierstadt", "Address3": "74706", "Address4": "", "Address5": "", "Address6": "", "Address7": "", "Address8": "", "Country": "DEU", "SuperAdministrativeArea": "", "AdministrativeArea": "Baden-Württemberg", "SubAdministrativeArea": "", "Locality": "", "DependentLocality": "", "DoubleDependentLocality": "", "Thoroughfare": "", "DependentThoroughfare": "", "Building": "", "Premise": "", "SubBuilding": "", "PostalCode": "74706", "Organization": "", "PostBox": "" }, "Matches": [{ "AVC": "P33-I35-P6-100", "AQI": "B", "Organization": "", "SubBuilding": "23", "Premise": "", "Building": "Osterburken", "PostBox": "", "DependentThoroughfare": "", "Thoroughfare": "Seckacher Str.", "DoubleDependentLocality": "", "DependentLocality": "Schlierstadt", "Locality": "Osterburken", "SubAdministrativeArea": "Reg.-Bez. Karlsruhe", "AdministrativeArea": "Baden-Württemberg", "SuperAdministrativeArea": "", "PostalCode": "74706", "Telephone": "", "Country": "DEU", "CountryName": "Germany", "Latitude": "49.454156", "Longitude": "9.363863", "GeoAccuracy": "A3", "Address": "Osterburken 23
Seckacher Str.
74706 Osterburken", "Address1": "Seckacher Strasse 23", "Address2": "Osterburken-Schlierstadt", "Address3": "74706", "Address4": "", "Address5": "", "Address6": "", "Address7": "", "Address8": "" }] }, { "Input": { "Address": "", "Address1": "Anna-Selzer-Strasse 11", "Address2": "Angelbachtal", "Address3": "74918", "Address4": "", "Address5": "", "Address6": "", "Address7": "", "Address8": "", "Country": "DEU", "SuperAdministrativeArea": "", "AdministrativeArea": "Baden-Württemberg", "SubAdministrativeArea": "", "Locality": "", "DependentLocality": "", "DoubleDependentLocality": "", "Thoroughfare": "", "DependentThoroughfare": "", "Building": "", "Premise": "", "SubBuilding": "", "PostalCode": "74918", "Organization": "", "PostBox": "" }, "Matches": [{ "AVC": "V44-I44-P6-100", "AQI": "A", "Organization": "", "SubBuilding": "", "Premise": "11", "Building": "", "PostBox": "", "DependentThoroughfare": "", "Thoroughfare": "Anna-Selzer-Str.", "DoubleDependentLocality": "", "DependentLocality": "", "Locality": "Angelbachtal", "SubAdministrativeArea": "Reg.-Bez. Karlsruhe", "AdministrativeArea": "Baden-Württemberg", "SuperAdministrativeArea": "", "PostalCode": "74918", "Telephone": "", "Country": "DEU", "CountryName": "Germany", "Latitude": "49.233090", "Longitude": "8.769230", "GeoAccuracy": "P4", "Address": "Anna-Selzer-Str. 11
74918 Angelbachtal", "Address1": "Anna-Selzer-Strasse 11", "Address2": "Angelbachtal", "Address3": "74918", "Address4": "", "Address5": "", "Address6": "", "Address7": "", "Address8": "" }] }, { "Input": { "Address": "", "Address1": "Schillerstrasse", "Address2": "13", "Address3": "Frau", "Address4": "", "Address5": "", "Address6": "", "Address7": "", "Address8": "", "Country": "DEU", "SuperAdministrativeArea": "", "AdministrativeArea": "Baden-Württemberg", "SubAdministrativeArea": "", "Locality": "", "DependentLocality": "", "DoubleDependentLocality": "", "Thoroughfare": "", "DependentThoroughfare": "", "Building": "", "Premise": "", "SubBuilding": "", "PostalCode": "79331", "Organization": "", "PostBox": "" }, "Matches": [{ "AVC": "P33-I35-P6-100", "AQI": "B", "Organization": "", "SubBuilding": "13", "Premise": "", "Building": "Frau", "PostBox": "", "DependentThoroughfare": "", "Thoroughfare": "Schillerstr.", "DoubleDependentLocality": "", "DependentLocality": "", "Locality": "Teningen", "SubAdministrativeArea": "Reg.-Bez. Freiburg", "AdministrativeArea": "Baden-Württemberg", "SuperAdministrativeArea": "", "PostalCode": "79331", "Telephone": "", "Country": "DEU", "CountryName": "Germany", "Latitude": "48.125054", "Longitude": "7.812914", "GeoAccuracy": "A3", "Address": "Frau 13
Schillerstr.
79331 Teningen", "Address1": "Schillerstrasse", "Address2": "13", "Address3": "Frau", "Address4": "", "Address5": "", "Address6": "", "Address7": "", "Address8": "" }] }, { "Input": { "Address": "", "Address1": "Hockenheimerstr 43", "Address2": "Reilingen", "Address3": "Baden Wurtemberg", "Address4": "", "Address5": "", "Address6": "", "Address7": "", "Address8": "", "Country": "DEU", "SuperAdministrativeArea": "", "AdministrativeArea": "Baden-Württemberg", "SubAdministrativeArea": "", "Locality": "", "DependentLocality": "", "DoubleDependentLocality": "", "Thoroughfare": "", "DependentThoroughfare": "", "Building": "", "Premise": "", "SubBuilding": "", "PostalCode": "68799", "Organization": "", "PostBox": "" }, "Matches": [{ "AVC": "P33-I35-P6-100", "AQI": "B", "Organization": "", "SubBuilding": "43", "Premise": "", "Building": "Reilingen Baden Wurtemberg", "PostBox": "", "DependentThoroughfare": "", "Thoroughfare": "Hockenheimer Str.", "DoubleDependentLocality": "", "DependentLocality": "", "Locality": "Reilingen", "SubAdministrativeArea": "Reg.-Bez. Karlsruhe", "AdministrativeArea": "Baden-Württemberg", "SuperAdministrativeArea": "", "PostalCode": "68799", "Telephone": "", "Country": "DEU", "CountryName": "Germany", "Latitude": "49.296629", "Longitude": "8.569265", "GeoAccuracy": "A3", "Address": "Reilingen Baden Wurtemberg 43
Hockenheimer Str.
68799 Reilingen", "Address1": "Hockenheimerstr 43", "Address2": "Reilingen", "Address3": "Baden Wurtemberg", "Address4": "", "Address5": "", "Address6": "", "Address7": "", "Address8": "" }] }, { "Input": { "Address": "", "Address1": "Am Ottersberg", "Address2": "42", "Address3": "Grunkraut", "Address4": "", "Address5": "", "Address6": "", "Address7": "", "Address8": "", "Country": "DEU", "SuperAdministrativeArea": "", "AdministrativeArea": "Baden-Württemberg", "SubAdministrativeArea": "", "Locality": "", "DependentLocality": "", "DoubleDependentLocality": "", "Thoroughfare": "", "DependentThoroughfare": "", "Building": "", "Premise": "", "SubBuilding": "", "PostalCode": "88287", "Organization": "", "PostBox": "" }, "Matches": [{ "AVC": "V44-I44-P6-100", "AQI": "A", "Organization": "", "SubBuilding": "", "Premise": "42", "Building": "", "PostBox": "", "DependentThoroughfare": "", "Thoroughfare": "Am Ottersberg", "DoubleDependentLocality": "", "DependentLocality": "", "Locality": "Grünkraut", "SubAdministrativeArea": "Reg.-Bez. Tübingen", "AdministrativeArea": "Baden-Württemberg", "SuperAdministrativeArea": "", "PostalCode": "88287", "Telephone": "", "Country": "DEU", "CountryName": "Germany", "Latitude": "47.739000", "Longitude": "9.656560", "GeoAccuracy": "P4", "Address": "Am Ottersberg 42<br />88287 Grünkraut", "Address1": "Am Ottersberg", "Address2": "42", "Address3": "Grunkraut", "Address4": "", "Address5": "", "Address6": "", "Address7": "", "Address8": "" }] } ]

Back to top

Take a trial - no obligation, full support Get started