Inputs

Specify any number of input attributes containing address data.

Note that Capscan Matchcode will work best if the address attributes are input in logical order (for example, Address1, Address2, Town, County, Postcode for UK addresses). For some addresses, it may be useful to input less data (for example, Address1 and Postcode), especially if the address fields contain information that is unlikely to be in the national address files.

Options

Specify the following options:

• Pool Name: Drives the reference data used to match against. Default value: PAF. Note: If no pools are configured, or if all licenses have expired the option will appear empty.

• Search Type: Drives the way in which Matchcode attempts to match the records against the address data. Type: Selection (Cross Check/Quick Browse/Search. Default value: Cross Check.

  Cross Check matches the input address against the address data, expecting a free-form partial or complete address.

  Quick Browse expects a partially input address, for example, Postcode and Building Number.

  Search mode is an all-purpose search that combines Cross Check and Quick Browse mode.

  Note that Cross Check mode returns more information about its matching (see Outputs - Flag attributes below).

  See the Capscan Matchcode API documentation for more information about the different search methods.

Outputs

Describes any data attribute or flag attribute outputs.

Data Attributes

There are the following data attributes:

• capscan.Organisation: The organization on the matched national address file record. Type: Added.

• capscan.Subbuilding: The sub-building on the matched record. Type: Added.

• capscan.Buildingname: The building name on the matched record. Type: Added.

• capscan.Buildingnumber: The building number on the matched record. Type: Added.

• capscan.Depstreet: The dependent street on the matched record. Type: Added.

• capscan.Street: The street on the matched record. Type: Added.

• capscan.DepLocality: The dependent locality on the matched record. Type: Added.

• capscan.Locality: The locality on the matched record. Type: Added.

• capscan.Posttown: The post town on the matched record. Type: Added.

• capscan.County: The county on the matched record. Type: Added.

• capscan.Postcode: The postcode on the matched record. Type: Added.

• capscan.FormattedAddressField: The address for the matched record, output as a single, concatenated, PAF-formatted address output. Type: Added.

Flags

There are the following flags:

• capscan.MatchScore: Stores the Match Score returned by the MatchCode API, indicating its level of confidence in the matching result. Possible values: A value between 0 and 100, where 100 represents the highest level of confidence.

• capscan.OutputStatus: Stores the Output Status returned by the MatchCode API, indicating the high-level result. Possible values:.

  V - Verified

  C - Corrected (and verified)

  N - Not matched

  Blank, if Quick Browse or Search mode was used

• capscan.MatchLevel: Stores the Match Level returned by the MatchCode API, indicating the depth of the address match. Possible values:.

  4 - Address matched to Organization level

  3 - Address matched to Premise level

  2 - Address matched to Street level

  1 - Address matched to Town level

  0 - No address elements matched (Cross Check mode), or No information, if Quick Browse or Search mode was used.