Skip to main content

Appendix I - Configuration Guide - UKAddressVerification Outputs

Lauren Wheeler
  • Updated
Previous Article  matchIT Hub Index Next Article 

The following field types can be used when specifying the outputs when the engine is running in UKAddressing mode.

The input column types are listed in Appendix A - Column Types. Only the following input column types are used in the address verification process:

  • Company;
  • Organization - synonym for Company;
  • Address1;
  • ...
  • Address9;
  • Town;
  • City - synonym for Town;
  • County;
  • Region - synonym for County;
  • Postcode;
  • Country.

See below for a list of other input fields that can be passed through to the output.

Unique Ref

  • UniqueRef.

Corrected address

  • Company;
  • Organization - synonym for Company;
  • Department;
  • Dept - synonym for Department;
  • Address1;
  • ...
  • Address8;
  • Town;
  • City - synonym for Town;
  • County;
  • Region - synonym for County;
  • Postcode;
  • DeliveryPointSuffix;
  • Dps - synonym for DeliveryPointSuffix;
  • Barcode;
  • Country;
  • ISO3166_2 - two-letter country codes;
  • ISO3166_3 - three-letter country codes;
  • ISO3166_N - three-digit country codes.

Result data

  • AddrScore - The similarity between the input data and closest reference data match as a percentage between 0 and 100. 100% means identical.;
  • PafFlag;
  • PafDesc;
  • ErrorCode;
  • UpdateFlag;
  • ElementStatus;
  • PostcodeUpdate;
  • VerifiedLevel.

PafFlag & PafDesc

PafFlag

PafDesc

Description

1

Verified

The record achieved a premise level match from the addressing engine and reached the address level score threshold. This is a confident match. The address and postcode fields will be updated.

2

Good

The record achieve a postcode level match and all input address elements were matched so the result was upgraded to an address level match. The address and postcode fields will be updated.

3

Partial

The record achieved a postcode level match and reached the postcode level score threshold. The postcode field will be updated.

4

Tentative

No Premise information (Org, Sub-building, Building Number, Building Name) was returned, or the score threshold was not met. The address and postcode fields will not be updated.

5

NoMatch

No match was found.

6

Foreign

The record was identified as foreign.

9

ProcessingFailure

An error has occurred processing the record.

ErrorCode

The ErrorCode field is a 17 character field that indicates the verification status. For example, “PREMP===CVVVARXXF”. This consists of nine parts in the following format:

ErrorCode part

Width

Description

Match level

4

Match level can have the following values:

“PREM” – Match to a single premise;

“PCOD” – Match to a complete postcode;

“PART” – Match to a partial postcode;

“NOMA” – No satisfactory match could be found;

“FORN” – Foreign address detected.

Passing level

1

Passing level can have the following values:

“I” – Individual level;

“A” – Address level;

“P” – Postcode level;

“N” – No match.

Postcode update

4

Postcode update can have the following values:

“ ” (four spaces) – No postcode or no match;

“----” – Input postcode, no output postcode;

“++++” – Output postcode, no input postcode;

“====” – No change to postcode;

“===C” – Change at postcode level;

“==CC” – Change at sector level;

“=CCC” – Change at outward code level;

“CCCC” – Change at area code level.

Premise flag

1

Premise flag can have the following values:

“X” – Not matched;

“V” – Verified;

“R” – Retained;

“C” – Corrected;

“A” - Added.

Street flag

1

See premise flag.

Locality flag

1

See premise flag.

Postcode flag

1

See premise flag.

Vanity flags

3

Leading flag can have the following values:

“XXX” – Not matched;

“SSS” – Some vanity elements retained;

“RRR” – Vanity elements retained;

“DDD” – Vanity elements removed.

Reformat flag

1

Reformat flag can have the following values:

“X” – Not matched;

“O” – Original address kept as-is;

“F” – Address fully reformatted.

If you are using Verify UK in conjunction with Verify US, you can configure the ErrorCode field to be a compatible format with the setting:
<settings><ukaddressing><outputs><options><compatibility><errorCode>standard</errorCode>
This makes the ErrorCode field 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;

A: Ambiguous - More than one close reference data match;

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;

Match Level

2

The level to which the input data matches the available reference data.

55: Delivery Point (PostBox or SubBuilding);

44: Premise (Premise or Building);

33: Thoroughfare;

22: Locality;

11: AdministrativeArea;

00: 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.

Parsing Level

2

The level to which the input data has some recognized form, through the use of pattern matching (e.g. a numeric value could be a premise number) and word lookup (e.g. ‘rd’ could be a ThoroughfareType, ‘Road’; ‘London’ could be a Town)

55: Delivery Point (PostBox or SubBuilding);

44: Premise (Premise or Building);

33: Thoroughfare;

22: Locality;

11: AdministrativeArea;

00: None.

Separator

1

-

Postcode Status

2

P8: PostOut and PostIn verified;

P7: PostOut verified, PostIn added or changed;

P6: PostOut verified;

P5: PostOut changed;

P3: PostOut added;

P2: PostOut identified;

P0: PostOut empty.

Separator

1

-

Match score

3

The similarity between the input data and closest reference data match as a percentage between 0 and 100. 100% means identical.

UpdateFlag

The UpdateFlag field indicates whether the record was updated:

 

UpdateFlag

Description

Address

Record address and postcode were updated.

Postcode

Record postcode was updated.

None

Record not updated.

ElementStatus

ElementStatus is a string of nine characters indicating how each part of the PAF address matched. Each position represents a different area of the address as follows:

  1. organisation
  2. pobox
  3. subbuilding
  4. buildingname
  5. buildingnumber
  6. street
  7. locality
  8. town
  9. county

Each character is one of:

Character

Description

_

not populated in PAF address

X

present in PAF address but not matched

C

fuzzy match, or some words matched

V

exact match

PostcodeUpdate

Value

Description

Y

Postcode updated by Royal Mail recoding

N

Postcode not changed by Royal Mail

VerifiedLevel

The level to which the address was verified.

Value

Description

0

Unkown

1

Delivery point

2

Premise

3

Thoroughfare

4

Town

4

Region

PAF address elements

  • PafOrganisation;
  • PafDepartment;
  • PafPoBox;
  • PoBox - synonym for PafPoBox;
  • PafSubbuildingName;
  • SubbuildingName - synonym for PafSubbuildingName;
  • PafBuildingName;
  • BuildingName - synonym for PafBuildingName;
  • PafBuildingNumber;
  • BuildingNumber - synonym for PafBuildingNumber;
  • PafDependentThoroughfare;
  • DependentThoroughfare - synonym for PafDependentThoroughfare;
  • PafThoroughfare;
  • Thoroughfare - synonym for PafThoroughfare;
  • PafDoubleDependentLocality;
  • DoubleDependentLocality - synonym for PafDoubleDependentLocality;
  • PafDependentLocality;
  • DependentLocality - synonym for PafDependentLocality;
  • PafPosttown;
  • PafPostcode;
  • PafDeliveryPoint;
  • PafDps - synonym for PafDeliveryPoint.

Additional PAF fields

  • UDPRN - Unique Delivery Point Number;
  • PostcodeType - 'S' small user, 'L' large user;
  • SUOrganisation - 'Y' small user organisation address, blank otherwise;
  • AddressKey - A combination of the PafAddressKey and PafOrganisationKey (uniquely identifies a delivery point);
  • PafAddressKey - 8 digit address key (padded with a leading 0s);
  • PafOrganisationKey - 8 digit organisation key (padded with a leading 0s);
  • NumHouseholds - if greater than 1, indicates there are flats behind the front door;
  • TraditionalCounty.

ONS Postcode Directory fields

Contains OS data © Crown copyright and database rights 2021
Contains Royal Mail data © Royal Mail copyright and database rights 2021
Contains National Statistics data © Crown copyright and database rights 2021

Geolocation

  • Easting;
  • Northing;
  • Latitude;
  • Longitude;
  • GridQuality.

Administrative areas

  • AdministrativeCounty;
  • ElectoralDivision;
  • ElectoralDivisionCode;
  • LocalAuthority;
  • LocalAuthorityCode;
  • ElectoralWard;
  • ElectoralWardCode;
  • OSCounty;
  • OSCountyCode.

Other geographies/regions

  • Parish;
  • ParishCode;
  • UserType;
  • NHSEnglandRegion;
  • NHSEnglandRegionCode;
  • ONSCountry - one of the four constituent countries of the UK or Crown dependencies (the Channel Islands or the Isle of Man);
  • ONSCountryCode;
  • Constituency;
  • ConstituencyCode;
  • EER - European Electoral Region;
  • EERCode;
  • PCT - Primary Care Trust;
  • PCTCode;
  • GOR - Government Office Region;
  • GORCode;
  • StandardStatisticalRegion;
  • StandardStatisticalRegionCode;
  • CensusAreaWard;
  • CensusAreaWardCode;
  • PFA - Police Force Area;
  • PFACode;
  • NationalPark;
  • NationalParkCode;
  • CensusOutputAreaCode;
  • CensusLowerSuperOutputArea;
  • CensusLowerSuperOutputAreaCode;
  • CensusMiddleSuperOutputAreaCode;
  • CCG - Clinical Commissioning Group;
  • CCGCode;
  • BuiltupArea;
  • BuiltupAreaCode;
  • BuiltupAreaSubdivision;
  • BuiltupAreaSubdivisionCode;
  • RuralUrbanClassification;
  • OutputAreaClassification;
  • OutputAreaSuperGroup;
  • OutputAreaGroup;
  • OutputAreaSubGroup;

Input fields

  • InputUniqueRef;
  • InputCompany;
  • InputOrganization - synonym for InputCompany;
  • InputDepartment;
  • InputAddress1;
  • ...
  • InputAddress9;
  • InputTown;
  • InputCity - synonym for InputTown;
  • InputCounty;
  • InputRegion - synonym for InputCounty;
  • InputPostcode;
  • InputZIP - synonym for InputPostcode;
  • InputPostOut;
  • InputPostIn;
  • InputDeliveryPoint;
  • InputDPS - synonym for InputDeliveryPoint;
  • InputCountry;
  • InputFullName;
  • InputPrefix;
  • InputFirstNames;
  • InputForenames - synonym for InputFirstNames;
  • InputMiddleNames;
  • InputInitials;
  • InputLastName;
  • InputSurname - synonym for InputLastName;
  • InputSuffix;
  • InputPhone;
  • InputMobile;
  • InputEmail;
  • InputDateOfBirth;
  • InputDOB - synonym for InputDateOfBirth;
  • InputWebsite;
  • InputFax;
  • InputJobTitle.
Previous Article  matchIT Hub Index Next Article 

Related articles