Address Batch Cleansing

Data must be provided in a csv file, containing the following columns.

Column	Type	Required	Description
id	string		A unique identifier for the row
company_name	string		The name of the company at the address
line_1	string	✔️	The first address line
line_2	string		The second address line
locality	string	✔️	The locality of the address
province	string		The province of the address
postal_code	string	✔️	The postal code of the address
country	string		The country provided in ISO 3166 format

It is possible to perform more than one type of cleanse on a single CSV file. For example, an address cleanse could be run on a file, followed by an email cleanse. Make sure that all the required columns are included for each cleanse you wish to perform. The columns can be included in any order. Fields can be left blank if the column is not applicable.

Cleansed File

The returned file will contain the provided columns, and the following:

• address_match_status
• address_error_codes
• cleansed_company_name
• cleansed_line_1
• cleansed_line_2
• cleansed_locality
• cleansed_province
• cleansed_postal_code
• cleansed_country

The address_match_status column will contain the status of the cleanse.

Status	Description
full_match	The address was a perfect match
partial_match	The address was a close match, and has been updated
no_match	There was no potential match for the address
error	There was an error with the address cleanse

The address_error_codes column will contain a comma separated list of reasons why the cleanse wasn't a full match

company_name

Error	Description
company_name_removed	The provided company name was not present in the cleansed address
company_name_added	No company name was provided but one is present in the cleansed address
company_name_mismatch	The provided company name does not match the company name in the cleansed address

line_1 and line_2

Error	Description
street_type_mismatch	The provided street type does not match the street type in the cleansed address
house_or_flat_number_added	No house or flat number was provided but one is present in the cleansed address
house_or_flat_number_not_found	The provided house or flat number was not present in the cleansed address
house_or_flat_number_mismatch	The provided house or flat number does not match the house or flat number in the cleansed address
address_line_mismatch	The provided street line does not match the street line in the cleansed address

locality

Error	Description
locality_name_removed	The provided locality was not present in the cleansed address
locality_name_added	No locality was provided but one is present in the cleansed address
locality_name_mismatch	The provided locality does not match the locality in the cleansed address

province

Error	Description
province_name_removed	The provided province name was not present in the cleansed address
province_name_added	No province name was provided but one is present in the cleansed address
province_name_mismatch	The provided province name does not match the province name in the cleansed address

postal_code

Error	Description
postal_code_added	No postal code was provided but one is present in the cleansed address
postal_code_mismatch	The provided postal code is valid but does not match the postal code in the cleansed address
incorrect_postal_code_area	The area is incorrect in the provided postal code
incorrect_postal_code_district	The district is incorrect in the provided postal code
incorrect_postal_code_subdistrict	The subdistrict is incorrect in the provided postal code
incorrect_postal_code_sector	The sector is incorrect in the provided postal code
incorrect_postal_code_unit	The unit is incorrect in the provided postal code
incorrect_postal_code	The provided postal code is incorrect
postal_code_invalid	The provided postal code is not valid

no_match

Error	Description
address_invalid	The provided address is not valid
postal_code_missing	No postal code was provided and no similar address could be found
postal_code_invalid	The provided postal code is not valid

error

Error	Description
unknown_server_error	An unknown server error ocurred
unknown_error	An unknown error ocurred