Headers

Name Type Description
Diagnostics string The diagnostic information.
Configuration string Custom configuration name

Body parameters

Headers

Name Type Description
layout string This returns the name of a layout.
return_unused string This will return any unused elements from your input.
return_extra_match_info string This provides any additional match information.
searches string
  • reference_id - If the request contained an ID, it will be returned here.
  • search - Contains the search information.

Headers

Name Type Description
Diagnostics string The diagnostic information.
Configuration string Custom configuration name

Body parameters

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 string
  • code - Product error code
  • message - Product error information message
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 string The formatted address line from the latest retrieved address.

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
  • 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 - Part-used piece of text (should only be retained if 'enhance part spent' setting is enabled).
line_type string
  • address - The unused text is a generic address part.
  • name - The unused text is a name.
line_position string
  • 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 (match_info)

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
  • 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
  • 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 The 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.