Support DESK

Follow

S4.1.3 - msp_GenerateCorrectedAddresses - US Addressing Settings, Inputs and Outputs

Previous Article matchIT SQL Index Next Article

4.1.3.1 US Addressing Settings

Setting

Description

Addressing->apiSettings->enabledUS

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

addressing->apiSettings->processing

Only applicable for US addresses that contain both a box number and a street number.

Valid values are “PreferBox” and “PreferStreet”; on output the former will place box numbers on the first address line, while the latter will instead place street numbers on the first address line.

addressing->apiSettings->useMixed

If this is set to "true", data is returned in mixed-case format. If this is set to "false", result data is returned in all upper case characters.

addressing->apiSettings->useAlias

If this is set to "true", alias street names are returned when they are used in the input. If this is set to "false", 'official' street names are returned even when alias street names are used in the input.

(An alias street name is an alternative name for a street that is acceptable to the USPS. It may be a name by which a street was formerly known, a commonly-used nickname for the street, or one the community prefers to use.)

addressing->apiSettings->noStdOnFail

If true, the addressing engine will skip the street standardization for any lookups which were unsuccessful (lookup return was false) and may not make casing and other changes to records that are partially valid. Note that the Disable19 setting will automatically make this false when Disable19 is set to True

addressing->apiSettings->verifyState

If true, the addressing engine will add an additional verification step for any state which it wants to change from the input state based on where the address is delivered from as opposed to the state where the actual address is located.

*setting is required to be turned off to properly qualify for local CASS Certified Processing.

addressing->apiSettings->disable19

If true, all records that match against the Zip+4 data will return an AddrScore of 0 which can be ambiguous. If set to false, the addressing engine will return the AddrScore 19 which details a 'DPV NoMatch'.
This means that the address was found in the Zip+4 data which is valid down to the street and premise range, but not matched against the DPV reference (meaning it is not a valid delivery point).

This setting is True by default for backwards compatability purposes and overrides the noStdOnFail setting.

4.1.3.2 US Addressing Input Fields

Name

Description

Organization or Company

Specifies the company name.

Suite

Specifies the suite or unit.

Address1, Address2 or Street, Street2

Specifies address lines.

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).

 

4.1.3.3 Output Fields

The following result code fields are always output:

Name

Description

AddrEngine

This indicates the addressing API (UK, US, INTernational) 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 US engine specific sections here for details.

PafDescExtra

See US engine specific description here.

ErrorCode

See US engine specific description here.

AddrScore

See US engine specific description here.

UpdateFlag

See US engine specific description here.

User specified output fields have a source mapping and one or more corrected mappings.

Source Mapping - The default mapping for data to populate in the selected column when no address match can be found for the given input. Available values will be the Address Types assigned to the Source Columns. Select 'None' for no default data.

Corrected Mappings - The corrected elements to populate in the selected column when a match is found. See the US engine specific output fields here. Multiple elements are permitted for a single output column, and will be separated with a space when combined.

Previous Article matchIT SQL Index Next Article

 

Was this article helpful?
0 out of 0 found this helpful

0 Comments

Please sign in to leave a comment.