International Batch Cleanse

Validate global addresses individually or in batches up to 100 records. Returns verified addresses with standardization and quality indicators.

POST /Cleansing/International/Batch/v1.20/json6.ws

Cleansing_International_Batch

cURL

curl --request POST \
  --url 'https://api.addressy.com/Cleansing/International/Batch/v1.20/json6.ws?Key=' \
  --header 'Content-Type: application/json' \
  --data '
{
  "Key": "AA11-AA11-AA11-AA11",
  "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": "",
      "Forename": "",
      "Surname": "",
      "MiddleName": "",
      "FullName": ""
    }
  ],
  "Options": {
    "ServerOptions": {
      "ActiveCassLibrary": "",
      "AddressLineSeparator": "<br>",
      "AliasPreference": "",
      "CassAvcEnable": "NO",
      "CassCityAbbreviation": "NO",
      "CassPreserveAlias": "NO",
      "CassUrbFirst": "NO",
      "CassZipFields": "NO",
      "CertifiedCountryList": "",
      "CombinedSearchMethods": "YES",
      "CombinedVerifyMethods": "YES",
      "ConfidenceThreshold": "90",
      "ConformToReference": "NO",
      "CountryFields": "Country",
      "DefaultCountry": "",
      "DuplicateHandlingMask": "",
      "EnhancedCountryTool": "OFF",
      "FieldNameWeight": "",
      "FieldStatus": "False",
      "ForceCountry": "",
      "GeocodeCountryList": "",
      "GeocodeMatchRules": "",
      "IgnoreUnmatched": "NO",
      "MaxResults": "",
      "MatchScoreAbsoluteThreshold": "60",
      "MatchScoreThresholdFactor": "95",
      "MaximumGeoDistance": "-1",
      "MinimumGeoAccuracyLevel": "0",
      "MinimumMatchscore": "0",
      "MinimumPostcode": "0",
      "MinimumSimilarity": "70",
      "MinimumVerificationLevel": "0",
      "OutputAddressFormat": "NO",
      "OutputCasing": "Title",
      "OutputFields": "",
      "OutputScript": "Latn",
      "OutputSortType": "AVC",
      "PreferPrimaryValidAlias": "NO",
      "QueryClause": "<string>",
      "QueryString": "",
      "RangeDecompose": "Match",
      "RangefieldPreference": "<string>",
      "ReferenceDatasetCacheSize": "5",
      "ReturnVerifiedFieldsOnly": "No",
      "SerpWesternStyle": "NO",
      "SimpleParse": "YES",
      "StrictReferenceMatch": "NO",
      "StrictRefMatchCountryList": "",
      "SuppressAdditionFields": "",
      "SuppressAddressFields": "",
      "SuppressFields": "",
      "SuppressUnmatched": "OFF",
      "SuppressMatchFields": "",
      "Table": "",
      "TransliterationIgnoreFields": "ID,ISO3166-2,ISO3166-3,_L,Latitude,Longitude,GeoAccuracy,GeoDistance,AVC",
      "ToolInfo": "NO",
      "UseSymbolicTransliteration": "YES",
      "VerifyCountryList": "",
      "VerifyMatchRules": ""
    },
    "Version": false,
    "Certify": false,
    "Enhance": false,
    "Deceased": false,
    "Goneaways": false,
    "Process": "Verify"
  }
}
'

200

Example

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

We don’t support API connections using HTTP - all calls should use HTTPS.

Authorizations

Key · string · query · required

Body

application/json

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.

Addresses · object[]

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'.

Show child attributes

Options · object

Used to specify various options and override processes.

Show child attributes

Response

200

application/json

Success

Input · object

Show child attributes

Matches · object[]

Show child attributes

Version · string