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, CountrySchema 2: Line1, Line2, Line3Schema 3: Full Address (Highest level detail)Schema 4: Each component (Lowest level detail)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.
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.
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.
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.
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
Premium Response: New Zealand
Attributes for International addresses may vary based on the cleanseXXX feature options chosen.
Premium Response: International with cleanseCertify set to 1.:Premium Response: International with cleanseEnhance set to 1.Premium Response: International with cleanseGeocode set to 1.
Exception Message
Failed to Parse:
Exception message for AU NZ "failed to parse record" looks like the following.
Exception Response: Australia and NewZealand
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
"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."
{
"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."
}
}
]
}