Data Quality user documentation
home/Address validation/Clean Web Service/API reference/Predefined layouts

Predefined layouts

The following datasets are supported by Clean Web Service when cleaning postal addresses.

Each dataset relates to addresses in a particular country, but some countries are served by more than one dataset. In these cases one of the datasets (AUG for Australia) contains geocoding DataPlus, which is absent from other datasets.

The countries, datasets and DataPlus elements you can use depend on the licenses available to you.

In each request:

  • the three-letter code of one of these datasets must be used as the value of the AddressDataset setting.
  • the name of a layout supported by this dataset must be used as the value of the Layout setting. Select a country from the list to view the predefined layouts available for it.

Sample request

...
    <ns:settings>
        <ns:namedvalue>
            <ns:key>AddressDataSet</ns:key>
            <ns:value>"Dataset code e.g. AUG"</ns:value>
         </ns:namedvalue>
        <ns:namedvalue>
            <ns:key>Layout</ns:key>
            <ns:value>"Layout name e.g. Geocoded National Address File (G-NAF)"</ns:value>
        </ns:namedvalue>
    </ns:settings>
...

Using the Australia address dataset, Australian addresses can be cleaned against one of the following predefined layouts:

AMAS Certified (Postal Address File)

Addresses are returned in an AMAS-Certified layout, and include unique Delivery Point Identifiers (DPIDs). Address barcoding is available.

This layout qualifies for AMAS reports.

Line Address Element(s) Example
1 [Automatic Line 1] 7 Alexander Street
2 [Automatic Line 2]
3 [Locality] [State Code] [Postcode] HAMILTON SOUTH NSW 2303
4 Delivery Point Identifier (DPID) 59172312
Line DataPlus Element Example
5 Barcode Sort Plan Number 017
6 Customer Barcode 1301011230012102100102333123313022013
Certified status

This address layout is Certified by your local carrier. To retain its Certified status, you may not edit the address lines or remove existing DataPlus elements. However, by creating a new layout based on this one, you may add DataPlus elements and retain the benefits of Certification, as long as the DataPlus elements you add are not included as part of a mailing address.

Standard Clean (Postal Address File)

Addresses are returned in a non-certified layout. Address barcoding is available.

Line Address Element(s) Example
1 [Automatic Line 1] 7 Alexander Street
2 [Automatic Line 2]
3 [Locality] [State Code] [Postcode] HAMILTON SOUTH NSW 2303

Using the Australia G-NAF address dataset, Australian addresses can be cleaned against the following predefined layout:

Geocoded National Address File (G-NAF)

Addresses are optimised for geocoding. A range of geocoding DataPlus items are available.

Line Address Element(s) Example
1 [Automatic Line 1] 7 Alexander Street
2 [Automatic Line 2]
3 [Locality][State Code][Postcode] HAMILTON SOUTH NSW 2303

Using the Canada address dataset, Canadian addresses can be cleaned against one of the following predefined layouts:

4 Line Standard

Similar to Standard, but supplied as a four-line layout.

Line Address Element(s) Example
1 [Automatic Line 1] The Greenview
2 [Municipality] KINGSTON
3 [Province code] ON
4 [Postal Code] K7M 7T5
5 Line Standard

Similar to Standard, but supplied as a five-line layout.

Line Address Element(s) Example
1 [Automatic Line 1] The Greenview
2 [Automatic Line 2] 14 Greenview Dr
3 [Municipality] KINGSTON
4 [Province code] ON
5 [Postal Code] K7M 7T5
5 Line Submitted

Similar to Submitted, but supplied as a five-line layout.

Line Address Element(s) Example
1 [Automatic Line 1] The Greenview
2 [Automatic Line 2] 14 Greenview Dr
3 [Municipality] KINGSTON
4 [Province code] ON
5 [Postal Code] K7M 7T5

When using Submitted layouts, all capitalisation sent in the request is retained.

Certified

A three-line layout. The language of the province is retained, but fully capitalized (for example, "ONTARIO").

This layout qualifies for SOA reports.

Line Address Element(s) Example
1 [Automatic Line 1] The Greenview
2 [Automatic Line 2] 14 Greenview Dr
3 [Municipality][Submitted Province][Province code] KINGSTON ONTARIO K7M 7T5
Certified status

This address layout is Certified by your local carrier. To retain its Certified status, you may not edit the address lines or remove existing DataPlus elements. However, by creating a new layout based on this one, you may add DataPlus elements and retain the benefits of Certification, as long as the DataPlus elements you add are not included as part of a mailing address.

Standard

A three-line layout. The two-letter province code replaces the information supplied (for example, "ON").

Line Address Element(s) Example
1 [Automatic Line 1] The Greenview
2 [Automatic Line 2] 14 Greenview Dr
3 [Municipality][Province code][Postal Code] KINGSTON ON K7M 7T5
Submitted

A three-line layout. The language and capitalisation of the province is retained (for example, "Ontario").

Line Address Element(s) Example
1 [Automatic Line 1] The Greenview
2 [Automatic Line 2] 14 Greenview Dr
3 [Municipality][Submitted Province][Postal Code] KINGSTON Ontario K7M 7T5

Using the France address dataset, French addresses can be cleaned against one of the following predefined layouts:

AFNOR

This layout is identical to the AFNOR with business names layout, but an organisation name is not required. A maximum of six lines (fields) will be returned, but the first line will be left blank if no organisation information is supplied.

Line Address Element(s) Example
1 [AFNOR line 1] TRADUCTEURS NAÏFS
2 [AFNOR line 2] APPARTEMENT 37, BÂTIMENT 4
3 [AFNOR line 3] LIEU DIT AU BALIVERNES
4 [Number] [Number Extension] [Street] 10A BOULEVARD GEORGES CLEMENCEAU
5 [PO Box] [Submitted Locality] NORD-PAS DE CALAIS
6 [Postal Code] [Town] [CEDEX Office] 62226 CALAIS CEDEX

This layout is identical to the 'AFNOR with business names' layout, but an organisation name is not required. A maximum of six lines (fields) will be returned, but the first line will be left blank if no organisation information is supplied.

AFNOR with business names

This layout is compliant with AFNOR standard XPZ10-011 (May 1997). Each address will be returned on a maximum of six lines (fields), with a maximum of 38 characters per line.

Line Address Element(s) Example
1 [AFNOR line 1] TRADUCTEURS NAÏFS
2 [AFNOR line 2] APPARTEMENT 37, BÂTIMENT 4
3 [AFNOR line 3] LIEU DIT AU BALIVERNES
4 [Number] [Number Extension] [Street] 10A BOULEVARD GEORGES CLEMENCEAU
5 [PO Box] [Submitted Locality] NORD-PAS DE CALAIS
6 [Postal Code] [Town] [CEDEX Office] 62226 CALAIS CEDEX

This layout is compliant with AFNOR standard XPZ10-011 (May 1997). Each address will be returned on a maximum of six lines (fields), with a maximum of 38 characters per line.

Standard

This layout is similar to the AFNOR layout, but the last line contains the addresses' département and postal code, in that order (rather than the postal code, town and CEDEX office). Organisation names are not required or expected.

Line Address Element(s) Example
1 [AFNOR line 1] TRADUCTEURS NAÏFS
2 [AFNOR line 2] APPARTEMENT 37, BÂTIMENT 4
3 [AFNOR line 3] LIEU DIT AU BALIVERNES
4 [Number] [Number Extension] [Street] 10A BOULEVARD GEORGES CLEMENCEAU
5 [PO Box] [Submitted Locality] NORD-PAS DE CALAIS
6 [Département] [Postal Code] PAS-DE-CALAIS 62226

Using the Ireland address dataset, Irish addresses can be cleaned against one of the following predefined layouts:

Resident Preferred

This layout returns the format of addresses commonly preferred by residents, as indicated by the address elements that are present in the input address. For example, 'Co Dublin' will be retained if present in the input address, rather than being replaced with an official equivalent (such as 'Dublin 22').

Line Address Element(s) Example
1 [Automatic Line 1] Meneen
2 [Automatic Line 2] Achadh Ghobhair
3 [Automatic Line 3] Cathair na Mart
4 [Automatic Line 4] Maigh Eo
5 [Automatic Line 5]
Resident Preferred Gaelic

Returns the format of addresses commonly preferred by residents (as above), but with address elements returned in their Gaelic format (where available).

Line Address Element(s) Example
1 [Automatic Line 1] Meneen
2 [Automatic Line 2] Achadh Ghobhair
3 [Automatic Line 3] Maigh Eo
4 [Automatic Line 4]
5 [Automatic Line 5]
Standard

This is the official An Post format of a given address. This format varies depending on whether a building group is present in the address.

Line Address Element(s) Example
1 [Automatic Line 1] Meneen
2 [Automatic Line 2] Aghagower
3 [Automatic Line 3] Westport
4 [Automatic Line 4] Co Mayo
5 [Automatic Line 5]
Gaelic

This is the official An Post format of a given address (as above), but with address elements returned in their Gaelic format (where available).

Line Address Element(s) Example
1 [Automatic Line 1] Meneen
2 [Automatic Line 2] Achadh Ghobhair
3 [Automatic Line 3] Maigh Eo
4 [Automatic Line 4]
5 [Automatic Line 5]

Using the New Zealand address dataset, New Zealand addresses can be cleaned against the following predefined layout:

SendRight Certified (Postal Address File)

The city of the address is returned as the [Locality] element. Address identification and coding DataPlus information is available.

This layout qualifies for SOA and SOA Log reports.

Line Address Element(s) Example
1 [Automatic Line 1] Villa 105
2 [Automatic Line 2] Summerset Retirement Village
3 [Automatic Line 3] 15 Aotea Drive, Aotea
4 [City][Postcode] Porirua 5024
Certified status

This address layout is Certified by your local carrier. To retain its Certified status, you may not edit the address lines or remove existing DataPlus elements. However, by creating a new layout based on this one, you may add DataPlus elements and retain the benefits of Certification, as long as the DataPlus elements you add are not included as part of a mailing address.

Using the Singapore address dataset, Singaporean addresses can be cleaned against the following predefined layout:

Standard

A standard address format for Singapore addresses.

Line Address Element(s) Example
1 [Automatic Line 1] Window Delivery 2
2 [Building Number][Street] 2 Raffles Link
3 [Floor][Unit][Building Name] #03-04 Marina Bayfront
4 [Locality][Postal code] Singapore 039392

Using the United Kingdom address dataset, British addresses can be cleaned against one of the following predefined layouts:

Royal Mail Standard

Similar to the Standard layout, but a Delivery Point Suffix is supplied as an additional address field. DataPlus fields are not available using this layout.

Line Address Element(s) Example
1 [Automatic Line 1] 26 Stokesby Road
2 [Automatic Line 2]
3 [Town] Chessington
4 [County] Surrey
5 [Postcode] KT9 2DU
6 [Delivery Point Suffix] 1A
Standard

A standard address format for British addresses.

Line Address Element(s) Example
1 [Automatic Line 1] 26 Stokesby Road
2 [Automatic Line 2]
3 [Town] Chessington
4 [County] Surrey
5 [Postcode] KT9 2DU

Using the United States address dataset, United States addresses can be cleaned against one of the following predefined layouts:

4-line Non-Certified

Identical to the Non-Certified layout, but supplied as a four-line layout.

Line Address Element(s) Example
1 [Automatic Line 1] The White House
2 [City Name] Washington
3 [State Code] DC
4 [ZIP Code] [ZIP +4 Code] 20500 0003
5-line Certified

Identical to the Certified layout, but supplied as a five-line layout.

This layout qualifies for CASS reports.

Note that if you encounter a seed address whilst using Clean , your account will be DPV locked and you will no longer be able to use certified cleaning.

Line Address Element(s) Example
1 [Automatic Line 1] The White House
2 [Automatic Line 2] Pennsylvania Ave Nw
3 [City Name] Washington
4 [State Code] DC
5 [ZIP Code] [ZIP +4 Code] 20500 0003
Line DataPlus Element(s) Example
6 DPV: DPV Footnotes AAN1
7 DPV: DPV Confirmation Indicator D
8 DPV: CMRA Confirmation Indicator N
9 DPV: Seed Address Indicator
10 DPV: Vacant Address Indicator N
11 DPV: No-Mail Indicator N

DPV (Delivery Point Validation) DataPlus elements return information about the validity of address records in accordance with USPS guidelines.

Note that if you encounter a seed address whilst using Clean , your account will be DPV locked and you will no longer be able to use certified cleaning.

Certified status

This address layout is Certified by your local carrier. To retain its Certified status, you may not edit the address lines or remove existing DataPlus elements. However, by creating a new layout based on this one, you may add DataPlus elements and retain the benefits of Certification, as long as the DataPlus elements you add are not included as part of a mailing address.

5-line Non-Certified

Identical to the Non-Certified layout, but supplied as a five-line layout.

Line Address Element(s) Example
1 [Automatic Line 1] The White House
2 [Automatic Line 2] Pennsylvania Ave Nw
3 [City Name] Washington
4 [State Code] DC
5 [ZIP Code] [ZIP +4 Code] 20500 0003
5-line Secondary Non-Certified

As above, but supplied as a five-line layout including a secondary building number (such as an apartment number).

Line Address Element(s) Example
1 [Automatic Line 1] The White House
2 [Secondary number] Apt 34
3 [City Name] Washington
4 [State Code] DC
5 [ZIP Code] [ZIP +4 Code] 20500 0003
6-line County Non-Certified

As above, but supplied as a six-line layout including the county name.

Line Address Element(s) Example
1 [Automatic Line 1] The White House
2 [Automatic Line 2] Pennsylvania Ave Nw
3 [City Name] Washington
4 [County Name] Washington D.C.
5 [State Code] DC
6 [ZIP Code] [ZIP +4 Code] 20500 0003
Certified

A standard three-line layout. Delivery Point Validation (DPV) is available, as well as LACSLink and SuiteLink data.

This layout qualifies for CASS reports.

Note that if you encounter a seed address whilst using Clean, your account will be DPV locked and you will no longer be able to use certified cleaning.

Line Address Element(s) Example
1 [Building/firm name] [Urbanization] The White House
2 [Primary number] [Automatic Line 2] 1600 Pennsylvania Ave Nw
3 [City Name] [State Code] [ZIP Code] [ZIP +4 Code] Washington DC 20500 0003
Line DataPlus Element(s) Example
6 DPV: DPV Footnotes AAN1
7 DPV: DPV Confirmation Indicator D
8 DPV: CMRA Confirmation Indicator N
9 DPV: Seed Address Indicator
10 DPV: Vacant Address Indicator N
11 DPV: No-Mail Indicator N

DPV (Delivery Point Validation) DataPlus elements return information about the validity of address records in accordance with USPS guidelines.

Note that if you encounter a seed address whilst using Clean, your account will be DPV locked and you will no longer be able to use certified cleaning.

Certified status

This address layout is Certified by your local carrier. To retain its Certified status, you may not edit the address lines or remove existing DataPlus elements. However, by creating a new layout based on this one, you may add DataPlus elements and retain the benefits of Certification, as long as the DataPlus elements you add are not included as part of a mailing address.

Some Clean DataPlus sets return values which can only be properly interpreted using specialized font files.

If you plan to use any of the DataPlus sets listed below, you should download the associated font files in order to use the data as intended.

Country DataPlus Set Download
Australia Customer Barcode AUS4STSTE.TTF
Singapore Barcode RM4SCC.TTF
United Kingdom Barcode RM4SCC.TTF
United States of America USPS POSTNET Barcode POSTNET.TTF

To use these font files, first install them in your operating system.

In your database or word processor, set the barcode portion of your cleaned addresses to display in the appropriate barcode font. You should make sure the barcodes are displayed correctly on screen before printing. For example, a RM4SCC-format barcode looks like this before and after the font is applied:

(BX11LT1AI)

Clean Web Service

API reference