Migrating the CI Reason Codes - Finalist - 10.0

Finalist Compatibility Interface (CI) Migration Guide

Product type
Software
Portfolio
Verify
Product family
Data Quality - Postals
Product
Finalist
Version
10.0
Language
English
Product name
Finalist
Title
Finalist Compatibility Interface (CI) Migration Guide
Copyright
2023
First publish date
1998
ft:lastEdition
2024-05-15
ft:lastPublication
2024-05-15T00:18:43.325870

The migration table below maps the CI reason codes to the Finalist native interface reason codes. Also, refer to the program notes on Using the FNCIRCAC Conversion Routine. Programs can also call FNCIRCAC to convert the Finalist native address information codes to the CI format.

Note: C field names are provided in the following table since COBOL cannot easily process "bit flags". For more information, refer to the description of PBITBYTE in FNCIRCAC.

Finalist CI Reason Code Description

Finalist Native Field Setting

Field/Notes

General Return Code

 

 

0ZIP Code, ZIP+4, and carrier route assigned

PBFN_SUCCESS

Return code from PBFNProcess

1

ZIP Code (5-digit) and carrier route assigned

PBFN_RTNZIPCRRT

PBFNAddressDataDef.cReturnLevel

2

ZIP Code only assigned

PBFN_RTNZIP

PBFNAddressDataDef.cReturnLevel

9

No codes assigned

PBFN_FAIL

Return code from PBFNProcess call

Reason Code 1

Return ZIP Code explanation

 

0

ZIP Code verified

PBFN_EXACT

PBFNAddressDataDef.cZip

1

ZIP Code returned

PBFN_RTN_DATA

PBFNAddressDataDef.cZip

2

ZIP Code unchanged due to unique ZIP Code.

N/A

The Finalist native interface always performs unique ZIP Code processing. This value is returned if the engine processing generated error code 4104 (error for not coding to unique ZIP Code).

3

ZIP Code unchanged due to ZIP Code correction

N/A

The Finalist native interface always performs ZIP Code processing. This is no longer a valid return code and is not supported.

4

ZIP Code determined valid in multiple choice situations

See notes

PBFNAddressDataDef.cZip has PBFN_EXACT set.

PBFNAddressDataDef.cFailureType has PBFN_COMPONENT_MULTI_CHOICE set.

5

ZIP Code determined unique-changed

PBFN_CORRECTED

PBFNAddressDataDef.cZip and PBFNAddressDataDef.cZipType have PBFN_UNIQUE set.

6

Last 2 digits of 5-digit ZIP Code changed

N/A

Not supported in the Finalist native interface. The PBFNAddressDataDef.cZip indicates changes have been made to the ZIP Code. To continue to use this information, a user driver can compare ZIP Codes.

7

First 3 digits of 5 digit ZIP Code changed

N/A

 

Not supported in the Finalist native interface. The PBFNAddressDataDef.cZip indicates changes have been made to the ZIP Code. To continue to use this information, a user driver can compare ZIP Codes.

9

ZIP Code not determined

PBFN_INVALID

PBFNAddressDataDef.cZip

Reason Code 2

Return city explanation

 

0

City verified as input

PBFN_EXACT

PBFNAddressDataDef.cCity

1

City returned-none input

PBFN_RTN_DATA

PBFNAddressDataDef.cCity

2

City standardized on input

PBFN_CORRECTED

PBFNAddressDataDef.cCity

3

USPS preferred name returned

N/A

Not supported in the Finalist native interface. See PBFNAddressDataDef.cCityType for available information.

4

City unchanged due to CTYCORR=NO

N/A

The Finalist native interface always performs city change processing. This is no longer a valid return code and not supported.

5

City name changed-corrected

PBFN_ CORRINPUT

PBFNAddressDataDef.cCity

6

Duplicate city name within state

N/A

Not supported in the Finalist native interface. This situation is very rare.

7

Non-mailing name

PBFN_NONMAILING_NAME

PBFNAddressDataDef.cCityType

9

City not determined

PBFN_INVALID

PBFNAddressDataDef.cCity

Reason Code 3

Return carrier route explanation

 

0

Carrier route verified

PBFN_EXACT

PBFNAddressDataDef.cCarrier

1

Carrier route returned

PBFN_RTN_DATA

PBFNAddressDataDef.cCarrier

2

Carrier route determined valid in multiple choice situation

PBFN_EXACT

PBFNAddressDataDef.cCarrier has PBFN_EXACT set.

PBFNAddressDataDef.cFailureType has

PBFN_COMPONENT_MULTI_CHOICE set.

3

Carrier route changed

PBFN_CORRINPUT

PBFNAddressDataDef.cCarrier

5

Weighting used to determine carrier route

N/A

Not supported in the Finalist native interface.

6

Default carrier route returned

See notes

PBFNAddressDataDef.cDefaultMatch=Y. Set if carrier route, ZIP+4, or DPBC is set to a default value.

7

Non-deliverable address

See notes

PBFNAddressDataDef.cNonDeliverableInd=Y

9

Carrier route not determined

PBFN_INVALID

PBFNAddressDataDef.cCarrier

Reason Code 4

Return ZIP+4 explanation

 

 

 

 

0

ZIP+4 verified

PBFN_EXACT

PBFNAddressDataDef.cZip4

1

ZIP+4 returned

PBFN_RTN_DATA

PBFNAddressDataDef.cZip4

2

ZIP+4 determined valid in multiple choice situation

PBFN_EXACT

PBFNAddressDataDef.cZip4 has PBFN_EXACT set.

PBFNAddressDataDef.cFailureType has PBFN_COMPONENT_MULTI_CHOICE set.

3

ZIP+4 changed

PBFN_CORRINPUT

PBFNAddressDataDef.cZip4

5

Weighting used to determine ZIP+4

N/A

Not supported in the Finalist native interface.

6

Default ZIP+4 returned

See notes

PBFNAddressDataDef.cDefaultMatch=Y. Set if carrier route, ZIP+4, or DPBC is set to a default value.

7

Non-deliverable address

PBFN_NONMAILING_NAME

PBFNAddressDataDef.cCityType

8

AMS-II has duplicate or overlapping range

PBFN_RANGE_OVERLAP

PBFNAddressDataDef.cRange

9

ZIP+4 not determined.

PBFN_INVALID

PBFNAddressDataDef.cZip4

Reason Code 5

Return street explanation

 

0

Street verified as input

PBFN_EXACT

PBFNAddressDataDef.cStreetName

1

Input street standardized

PBFN_CORRECTED

PBFNAddressDataDef.cStreetName

2

Street found using exceptions table

See notes

PBFNAddressDataDef.cExpectionsInd=Y. Exceptions table used during processing.

3

Street found using phonetics match

PBFN_CORRINPUT

PBFNAddressDataDef.cStreetName

4

Street matched using up to three character variation

See notes

Internal logic has changed. This is no longer a valid reason code in the Finalist native interface. Refer to PBFNAddressDataDef.cStreet for information on street name changes.

5

Street failed because of EWS match

4460

PBFNAddressDataDef.cError

6

Street matched using secondary isolation

N/A

Internal logic has changed. This is no longer a valid reason code in the Finalist native interface.

7

Street found using dual address rules

See notes

PBFNAddressDataDef.cDualAddressInd=Y

9

Street not matched

PBFN_INVALID

PBFNAddressDataDef.cStreetName

Reason Code 6

Return street range explanation

 

0

Street range correct

PBFN_EXACT

PBFNAddressDataDef.cRange

1

No match on alpha portion of range

PBFN_RANGE_ALPHA_MISMATCH

PBFNAddressDataDef.cRange

2   

No input range

PBFN_NODATA

PBFNAddressDataDef.cRange

3

Out of range

PBFN_INVALID

PBFNAddressDataDef.cRange

4

Valid ranges and street names from multiple ZIP Codes

See notes

Check for ambiguous flags in field settings.

9

Range not determined

PBFN_INVALID

PBFNAddressDataDef.cRange

Reason code 7

Return suffix/directional explanation

 

0

Suffix and directional correct

PBFN_EXACT

PBFNAddressDataDef.cSuffix, cPreDir, and cPostDir fields all set to value.

1

Suffix missing or incorrect

PBFN_NODATA or PBFN_INVALID

PBFNAddressDataDef.cSuffix

2

Directional missing or incorrect

PBFN_NODATA or PBFN_INVALID

PBFNAddressDataDef.cPreDir or cPostDir fields set to value.

3

Directional and suffix incorrect

PBFN_NODATA or PBFN_INVALID

PBFNAddressDataDef.cSuffix, cPreDir, and cPostDir fields all set to value.

4

Suffix multiple choice

PBFN_COMPONENT_MULTI_CHOICE

PBFNAddressDataDef.cSuffix

5

Directional multiple choice

PBFN_COMPONENT_MULTI_CHOICE

PBFNAddressDataDef.cPreDir or cPostDir fields set to value.

6

Directional outside cardinal point

PBFN_CARDINAL_FAILURE

PBFNAddressDataDef.cPreDir or cPostDir fields set to value.

9

Suffix/directional could not be determined

PBFN_INVALID

PBFNAddressDataDef.cSuffix or cPreDir or cPostDir fields set to value.

Reason code 7

Alias street explanation

 

0

Input street is not an alias

0

PBFNAddressDataDef.cStreetType

1

Input street is a preferred alias

PBFN_PREF_ALIAS

PBFNAddressDataDef.cStreetType

2

Input street is a nickname alias

PBFN_OTHER_ALIAS

PBFNAddressDataDef.cStreetType

4

Input street is an alias multiple choice

PBFN_COMPONENT_MULTI_CHOICE

PBFNAddressDataDef.cStreetName

5

Input street is an alternate at delivery

PBFN_ALT_AT_DEL

PBFNAddressDataDef.cStreetType

9

Input street could not be matched

PBFN_INVALID

PBFNAddressDataDef.cStreetName

Reason Code 9

Firm name description

 

0

System returned the input firm name (if any) to the label area (or there was no firm on input).

PBFN_NODATA or PBFN_EXACT

PBFNAddressDataDef.cFirm

1

System changed and returned the firm name per your specification of FIRMCORR=YES and FIMRLBL=DB

N/A

Not supported in the Finalist native interface. Finalist allows bypass firm processing; however, this is a non-CASS feature.

Finalist will not load that portion of the database if specified not to process firms. Set this option in the configuration file using "Process Firms".

2

System changed the firm name for matching purposes but was not returned due to FIRMCORR=YES and FIRMLBL=INP (system returns input firm name)

N/A

Not supported in the Finalist native interface. The corrected firm name is always returned in return structure firm field. You decide which address to use based on the PBFNAddressDataDef.cFirm field and the original input address.

3

Firm record matched but the firm name was missing

5103

PBFNAddressDataDef.cError

9

Firm processing was not successful. There was information on the firm line but it could not be matched to the address

5104

PBFNAddressDataDef.cError

Reason Code 10

Unit Descriptor Description

 

0

Unit designator (if any) is correct

PBFN_EXACT or PBFN_NODATA

PBFNAddressDataDef.cUnit1Designator or cUnit2Designator

1

Unit designator changed or added

PBFN_RTN_DATA or PBFN_CORRINPUT

PBFNAddressDataDef.cUnit1Designator or cUnit2Designator

2

Unit designator abbreviated

PBFN_CORRECTED

PBFNAddressDataDef.cUnit1Designator or cUnit2Designator

3

Unit designator missing or no unit number

5101

PBFNAddressDataDef.cError

4

Unit designator invalid

PBFN_INVALID

PBFNAddressDataDef.cUnit1Designator or cUnit2Designator

9

Secondary address error

5102

PBFNAddressDataDef.cError

Reason Code 11

Unit number description

 

0

Unit number (if any) is correct

PBFN_EXACT, PBFN_NODATA, or

PBFN_CORRECTED

PBFNAddressDataDef.cUnit1Range or cUnit2Range

1

Unit number alpha character transposed

PBFN_RANGE_ALPHA_MISMATCH

PBFNAddressDataDef.cRange or cUnit1Range or cUnit2Range

2

Unit number valid in multiple choice

PBFN_COMPONENT_MULTI_CHOICE

PBFNAddressDataDef - any address component may receive this disposition if the effect of the address coding was ambiguous.

3

Unit number missing

5101

PBFNAddressDataDef.cError

4

Unit number invalid

PBFN_INVALID

PBFNAddressDataDef, any address component may receive this disposition if the matched address indicates the input address was incorrect.

7

RR/HC box number alpha character transposed

PBFN_RANGE_ALPHA_MISMATCH

PBFNAddressDataDef.cAddressType=PBFN_ADSTYPE_RR or PBFN_ADSTYPE_HC

8

PO box number alpha character transposed

PBFN_RANGE_ALPHA_MISMATCH

PBFNAddressDataDef.cAddressType=PBFN_ADSTYPE_PO_BOX

9

Unit number not determined

PBFN_INVALID

 

Reason Code 12

Non-conventional description

 

0

Non-conventional address correct (if present)

Y

PBFNAddressDataDef.cAddressUnchanged=Y. Check PBFNAddressDataDef.cAddressType.

1

RR/HC corrected

N

PBFNAddressDataDef.cAddressUnchanged=N.

PBFNAddressDataDef.cAddressType=PBFN_ADSTYPE

_RR or PBFN_ADSTYPE_HC.

2

PO Box corrected

N

PBFNAddressDataDef.cAddressUnchanged=N.

PBFNAddressDataDef.cAddressType=PBFN_ADSTYPE

_PO_BOX.

3

General delivery corrected

N

PBFNAddressDataDef.cAddressUnchanged=N.

PBFNAddressDataDef.cAddressType=PBFN_ADSTYPE

_GD.

9

Non-conventional address not determined

N

PBFNAddressDataDef.cAddressUnchanged=N.

PBFNAddressDataDef.cAddressType=PBFN_ADSTYPE

_UNKNOWN.