Address Cleanse

Verifies, corrects and enriches address data to the highest level of precision and confidence, globally and at scale

Validate 1 to 100 addresses per requests.

Our flexible service allows:

1. Up to 100 addresses per request

2. Each Address can be from any country.

3. Each Address can have its own schema. Reducing effort and improving results.

Resource URL

    POST    https://hosted.mastersoftgroup.com/harmony/rest/v2/address/cleanse

Request

Upto 100 addresses can be validated per request from any country with many input schemas.

This flexibility in our service enables you to call our service using your list schema to achieve optimal results.

{
    "payload": 
    [
      {
      "buildingName": "string",
      "country": "string",
      "eid": "string",
      "flatUnitNumber": "string",
      "flatUnitType": "string",
      "floorLevelNumber": "string",
      "floorLevelType": "string",
      "fullAddress": "string",
      "id": "string",
      "lotNumber": "string",
      "postal": "string",
      "postalNumber": "string",
      "postalType": "string",
      "postcode": "string",
      "street": "string",
      "street2": "string",
      "streetName": "string",
      "streetNumber": "string",
      "streetSuffix": "string",
      "streetType": "string",
      "subLocality": "string",
      "subdwelling": "string",
      "city": "string", 
      "line1": "string",
      "line2": "string",
      "line3": "string",
      "province": "string",
      "sourceOfTruth": "string"
    }
  ],
    "featureOptions": 
    {
      "additionalProp1": "string",
      "additionalProp2": "string",
      "additionalProp3": "string"
    }
}

Example payload schemas

We've designed our API with flexible payload schemas. Meaning you can match the way you have stored the data into the optimal schema for our service.

Reducing your overall integration effort whilst improving performance of the service.

We recommend choosing the below schemas for each address you need cleansed.

Please ensure the information is not duplicated in any of the address lines to achieve better validation results.

Schema 1: Line 1, Line 2, City, Province, Postcode, Country

{
    "payload": [
       {
         "country": "AU",
         "line1": "1/37A Tahnee Street",
         "line2":"",
         "city": "Sanctuary Point",
         "province":"NSW",
         "postcode": "2540"
        },
        {
         "country":"US",
         "line1":"101 California Ave",
         "line2":"Unit @@1101",
         "city":"Santa Mon",
         "province":" CA",
         "postcode":"90403-3523"
        }
       ],
    "featureOptions": {
        "caseType": "UP",
        "exposeAttributes":7,
        "exposeChanges":"1",
        "cleanseEnhance":0,  // set to 1 for premium
        "cleanseGeocode":0,  // set to 1 for premium
        "cleanseCertify":0   // set to 1 for premium
    }
}

Schema 2: Line1, Line2, Line3

  {
    "payload": [
       {
         "country": "AU",
         "line1": "Unit 1",
         "line2":"37A Tahnee Street",
         "line3":"Sanctuary Point NSW 2540"
         },
         {
         "country": "AU",
         "line1": "Unit 1 37A Tahnee Street",
         "line2":"",
         "line3":"Sanctuary Point NSW 2540"
         },
        {
         "country":"US",
         "line1":"101 California Ave",
         "line2":"Unit @@1101",
         "line3":"Santa Monica, CA 90403-3523"
         }
       ],
    "featureOptions": {
        "caseType": "UP",
        "exposeAttributes":7,
        "exposeChanges":"1",
        "cleanseEnhance":0,  // set to 1 for premium
        "cleanseGeocode":0,  // set to 1 for premium
        "cleanseCertify":0   // set to 1 for premium
    }
}

Schema 3: Full Address (Highest level detail)

{
    "payload": [ 
        { 
            "country": "AU",
            "fullAddress": "SE 202, 220 George Street, Syndey 2000",
            "sourceOfTruth": "AUSOTS"
            }, 
        { 
            "country": "AU",
            "fullAddress": "3 Orara Street, waitara nsw",
            "sourceOfTruth": "AUSOTS"
        },
        {
             "country":"US",
             "fullAddress":"101 California Ave Unit @@1101 Santa Monica, CA 90403-3523"
         } 
    ],
    "featureOptions": 
        {
        "caseType": "UP",
        "exposeAttributes":7,
        "exposeChanges":"1",
        "cleanseEnhance":0,    // set to 1 for premium
        "cleanseGeocode":0,    // set to 1 for premium
        "cleanseCertify":0     // set to 1 for premium
    }
}

Schema 4: Each component (Lowest level detail)

{
    "payload": [ 
        {
             "country": "AU",
             "subdwelling": "SE 202",
             "streetNumber": "220",
             "streetName": "George",
             "streetType": "Street",
             "city": "Syndey",
             "province": "NSW",
             "postcode": "2000"
             
        },
        {
             "country": "US",
             "subdwelling": "Unit @@1101",
             "streetNumber": "101",
             "streetName": "California",
             "streetType": "Ave",
             "city": "Santa Monica",
             "province":"CA",
             "postcode": "90403-3523"            
             
        }
    ],
    "featureOptions": 
        {
        "caseType": "UP",
        "exposeAttributes":7,
        "exposeChanges":"1",
        "cleanseEnhance":0,     // set to 1 for premium
        "cleanseGeocode":0,     // set to 1 for premium
        "cleanseCertify":0      // set to 1 for premium
    }
}

Schema for USA Postal Certified

Using cleanseCertify feature option with US addresses mandates the input address presentation to be entered in the following recommended formats for best match validation results.

{
    "payload": [
      
        {
         "country":"US",
         "line1":"101 California Ave",
         "line2":"Unit #1101",
         "line3":"Santa Monica, CA 90403-3523"
        },
        {
         "country":"US",
         "line1":"101 California Ave",
         "line2":"Unit 1101",
         "city":"Santa Monica",
         "province":"CA",
         "postcode":"90403-3523"
        },
    ],
    "featureOptions": {       
          "cleanseCertify":1   // set to 1 for premium            
    }
}

Line 1: is a representation of address fields usually house sub-dwellings, street numbers, street names, buildingName etc. This is usually determined by how you have data stored.

Line 2: is a representation of address fields usually additional information not contained in Line 1 such as suite numbers or floor information or subdwellings (not contained in Line 1). This is usually determined by how you have data stored.

Line 3: is a representation of address fields usually around city, province, suburbs/locality for example "suburb postcode region".

Note: Please ensure the information populated in city/province/postcode is not duplicated in any of the address lines to achieve better validation results.

Service Options

Address Cleanse V2 API leverages both Standard and Premium Address Cleanse services.

Standard Cleanse Service:

The validation data set for standard cleanse service is using our default datasets (AU: GNAF, NZ: NZPAF, INTL: INTL Standard. By default the API is set to Standard services meaning you do not need to specify within the API requests.

    "featureOptions": 
        {
        "cleanseEnhance":0,
        "cleanseGeocode":0,
        "cleanseCertify":0 
    }

Premium Cleanse Service:

This service provides access to advanced cleanse functions.

This allows the input request to pass on specific sourceOfTruth for AU, NZ addresses and allows to enhance the international data by setting the featureOptions to 1.

To get INTL geocodes requires "cleanseGeocode":1.

Utilizing cleanse featureOptions requires access. To get access contact a member of the team.

// Enabling Premium Cleanse Service
    "featureOptions": 
        {
        "cleanseEnhance":1,
        "cleanseGeocode":1,
        "cleanseCertify":1 
    }

Configurations

Name	type	example
sourceOfTruth	string	defaults AU: GNAF NZ: NZPAF INTL: INTL	Premium service only. Defines selection of premium datasets being used to Cleanse the data.
caseType	string	TITLE, default empty	caseType for returned address components and attributes. LOW = lowercase, UP = UPPERCASE, TITLE = Title Case
exposeAttributes	Integer	("0"|"1"|"7") default 1	AU only. Enriches the data with address related attributes depending on value. Options 0,1,7
exposeChanges	Integer	("0"|"1") default 0	AU NZ only. Determines whether to include PDP change items in response.
cleanseEnhance	boolean	("0"|"1") default 0	Premium service only. This option when set to 1 enhances AU NZ data with additional data attributes based on sourceOfTruth set in the input. AU: AUPAF, AUSOTS NZ: NZAD For International addresses this option will determine the Enhanced data pack to be used based on the country input in the request.
cleanseCertify	boolean	("0"|"1") default 0	Premium service only. International only. This option when set to 1 uses the country input to determine which certification data set to be used for international address validation.
cleanseGeocode	boolean	("0"|"1") default 0	Premium service only. International only. This option when set to 1 returns geocode information for international addresses.

Response

See Address Field Mapping Guide for integration best practices.

Response of Basic Cleanse Service

The response body is an AddressRestResponse object:

Basic Response: Australia

{
    "status": "SUCCESS",
    "messages": [],
    "payload": [
        {
            "_type": "ParsedAddressAu",
            "fullAddress": "37A TAHNEE STREET,SANCTUARY POINT NSW 2540",
            "country": "AUSTRALIA",
            "postcode": "2540",
            "subLocality": "",
            "street2": "",
            "street": "TAHNEE STREET",
            "streetNumber": "37A",
            "postal": "",
            "postalType": "",
            "postalNumber": "",
            "buildingName": "",
            "subdwelling": "1",
            "eid": null,
            "lotNumber": null,
            "flatUnitNumber": "1",
            "flatUnitType": "",
            "floorLevelNumber": "",
            "floorLevelType": "",
            "streetSuffix": "",
            "streetType": "STREET",
            "streetName": "TAHNEE",
            "attributes": {
                "AddressMessage": "POINT",
                "AddressQuality": "9",
                "City": "SANCTUARY POINT",
                "CountryIso2": "AU",
                "CountryIso3": "AUS",
                "CountryIsoNumber": "036",
                "GeocodeLevel": "7",
                "GNAFConfidence": "2",
                "GNAFGroupPID": "NSW2928419",
                "GNAFLocalityPID": "LOCFFAAAEA80667",
                "GNAFPID": "GANSW720384012",
                "GNAFPIDPosition": "SINGLE",
                "GNAFPointPID": "GANSW720384012",
                "GNAFReliability": "2",
                "is_principal": "P",
                "Latitude": "-35.09635821",
                "Longitude": "150.61885685",
                "MeshblockId": "11221970000",
                "MeshBlockID2016": "11205649900",
                "MeshBlockID2021": "11221970000",
                "ParcelID": "1/SP103571",
                "ProvinceCode": "NSW",
                "ProvinceName": "NSW",
                "UserInferred": "1"
            },
            "id": null,
            "careOf": "",
            "exception": null,
            "unknown": "",
            "changedItems": [
                {
                    "componentID": "GNAFValidation",
                    "actionType": "INFO",
                    "affectedElement": "PointSubdwellingAddress",
                    "oldValue": "",
                    "newValue": ""
                },
                {
                    "componentID": "GNAFValidation",
                    "actionType": "INFO",
                    "affectedElement": "RecordMatch",
                    "oldValue": "",
                    "newValue": "POINT"
                },
                .........

],
            "state": "NSW",
            "locality": "SANCTUARY POINT"
        }
    ]
}	    

Basic Response: New Zealand

{
    "status": "SUCCESS",
    "messages": [],
    "payload": [
        {
            "_type": "ParsedAddressNz",
            "fullAddress": "FLAT 1F, 1C QUEEN MARY AVENUE, EPSOM, AUCKLAND 1023",
            "country": "NEW ZEALAND",
            "postcode": "1023",
            "subLocality": "",
            "street2": "",
            "street": "QUEEN MARY AVENUE",
            "streetNumber": "1C",
            "postal": "",
            "postalType": "",
            "postalNumber": "",
            "buildingName": "",
            "subdwelling": "L 1 FLAT 1F",
            "eid": null,
            "lotNumber": null,
            "flatUnitNumber": "1f",
            "flatUnitType": "FLAT",
            "floorLevelNumber": "1",
            "floorLevelType": "L",
            "streetSuffix": "",
            "streetType": "AVENUE",
            "streetName": "QUEEN MARY",
            "attributes": {
                "AddressQuality": "9",
                "AddressType": "URBAN",
                "City": "AUCKLAND",
                "CountryIso2": "NZ",
                "CountryIso3": "NZL",
                "CountryIsoNumber": "554",
                "DPID": "3074094",
                "GeocodeLevel": "2",
                "Latitude": "-36.892132",
                "Longitude": "174.774021",
                "MatchedRule": "NZPAF_URBAN_ADDRESS: NAME_BASED_MATCH_RULE(EXACT_MATCH)",
                "MeshblockId": "4001695",
                "NZMapGrid": "2668501 6477320",
                "NZTM": "1758075.229551 5915624.334052",
                "ParcelId": "4801242",
                "PostalID": "3074094",
                "ProvinceCode": "",
                "ProvinceName": "",
                "UserInferred": "L 1",
                "XCoordinate": "2668501",
                "XNztm": "1758075.229551",
                "YCoordinate": "6477320",
                "YNztm": "5915624.334052"
            },
            "id": null,
            "rdNumber": "",
            "careOf": "",
            "exception": null,
            "unknown": "",
            "changedItems": null,
            "suburb": "EPSOM",
            "townCity": "AUCKLAND"
        }
    ]
}

Basic Response: International

{
    "status": "SUCCESS",
    "messages": [],
    "payload": [
        {
            "_type": "AddressIntl",
            "fullAddress": "101 CALIFORNIA AVE UNIT 1101,SANTA MONICA CA 90403-3523",
            "country": "UNITED STATES",
            "postcode": "90403-3523",
            "street2": null,
            "street": "CALIFORNIA AVE",
            "streetNumber": "101",
            "postal": null,
            "postalType": null,
            "postalNumber": null,
            "buildingName": null,
            "subdwelling": "UNIT 1101",
            "attributes": {
                "CountryIso2": "US",
                "PremiseNumber": "101",
                "HyphenClass": "C",
                "CountryIso3": "USA",
                "DeliveryAddress": "101 CALIFORNIA AVE UNIT 1101",
                "City": "SANTA MONICA",
                "Sequence": "1",
                "AVC": "V55-I55-P8-099",
                "PostalCodeSecondary": "3523",
                "DeliveryAddress1": "101 CALIFORNIA AVE UNIT 1101",
                "ProvinceName": "CA",
                "SubAdministrativeArea": "LOS ANGELES",
                "AQI": "B",
                "ProvinceCode": "CA",
                "CountryIsoNumber": "840",
                "PostalCodePrimary": "90403",
                "Line1": "101 CALIFORNIA AVE UNIT 1101",
                "Line2": "SANTA MONICA CA 90403-3523",
                "MatchRuleLabel": "1",
                "SubBuildingLeadingType": "UNIT"
            },
            "id": null,
            "district": null,
            "city": "SANTA MONICA",
            "province": "CA"
        }
    ]
}

Response of Premium Cleanse Service

The response body is an AddressRestResponse object:

Attributes for Australia and NewZealand address samples may vary based on the input sourceOfTruth chosen.

Reduce integration effort. See Address Field Mappings to use the Universal Response objects (same fields in every response).

Premium Response: Australia

{
    "status": "SUCCESS",
    "messages": [],
    "payload": [
        {
            "_type": "ParsedAddressAu",
            "fullAddress": "37 TAHNEE ST,SANCTUARY POINT NSW 2540",
            "country": "AUSTRALIA",
            "postcode": "2540",
            "subLocality": "",
            "street2": "",
            "street": "TAHNEE ST",
            "streetNumber": "37",
            "postal": "",
            "postalType": "",
            "postalNumber": "",
            "buildingName": "",
            "subdwelling": "UNIT 1",
            "eid": null,
            "lotNumber": null,
            "flatUnitNumber": "1",
            "flatUnitType": "UNIT",
            "floorLevelNumber": "",
            "floorLevelType": "",
            "streetSuffix": "",
            "streetType": "ST",
            "streetName": "TAHNEE",
            "attributes": {
                "Accuracy": "PPM",
                "AddressQuality": "9",
                "advertising_mail_ind": "N",
                "Barcode": "1301011211001001012110322111221321013",
                "Bsp": "020",
                "City": "SANCTUARY POINT",
                "CountryIso2": "AU",
                "CountryIso3": "AUS",
                "CountryIsoNumber": "036",
                "deliver_mail_ind": "Y",
                "DPID": "54031173",
                "non_residential_ind": "N",
                "PAFPosition": "SINGLE",
                "PostalID": "54031173",
                "PostalIDPosition": "SINGLE",
                "ProvinceCode": "NSW",
                "ProvinceName": "NSW",
                "residential_ind": "Y",
                "UserInferred": "UNIT 1"
            },
            "id": null,
            "careOf": "",
            "exception": null,
            "unknown": "",
            "changedItems": [
                {
                    "componentID": "AMASHAVE",
                    "actionType": "INFO",
                    "affectedElement": "PointSubdwellingAddress",
                    "oldValue": "",
                    "newValue": ""
                },
                {
                    "componentID": "AMASHAVE",
                    "actionType": "MODIFY",
                    "affectedElement": "PostalId",
                    "oldValue": "00000000",
                    "newValue": "54031173"
                },
......
],
            "state": "NSW",
            "locality": "SANCTUARY POINT"
        }
    ]
}

Premium Response: New Zealand

{
    "status": "SUCCESS",
    "messages": [],
    "payload": [
        {
            "_type": "ParsedAddressNz",
            "fullAddress": "1C QUEEN MARY AVENUE, EPSOM, AUCKLAND 1023",
            "country": "NEW ZEALAND",
            "postcode": "1023",
            "subLocality": "",
            "street2": "",
            "street": "QUEEN MARY AVENUE",
            "streetNumber": "1C",
            "postal": "",
            "postalType": "",
            "postalNumber": "",
            "buildingName": "",
            "subdwelling": "L 1 FLAT 1F",
            "eid": null,
            "lotNumber": null,
            "flatUnitNumber": "1f",
            "flatUnitType": "FLAT",
            "floorLevelNumber": "1",
            "floorLevelType": "L",
            "streetSuffix": "",
            "streetType": "AVENUE",
            "streetName": "QUEEN MARY",
            "attributes": {
                "AddressQuality": "9",
                "AddressType": "URBAN",
                "City": "AUCKLAND",
                "CountryIso2": "NZ",
                "CountryIso3": "NZL",
                "CountryIsoNumber": "554",
                "DeliveredTo": "N",
                "DPID": "3663896",
                "ExtraAddressLine1": "1C QUEEN MARY AVENUE",
                "ExtraAddressLine2": "EPSOM",
                "ExtraAddressLine3": "AUCKLAND  1023",
                "GeocodeLevel": "1",
                "Latitude": "-36.8920929147149",
                "Longitude": "174.77399503296274",
                "MatchedRule": "NZPAF_URBAN_ADDRESS: NAME_BASED_MATCH_RULE(EXACT_MATCH)",
                "MeshblockId": "4001695",
                "NZMapGrid": "2668499 6477324",
                "NZTM": "1758072.99109137 5915628.69698302",
                "ParcelId": "4801242",
                "PostalID": "3663896",
                "ProvinceCode": "",
                "ProvinceName": "AUCKLAND REGION",
                "RegionalCouncilId": "2",
                "RegionalCouncilName": "AUCKLAND REGION",
                "Source": "NZPOST",
                "TaId": "76",
                "TaName": "AUCKLAND",
                "UserInferred": "L 1 FLAT 1F",
                "XCoordinate": "2668499",
                "XNztm": "1758072.99109137",
                "YCoordinate": "6477324",
                "YNztm": "5915628.69698302"
            },
            "id": null,
            "rdNumber": "",
            "deliveredTo": "N",
            "careOf": "",
            "exception": null,
            "unknown": "",
            "changedItems": [
                {
                    "componentID": "CaseConversion",
                    "actionType": "MODIFY",
                    "affectedElement": "Address Line",
                    "oldValue": "1C QUEEN MARY AVENUE, EPSOM, AUCKLAND 1023",
                    "newValue": "1c Queen Mary Avenue, Epsom, Auckland 1023"
                },
                {
                    "componentID": "CaseConversion",
                    "actionType": "MODIFY",
                    "affectedElement": "Street Number",
                    "oldValue": "1C",
                    "newValue": "1c"
                },

...............

],
            "suburb": "EPSOM",
            "townCity": "AUCKLAND"
        }
    ]
}

Attributes for International addresses may vary based on the cleanseXXX feature options chosen.

Premium Response: International with cleanseCertify set to 1.:

{
    "status": "SUCCESS",
    "messages": [],
    "payload": [
        {
            "_type": "AddressIntl",
            "fullAddress": "101 CALIFORNIA AVE UNIT 1101,SANTA MONICA CA 90403-3523",
            "country": "UNITED STATES",
            "postcode": "90403-3523",
            "street2": null,
            "street": "CALIFORNIA AVE",
            "streetNumber": "101",
            "postal": null,
            "postalType": null,
            "postalNumber": "",
            "buildingName": null,
            "subdwelling": "UNIT 1101",
            "attributes": {
                "CountryIso2": "US",
                "eLOTNumber": "0070",
                "CongressionalDistrict": "36",
                "CountryIso3": "USA",
                "eLOTCode": "A",
                "DropCount": "",
                "DropSiteIndicator": " ",
                "AutoZoneIndicator": "D",
                "DeliveryAddress1": "101 CALIFORNIA AVE UNIT 1101",
                "BusinessIndicator": " ",
                "Footnotes": "N#",
                "OtherIndicator": "",
                "PostalCodeSecondaryRangeHigh": "3523",
                "CarrierRoute": "C030",
                "LACSLinkIndicator": " ",
                "AQI": "B",
                "DPVConfirmedIndicator": "Y",
                "CountryIsoNumber": "840",
                "CentralizedIndicator": "",
                "PMBType": "",
                "CurbIndicator": "",
                "DPVLACSIndicator": " ",
                "PrimaryNumRangeLow": "0000000101",
                "ReturnCode": "31",
                "PostalCodeSecondaryRangeLow": "3523",
                "VacantIndicator": "N",
                "City": "SANTA MONICA",
                "Sequence": "1",
                "AVC": "V55-I55-P8-097",
                "PostalCodeSecondary": "3523",
                "DependentLocality": "",
                "FalsePositiveIndicator": " ",
                "SUITELinkFootnote": "",
                "SecondaryNumRangeCode": "B",
                "NDCBUIndicator": "",
                "ThoroughfarePreDirection": "",
                "ThoroughfareTrailingType": "AVE",
                "PMBNumber": "",
                "PrimaryNumRangeCode": "O",
                "Organization": "",
                "PremiseNumber": "101",
                "SecondaryNumRangeLow": "00001004",
                "PrimaryNumRangeHigh": "0000000101",
                "DeliveryAddress": "101 CALIFORNIA AVE UNIT 1101",
                "ThrowbackIndicator": "N",
                "ResidentialDelivery": "Y",
                "CheckDigit": "8",
                "ProvinceName": "CA",
                "CMRAIndicator": "N",
                "DeliveryPointBarCode": "768",
                "RecordType": "H",
                "NoStatIndicator": "N",
                "SecondaryAddressLine": "SANTA MONICA CA 90403-3523",
                "PostBoxType": "",
                "PostalCodePrimary": "90403",
                "DPVFootnotes": "AABB",
                "FIPSCountyCode": "037",
                "EducationalIndicator": " ",
                "SecondaryNumRangeHigh": "00001102",
                "PrimaryAddressLine": "101 CALIFORNIA AVE UNIT 1101",
                "Finance": "056978",
                "SeasonalIndicator": " ",
                "ThoroughfarePostDirection": "",
                "SubAdministrativeArea": "LOS ANGELES",
                "DefaultFlag": " ",
                "ProvinceCode": "CA",
                "LACSLinkCode": "",
                "Line1": "101 CALIFORNIA AVE UNIT 1101",
                "Line2": "SANTA MONICA CA 90403-3523",
                "SubBuildingLeadingType": "UNIT"
            },
            "id": null,
            "district": null,
            "city": "SANTA MONICA",
            "province": "CA"
        }
    ]
}

Premium Response: International with cleanseEnhance set to 1.

{
    "status": "SUCCESS",
    "messages": [],
    "payload": [
        {
            "_type": "AddressIntl",
            "fullAddress": "101 CALIFORNIA AVE UNIT 1101,SANTA MONICA CA 90403-3523",
            "country": "UNITED STATES",
            "postcode": "90403-3523",
            "street2": null,
            "street": "CALIFORNIA AVE",
            "streetNumber": "101",
            "postal": null,
            "postalType": null,
            "postalNumber": null,
            "buildingName": null,
            "subdwelling": "UNIT 1101",
            "attributes": {
                "CensusClassCode": "C1",
                "CountryIso2": "US",
                "PremiseNumber": "101",
                "CountryIso3": "USA",
                "DeliveryAddress": "101 CALIFORNIA AVE UNIT 1101",
                "AdministrativeAreaISO2": "US-CA",
                "DeliveryAddress1": "101 CALIFORNIA AVE UNIT 1101",
                "ProvinceName": "CA",
                "TimeZone_DST": "-07:00",
                "AQI": "B",
                "CountryIsoNumber": "840",
                "PostalCodePrimary": "90403",
                "GNISFeatureID": "2411825",
                "CensusIndicator": "LOCALITY",
                "HyphenClass": "C",
                "City": "SANTA MONICA",
                "Sequence": "1",
                "AVC": "V55-I55-P8-099",
                "PostalCodeSecondary": "3523",
                "CensusCode": "70000",
                "TimeZone_UTC": "-08:00",
                "SubAdministrativeArea": "LOS ANGELES",
                "ProvinceCode": "CA",
                "MetropolitanDivision": "LOS ANGELES-LONG BEACH-GLENDALE, CA=31084",
                "Line1": "101 CALIFORNIA AVE UNIT 1101",
                "CBSAMetropolitanStatisticalArea": "LOS ANGELES-LONG BEACH-ANAHEIM, CA=31080",
                "TimeZone_Name": "PACIFIC STANDARD TIME",
                "Line2": "SANTA MONICA CA 90403-3523",
                "MatchRuleLabel": "1 D1 D1 D1",
                "SubBuildingLeadingType": "UNIT"
            },
            "id": null,
            "district": null,
            "city": "SANTA MONICA",
            "province": "CA"
        }
    ]
}

Premium Response: International with cleanseGeocode set to 1.

{
    "status": "SUCCESS",
    "messages": [],
    "payload": [
        {
            "_type": "AddressIntl",
            "fullAddress": "101 CALIFORNIA AVE UNIT 1101,SANTA MONICA CA 90403-3523",
            "country": "UNITED STATES",
            "postcode": "90403-3523",
            "street2": null,
            "street": "CALIFORNIA AVE",
            "streetNumber": "101",
            "postal": null,
            "postalType": null,
            "postalNumber": null,
            "buildingName": null,
            "subdwelling": "UNIT 1101",
            "attributes": {
                "CountryIso2": "US",
                "PremiseNumber": "101",
                "HyphenClass": "C",
                "CountryIso3": "USA",
                "DeliveryAddress": "101 CALIFORNIA AVE UNIT 1101",
                "Latitude": "34.018630",
                "City": "SANTA MONICA",
                "Sequence": "1",
                "Longitude": "-118.502740",
                "AVC": "V55-I55-P8-099",
                "PostalCodeSecondary": "3523",
                "DeliveryAddress1": "101 CALIFORNIA AVE UNIT 1101",
                "ProvinceName": "CA",
                "GeoAccuracy": "P4",
                "SubAdministrativeArea": "LOS ANGELES",
                "AQI": "B",
                "GeoDistance": "0.0",
                "ProvinceCode": "CA",
                "CountryIsoNumber": "840",
                "PostalCodePrimary": "90403",
                "Line1": "101 CALIFORNIA AVE UNIT 1101",
                "Line2": "SANTA MONICA CA 90403-3523",
                "MatchRuleLabel": "1",
                "SubBuildingLeadingType": "UNIT"
            },
            "id": null,
            "district": null,
            "city": "SANTA MONICA",
            "province": "CA"
        }
    ]
}

Exception Message

Failed to Parse:

Exception message for AU NZ "failed to parse record" looks like the following.

"Exception": "H112 : No pattern matched for this input - VRI BUILDING BLDG 403 30 FLEMINGTON ROAD, PARKVILLE VIC 3052. Check for punctuation errors, duplicate fields, incorrect input format and incorrect input data."

Exception Response: Australia and NewZealand

{
    "status": "SUCCESS",
    "messages": [],
    "payload": [
        {
            "_type": "AddressV2",
            "fullAddress": "VRI BUILDING BLDG 403 30 FLEMINGTON ROAD, PARKVILLE VIC 3052",
            "country": "AU",
            "attributes": {
                "Exception": "H112 : No pattern matched for this input - VRI BUILDING BLDG 403 30 FLEMINGTON ROAD, PARKVILLE VIC 3052. Check for punctuation errors, duplicate fields, incorrect input format and incorrect input data."
            }
        },
        {
            "_type": "AddressV2",
            "fullAddress": "PRESTIGE BUILDING FLAT 2F 31 PIRIE STREET, MOUNT VICTORIA, WELLINGTON 6011",
            "country": "NZ",
            "attributes": {
                "Exception": "H112 : No pattern matched for this input - PRESTIGE BUILDING FLAT 2F 31 PIRIE STREET, MOUNT VICTORIA, WELLINGTON 6011. Check for punctuation errors, duplicate fields, incorrect input format and incorrect input data."
            }
        }
    ]
}

Failed to Validate

For AU ad NZ: ChangedItems in the response will indicate the records not validated. "affectedElement": "ParsedWithoutMatchInPaf"

For International address: AVC code indicates the address match level. Records with AVC codes prefixed with "U" are unverified matches.

Records failed to validate: Australia, NewZealand and International

{
    "status": "SUCCESS",
    "messages": [],
    "payload": [
        {
            "_type": "ParsedAddressAu",
            "fullAddress": "XYZ BUNGARRIBEE QLD 2807",
            "country": "AUSTRALIA",
            "postcode": "2807",
            "subLocality": "",
            "street2": "",
            "street": "",
            "streetNumber": "",
            "postal": "",
            "postalType": "",
            "postalNumber": "",
            "buildingName": "",
            "subdwelling": "",
            "eid": null,
            "lotNumber": null,
            "flatUnitNumber": "",
            "flatUnitType": "",
            "floorLevelNumber": "",
            "floorLevelType": "",
            "streetSuffix": "",
            "streetType": "",
            "streetName": "",
            "attributes": {
                "AddressQuality": "4",
                "City": "XYZ BUNGARRIBEE",
                "CountryIso2": "AU",
                "CountryIso3": "AUS",
                "CountryIsoNumber": "036",
                "ProvinceCode": "QLD",
                "ProvinceName": "QLD"
            },
            "id": null,
            "careOf": "",
            "exception": null,
            "unknown": "",
            "changedItems": [
                {
                    "componentID": "GNAFValidation",
                    "actionType": "INFO",
                    "affectedElement": "ParsedWithoutMatchInPaf",
                    "oldValue": "",
                    "newValue": ""
                },
                {
                    "componentID": "GNAFValidation",
                    "actionType": "INFO",
                    "affectedElement": "HE019",
                    "oldValue": "",
                    "newValue": ""
                }
            ],
            "state": "QLD",
            "locality": "XYZ BUNGARRIBEE"
        },
        {
            "_type": "ParsedAddressNz",
            "fullAddress": "UNIT 1 G 86 VICTORIA STREET, WELLINGTON CENTRAL, WELLINGTON 6011",
            "country": "NEW ZEALAND",
            "postcode": "6011",
            "subLocality": "",
            "street2": "",
            "street": "VICTORIA ST",
            "streetNumber": "86",
            "postal": "",
            "postalType": "",
            "postalNumber": "",
            "buildingName": "",
            "subdwelling": "G UNIT 1",
            "eid": null,
            "lotNumber": null,
            "flatUnitNumber": "1",
            "flatUnitType": "UNIT",
            "floorLevelNumber": "G",
            "floorLevelType": "",
            "streetSuffix": "",
            "streetType": "ST",
            "streetName": "VICTORIA",
            "attributes": {
                "AddressQuality": "9",
                "City": "WELLINGTON",
                "CountryIso2": "NZ",
                "CountryIso3": "NZL",
                "CountryIsoNumber": "554",
                "MatchedRule": "NZPAF_URBAN_ADDRESS: WIDE_MATCH_RULE(NO_MATCH)",
                "ProvinceCode": "",
                "ProvinceName": ""
            },
            "id": null,
            "rdNumber": "",
            "careOf": "",
            "exception": null,
            "unknown": "",
            "changedItems": [
                {
                    "componentID": "NZHAVEGeoPAF",
                    "actionType": "INFO",
                    "affectedElement": "PointUrbanSubdwellingAddress",
                    "oldValue": "",
                    "newValue": ""
                },
                {
                    "componentID": "NZHAVEGeoPAF",
                    "actionType": "INFO",
                    "affectedElement": "ParsedWithoutMatchInPaf",
                    "oldValue": "",
                    "newValue": ""
                },
                {
                    "componentID": "NZHAVEGeoPAF",
                    "actionType": "ADD",
                    "affectedElement": "HE003",
                    "oldValue": "",
                    "newValue": ""
                },
                {
                    "componentID": "NZAddressStandardization",
                    "actionType": "MODIFY",
                    "affectedElement": "StreetType",
                    "oldValue": "STREET",
                    "newValue": "ST"
                }
            ],
            "suburb": "WELLINGTON CENTRAL",
            "townCity": "WELLINGTON"
        },
        {
            "_type": "AddressIntl",
            "fullAddress": null,
            "country": "UNITED STATES",
            "postcode": null,
            "street2": null,
            "street": null,
            "streetNumber": null,
            "postal": null,
            "postalType": null,
            "postalNumber": null,
            "buildingName": null,
            "subdwelling": null,
            "attributes": {
                "CountryIso2": "US",
                "eLOTNumber": "",
                "CongressionalDistrict": "",
                "CountryIso3": "USA",
                "eLOTCode": "",
                "DropCount": "",
                "DropSiteIndicator": " ",
                "AutoZoneIndicator": "",
                "BusinessIndicator": " ",
                "Footnotes": "C#",
                "OtherIndicator": "",
                "PostalCodeSecondaryRangeHigh": "0000",
                "CarrierRoute": "",
                "LACSLinkIndicator": " ",
                "AQI": "E",
                "DPVConfirmedIndicator": " ",
                "CountryIsoNumber": "840",
                "CentralizedIndicator": "",
                "PMBType": "",
                "CurbIndicator": "",
                "DPVLACSIndicator": " ",
                "PrimaryNumRangeLow": "",
                "ReturnCode": "12",
                "PostalCodeSecondaryRangeLow": "0000",
                "VacantIndicator": " ",
                "City": "",
                "Sequence": "1",
                "AVC": "U00-I00-P0-100",
                "PostalCodeSecondary": "",
                "DependentLocality": "",
                "FalsePositiveIndicator": " ",
                "SUITELinkFootnote": "",
                "SecondaryNumRangeCode": " ",
                "NDCBUIndicator": "",
                "PMBNumber": "",
                "PrimaryNumRangeCode": " ",
                "Organization": "",
                "SecondaryNumRangeLow": "",
                "PrimaryNumRangeHigh": "",
                "ThrowbackIndicator": " ",
                "ResidentialDelivery": " ",
                "CheckDigit": "",
                "ProvinceName": "",
                "CMRAIndicator": " ",
                "DeliveryPointBarCode": "",
                "RecordType": " ",
                "NoStatIndicator": " ",
                "SecondaryAddressLine": "",
                "PostalCodePrimary": "",
                "DPVFootnotes": "A1M1",
                "FIPSCountyCode": "",
                "EducationalIndicator": " ",
                "SecondaryNumRangeHigh": "",
                "PrimaryAddressLine": "",
                "Finance": "000000",
                "SeasonalIndicator": " ",
                "DefaultFlag": " ",
                "ProvinceCode": "",
                "LACSLinkCode": ""
            },
            "id": null,
            "district": null,
            "city": "",
            "province": ""
        }
    ]
}