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": [
      {
        "Latitude": "<string>",
        "Longitude": "<string>",
        "GeoAccuracy": "<string>",
        "GeoDistance": "<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>",
        "CountryName": "<string>",
        "ISO3166-2": "<string>",
        "ISO3166-3": "<string>",
        "ISO3166-N": "<string>",
        "PostalCodePrimary": "<string>",
        "PostalCodeSecondary": "<string>",
        "AddressFormat": "<string>",
        "DeliveryAddressFormat": "<string>",
        "AVC": "<string>",
        "AQI": "<string>",
        "Sequence": "<string>",
        "Contact": "<string>",
        "Function": "<string>",
        "Department": "<string>",
        "Unmatched": "<string>",
        "MatchRuleLabel": "<string>",
        "HyphenClass": "<string>",
        "AdministrativeAreaName": "<string>",
        "AdministrativeAreaTrailingType": "<string>",
        "AdministrativeAreaType": "<string>",
        "LocalityExtra": "<string>",
        "LocalitySpecial": "<string>",
        "LocalityName": "<string>",
        "LocalityType": "<string>",
        "LocalityTrailingType": "<string>",
        "DependentLocalityName": "<string>",
        "DependentLocalityType": "<string>",
        "DependentLocalityLeadingType": "<string>",
        "DoubleDependentLocalityName": "<string>",
        "DoubleDependentLocalityType": "<string>",
        "ThoroughfarePreDirection": "<string>",
        "ThoroughfareType": "<string>",
        "ThoroughfareLeadingType": "<string>",
        "ThoroughfareName": "<string>",
        "ThoroughfareTrailingType": "<string>",
        "ThoroughfarePostDirection": "<string>",
        "DependentThoroughfarePreDirection": "<string>",
        "DependentThoroughfareLeadingType": "<string>",
        "DependentThoroughfareName": "<string>",
        "DependentThoroughfareTrailingType": "<string>",
        "DependentThoroughfarePostDirection": "<string>",
        "BuildingLeadingType": "<string>",
        "BuildingName": "<string>",
        "BuildingType": "<string>",
        "BuildingTrailingType": "<string>",
        "PremiseType": "<string>",
        "PremiseNumber": "<string>",
        "PremiseExtra": "<string>",
        "SubBuildingType": "<string>",
        "SubBuildingLeadingType": "<string>",
        "SubBuildingNumber": "<string>",
        "SubBuildingName": "<string>",
        "SubBuildingBlock": "<string>",
        "SubBuildingDoor": "<string>",
        "SubBuildingStaircase": "<string>",
        "Bolignummer": "<string>",
        "DeliveryInstallationAreaName": "<string>",
        "DeliveryInstallationType": "<string>",
        "DeliveryInstallationQualifierName": "<string>",
        "RouteType": "<string>",
        "RouteNumber": "<string>",
        "BranchName": "<string>",
        "MakaniNumber": "<string>",
        "ShortAddressCode": "<string>",
        "OrganizationName": "<string>",
        "OrganizationType": "<string>",
        "OrganizationTrailingType": "<string>",
        "PostBoxType": "<string>",
        "PostBoxNumber": "<string>",
        "BoxBagLobbyName": "<string>",
        "DPID": "<string>",
        "FloorType": "<string>",
        "FloorNumber": "<string>",
        "LotNumber": "<string>",
        "PostBoxNum": "<string>",
        "PostBoxNumberPrefix": "<string>",
        "PostBoxNumberSuffix": "<string>",
        "PrimaryPremise": "<string>",
        "PrimaryPremiseSuffix": "<string>",
        "SecondaryPremise": "<string>",
        "SecondaryPremiseSuffix": "<string>",
        "PreSortZone": "<string>",
        "PrintPostZone": "<string>",
        "Barcode": "<string>",
        "PrimaryAddressLine": "<string>",
        "SecondaryAddressLine": "<string>",
        "AutoZoneIndicator": "<string>",
        "CarrierRoute": "<string>",
        "CheckDigit": "<string>",
        "CMRAIndicator": "<string>",
        "CongressionalDistrict": "<string>",
        "DefaultFlag": "<string>",
        "DeliveryPointBarCode": "<string>",
        "DNA": "<string>",
        "DPVConfirmedIndicator": "<string>",
        "DPVFootnotes": "<string>",
        "DPVLACSIndicator": "<string>",
        "DropSiteIndicator": "<string>",
        "eLOTCode": "<string>",
        "eLOTNumber": "<string>",
        "EnhancedReturnCode": "<string>",
        "EWSFlag": "<string>",
        "FalsePositiveIndicator": "<string>",
        "Finance": "<string>",
        "FIPSCountyCode": "<string>",
        "LACSLinkCode": "<string>",
        "LACSLinkIndicator": "<string>",
        "LACSStatus": "<string>",
        "NDDFlag": "<string>",
        "NDDValues": "<string>",
        "NoStatIndicator": "<string>",
        "NoStatReason": "<string>",
        "NSL": "<string>",
        "ParsedGarbage": "<string>",
        "PBSAIndicator": "<string>",
        "PMBNumber": "<string>",
        "PMBType": "<string>",
        "POBoxOnly": "<string>",
        "RecordType": "<string>",
        "ResidentialDelivery": "<string>",
        "ResultsString": "<string>",
        "ReturnCode": "<string>",
        "SUITELinkFootnote": "<string>",
        "ThrowbackIndicator": "<string>",
        "VacantIndicator": "<string>",
        "Zip5Valid": "<string>",
        "SerpStatusEx": "<string>",
        "Questionable": "<string>",
        "Result": "<string>",
        "GeneralDelivery": "<string>",
        "DeliveryInstallation": "<string>",
        "Route": "<string>",
        "AdditionalContent": "<string>",
        "ResCom_Flag": "<string>",
        "TimeZone_UTC": "<string>",
        "TimeZone_DST": "<string>",
        "TimeZone_Name": "<string>",
        "UDPRNKey": "<string>",
        "UPRN": "<string>",
        "ParentUPRN": "<string>",
        "OwningUDPRN": "<string>",
        "UMRRN": "<string>",
        "ResidentialCommercialFlag": "<string>",
        "DPS": "<string>",
        "PostcodeType": "<string>",
        "AddressKey": "<string>",
        "OrganisationKey": "<string>",
        "FormerPostalCounty": "<string>",
        "AdministrativeCounty": "<string>",
        "TraditionalCounty": "<string>",
        "AdministrativeAreaISO2": "<string>",
        "Country": "<string>",
        "CensusIndicator": "<string>",
        "CensusCode": "<string>",
        "CensusClassCode": "<string>",
        "GNISFeatureID": "<string>",
        "CBSAMetropolitanStatisticalArea": "<string>",
        "CBSAMicropolitanStatisticalArea": "<string>",
        "NECTAMetropolitanStatisticalArea": "<string>",
        "NECTAMicropolitanStatisticalArea": "<string>",
        "MetropolitanDivision": "<string>",
        "NECTADivision": "<string>",
        "BlockCode": "<string>",
        "BlockGroupCode": "<string>",
        "CBSACode": "<string>",
        "CBSAName": "<string>",
        "CountyCode": "<string>",
        "MetroDivisionCode": "<string>",
        "MetroDivisionName": "<string>",
        "NECTACode": "<string>",
        "NECTAName": "<string>",
        "NECTADivisionCode": "<string>",
        "NECTADivisionName": "<string>",
        "OldMSACode": "<string>",
        "OldMSAName": "<string>",
        "StateCode": "<string>",
        "TractCode": "<string>",
        "LatitudeStatus": "<string>",
        "LongitudeStatus": "<string>",
        "AddressStatus": "<string>",
        "Address1Status": "<string>",
        "Address2Status": "<string>",
        "Address3Status": "<string>",
        "Address4Status": "<string>",
        "Address5Status": "<string>",
        "Address6Status": "<string>",
        "Address7Status": "<string>",
        "Address8Status": "<string>",
        "DeliveryAddressStatus": "<string>",
        "DeliveryAddress1Status": "<string>",
        "DeliveryAddress2Status": "<string>",
        "DeliveryAddress3Status": "<string>",
        "DeliveryAddress4Status": "<string>",
        "DeliveryAddress5Status": "<string>",
        "DeliveryAddress6Status": "<string>",
        "DeliveryAddress7Status": "<string>",
        "DeliveryAddress8Status": "<string>",
        "CountryStatus": "<string>",
        "IDStatus": "<string>",
        "SuperAdministrativeAreaStatus": "<string>",
        "AdministrativeAreaStatus": "<string>",
        "SubAdministrativeAreaStatus": "<string>",
        "LocalityStatus": "<string>",
        "DependentLocalityStatus": "<string>",
        "DoubleDependentLocalityStatus": "<string>",
        "ThoroughfareStatus": "<string>",
        "DependentThoroughfareStatus": "<string>",
        "BuildingStatus": "<string>",
        "PremiseStatus": "<string>",
        "SubBuildingStatus": "<string>",
        "SubBuildingFloorStatus": "<string>",
        "PostalCodeStatus": "<string>",
        "OrganizationStatus": "<string>",
        "PostBoxStatus": "<string>",
        "CountryNameStatus": "<string>",
        "ISO3166-2Status": "<string>",
        "ISO3166-3Status": "<string>",
        "ISO3166-NStatus": "<string>",
        "PostalCodePrimaryStatus": "<string>",
        "PostalCodeSecondaryStatus": "<string>",
        "AddressFormatStatus": "<string>",
        "DeliveryAddressFormatStatus": "<string>",
        "AVCStatus": "<string>",
        "AQIStatus": "<string>",
        "SequenceStatus": "<string>",
        "GeoAccuracyStatus": "<string>",
        "GeoDistanceStatus": "<string>",
        "ContactStatus": "<string>",
        "FunctionStatus": "<string>",
        "DepartmentStatus": "<string>",
        "UnmatchedStatus": "<string>",
        "MatchRuleLabelStatus": "<string>",
        "HyphenClassStatus": "<string>",
        "AdministrativeAreaNameStatus": "<string>",
        "AdministrativeAreaTrailingTypeStatus": "<string>",
        "AdministrativeAreaTypeStatus": "<string>",
        "LocalityExtraStatus": "<string>",
        "LocalitySpecialStatus": "<string>",
        "LocalityNameStatus": "<string>",
        "LocalityTypeStatus": "<string>",
        "LocalityTrailingTypeStatus": "<string>",
        "DependentLocalityNameStatus": "<string>",
        "DependentLocalityTypeStatus": "<string>",
        "DependentLocalityLeadingTypeStatus": "<string>",
        "DoubleDependentLocalityNameStatus": "<string>",
        "DoubleDependentLocalityTypeStatus": "<string>",
        "ThoroughfarePreDirectionStatus": "<string>",
        "ThoroughfareTypeStatus": "<string>",
        "ThoroughfareLeadingTypeStatus": "<string>",
        "ThoroughfareNameStatus": "<string>",
        "ThoroughfareTrailingTypeStatus": "<string>",
        "ThoroughfarePostDirectionStatus": "<string>",
        "DependentThoroughfarePreDirectionStatus": "<string>",
        "DependentThoroughfareLeadingTypeStatus": "<string>",
        "DependentThoroughfareNameStatus": "<string>",
        "DependentThoroughfareTrailingTypeStatus": "<string>",
        "DependentThoroughfarePostDirectionStatus": "<string>",
        "BuildingLeadingTypeStatus": "<string>",
        "BuildingNameStatus": "<string>",
        "BuildingTypeStatus": "<string>",
        "BuildingTrailingTypeStatus": "<string>",
        "PremiseTypeStatus": "<string>",
        "PremiseNumberStatus": "<string>",
        "PremiseExtraStatus": "<string>",
        "SubBuildingTypeStatus": "<string>",
        "SubBuildingLeadingTypeStatus": "<string>",
        "SubBuildingNumberStatus": "<string>",
        "SubBuildingNameStatus": "<string>",
        "SubBuildingBlockStatus": "<string>",
        "SubBuildingDoorStatus": "<string>",
        "SubBuildingStaircaseStatus": "<string>",
        "BolignummerStatus": "<string>",
        "DeliveryInstallationAreaNameStatus": "<string>",
        "DeliveryInstallationTypeStatus": "<string>",
        "DeliveryInstallationQualifierNameStatus": "<string>",
        "RouteTypeStatus": "<string>",
        "RouteNumberStatus": "<string>",
        "BranchNameStatus": "<string>",
        "MakaniNumberStatus": "<string>",
        "ShortAddressCodeStatus": "<string>",
        "OrganizationNameStatus": "<string>",
        "OrganizationTypeStatus": "<string>",
        "OrganizationTrailingTypeStatus": "<string>",
        "PostBoxTypeStatus": "<string>",
        "PostBoxNumberStatus": "<string>",
        "BoxBagLobbyNameStatus": "<string>",
        "CensusIndicatorStatus": "<string>",
        "CensusCodeStatus": "<string>",
        "CensusClassCodeStatus": "<string>",
        "GNISFeatureIDStatus": "<string>",
        "CBSAMetropolitanStatisticalAreaStatus": "<string>",
        "CBSAMicropolitanStatisticalAreaStatus": "<string>",
        "NECTAMetropolitanStatisticalAreaStatus": "<string>",
        "NECTAMicropolitanStatisticalAreaStatus": "<string>",
        "MetropolitanDivisionStatus": "<string>",
        "NECTADivisionStatus": "<string>",
        "BlockCodeStatus": "<string>",
        "BlockGroupCodeStatus": "<string>",
        "CBSACodeStatus": "<string>",
        "CBSANameStatus": "<string>",
        "CountyCodeStatus": "<string>",
        "MetroDivisionCodeStatus": "<string>",
        "MetroDivisionNameStatus": "<string>",
        "NECTACodeStatus": "<string>",
        "NECTANameStatus": "<string>",
        "NECTADivisionCodeStatus": "<string>",
        "NECTADivisionNameStatus": "<string>",
        "OldMSACodeStatus": "<string>",
        "OldMSANameStatus": "<string>",
        "StateCodeStatus": "<string>",
        "TractCodeStatus": "<string>",
        "DPIDStatus": "<string>",
        "FloorTypeStatus": "<string>",
        "FloorNumberStatus": "<string>",
        "LotNumberStatus": "<string>",
        "PostBoxNumStatus": "<string>",
        "PostBoxNumberPrefixStatus": "<string>",
        "PostBoxNumberSuffixStatus": "<string>",
        "PrimaryPremiseStatus": "<string>",
        "PrimaryPremiseSuffixStatus": "<string>",
        "SecondaryPremiseStatus": "<string>",
        "SecondaryPremiseSuffixStatus": "<string>",
        "PreSortZoneStatus": "<string>",
        "PrintPostZoneStatus": "<string>",
        "BarcodeStatus": "<string>",
        "PrimaryAddressLineStatus": "<string>",
        "SecondaryAddressLineStatus": "<string>",
        "AutoZoneIndicatorStatus": "<string>",
        "CarrierRouteStatus": "<string>",
        "CheckDigitStatus": "<string>",
        "CMRAIndicatorStatus": "<string>",
        "CongressionalDistrictStatus": "<string>",
        "DefaultFlagStatus": "<string>",
        "DeliveryPointBarCodeStatus": "<string>",
        "DNAStatus": "<string>",
        "DPVConfirmedIndicatorStatus": "<string>",
        "DPVFootnotesStatus": "<string>",
        "DPVLACSIndicatorStatus": "<string>",
        "DropSiteIndicatorStatus": "<string>",
        "eLOTCodeStatus": "<string>",
        "eLOTNumberStatus": "<string>",
        "EnhancedReturnCodeStatus": "<string>",
        "EWSFlagStatus": "<string>",
        "FalsePositiveIndicatorStatus": "<string>",
        "FinanceStatus": "<string>",
        "FIPSCountyCodeStatus": "<string>",
        "LACSLinkCodeStatus": "<string>",
        "LACSLinkIndicatorStatus": "<string>",
        "LACSStatusStatus": "<string>",
        "NDDFlagStatus": "<string>",
        "NDDValuesStatus": "<string>",
        "NoStatIndicatorStatus": "<string>",
        "NoStatReasonStatus": "<string>",
        "NSLStatus": "<string>",
        "ParsedGarbageStatus": "<string>",
        "PBSAIndicatorStatus": "<string>",
        "PMBNumberStatus": "<string>",
        "PMBTypeStatus": "<string>",
        "POBoxOnlyStatus": "<string>",
        "RecordTypeStatus": "<string>",
        "ResidentialDeliveryStatus": "<string>",
        "ResultsStringStatus": "<string>",
        "ReturnCodeStatus": "<string>",
        "SUITELinkFootnoteStatus": "<string>",
        "ThrowbackIndicatorStatus": "<string>",
        "VacantIndicatorStatus": "<string>",
        "Zip5ValidStatus": "<string>",
        "SerpStatusExStatus": "<string>",
        "QuestionableStatus": "<string>",
        "ResultStatus": "<string>",
        "GeneralDeliveryStatus": "<string>",
        "DeliveryInstallationStatus": "<string>",
        "RouteStatus": "<string>",
        "AdditionalContentStatus": "<string>",
        "ResCom_FlagStatus": "<string>",
        "TimeZone_UTCStatus": "<string>",
        "TimeZone_DSTStatus": "<string>",
        "TimeZone_NameStatus": "<string>",
        "UDPRNKeyStatus": "<string>",
        "UPRNStatus": "<string>",
        "ParentUPRNStatus": "<string>",
        "OwningUDPRNStatus": "<string>",
        "UMRRNStatus": "<string>",
        "ResidentialCommercialFlagStatus": "<string>",
        "DPSStatus": "<string>",
        "PostcodeTypeStatus": "<string>",
        "AddressKeyStatus": "<string>",
        "OrganisationKeyStatus": "<string>",
        "FormerPostalCountyStatus": "<string>",
        "AdministrativeCountyStatus": "<string>",
        "TraditionalCountyStatus": "<string>",
        "AdministrativeAreaISO2Status": "<string>"
      }
    ],
    "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. Note: we don’t support API connections using HTTP - all calls should use HTTPS.

Body

application/json

Response

200
application/json

Success

The response is of type ListOfServiceResponseItem · object[].