Where to find the Finalist Reason Codes for the Compatibility Interface Product APIs

Products Affected:  Finalist
The Finalist Reason Codes for the Compatibility Interface can be found in Chapter 3 of the Finalist Reference Guide).  The field names FINAL-REASON-CODE1 through FINAL-REASON-CODE12 provide descriptions of the reason codes.  The field names FINAL-INFO-CODE1 through FINAL-INFO-CODE10 provide descriptions of the address information codes.  Here is an example:

FINAL-REASON-CODE1
cReasonCode[0]

Reason Code 1 - Return ZIP Code Explanation:

• 0 — ZIP Code verified. Same as PBFNAddressInfoDef.cZip = PBFN_EXACT.
• 1 — ZIP Code returned. Same as PBFNAddressInfoDef.cZip = PBFN_RTN_DATA.
• 2 — ZIP Code undetermined. Could not code into a Unique ZIP code. Same as PBFNProcessDataDef.cError = 4104.
• 4 — ZIP Code determined valid in multiple choice situations. Same as PBFNAddressInfoDef.cZip = PBFN_EXACT if PBFNAddressInfoDef.cFailureType = PBFN_COMPONENT_MULTI_CHOICE.
• 5 — ZIP Code determined unique-changed. Same as PBFNAddressInfoDef.cZip = PBFN_CORRECTED if PBFNAddressInfoDef.cZipType = PBFN_UNIQUE.
• 6 — Last two digits of ZIP code changed. Same as comparing the original ZIP code with the returned ZIP code.
• 7 — First three digits of ZIP code changed. Same as comparing the original ZIP code with the returned ZIP code.
• 9 — ZIP Code not determined. Same as PBFNAddressInfoDef.cZip = PBFN_INVALID.

FINAL-INFO-CODE1
cInformationCode[0]

Address Information Code 1 - City Type Information:

• 0 — Single ZIP Code city. Same as PBFNAddressInfoDef.cCityType = PBFN_SINGLEZONE.
• 1 — Multi-ZIP Code city. Same as PBFNAddressInfoDef.cCityType = PBFN_MULTIZONE.
• 9 — City type not determined. Same as PBFNAddressInfoDef.cCityType = 0.
UPDATED:  August 31, 2017