curl --request POST \
--url https://api.addressy.com/Cleansing/International/Batch/v1.10/json6.ws \
--header 'Content-Type: application/json' \
--data '
{
"Key": "AA11-AA11-AA11-AA11",
"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": ""
}
],
"GeoCode": false,
"Options": {
"ServerOptions": {
"CassAvcEnable": "NO",
"CassUrbFirst": "NO",
"CassZipFields": "NO",
"CassCityAbbreviation": "NO",
"MaxResults": "",
"MinimumMatchscore": "0",
"MinimumVerificationLevel": "0",
"AddressLineSeparator": "<br>",
"MinimumSimilarity": "70",
"SuppressAddressFields": "",
"SuppressAdditionFields": "",
"SuppressFields": "",
"CombinedSearchMethods": "YES",
"MinimumGeoAccuracyLevel": "0",
"MaximumGeoDistance": "-1",
"OutputScript": "Latn",
"OutputCasing": "Title",
"EnhancedCountryTool": "OFF",
"CertifiedCountryList": "",
"DefaultCountry": "",
"CountryFields": "Country",
"FieldNameWeight": "",
"ForceCountry": "",
"MatchScoreAbsoluteThreshold": "60",
"MatchScoreThresholdFactor": "95",
"OutputAddressFormat": "NO",
"TransliterationIgnoreFields": "ID,ISO3166-2,ISO3166-3,_L,Latitude,Longitude,GeoAccuracy,GeoDistance,AVC",
"ToolInfo": "NO",
"UseSymbolicTransliteration": "YES",
"DuplicateHandlingMask": "",
"NativeAddressLineReverse": "",
"SimpleParse": "YES",
"ReturnVerifiedFieldsOnly": "No",
"FieldStatus": "False",
"IgnoreUnmatched": "NO",
"MinimumPostcode": "0",
"SuppressUnmatched": "OFF",
"SuppressMatchFields": "",
"OutputSortType": "AVC",
"RangeDecompose": "Match",
"PreferPrimaryValidAlias": "NO",
"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>"
}
]International Batch Cleanse
Validate global addresses individually or in batches up to 100 records. Returns verified addresses with standardization and quality indicators.
curl --request POST \
--url https://api.addressy.com/Cleansing/International/Batch/v1.10/json6.ws \
--header 'Content-Type: application/json' \
--data '
{
"Key": "AA11-AA11-AA11-AA11",
"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": ""
}
],
"GeoCode": false,
"Options": {
"ServerOptions": {
"CassAvcEnable": "NO",
"CassUrbFirst": "NO",
"CassZipFields": "NO",
"CassCityAbbreviation": "NO",
"MaxResults": "",
"MinimumMatchscore": "0",
"MinimumVerificationLevel": "0",
"AddressLineSeparator": "<br>",
"MinimumSimilarity": "70",
"SuppressAddressFields": "",
"SuppressAdditionFields": "",
"SuppressFields": "",
"CombinedSearchMethods": "YES",
"MinimumGeoAccuracyLevel": "0",
"MaximumGeoDistance": "-1",
"OutputScript": "Latn",
"OutputCasing": "Title",
"EnhancedCountryTool": "OFF",
"CertifiedCountryList": "",
"DefaultCountry": "",
"CountryFields": "Country",
"FieldNameWeight": "",
"ForceCountry": "",
"MatchScoreAbsoluteThreshold": "60",
"MatchScoreThresholdFactor": "95",
"OutputAddressFormat": "NO",
"TransliterationIgnoreFields": "ID,ISO3166-2,ISO3166-3,_L,Latitude,Longitude,GeoAccuracy,GeoDistance,AVC",
"ToolInfo": "NO",
"UseSymbolicTransliteration": "YES",
"DuplicateHandlingMask": "",
"NativeAddressLineReverse": "",
"SimpleParse": "YES",
"ReturnVerifiedFieldsOnly": "No",
"FieldStatus": "False",
"IgnoreUnmatched": "NO",
"MinimumPostcode": "0",
"SuppressUnmatched": "OFF",
"SuppressMatchFields": "",
"OutputSortType": "AVC",
"RangeDecompose": "Match",
"PreferPrimaryValidAlias": "NO",
"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>"
}
]Body
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.
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.
Show child attributes
Show child attributes
Whether you want geo-coordinates to be appended to your results (if available). There is an additional cost associated with enabling this option.
Used to specify various options and override processes.
Show child attributes
Show child attributes
The following commands can be used to control and manipulate the Loqate process or output. These are considered advanced functions, and we recommend that server options are used in custom workflows.
Show child attributes
Show child attributes
The default will Z00-00-00-000 (AVC) and Z (AQI), but computing the report values can be forced. Please note that if returned, these fields may not accurately reflect the changes made in the record during the CASS process.
YES, NO This specifies the Urbanization location on the address lines output (Puerto Rico only). The default will put the value after the address lines(s) with premise, thoroughfare, and sub-building.
YES, NO Populate “Finance” and “AutoZoneIndicator”. If these fields are desired, customers will experience a moderate performance degradation (up to 20%).
YES, NO If a Locality name is longer than 13 characters, this option can be used to return the official, short version. Both short and long versions are valid according to CASS.
YES, NO Used to specify the maximum number of results to return in the ProcessResults structure.
Used to specify the minimum matchscore a record must reach in order to avoid reversion.
Used to specify the minimum verification level a record must reach in order to avoid reversion.
Used to specify the string which will separate the output address lines within the output Address field
Used to specify the minimum similarity score that is needed to make a match to a candidate result.
Used to specify the comma-delimited list of fields that should be suppressed from the Address field output.
Used to specify the comma-delimited list of fields that should not be added to an output result if they do not appear in the input record.
Used to specify the comma-delimited list of fields that should be suppressed from the output.
Specifies whether or not to use a word-based search algorithm similar to a web search engine approach.
YES, NO Used to specify the minimum GeoAccuracy level a geocode must reach in order to be returned as a result.
Used to specify the maximum GeoDistance a geocode can reach and still be returned as a result.
Used to specify the language or character set (based on based on the ISO 15924 standard) in which the output should be encoded.
Latn, Cyrl, Grek, Hebr, Hani, Hans, Arab, Thai, Hang, Native Used to specify the letter case to use for output fields.
Title, Upper, Lower This option allows users to enable the Automatic Country Identification.
ON, OFF Used to specify a comma-delimited list of countries where data should be processed using the relevant certified process. e.g. “USA,CAN,AUS” to give CASS, SERP, and AMAS certified output respectively.
Used to specify the ISO 3166-1 alpha-3 code which should be used if no identifiable country can be found in an input record.
Used to specify the comma delimited list of fields to be searched for country information. This should be a subset of the ParseFields entry.
Used to specify the default field name weight, between 1 and 255. Default 10. A larger value will give more precedence to the supplied field name, a smaller value will give more precedence to the GKR matches. Individual field name weights can also be declared using the syntax ‘=|=’, etc. For instance ‘Organization=240|AdministrativeArea=100|50’ would mean a field name weight of 240 for the Organization field, 100 for the AdministrativeArea field, and a default of 50 for all remaining fields.
Used to specify the ISO 3166-1 alpha-3 code which should be used for all input records.
Used to specify the minimum matchscore a record must reach in the Match process to be taken into account as a candidate for matching.
This is a value that is used as a factor of the highest matching result. The resulting value is then used as a cut-off for considering candidates for the results. The higher the value of the factor, the higher the chance of getting a good verification result.
Used to specify whether to output an extra field for the Address block fields with the suffix ‘Format’ showing how the hierarchical field positioning has occurred.
YES, NO Used to specify the fields that should not be transliterated.
Specify ‘Yes’ to output extra debug information viewable using the getFieldInfo method.
YES, NO Specify ‘No’ to limit transliteration to complete field phrase matches.
YES, NO Used to specify the duplicate handling level, between 0 and 15. Default is 0. When option is set, duplicate components in the input address are removed if it meets a certain criteria.
Used to specify whether to reverse the order of the input address lines when processing non-Latin data. Usually this is set on a per-country basis automatically, but can be overridden by setting the server option as appropriate. When set to False, any input Address lines are concatenated for parsing in normal order (e.g. Address1 + Address2 + Address3), when set to True any input Address lines are concatenated for parsing in reverse order (e.g. Address3 + Address2 + Address1).
Specifies whether or not to use the ‘simple parse’ algorithm. This option looks for something like premise + street in the address field, but is not particularly tolerant of invalid input data.
YES, NO This option will return only verified fields, meaning that it will remove anything that isn’t verified from any field. SuppressUnmatched option will only suppress the unverified components in the Address field. Default No, meaning all fields will be returned. This can be specified on a per-country basis, with the added ability to specify fields to ignore during the check, using the following syntax ReturnVerifiedFieldsOnly=[:;;…;][,:;…;,…,]. e.g. ReturnVerifiedFieldsOnly=BE:SubBuilding;Premise,DE:SubBuilding;Premise,AT:SubBuilding;Premise or ReturnVerifiedFieldsOnly=US,CA,GB. The former will return verified fields only in Belgium, Germany, and Austria, but will retain non-verified data in the Premise and SubBuilding fields, the latter will return verified fields only in USA, Canada, UK.
Allow unmatched input data within the address lines to be ignored during a Search process, meaning that a search can proceed matching only partial input data. We don’t recommend you use this server option on a Verify process, as it may reduce the accuracy of otherwise valid results.
YES, NO Used to specify the minimum postcode status a record must reach in order to avoid reversion.
If this option is set to TRUE or ON, unverified fields will not be output in Address fields (Address, Address1, Address2, etc.).
ON, OFF Used to specify the comma-delimited list of fields that should be suppressed when determining the Address Verification Code.
Used to specify the order in which the Search output results should be sorted. To sort in alphabetical order use ‘Alphabetical’, or alternatively specify ‘AVC’ to sort from the highest verification level to the lowest verification level. The option can also be set to ‘Similarity’ giving an indication of the percentage of the input characters that have been matched in the output.
Alphabetical, AVC Used to specify how to expand ranges such as premise numbers and sub building numbers. Valid values are ‘Match’ (returning only the value matching the input query), ‘Range’ (returning a human-readable range, e.g. ‘1-9 Odd’), or ‘Full’ (expanding out the range into its constituent numbers, e.g. ‘1’, ‘2’, ‘3’, ‘4’, ‘5’).
Match, Range, Full When option is set to “Yes”, the engine will pick out the first valid alias it finds within the reference data.
YES, NO Used to specify the number of MRU reference datasets to cache.
Return Loqate engine version with request.
Use certified data set. AMAS (AU), CASS (US) or SERP (CA). The country of the input address will determine which certification product is used.
Use enhanced datasets. Returns enhance fields if applicable.
Loqate Process to run.
Verify, Geocode, Search, Enhance, AMAS, CASS, Country, Format, GKRInfo, Match, Parse, Query, Report, SERP, ReverseGeocode, AutoComplete Response
Success
Show child attributes
Show child attributes
Show child attributes
Show child attributes
The WGS 84 latitude in decimal degrees format.
The WGS 84 longitude in decimal degrees format.
The GeoAccuracy code.
The radius of accuracy in meters, giving an indication of the likely maximum distance between the given geocode and the physical location. Please note that this field is derived from and therefore dependent on the accuracy and coverage of the underlying reference data.
The full address, correctly formatted for mailing in the relevant country, including line breaks specified using the AddressLineSeparator option. Do not use ‘Address’ as input when running CASS. The preferred input for CASS is (Address1 + Locality + AdministrativeArea + PostalCode + Country). However, (Address1 + Address2 + Country) will also work.
The Address1-8 fields can be used to specify input address line data, and on output will contain the correctly formatted address split into individual address lines for mailing in the relevant country.
The full address minus the Organization, Locality, AdministrativeArea hierarchy and PostalCode hierarchy fields, correctly formatted for mailing in the relevant country, including line breaks specified using the AddressLineSeparator option.
The DeliveryAddress1-8 fields contain the individual lines contained within the DeliveryAddress field.
Optional. This field will be passed through to the output unchanged.
The largest geographic data element within a country.
The most common geographic data element within a country. For instance, USA State, and Canadian Province.
The smallest geographic data element within a country. For instance, USA County.
The most common population center data element within a country. For instance, USA City, Canadian Municipality.
A smaller population center data element, dependent on the contents of the Locality field. For instance, Turkish Neighborhood.
The smallest population center data element, dependent on both the contents of the Locality and DependentLocality fields. For instance, UK Village.
The most common street or block data element within a country. For instance, USA Street.
The dependent street or block data element within a country. For instance, UK Dependent Street.
The descriptive name identifying an individual location, should one exist.
The alphanumeric code identifying an individual location, should one exist.
The secondary identifiers for a particular delivery point. For instance, “FLAT 1” or “SUITE 212”.
The parsed floor information within the SubBuilding field, and includes the floor label (or type) and a numeric where applicable. For example, “L7” or “Fl 12”.
The complete postal code for a particular delivery point, should such detail be able to be determined.
The business name associated with a particular delivery point, should one exist.
The post box for a particular delivery point, should one exist.
The ISO 3166 official country name.
The ISO 3166 2-character country code.
The ISO 3166 3-character country code.
The ISO 3166 3-digit numeric country code.
The primary postal code used for a particular country. For instance, USA Zip, Canadian Postcode, Indian PINcode.
Secondary postal code information, if used in a particular country and if such detail is able to be determined and reference data is available. For instance, USA Zip Plus 4.
If Server Option “OutputAddressFormat“ is “Yes“, then this field will contain the fields used to construct the “Address“ Field. For example, “Organization
DeliveryAddress
Locality AdministrativeArea PostalCode“. The default “
“ line breaks can be changed with the AddressLineSeparator Server Option.
If Server Option “OutputAddressFormat“ is “Yes“, then this field will contain the fields used to construct the “DeliveryAddress“ Field. For example, “Organization
DeliveryAddress
Locality AdministrativeArea PostalCode“. The default “
“ line breaks can be changed with the AddressLineSeparator Server Option.
When multiple addresses are included in a single Verify request this counter will show the order of the addresses from the input. For example: 7 represents the 7th address in the input request.
Contact name information.
Function or job title information.
Organizational department information.
The Loqate Engine uses a set of rules to match the input with the reference data. Each rule is identified by a match rule label. Please refer to the Match Process and Match Rule Syntax pages for more information regarding the Match Rules.
The name indicator within the AdministrativeArea field, should one exist. For example, Taipai where the AdministrativeArea is Taipai City.
The trailing AdministrativeArea type, should one exist. For example, City where the AdministrativeArea is Taipai City.
The AdministrativeArea type, should one exist. For example, City where the AdministrativeArea is Taipai City.
Information that could be present along with the Locality. This information is not considered as part of the Postal authority data but is still necessary for parsing the address in order to obtain a complete delivery address. Available if a sufficient level of parsing detail exists within a particular country. Example: 12 rue de la Gare, 75019 PARIS CEDEX, France. CEDEX will be considered as Locality Extra.
This field combines both the Locality and LocalityExtra components, to capture specific locality information that includes essential details for accurate address parsing and delivery. For example, in the address “12 rue de la Gare, 75019 PARIS CEDEX, France,” the term “Paris CEDEX” represents the LocalitySpecial. It encompasses both the primary locality (Paris) and the additional locality information (CEDEX) that is necessary for a complete and precise delivery address.
The name indicator within the Locality field, should one exist. For example: Jeju where the Locality is Jeju-Si.
The type indicator for Locality, should one exist. For example: Dist. where the Locality is Da’an Dist.
The type indicator for Locality, should one exist. For example: Dist. where the Locality is Da’an Dist.
The name indicator within the DependentLocality field, should one exist. For instance, if DependentLocality contains “Dong Cheng Qu” DependentLocalityName contains “Dong Cheng” if a sufficient level of parsing detail exists for the particular country.
The DependentLocality indicator within the DependentLocality field, should one exist. For instance, if DependentLocality contains “Dong Cheng Qu” DependentLocalityType contains “Qu” if a sufficient level of parsing detail exists for the particular country.
The leading dependent locality type indicator, should one exist. For example, “Rancheria San Jose Cacahuatepec” where the DependentLocality is Ciudad Renacimiento.
The name indicator within the DoubleDependentLocality field, should one exist. For instance, if DoubleDependentLocality contains “Xin Zhuang Zhen” DoubleDependentLocalityName contains “Xin Zhuang” if a sufficient level of parsing detail exists for the particular country.
The DoubleDependentLocality indicator within the DoubleDependentLocality field, should one exist. For instance, if DoubleDependentLocality contains “Xin Zhuang Zhen” DoubleDependentLocalityType contains “Zhen” if a sufficient level of parsing detail exists for the particular country.
The prefix directional contained within the Thoroughfare field, should one exist. For instance, if Thoroughfare contains “N MAIN ST” ThoroughfarePreDirection contains “N” if a sufficient level of parsing detail exists for the particular country.
The type of thoroughfare should one exist. Examples include Road, Vei, St, Rua, Avenita, Pereulok, 路
The leading thoroughfare type indicator within the Thoroughfare field, should one exist. For instance, if Thoroughfare contains “RUE DE LA GARE” ThoroughfareLeadingType contains “RUE” if a sufficient level of parsing detail exists for the particular country.
The name indicator within the Thoroughfare field, should one exist. For instance, if Thoroughfare contains “N MAIN ST” ThoroughfareName contains “MAIN” if a sufficient level of parsing detail exists for the particular country.
The trailing thoroughfare type indicator within the Thoroughfare field, should one exist. For instance, if Thoroughfare contains “N MAIN ST” ThoroughfareTrailingType contains “ST” if a sufficient level of parsing detail exists for the particular country.
The postfix directional contained within the Thoroughfare field, should one exist. For instance, if Thoroughfare contains “MAIN ST N” ThoroughfarePostDirection contains “N” if a sufficient level of parsing detail exists for the particular country.
The prefix directional contained within the DependentThoroughfare field, should one exist. For instance, if DependentThoroughfare contains “N MAIN ST” DependentThoroughfarePreDirection contains “N” if a sufficient level of parsing detail exists for the particular country.
The leading thoroughfare type indicator within the DependentThoroughfare field, should one exist. For instance, if DependentThoroughfare contains “RUE DE LA GARE” DependentThoroughfareLeadingType contains “RUE” if a sufficient level of parsing detail exists for the particular country.
The name indicator within the DependentThoroughfare field, should one exist. For instance, if DependentThoroughfare contains “N MAIN ST” DependentThoroughfareName contains “MAIN” if a sufficient level of parsing detail exists for the particular country.
The trailing thoroughfare type indicator within the DependentThoroughfare field, should one exist. For instance, if DependentThoroughfare contains “N MAIN ST” DependentThoroughfareTrailingType contains “ST” if a sufficient level of parsing detail exists for the particular country.
The postfix directional contained within the DependentThoroughfare field, should one exist. For instance, if DependentThoroughfare contains “MAIN ST N” DependentThoroughfarePostDirection contains “N” if a sufficient level of parsing detail exists for the particular country.
The leading building type indicator within the Building field, should one exist. For instance, if Building contains “BLOC C” BuildingLeadingType contains “BLOC” if a sufficient level of parsing detail exists for the particular country.
The name indicator within the Building field, should one exist. For instance, if Building contains “WESTMINSTER HOUSE” BuildingName contains “WESTMINSTER” if a sufficient level of parsing detail exists for the particular country.
The Building indicator within the Building field, should one exist. Examples include Place, 城.
The trailing building type indicator within the Building field, should one exist. For instance, if Building contains “WESTMINSTER HOUSE” BuildingTrailingType contains “HOUSE” if a sufficient level of parsing detail exists within a particular country.
The leading premise type indicator within the Premise field, should one exist. For instance, if Premise contains “Plot 7/7A” PremiseType contains “Plot” if a sufficient level of parsing detail exists within a particular country.
The alphanumeric indicator within the Premise field, should one exist. For instance, if Premise contains “Plot 7/7A” PremiseNumber contains “7/7A” if a sufficient level of parsing detail exists within a particular country.
Information that could be present as part of the Premise field. This information is not considered as part of the Postal authority data but is still necessary for parsing the address in order to obtain a complete delivery address. Available if a sufficient level of parsing detail exists within a particular country. Example: In French address, the Premise number could be followed by words bis and ter which will be considered as Premise Extra . 25 bis rue Emile Zola, 91190 GIF SUR YVETTE, France. Bis will be considered as PremiseExtra.
The leading sub-building type indicator within the SubBuilding field, should one exist. For instance, if SubBuilding contains “FLAT 1” SubBuildingType contains “FLAT” if a sufficient level of parsing detail exists within a particular country.
The sub-building type indicator within the SubBuilding field, should one exist. For instance, if SubBuilding contains “FLAT 1” SubBuildingLeadingType contains “FLAT” if a sufficient level of parsing detail exists within a particular country.
The alphanumeric indicator within the SubBuilding field, should one exist. For instance, if SubBuilding contains “FLAT 1” SubBuildingNumber contains “1” if a sufficient level of parsing detail exists within a particular country.
The descriptive name within the SubBuilding field. For instance, if SubBuilding contains “BASEMENT FLAT” SubBuildingName contains “BASEMENT FLAT”.
The secondary identifiers for a particular delivery point. For instance – BLOQUE 7.
The secondary identifiers for a particular delivery point. For instance PUERTA D.
The secondary identifiers for a particular delivery point. For instance PUERTA D.
The utility unit number consists of a letter followed by four numbers (Norway/NO/NOR only). Examples include: H0001, L0002, U0004, K0032.
The name of a village, town, municipality, city, or metropolitan area that forms part of a Delivery Installation Name (Canada/CA/CAN only). Examples include: Ladysmith, Roxton Pond.
An abbreviation that represents the type of installation (Canada/CA/CAN only). Examples include: STN – Postal Station, PO – Post Office, BDP – Bureau De Poste.
When more than one delivery installation serves an area described by the Delivery Installation Area Name, the qualifier name uniquely identifies the delivery installation (Canada/CA/CAN only). Examples include: Cap-A-L’aigle, B, St Michel, 32, Bank Hunt Club.
A code that identifies the type of route service (Canada/CA/CAN only). Examples include: RR – Rural Route, SS – Suburban Service.
A number that identifies the specific Delivery Mode (Canada/CA/CAN only). Examples include: 22, 62, 404.
Branch name of Department field (Canada/CA/CAN only). Examples include: Agence De Parcs Canada, Fisheries and Oceans, Ottawa District Office.
A Makani number is a 10-digit number which gives you the exact location of the entrance of a building (United Arab Emirates/AE/ARE only). For example: 3000595279.
A short address that consists of four letters followed by four numbers (Saudi Arabia/SA/SAU only). For example: RGSA3808.
The name indicator within the Organization field, should one exist. For instance, if Organization contains ‘Loqate Inc” OrganizationName contains “Loqate” if a sufficient level of parsing detail exists for the particular country.
The type indicator contained within the Organization field, should one exist. For instance, if Organization contains “Loqate Inc” OrganizationType contains “Inc” if a sufficient level of parsing detail exists for the particular country.
The trailing type indicator contained within the Organization field, should one exist. For example: Corp., Gmbh.
The type indicator contained within the PostBox field, should one exist. For instance, if PostBox contains “PO BOX 1234” PostBoxType contains “PO BOX” if a sufficient level of parsing detail exists for the particular country.
The alphanumeric indicator within the PostBox field, should one exist. For instance, if PostBox contains “PO BOX 1234” PostBoxNumber contains “1234” if a sufficient level of parsing detail exists for the particular country.
Box lobby name or New Zealand Post shop name (New Zealand/NZ/NZL only). Examples include: MAUNGATAPERE POSTCENTRE, NEWMARKET POSTSHOP, MOUNT COOK.
A unique 8-digit number which is assigned for every new address to the source address database.
Type of floor or level.
Floor or level number (including alpha characters).
Allotment number.
Postal delivery number if the address is a postal delivery type.
Postal delivery number prefix related to the postal delivery number.
Postal delivery number suffix related to the postal delivery number.
Thoroughfare number for a property (first number in a property ranged address).
Suffix for the thoroughfare number.
Second thoroughfare number (only used if the property has a ranged address eg 23-25).
Suffix for the second thoroughfare number.
Also known as Barcode Sort Plan (BSP) number. The number of one of 54 individual sort regions around Australia. To qualify for Australia Post’s PreSort Letters Service, letters must be sorted based on this number.
Also known as a PreSort Indicator. To qualify for Australia Post’s Print Post Service, letters must be sorted based on this number.
Standard barcode based on the DPID.
Primary address line in standardized format.
Secondary address line in standardized format.
Delivery Point Bar Code check digit. This is the last character of the DeliveryPointBarCode.
The congressional district to which the address belongs.
A value of “Y” indicates that the record matched to a high-rise default, rural route default, or street default record in the ZIP+4 file. Blank = not a default.
A 3-digit code which consists of the 2-digit delivery point code and 1-digit check digit. This is used to create the 12-digit POSTNET barcode which consists of the 5-digit ZIP Code, 4-digit ZIP+4 addon code, and this 3-digit code.
This field will always be empty.
4-digit sequence number for eLOT (Enhanced Line of Travel): gives mailers the ability to sort their mailings in approximate carrier-casing sequence. eLOT sorting allows for carrier route presort discounts. Blank = address not submitted for eLOT. See here for more details.
A value of “Y” indicates that the address matched a record in the EWS (Early Warning System) file, thus resulting in a ZIP+4 no match. Blank = address was not flagged by EWS.
The False Positive table flags the False Positive addresses. This is a flag to determine whether a mailing list is being generated or created during validation. Creating a mailing list through DPV certification is not allowed by the USPS. See here for more details.
A code assigned to Postal Service™ facilities (primarily Post Offices) to collect cost and statistical data and compile revenue and expense data. An example output for 805 Veterans Blvd, Redwood City, CA 94063 is 056378. Note that the reference for this information can be found here. This field will be blank due to performance reasons unless the server option CassZipFields is set to “Yes”.
The 5 digit FIPS (Federal Information Processing Standard) code which uniquely identifies counties. The first two will be the state code and the last three are the county. For example, San Francisco, CA is 06075.
A value of “L” indicates that the input address matched an entry in the Locatable Address Conversion Service database and the input address has been converted from a rural-style address to a city-style address. Blank = no LACS Status returned.
DPV Non-Delivery Day Values. This seven-character field represents Sunday-Saturday and will contain an N for the days where mail can be delivered. For example, “YNNNNNY” means mail is is not received on Saturday or Sunday (e.g. the business is closed).
Indicates the address is not receiving delivery, and the address is not counted as a possible delivery. These addresses are not receiving delivery because A) delivery has not been established; B) customer receives mail as a part of a drop; or C) the address is no longer a possible delivery because the carrier destroys or returns all the mail. See here for more details.
This field will capture information that the CASS engine is able to parse out of the input during the matching process.
Private Mailbox Value will be appended to the PrimaryAddressLine field. This information used to be in SecondaryAddressLine. For example, this will be the “252“ in “PMB 252“.
Private Mailbox Type will be appended to the PrimaryAddressLine field. For example, if the Private Mailbox Value was “PMB 100”, then PMBType would be “PMB”. PMBs allow individuals or offices a private mailbox to simplify internal mail distribution, retain privacy, or have convenient hours of mail pickup. They can be rented as needed through a commercial mail receiving agency (CMRA), which may be more cost-effective than renting a box at the post office.
Provides information about the process and output address. View all possible values for this field.
“VALID” for valid addresses. Otherwise, internal error code.
This field is available when adding “SERP” to the Loqate engine. It identifies a General Delivery type address – Example value: GD.
This field is available when adding “SERP” to the Loqate engine. It contains the Station Information to direct mail to the proper postal installation for non-civic addresses. Example value: STN A.
This field is available when adding “SERP” to the Loqate engine. It identifies a Route Address, such as Rural Route, Military Route. Example value: RR 6.
This field is available when adding “SERP” to the Loqate engine. Sometimes a site specification and compartment is assigned for delivery to a rural address that does not have a civic address. Example value: SITE 6 COMP 10.
UTC defines the Coordinated Universal Time. Example: 2869 S County Road 210, Knox IN 46534-7969, USA. Returned UTC values: -05:00
DST defines the Daylight Saving Time. Example: 2869 S County Road 210, Knox IN 46534-7969, USA Returned DST values: -06:00
For more information about accessing or using the Time Zone data please contact you account manager or support.
The Royal Mail UDPRN, or Unique Delivery Point Reference Number, is an eight-digit numeric key that is unique to every delivery point record in the PAF. There are some cases where AddressKeys or OrganisationKeys will change or be re-used, so the UDPRN key is a more permanent reference to a given delivery point.
The Unique Property Reference Number (UPRN) is the twelve-digit Ordnance Survey’s unique record ID for a property and is a persistent ID for a property.
The Parent UPRN is a twelve-digit UPRN of the ‘shell’ or ‘owning’ building of a Multiple Residence (flat, unit or apartment). Note that this is inferred from the relationships of an Multi Residence with a PAF parent address record.
The Owning UDPRN is an eight-digit UDPRN key of the ‘shell’ or ‘owning’ PAF building record of a Multiple Residence (flat, unit or apartment). For example, if “Ground Floor Flat, Princes House” is a Multiple Residence record, then “Princes House” would be its owning building.
The Unique Multiple Residence Reference Number (UMRRN) is an eight-digit numeric key that is unique to every Multiple Residence (MR).
A flag indicating if the address is known to be residential or commercial. Values are “R” (residential), “C” (commercial), or blank (unknown).
The Delivery Point Suffix (DPS) is used with a postcode to generate a machine-readable barcode (RM4SCC), which then serves as a unique reference to an active property or delivery point. It is made up of one number (1-9) and one character (A-T), and is assigned by Royal Mail. It is possible that an address is not assigned a DPS value, in which case a default value of 9U or 9Z is used. 1A is also reserved for postcodes that have PostCodeType = L (Large User). See here for more details.
Every address in the Royal Mail Postal Address File (PAF) is assigned an 8-digit value that serves as a persistent reference to a building or delivery point, even when there are changes to a postcode.
Each Organization that is added to PAF is assigned an 8-digit number that serves as a unique delivery point when used alongside the AddressKey and PostcodeType. This is useful to identify small businesses that share an address (the address will appear multiple times in the PAF). For residential addresses, OrganisationKey is set to 0.
Default value for AdministrativeArea, or County, in the United Kingdom. Defined and supplied by Royal Mail. These values were used prior to the postcode system introduced in the 1970s to differentiate Locality names that were the same, or similar (e.g. 'Avon'). This field is assigned as the AdministrativeArea default as it remains static and provides a consistent geographic boundary.
Alternative value for AdministrativeArea, or County, in the United Kingdom. Defined and supplied by Royal Mail. This is the Unitary Authority name (where one is present), and provided by the Office for National Statistics. This field can change more frequently due to administrative changes in the respective area. E.g. “Bristol, City Of”.
Alternative value for AdministrativeArea, or County, in the United Kingdom. Defined and supplied by Royal Mail. These values date from the 1800s and were assigned by the Association of British Counties. E.g. “Gloucestershire”.
This field is used to supply the country name or code (ISO 3166 2-character country code and ISO 3166 3-character country code).
The address level for which the census data was returned. In Census Plus, this field will show the value “Premise”, the most accurate address level in Census Plus data, when there is Premise level match found. Otherwise, the value field would not be visible.
Census Code defines that the Census data is referencing the Census Codes, previously known as the Federal Information Processing Standard (FIPS) code. Unlike its previous FIPS code value, Census Codes are currently used as the government code to represent Admin Places in the U.S. Census Codes are published for Administrative Areas (Admin Level 1-4 in the U.S.) and all Zones with official government codes.
Census Class Code defines the census classification of a place. Census Class Code corresponding to the FIPS 55-3 standard. Census Class Codes are alphanumeric and can be referred at https://www.census.gov/library/reference/code-lists/class-codes.html. Census Class Codes are published only for level 3 and 4 Administrative Areas and Zones. See here for more details.
Defines that the Census data is referring to a county or group of closely tied contiguous counties that serve as a distinct employment region within a metropolitan statistical area that has a population core of at least 2.5 million. See here for full details.
Defines NECTAs (see definition above) containing a single core with a population of at least 2.5 million that are subdivided to form smaller groupings of cities and towns referred to as NECTA Divisions.
Refers to the official name given to the CBSAs which complements the CBSACode field value as defined above. For definition of CBSA, please refer to the CBSACode field definition above.
MetroDivisionName refers to the official name given to the Metropolitan Division which complements the MetroDivisionCode field value as defined above. For definition of Metropolitan Division, please refer to the MetroDivisionCode field definition above.
NECTA Division defines NECTAs (see definition under NECTACode field above) containing a single core with a population of at least 2.5 million that are subdivided to form smaller groupings of cities and towns referred to as NECTA Divisions. NECTADivisionCode is typically represented in a 5-digits value.
NECTADivisionName refers to the official name given to the NECTA Divisions which complements the NECTADivisionCode field value as defined above. For definition of NECTA Division, please refer to the NECTADivisionCode field definition above.
OldMSAName refers to the official name given to the MSA (metropolitan areas) which complements the OldMSACode field value as defined above. For definition of MSA, please refer to the OldMSACode field definition above.
TractCode represents the census data that defines geographic entities within counties, where each TractCode is typically a 6-digit codes (including any leading zeros, and also two “trailing” zeros in the many cases in which the basic tract codes has no suffix). See here for full details.
Each of the following '-Status' fields is an indicator to show if a field is Verified or Identified.
Was this page helpful?