S4.1.2 - msp_GenerateCorrectedAddresses - International Addressing Settings, Inputs and Outputs

Setting

Description

Addressing->apiSettings->enabledInt

When set to “false” the international addressing API is not used even when licensed. Default “true”.

addressing->apiSettings->outputCasing

Used to specify the letter case to use for output fields. Valid options are ‘Upper’ and ‘Title’ (default is ‘Title’).

addressing->apiSettings->confidenceThreshold

Used to specify the threshold at which to stop returning parse interpretations, as a percentage of the confidence of the top result (default is 90).

addressing->apiSettings->minimumMatchscore

Used to specify the minimum matchscore a record must reach in order to avoid reversion (default is 0, valid values are 0-100).

addressing->apiSettings->minimumPostcode

Used to specify the minimum postcode status a record must reach in order to avoid reversion (default is 0, valid values are 0-8).

addressing->apiSettings->minimumVerificationLevel

Used to specify the minimum verification level a record must reach in order to avoid reversion (default is 4, valid values are 0-5).

addressing->apiSettings->minimumVerificationLevelPerCountry

This can be used to override the minimum verification level (see above) for individual countries. This setting can contain multiple items separated by spaces, where each item is of the format "Country=Level" and Country is the three-letter country code as defined by ISO 3166-1. For example, "CAN=3 IND=3" provides levels for Canada and India only whilst all other countries will use the minimum verification level specified above.

addressing->apiSettings->intelligentScoring

If enabled, both the verification status (verified, partial, no match) and the verification level (delivery point, premise, thoroughfare, town, or region) are considered; if disabled, only the verification status is used.

addressing->apiSettings->defaultCountry

3-character country code (ISO 3166-1 alpha-3) of the country to assume when no country name or country code is explicitly specified and matchIT is unable to determine the country from other address details.

addressing->apiSettings->certificationProcesses

Used to enable the postal authority certification processes:
CASS: USPS

Available in locally installed API mode only. Specialist data files must be installed separately.

Setting

Description

addressing->apiSettings->cloudKey

Authenticates calls to the international addressing cloud web service; if not specified, then locally installed data will be used.

Name

Description

Organization or Company

Specifies the company name.

Suite

Specifies the suite or unit.

Street, Street2, Address1 – Address12

Up to 12 address lines can be specified.

Urbanization

Specifies the urbanization.

City or Town

Specifies the city.

State or County or Region

Specifies administrative area.

Zip or Zipplus4 or Postcode

Specifies the 5-digit or 9-digit ZIP code.

Plus4

Specifies the ZIP+4 (if these are in separate columns).

Country

Specifies the country

Name

Description

AddrEngine

This indicates the addressing API (UK, US, INT) that each record is verified with (this is only output if licensed for multiple APIs).

PafFlag

A numeric representation of the PafDesc column.

PafDesc

Indicates the level at which an address was validated (“Verified”, “Good”, “Partial”, “Tentative”, and “NoMatch”). See INT engine specific sections here for details.

PafDescExtra

ErrorCode

See INT engine specific description here.

AddrScore

See INT engine specific description here.

UpdateFlag

See INT engine specific description here.