Previous Article | Addresing section | Next Article |
This section describes the following return codes: PafFlag, PafDesc, ErrorCode, AddrScore, UpdateFlag.
The PafFlag and PafDesc fields indicate whether a record has been verified or not during the addressing process:
PafFlag |
PafDesc |
Description |
1 |
Verified |
A complete match was made between the input data and a single record from the available reference data. |
3 |
Partial |
A partial match was made. |
5 |
NoMatch |
No match was found. |
9 |
ProcessingFailure |
An error has occurred processing the record. |
The ErrorCode field is a 14 character field that indicates the verification status. For example, “V44-I44-P3-100”. This consists of the following single character codes:
ErrorCode part |
Width |
Description |
Verification Status |
1 |
Verification status can have the following values V: Verified - A complete match was made between the input data and a single record from the available reference data; P: Partially Verified - A partial match was made between the input data and a single record from the available reference data; U: Unverified - Unable to verify. The output fields will contain the input data; A: Ambiguous - More than one close reference data match; C: Conflict - More than one close reference data match with conflicting values; R: Reverted - Record could not be verified to the specified minimum acceptable level. The output fields will contain the input data. |
Post-Processed Verification Match Level |
1 |
The post-processed verification match level gives the level to which the input data matches the available reference data once all changes and additions performed during the verification process have been taken into account. 5: Delivery Point (PostBox or SubBuilding); 4: Premise (Premise or Building); 3: Thoroughfare; 2: Locality; 1: AdministrativeArea; 0: None. |
Pre-Processed Verification Match Level |
1 |
The pre-processed verification match level gives the level to which the input data matches the available reference data prior to any changes or additions performed during the verification process. 5: Delivery Point (PostBox or SubBuilding); 4: Premise (Premise or Building); 3: Thoroughfare; 2: Locality; 1: AdministrativeArea; 0: None. |
Separator |
1 |
- |
Parsing Status |
1 |
I: Identified and Parsed - All input data has been able to be identified and placed into components; U: Unable to parse - Not all input data has been able to be identified and parsed. |
Lexicon Identification Match Level |
1 |
The lexicon identification match level gives the level to which the input data has some recognised form, through the use of pattern matching (e.g. a numeric value could be a premise number) and lexicon matching (e.g. ‘rd’ could be a ThoroughfareType, ‘Road’; ‘London’ could be a Locality) 5: Delivery Point (PostBox or SubBuilding); 4: Premise (Premise or Building); 3: Thoroughfare; 2: Locality; 1: AdministrativeArea; 0: None. |
Context Identification Match Level |
1 |
The context identification match level gives the level to which the input data can be recognised based on the context in which it appears. This is the least accurate form of matching and is based on identifying a word as, for instance, a Thoroughfare based on it being preceded by something that could be a Premise, and followed by something that could be a Locality, the latter items being identified through a match against the reference data or the lexicon. 5: Delivery Point (PostBox or SubBuilding); 4: Premise (Premise or Building); 3: Thoroughfare; 2: Locality; 1: AdministrativeArea; 0: None. |
Separator |
1 |
- |
Postcode Status |
2 |
P8: PostalCodePrimary and PostalCodeSecondary verified; P7: PostalCodePrimary verified, PostalCodeSecondary added or changed; P6: PostalCodePrimary verified; P5: PostalCodePrimary verified with small change; P4: PostalCodePrimary verified with large change; P3: PostalCodePrimary added; P2: PostalCodePrimary identified by lexicon; P1: PostalCodePrimary identified by context; P0: PostalCodePrimary empty. |
Separator |
1 |
- |
Matchscore |
3 |
The accuracy matchscore gives the similarity between the input data and closest reference data match as a percentage between 0 and 100. 100% means complete similarity. |
The AddrScore field contains the value of Matchscore from the ErrorCode.
The UpdateFlag field indicates whether the record was updated:
UpdateFlag |
Description |
Address |
Record address and postcode were updated. |
None |
Record not updated. |
Previous Article | Addresing section | Next Article |