Data Quality user documentation
home/Address validation/Batch API/API reference (REST)/Clean

Clean

Headers

Name Type Description
Enable-Diagnostics string Not implemented.
Configuration
(Optional)		 string Custom configuration name.

Body parameters

Name Type Description
layout string This name of a layout to use for formatting address matches.
return_unused
(Optional)		 string Setting this parameter to true will include any unused elements from your input in the response.
return_extra_match_info
(Optional)		 string Setting this parameter to true will include additional match information in the response.
searches collection Collection containing all search objects in this batch.
reference_id
(Optional)		 string Unique customer defined ID. If supplied, this ID will be returned with the response.
search string The address to clean.

Body parameters

The response from the API returns a results collection. Every array item includes the below fields. Should an error occur, an error object is returned instead.

Name Type Description
reference_id string If the request contained an ID, it will be returned here.
original_search string Contains the original search as in the request.
error object Information on a product error that occured.
code integer The error code.
message string The description of the error.
postcode string The postcode matched to the input.
country string The Country being used for this search.
match_code string The match code returned from this search for this input.
formatted_lines collection A collection of formatted address lines from the latest retrieved address.
unused_lines collection A collection containing information on the unused lines. See Unused lines for more information.
match_info object Expanded match information, that can be found in encoded form in the match code. See Match information for more information.

Unused lines

Information on the unused lines.

Name Type Description
unused_input string Gets any unused lines from the latest input address.
line_completeness string The possible values for this parameter are:
  • none - unused.
  • complete_line - The unused text is a complete input line.
  • partial_line - The unused text is part of an input line.
  • text_fragment - Partially used piece of text (should only be retained if 'enhance part spent' setting is enabled).
line_type string The possible values for this parameter are:
  • address - The unused text is a generic address part.
  • name - The unused text is a name.
line_position string The possible values for this parameter are:
  • none - unused.
  • pre_street - The unused text is a complete input line.
  • post_street - The unused text is part of an input line.
is_care_of boolean Denotes whether the line is a 'care of' premises prefix.
is_alpha_premise_suffix boolean Denotes whether the line is an alphabetic premises suffix.

Match information

Expanded match information, that can be found in encoded form in the match code.

Name Type Descrption
match_type string Provides the match success for the input address.
confidence string The confidence level of the match defined by the match rules.
postcode_action string The possible value for this parameter are:
  • none - No action was taken
  • ok - The existing postal code was already correct.
  • added - A new postal code has been added.
  • corrected - The existing postal code has been corrected.
address_action string The possible value for this parameter are:
  • none - No action was taken as the supplied address was not matched.
  • reformatted - Part or all of the address has been reformatted.
  • enhanced - The existing address was enhanced. No significant information has been removed, but some information has been added.
  • corrected - The existing address has been corrected.
generic_info collection A collection of generic information bits for the match.

The following response codes can be returned by the API:

Status Code Reason phrase Description
200 Success Request processed successfully.
400 Bad Request Request failed due to malformed syntax.
408 Request timeout Response was not returned within the timeout allowance.
500 Internal Server Error The server has encountered an error.
Batch API

API reference (REST)