--- title: "Cleanse Address" method: POST path: "/cleanse/addresses" tags: ["UK"] --- # Cleanse Address `POST /cleanse/addresses` The address cleanse API attempts to return the closest matching address for any given address inputs. We also return a number of Match Level indicators that describe the degree to which the suggested address matches the input address. The more impaired the input address, the harder it is to cleanse. ## Confidence Score The confidence score is a number ranging between 0 and 1. Where 1 implies a full match and 0 implies no major elements completely match. Each incorrect, missing or misspelled element will subtract from the overall confidence score. ### Deciding on an Acceptable Confidence Score Threshold Different address cleanse projects can have radically different inputs. However, within each project, the inputs tend to repeat the same errors. For instance, some input datasets may be exclusively inputted manually and be prone to typos. Others may have a persistently missing datapoint such as organisation name or postcode. For this reason, it is important to understand that there is no absolute Confidence Score threshold. Instead, the acceptable confidence score must be determined on a project by project basis based on systematic errors present in the data and business goals. When determining an acceptable Confidence Score threshold you should load a subset of the dataset into a spreadsheet application like Excel and sort on the score. Scrolling from top-to-bottom you will be able to observe matches from best to worst. As you start to hit the lower quality searches, you will be able to roughly determine: - Which confidence scores indicate ambiguous matches (i.e. up to building level only) - Which confidence scores indicate a poor or no match (i.e. the nearest matching address is too far from the input address) Depending on your business goals, you can also use the Match Levels to determine an acceptable match. For instance, do you need to match up to the thoroughfare or building name only? Are accurate organisation names an important feature? ## Query parameters - `api_key` string - `tags` string - `context` string ## Request body - object - `query` string, required — Freeform address input to cleanse - `postcode` string — Optionally specify postal code for the address. - `post_town` string — Optionally specify the city or town of the address. For UK verifications, this should be the "post town" of the address. For USA verifications, this should be the city of the address. - `county` string — Optionally specify the county or state of the address. For UK verifications, we recommend omitting this field as county data is unreliable. For USA verifications, this should be the state of the address. ## Response `200` Success - CleanseResponse - `code` 2000, required - `message` 'Success', required - `result` union, required - GbrCleanseMatch - `query` string, required — Originally submitted query - `match` union, required — Nearest matching address - PafAddress — Standard UK Address. Also known as a Postcode Address File (PAF) address is defined by Royal Mail and updated on a daily cadence. A PAF Address represents a deliverable endpoint. - `id` string, required — Global unique internally generated identifier for an address - `dataset` 'paf', required — Indicates the provenance of an address - `country_iso` 'GBR' | 'IMN' | 'JEY' | 'GGY', required — 3 letter country code (ISO 3166-1) - `country_iso_2` 'GB' | 'IM' | 'JE' | 'GG', required — 2 letter country code (ISO 3166-1) - `country` 'England' | 'Scotland' | 'Wales' | 'Northern Ireland' | 'Jersey' | 'Guernsey' | 'Isle of Man', required — Full country names (ISO 3166) - `language` 'en', required — Language represented by 2 letter ISO Code (639-1) - `line_1` string, required — First Address Line. Often contains premise and thoroughfare information. In the case of a commercial premise, the first line is always the full name of the registered organisation. Never empty. - `line_2` string, required — Second Address Line. Often contains thoroughfare and locality information. May be empty - `line_3` string, required — Third address line. May be empty. - `post_town` string, required — **Filter by Town or City" A Post Town is mandatory for delivery of mail to a Delivery Point. This is not necessarily the nearest town geographically, but a routing instruction to the Royal Mail delivery office sorting mail for that Delivery Point. A Post Town will always be present in every address, and for some Localities the Post Town will be the only locality element present. - `postcode` string, required — Correctly formatted postcode. Capitalised and spaced. - `county` string, required — Since postal, administrative or traditional counties may not apply to some addresses, the county field is designed to return whatever county data is available. Normally, the postal county is returned. If this is not present, the county field will fall back to the administrative county. If the administrative county is also not present, the county field will fall back to the traditional county. May be empty in cases where no administrative, postal or traditional county present. - `county_code` string, required — Short code representing the county or province. May be empty (`""`) - `uprn` string, required — UPRN stands for Unique Property Reference Number and is maintained by the Ordnance Survey (OS). Local governments in the UK have allocated a unique number for each land or property. Up to 12 digits in length. Multiple Residence premises currently share the same UPRN as the parent premise. May not be available for a small number of Great Britain addresses due to longer update cycles for Ordnance Survey's AddressBase datasets. Returns empty string "" in these instances. Although UPRN takes an integer format, we encode and transmit this data as strings. As a 12 digit number, the UPRN can exceed the maximum safe integer `Number.MAX_SAFE_INTEGER` in most browsers causing this datapoint to be corrupted. Take special care when storing UPRN. As a 12 digit identifier, you will need 64 bits to encode every possible UPRN value. This means applications like Excel will corrupt cells containing UPRN values. - `udprn` integer, required — UDPRN stands for ‘Unique Delivery Point Reference Number’. Royal Mail assigns a unique UDPRN code for each premise on PAF. Simple, unique reference number for each Delivery Point. Unlikely to be reused when an address expires. Up to 8-digit numeric code. A new UDPRN is automatically assigned to each new Delivery Point added to PAF. - `umprn` union, required — A small minority of individual premises (as identified by a UDPRN) may have multiple occupants behind the same letterbox. These are known as Multiple Residence occupants and can be queried via the Multiple Residence dataset. Simple, unique reference number for each Multiple Residence occupant. Note: this will be an empty string `""` when not used. - string — If premise is not multiple occupancy, this will be an empty string - number — If premise is multiple occupancy, this will be an integer - `postcode_outward` string, required — The first part of a postcode is known as the outward code. e.g. The outward code of ID1 1QD is ID1. Enables mail to be sorted to the correct local area for delivery. This part of the code contains the area and the district to which the mail is to be delivered, e.g. ‘PO1’, ‘SW1A’ or ‘B23’. - `postcode_inward` string, required — The second part of a postcode is known as the inward code. e.g. The inward code of ID1 1QD is 1QD. The number identifies the sector in the postal district. The number is followed by 2 letters. The letters then define one or more properties in that sector. - `dependant_locality` string, required — When the same thoroughfare name reoccurs in a Post town, it may not be possible to make it dependant on a dependant thoroughfare. In this case the thoroughfare is dependant on a locality. For example if we want to find 1 Back Lane in Huddersfield we see that there are three. - `double_dependant_locality` string, required — Used to supplement Dependant Locality. A Double Dependant Locality supplied along with a Dependant Locality if the Dependant Locality exists twice in the same locality. - `thoroughfare` string, required — Also known as the street or road name. In general each Thoroughfare Name will have a separate Postcode. Longer Thoroughfares with high number ranges often have multiple Postcodes covering the entire length of the road, with breaks at suitable points e.g. junctions or natural breaks in the road. - `dependant_thoroughfare` string, required — Used to supplement thoroughfare. When a thoroughfare name is used twice in the same Post Town, the dependant thoroughfare is added to uniquely indentify a delivery point. - `building_number` string, required — Number to identify premise on a thoroughfare or dependant thoroughfare. - `building_name` string, required — Name of residential or commercial premise. Examples: - The Manor - 1-2 - A - 12A - K - Victoria House - `sub_building_name` string, required — When a premise is split into individual units such as flats, apartments or business units. Cannot be present without either building_name or building_number. E.g. Flat 1, A, 10B - `po_box` string, required — When the PO Box Number field is populated it will contain PO BOX nnnnnn where n represents the PO Box number. Note that the PO Box details can occasionally consist of a combination of numbers and letters. PO Box Numbers are only allocated to Large Users. - `department_name` string, required — Used to supplment Organisation Name to identify a deparment within the organisation. - `organisation_name` string, required — Used to supplment Organisation Name to identify a deparment within the organisation - `postcode_type` 'S' | 'L' | '', required — This indicates the type of user. It can only take the values 'S' or 'L' indicating small or large respectively. Large User Postcodes. These are assigned to one single address either due to the large volume of mail received at that address, or because a PO Box or Selectapost service has been set up. Small User Postcodes. These identify a group of Delivery Points. On average there are 19 Delivery Points per Postcode. However this can vary between 1 and, in some cases, 100. There will never be more than 100 Delivery Points on a Postcode. - `su_organisation_indicator` string, required — Small User Organisation Indicator can have the values 'Y' or space. A value of 'Y' indicates that a Small User Organisation is present at this address. - `delivery_point_suffix` string, required — A unique Royal Mail 2-character code (the first numeric & the second alphabetical), which, when added to the Postcode, enables each live Delivery Point to be uniquely identified. Once the Delivery Point is deleted from PAF the DPS may be reused (although they aren’t reused until all remaining Delivery Points in the range have been allocated). The DPS for a Large User is always '1A' as each Large User has its own Postcode. - `premise` string, required — A pre-computed string which sensibly combines building_number, building_name and sub_building_name. building_number, building_name and sub_building_name represent raw data from Royal Mail's and can be difficult to parse if you are unaware of how the Postcode Address File premise fields work together. For this reason, we also provide a pre-computed premise field which intelligently gathers these points into a single, simple premise string. This field is ideal if you want to pull premise information and thoroughfare information separately instead of using our address lines data. - `administrative_county` string, required — The current administrative county to which the postcode has been assigned. A Unitary Authority name, where one is present. If there is no Unitary Authority, the County name is used. This information is not static, because County boundaries may change due to administrative changes. Data source: ONS - `postal_county` string, required — Postal counties were used for the distribution of mail before the Postcode system was introduced in the 1970s. The Former Postal County was the Administrative County at the time. This data rarely changes. May be empty. - `traditional_county` string, required — Traditional counties are provided by the Association of British Counties. It is historical data, and can date from the 1800s. May be empty. - `district` string, required — The current district/unitary authority to which the postcode has been assigned. - `ward` string, required — The current administrative/electoral area to which the postcode has been assigned. May be empty for a small number of addresses. - `longitude` union, required — The longitude of the postcode (WGS84/ETRS89). Can be a positive or negative decimal. E.g. -0.1283983 Returns an empty string if no location data is available. - string — Empty string `""` if not available - number — Represents longitude - `latitude` union, required — The latitude of the postcode (WGS84/ETRS89). Can be a positive or negative decimal. E.g. `51.5083983`. Returns an empty string if no location data is available. - string — Empty string `""` if not available - number — Represents latitude - `eastings` union, required — Eastings reference using the [Ordnance Survey National Grid reference system](https://en.wikipedia.org/wiki/Ordnance_Survey_National_Grid). Northern Ireland Eastings uses the [Irish Grid Reference System](https://en.wikipedia.org/wiki/Irish_grid_reference_system). Metres from origin. E.g. `550458` Returns an empty string if no location data is available. Otherwise a number is returned. - string — Empty string `""` if not available - number — Metres offset east from origin - `northings` union, required — Northings reference using the [Ordnance Survey National Grid reference system](https://en.wikipedia.org/wiki/Ordnance_Survey_National_Grid) Northern Ireland Northings uses the [Irish Grid Reference System](https://en.wikipedia.org/wiki/Irish_grid_reference_system) Metres from origin. E.g. `180458` Returns an empty string if no location data is available. Otherwise a number is returned - string — Empty string `""` if not available - number — Metres offset north from origin - MrAddress — Subdivision of a Postcode Address File address. Also known as a Multiple Residence or Multiple Occupancy address. A Multiple Residence address does not have its own deliverable endpoint. Instead it relies on the deliverable endpoint of a parent address, where the parent address can be found on the main Postcode Address File. - `id` string, required — Global unique internally generated identifier for an address - `dataset` 'mr', required — Indicates the provenance of an address - `country_iso` 'GBR' | 'IMN' | 'JEY' | 'GGY', required — 3 letter country code (ISO 3166-1) - `country_iso_2` 'GB' | 'IM' | 'JE' | 'GG', required — 2 letter country code (ISO 3166-1) - `country` 'England' | 'Scotland' | 'Wales' | 'Northern Ireland' | 'Jersey' | 'Guernsey' | 'Isle of Man', required — Full country names (ISO 3166) - `language` 'en', required — Language represented by 2 letter ISO Code (639-1) - `line_1` string, required — First Address Line. Often contains premise and thoroughfare information. In the case of a commercial premise, the first line is always the full name of the registered organisation. Never empty. - `line_2` string, required — Second Address Line. Often contains thoroughfare and locality information. May be empty - `line_3` string, required — Third address line. May be empty. - `post_town` string, required — **Filter by Town or City" A Post Town is mandatory for delivery of mail to a Delivery Point. This is not necessarily the nearest town geographically, but a routing instruction to the Royal Mail delivery office sorting mail for that Delivery Point. A Post Town will always be present in every address, and for some Localities the Post Town will be the only locality element present. - `postcode` string, required — Correctly formatted postcode. Capitalised and spaced. - `county` string, required — Since postal, administrative or traditional counties may not apply to some addresses, the county field is designed to return whatever county data is available. Normally, the postal county is returned. If this is not present, the county field will fall back to the administrative county. If the administrative county is also not present, the county field will fall back to the traditional county. May be empty in cases where no administrative, postal or traditional county present. - `county_code` string, required — Short code representing the county or province. May be empty (`""`) - `uprn` string, required — UPRN stands for Unique Property Reference Number and is maintained by the Ordnance Survey (OS). Local governments in the UK have allocated a unique number for each land or property. Up to 12 digits in length. Multiple Residence premises currently share the same UPRN as the parent premise. May not be available for a small number of Great Britain addresses due to longer update cycles for Ordnance Survey's AddressBase datasets. Returns empty string "" in these instances. Although UPRN takes an integer format, we encode and transmit this data as strings. As a 12 digit number, the UPRN can exceed the maximum safe integer `Number.MAX_SAFE_INTEGER` in most browsers causing this datapoint to be corrupted. Take special care when storing UPRN. As a 12 digit identifier, you will need 64 bits to encode every possible UPRN value. This means applications like Excel will corrupt cells containing UPRN values. - `udprn` integer, required — UDPRN stands for ‘Unique Delivery Point Reference Number’. Royal Mail assigns a unique UDPRN code for each premise on PAF. Simple, unique reference number for each Delivery Point. Unlikely to be reused when an address expires. Up to 8-digit numeric code. A new UDPRN is automatically assigned to each new Delivery Point added to PAF. - `umprn` union, required — A small minority of individual premises (as identified by a UDPRN) may have multiple occupants behind the same letterbox. These are known as Multiple Residence occupants and can be queried via the Multiple Residence dataset. Simple, unique reference number for each Multiple Residence occupant. Note: this will be an empty string `""` when not used. - string — If premise is not multiple occupancy, this will be an empty string - number — If premise is multiple occupancy, this will be an integer - `postcode_outward` string, required — The first part of a postcode is known as the outward code. e.g. The outward code of ID1 1QD is ID1. Enables mail to be sorted to the correct local area for delivery. This part of the code contains the area and the district to which the mail is to be delivered, e.g. ‘PO1’, ‘SW1A’ or ‘B23’. - `postcode_inward` string, required — The second part of a postcode is known as the inward code. e.g. The inward code of ID1 1QD is 1QD. The number identifies the sector in the postal district. The number is followed by 2 letters. The letters then define one or more properties in that sector. - `dependant_locality` string, required — When the same thoroughfare name reoccurs in a Post town, it may not be possible to make it dependant on a dependant thoroughfare. In this case the thoroughfare is dependant on a locality. For example if we want to find 1 Back Lane in Huddersfield we see that there are three. - `double_dependant_locality` string, required — Used to supplement Dependant Locality. A Double Dependant Locality supplied along with a Dependant Locality if the Dependant Locality exists twice in the same locality. - `thoroughfare` string, required — Also known as the street or road name. In general each Thoroughfare Name will have a separate Postcode. Longer Thoroughfares with high number ranges often have multiple Postcodes covering the entire length of the road, with breaks at suitable points e.g. junctions or natural breaks in the road. - `dependant_thoroughfare` string, required — Used to supplement thoroughfare. When a thoroughfare name is used twice in the same Post Town, the dependant thoroughfare is added to uniquely indentify a delivery point. - `building_number` string, required — Number to identify premise on a thoroughfare or dependant thoroughfare. - `building_name` string, required — Name of residential or commercial premise. Examples: - The Manor - 1-2 - A - 12A - K - Victoria House - `sub_building_name` string, required — When a premise is split into individual units such as flats, apartments or business units. Cannot be present without either building_name or building_number. E.g. Flat 1, A, 10B - `po_box` string, required — When the PO Box Number field is populated it will contain PO BOX nnnnnn where n represents the PO Box number. Note that the PO Box details can occasionally consist of a combination of numbers and letters. PO Box Numbers are only allocated to Large Users. - `department_name` string, required — Used to supplment Organisation Name to identify a deparment within the organisation. - `organisation_name` string, required — Used to supplment Organisation Name to identify a deparment within the organisation - `postcode_type` 'S' | 'L' | '', required — This indicates the type of user. It can only take the values 'S' or 'L' indicating small or large respectively. Large User Postcodes. These are assigned to one single address either due to the large volume of mail received at that address, or because a PO Box or Selectapost service has been set up. Small User Postcodes. These identify a group of Delivery Points. On average there are 19 Delivery Points per Postcode. However this can vary between 1 and, in some cases, 100. There will never be more than 100 Delivery Points on a Postcode. - `su_organisation_indicator` string, required — Small User Organisation Indicator can have the values 'Y' or space. A value of 'Y' indicates that a Small User Organisation is present at this address. - `delivery_point_suffix` string, required — A unique Royal Mail 2-character code (the first numeric & the second alphabetical), which, when added to the Postcode, enables each live Delivery Point to be uniquely identified. Once the Delivery Point is deleted from PAF the DPS may be reused (although they aren’t reused until all remaining Delivery Points in the range have been allocated). The DPS for a Large User is always '1A' as each Large User has its own Postcode. - `premise` string, required — A pre-computed string which sensibly combines building_number, building_name and sub_building_name. building_number, building_name and sub_building_name represent raw data from Royal Mail's and can be difficult to parse if you are unaware of how the Postcode Address File premise fields work together. For this reason, we also provide a pre-computed premise field which intelligently gathers these points into a single, simple premise string. This field is ideal if you want to pull premise information and thoroughfare information separately instead of using our address lines data. - `administrative_county` string, required — The current administrative county to which the postcode has been assigned. A Unitary Authority name, where one is present. If there is no Unitary Authority, the County name is used. This information is not static, because County boundaries may change due to administrative changes. Data source: ONS - `postal_county` string, required — Postal counties were used for the distribution of mail before the Postcode system was introduced in the 1970s. The Former Postal County was the Administrative County at the time. This data rarely changes. May be empty. - `traditional_county` string, required — Traditional counties are provided by the Association of British Counties. It is historical data, and can date from the 1800s. May be empty. - `district` string, required — The current district/unitary authority to which the postcode has been assigned. - `ward` string, required — The current administrative/electoral area to which the postcode has been assigned. May be empty for a small number of addresses. - `longitude` union, required — The longitude of the postcode (WGS84/ETRS89). Can be a positive or negative decimal. E.g. -0.1283983 Returns an empty string if no location data is available. - string — Empty string `""` if not available - number — Represents longitude - `latitude` union, required — The latitude of the postcode (WGS84/ETRS89). Can be a positive or negative decimal. E.g. `51.5083983`. Returns an empty string if no location data is available. - string — Empty string `""` if not available - number — Represents latitude - `eastings` union, required — Eastings reference using the [Ordnance Survey National Grid reference system](https://en.wikipedia.org/wiki/Ordnance_Survey_National_Grid). Northern Ireland Eastings uses the [Irish Grid Reference System](https://en.wikipedia.org/wiki/Irish_grid_reference_system). Metres from origin. E.g. `550458` Returns an empty string if no location data is available. Otherwise a number is returned. - string — Empty string `""` if not available - number — Metres offset east from origin - `northings` union, required — Northings reference using the [Ordnance Survey National Grid reference system](https://en.wikipedia.org/wiki/Ordnance_Survey_National_Grid) Northern Ireland Northings uses the [Irish Grid Reference System](https://en.wikipedia.org/wiki/Irish_grid_reference_system) Metres from origin. E.g. `180458` Returns an empty string if no location data is available. Otherwise a number is returned - string — Empty string `""` if not available - number — Metres offset north from origin - NybAddress — A UK premise under construction and currently not occupied. This dataset is updated by Royal Mail on a monthly cadence. - `id` string, required — Global unique internally generated identifier for an address - `dataset` 'nyb', required — Indicates the provenance of an address - `country_iso` 'GBR' | 'IMN' | 'JEY' | 'GGY', required — 3 letter country code (ISO 3166-1) - `country_iso_2` 'GB' | 'IM' | 'JE' | 'GG', required — 2 letter country code (ISO 3166-1) - `country` 'England' | 'Scotland' | 'Wales' | 'Northern Ireland' | 'Jersey' | 'Guernsey' | 'Isle of Man', required — Full country names (ISO 3166) - `language` 'en', required — Language represented by 2 letter ISO Code (639-1) - `line_1` string, required — First Address Line. Often contains premise and thoroughfare information. In the case of a commercial premise, the first line is always the full name of the registered organisation. Never empty. - `line_2` string, required — Second Address Line. Often contains thoroughfare and locality information. May be empty - `line_3` string, required — Third address line. May be empty. - `post_town` string, required — **Filter by Town or City" A Post Town is mandatory for delivery of mail to a Delivery Point. This is not necessarily the nearest town geographically, but a routing instruction to the Royal Mail delivery office sorting mail for that Delivery Point. A Post Town will always be present in every address, and for some Localities the Post Town will be the only locality element present. - `postcode` string, required — Correctly formatted postcode. Capitalised and spaced. - `county` string, required — Since postal, administrative or traditional counties may not apply to some addresses, the county field is designed to return whatever county data is available. Normally, the postal county is returned. If this is not present, the county field will fall back to the administrative county. If the administrative county is also not present, the county field will fall back to the traditional county. May be empty in cases where no administrative, postal or traditional county present. - `county_code` string, required — Short code representing the county or province. May be empty (`""`) - `uprn` string, required — UPRN stands for Unique Property Reference Number and is maintained by the Ordnance Survey (OS). Local governments in the UK have allocated a unique number for each land or property. Up to 12 digits in length. Multiple Residence premises currently share the same UPRN as the parent premise. May not be available for a small number of Great Britain addresses due to longer update cycles for Ordnance Survey's AddressBase datasets. Returns empty string "" in these instances. Although UPRN takes an integer format, we encode and transmit this data as strings. As a 12 digit number, the UPRN can exceed the maximum safe integer `Number.MAX_SAFE_INTEGER` in most browsers causing this datapoint to be corrupted. Take special care when storing UPRN. As a 12 digit identifier, you will need 64 bits to encode every possible UPRN value. This means applications like Excel will corrupt cells containing UPRN values. - `udprn` integer, required — UDPRN stands for ‘Unique Delivery Point Reference Number’. Royal Mail assigns a unique UDPRN code for each premise on PAF. Simple, unique reference number for each Delivery Point. Unlikely to be reused when an address expires. Up to 8-digit numeric code. A new UDPRN is automatically assigned to each new Delivery Point added to PAF. - `umprn` union, required — A small minority of individual premises (as identified by a UDPRN) may have multiple occupants behind the same letterbox. These are known as Multiple Residence occupants and can be queried via the Multiple Residence dataset. Simple, unique reference number for each Multiple Residence occupant. Note: this will be an empty string `""` when not used. - string — If premise is not multiple occupancy, this will be an empty string - number — If premise is multiple occupancy, this will be an integer - `postcode_outward` string, required — The first part of a postcode is known as the outward code. e.g. The outward code of ID1 1QD is ID1. Enables mail to be sorted to the correct local area for delivery. This part of the code contains the area and the district to which the mail is to be delivered, e.g. ‘PO1’, ‘SW1A’ or ‘B23’. - `postcode_inward` string, required — The second part of a postcode is known as the inward code. e.g. The inward code of ID1 1QD is 1QD. The number identifies the sector in the postal district. The number is followed by 2 letters. The letters then define one or more properties in that sector. - `dependant_locality` string, required — When the same thoroughfare name reoccurs in a Post town, it may not be possible to make it dependant on a dependant thoroughfare. In this case the thoroughfare is dependant on a locality. For example if we want to find 1 Back Lane in Huddersfield we see that there are three. - `double_dependant_locality` string, required — Used to supplement Dependant Locality. A Double Dependant Locality supplied along with a Dependant Locality if the Dependant Locality exists twice in the same locality. - `thoroughfare` string, required — Also known as the street or road name. In general each Thoroughfare Name will have a separate Postcode. Longer Thoroughfares with high number ranges often have multiple Postcodes covering the entire length of the road, with breaks at suitable points e.g. junctions or natural breaks in the road. - `dependant_thoroughfare` string, required — Used to supplement thoroughfare. When a thoroughfare name is used twice in the same Post Town, the dependant thoroughfare is added to uniquely indentify a delivery point. - `building_number` string, required — Number to identify premise on a thoroughfare or dependant thoroughfare. - `building_name` string, required — Name of residential or commercial premise. Examples: - The Manor - 1-2 - A - 12A - K - Victoria House - `sub_building_name` string, required — When a premise is split into individual units such as flats, apartments or business units. Cannot be present without either building_name or building_number. E.g. Flat 1, A, 10B - `po_box` string, required — When the PO Box Number field is populated it will contain PO BOX nnnnnn where n represents the PO Box number. Note that the PO Box details can occasionally consist of a combination of numbers and letters. PO Box Numbers are only allocated to Large Users. - `department_name` string, required — Used to supplment Organisation Name to identify a deparment within the organisation. - `organisation_name` string, required — Used to supplment Organisation Name to identify a deparment within the organisation - `postcode_type` 'S' | 'L' | '', required — This indicates the type of user. It can only take the values 'S' or 'L' indicating small or large respectively. Large User Postcodes. These are assigned to one single address either due to the large volume of mail received at that address, or because a PO Box or Selectapost service has been set up. Small User Postcodes. These identify a group of Delivery Points. On average there are 19 Delivery Points per Postcode. However this can vary between 1 and, in some cases, 100. There will never be more than 100 Delivery Points on a Postcode. - `su_organisation_indicator` string, required — Small User Organisation Indicator can have the values 'Y' or space. A value of 'Y' indicates that a Small User Organisation is present at this address. - `delivery_point_suffix` string, required — A unique Royal Mail 2-character code (the first numeric & the second alphabetical), which, when added to the Postcode, enables each live Delivery Point to be uniquely identified. Once the Delivery Point is deleted from PAF the DPS may be reused (although they aren’t reused until all remaining Delivery Points in the range have been allocated). The DPS for a Large User is always '1A' as each Large User has its own Postcode. - `premise` string, required — A pre-computed string which sensibly combines building_number, building_name and sub_building_name. building_number, building_name and sub_building_name represent raw data from Royal Mail's and can be difficult to parse if you are unaware of how the Postcode Address File premise fields work together. For this reason, we also provide a pre-computed premise field which intelligently gathers these points into a single, simple premise string. This field is ideal if you want to pull premise information and thoroughfare information separately instead of using our address lines data. - `administrative_county` string, required — The current administrative county to which the postcode has been assigned. A Unitary Authority name, where one is present. If there is no Unitary Authority, the County name is used. This information is not static, because County boundaries may change due to administrative changes. Data source: ONS - `postal_county` string, required — Postal counties were used for the distribution of mail before the Postcode system was introduced in the 1970s. The Former Postal County was the Administrative County at the time. This data rarely changes. May be empty. - `traditional_county` string, required — Traditional counties are provided by the Association of British Counties. It is historical data, and can date from the 1800s. May be empty. - `district` string, required — The current district/unitary authority to which the postcode has been assigned. - `ward` string, required — The current administrative/electoral area to which the postcode has been assigned. May be empty for a small number of addresses. - `longitude` union, required — The longitude of the postcode (WGS84/ETRS89). Can be a positive or negative decimal. E.g. -0.1283983 Returns an empty string if no location data is available. - string — Empty string `""` if not available - number — Represents longitude - `latitude` union, required — The latitude of the postcode (WGS84/ETRS89). Can be a positive or negative decimal. E.g. `51.5083983`. Returns an empty string if no location data is available. - string — Empty string `""` if not available - number — Represents latitude - `eastings` union, required — Eastings reference using the [Ordnance Survey National Grid reference system](https://en.wikipedia.org/wiki/Ordnance_Survey_National_Grid). Northern Ireland Eastings uses the [Irish Grid Reference System](https://en.wikipedia.org/wiki/Irish_grid_reference_system). Metres from origin. E.g. `550458` Returns an empty string if no location data is available. Otherwise a number is returned. - string — Empty string `""` if not available - number — Metres offset east from origin - `northings` union, required — Northings reference using the [Ordnance Survey National Grid reference system](https://en.wikipedia.org/wiki/Ordnance_Survey_National_Grid) Northern Ireland Northings uses the [Irish Grid Reference System](https://en.wikipedia.org/wiki/Irish_grid_reference_system) Metres from origin. E.g. `180458` Returns an empty string if no location data is available. Otherwise a number is returned - string — Empty string `""` if not available - number — Metres offset north from origin - PafAliasAddress — PAF Aliases addresses are alternate ways to present an address already found on PAF. Alias data is information the public chooses to use when addressing mail, but which isn’t actually required for delivery purposes. The Alias data contains records of alternative address details that are included in the address but not necessarily needed for delivery purposes. - `id` string, required — Global unique internally generated identifier for an address - `dataset` 'pafa', required — Indicates the provenance of an address - `country_iso` 'GBR' | 'IMN' | 'JEY' | 'GGY', required — 3 letter country code (ISO 3166-1) - `country_iso_2` 'GB' | 'IM' | 'JE' | 'GG', required — 2 letter country code (ISO 3166-1) - `country` 'England' | 'Scotland' | 'Wales' | 'Northern Ireland' | 'Jersey' | 'Guernsey' | 'Isle of Man', required — Full country names (ISO 3166) - `language` 'en', required — Language represented by 2 letter ISO Code (639-1) - `line_1` string, required — First Address Line. Often contains premise and thoroughfare information. In the case of a commercial premise, the first line is always the full name of the registered organisation. Never empty. - `line_2` string, required — Second Address Line. Often contains thoroughfare and locality information. May be empty - `line_3` string, required — Third address line. May be empty. - `post_town` string, required — **Filter by Town or City" A Post Town is mandatory for delivery of mail to a Delivery Point. This is not necessarily the nearest town geographically, but a routing instruction to the Royal Mail delivery office sorting mail for that Delivery Point. A Post Town will always be present in every address, and for some Localities the Post Town will be the only locality element present. - `postcode` string, required — Correctly formatted postcode. Capitalised and spaced. - `county` string, required — Since postal, administrative or traditional counties may not apply to some addresses, the county field is designed to return whatever county data is available. Normally, the postal county is returned. If this is not present, the county field will fall back to the administrative county. If the administrative county is also not present, the county field will fall back to the traditional county. May be empty in cases where no administrative, postal or traditional county present. - `county_code` string, required — Short code representing the county or province. May be empty (`""`) - `uprn` string, required — UPRN stands for Unique Property Reference Number and is maintained by the Ordnance Survey (OS). Local governments in the UK have allocated a unique number for each land or property. Up to 12 digits in length. Multiple Residence premises currently share the same UPRN as the parent premise. May not be available for a small number of Great Britain addresses due to longer update cycles for Ordnance Survey's AddressBase datasets. Returns empty string "" in these instances. Although UPRN takes an integer format, we encode and transmit this data as strings. As a 12 digit number, the UPRN can exceed the maximum safe integer `Number.MAX_SAFE_INTEGER` in most browsers causing this datapoint to be corrupted. Take special care when storing UPRN. As a 12 digit identifier, you will need 64 bits to encode every possible UPRN value. This means applications like Excel will corrupt cells containing UPRN values. - `udprn` integer, required — UDPRN stands for ‘Unique Delivery Point Reference Number’. Royal Mail assigns a unique UDPRN code for each premise on PAF. Simple, unique reference number for each Delivery Point. Unlikely to be reused when an address expires. Up to 8-digit numeric code. A new UDPRN is automatically assigned to each new Delivery Point added to PAF. - `umprn` union, required — A small minority of individual premises (as identified by a UDPRN) may have multiple occupants behind the same letterbox. These are known as Multiple Residence occupants and can be queried via the Multiple Residence dataset. Simple, unique reference number for each Multiple Residence occupant. Note: this will be an empty string `""` when not used. - string — If premise is not multiple occupancy, this will be an empty string - number — If premise is multiple occupancy, this will be an integer - `postcode_outward` string, required — The first part of a postcode is known as the outward code. e.g. The outward code of ID1 1QD is ID1. Enables mail to be sorted to the correct local area for delivery. This part of the code contains the area and the district to which the mail is to be delivered, e.g. ‘PO1’, ‘SW1A’ or ‘B23’. - `postcode_inward` string, required — The second part of a postcode is known as the inward code. e.g. The inward code of ID1 1QD is 1QD. The number identifies the sector in the postal district. The number is followed by 2 letters. The letters then define one or more properties in that sector. - `dependant_locality` string, required — When the same thoroughfare name reoccurs in a Post town, it may not be possible to make it dependant on a dependant thoroughfare. In this case the thoroughfare is dependant on a locality. For example if we want to find 1 Back Lane in Huddersfield we see that there are three. - `double_dependant_locality` string, required — Used to supplement Dependant Locality. A Double Dependant Locality supplied along with a Dependant Locality if the Dependant Locality exists twice in the same locality. - `thoroughfare` string, required — Also known as the street or road name. In general each Thoroughfare Name will have a separate Postcode. Longer Thoroughfares with high number ranges often have multiple Postcodes covering the entire length of the road, with breaks at suitable points e.g. junctions or natural breaks in the road. - `dependant_thoroughfare` string, required — Used to supplement thoroughfare. When a thoroughfare name is used twice in the same Post Town, the dependant thoroughfare is added to uniquely indentify a delivery point. - `building_number` string, required — Number to identify premise on a thoroughfare or dependant thoroughfare. - `building_name` string, required — Name of residential or commercial premise. Examples: - The Manor - 1-2 - A - 12A - K - Victoria House - `sub_building_name` string, required — When a premise is split into individual units such as flats, apartments or business units. Cannot be present without either building_name or building_number. E.g. Flat 1, A, 10B - `po_box` string, required — When the PO Box Number field is populated it will contain PO BOX nnnnnn where n represents the PO Box number. Note that the PO Box details can occasionally consist of a combination of numbers and letters. PO Box Numbers are only allocated to Large Users. - `department_name` string, required — Used to supplment Organisation Name to identify a deparment within the organisation. - `organisation_name` string, required — Used to supplment Organisation Name to identify a deparment within the organisation - `postcode_type` 'S' | 'L' | '', required — This indicates the type of user. It can only take the values 'S' or 'L' indicating small or large respectively. Large User Postcodes. These are assigned to one single address either due to the large volume of mail received at that address, or because a PO Box or Selectapost service has been set up. Small User Postcodes. These identify a group of Delivery Points. On average there are 19 Delivery Points per Postcode. However this can vary between 1 and, in some cases, 100. There will never be more than 100 Delivery Points on a Postcode. - `su_organisation_indicator` string, required — Small User Organisation Indicator can have the values 'Y' or space. A value of 'Y' indicates that a Small User Organisation is present at this address. - `delivery_point_suffix` string, required — A unique Royal Mail 2-character code (the first numeric & the second alphabetical), which, when added to the Postcode, enables each live Delivery Point to be uniquely identified. Once the Delivery Point is deleted from PAF the DPS may be reused (although they aren’t reused until all remaining Delivery Points in the range have been allocated). The DPS for a Large User is always '1A' as each Large User has its own Postcode. - `premise` string, required — A pre-computed string which sensibly combines building_number, building_name and sub_building_name. building_number, building_name and sub_building_name represent raw data from Royal Mail's and can be difficult to parse if you are unaware of how the Postcode Address File premise fields work together. For this reason, we also provide a pre-computed premise field which intelligently gathers these points into a single, simple premise string. This field is ideal if you want to pull premise information and thoroughfare information separately instead of using our address lines data. - `administrative_county` string, required — The current administrative county to which the postcode has been assigned. A Unitary Authority name, where one is present. If there is no Unitary Authority, the County name is used. This information is not static, because County boundaries may change due to administrative changes. Data source: ONS - `postal_county` string, required — Postal counties were used for the distribution of mail before the Postcode system was introduced in the 1970s. The Former Postal County was the Administrative County at the time. This data rarely changes. May be empty. - `traditional_county` string, required — Traditional counties are provided by the Association of British Counties. It is historical data, and can date from the 1800s. May be empty. - `district` string, required — The current district/unitary authority to which the postcode has been assigned. - `ward` string, required — The current administrative/electoral area to which the postcode has been assigned. May be empty for a small number of addresses. - `longitude` union, required — The longitude of the postcode (WGS84/ETRS89). Can be a positive or negative decimal. E.g. -0.1283983 Returns an empty string if no location data is available. - string — Empty string `""` if not available - number — Represents longitude - `latitude` union, required — The latitude of the postcode (WGS84/ETRS89). Can be a positive or negative decimal. E.g. `51.5083983`. Returns an empty string if no location data is available. - string — Empty string `""` if not available - number — Represents latitude - `eastings` union, required — Eastings reference using the [Ordnance Survey National Grid reference system](https://en.wikipedia.org/wiki/Ordnance_Survey_National_Grid). Northern Ireland Eastings uses the [Irish Grid Reference System](https://en.wikipedia.org/wiki/Irish_grid_reference_system). Metres from origin. E.g. `550458` Returns an empty string if no location data is available. Otherwise a number is returned. - string — Empty string `""` if not available - number — Metres offset east from origin - `northings` union, required — Northings reference using the [Ordnance Survey National Grid reference system](https://en.wikipedia.org/wiki/Ordnance_Survey_National_Grid) Northern Ireland Northings uses the [Irish Grid Reference System](https://en.wikipedia.org/wiki/Irish_grid_reference_system) Metres from origin. E.g. `180458` Returns an empty string if no location data is available. Otherwise a number is returned - string — Empty string `""` if not available - number — Metres offset north from origin - WelshPafAddress — Welsh language alternative for a PAF Address - `id` string, required — Global unique internally generated identifier for an address - `dataset` 'pafw', required — Indicates the provenance of an address - `country_iso` 'GBR', required — 3 letter country code (ISO 3166-1) - `country_iso_2` 'GB', required — 2 letter country code (ISO 3166-1) - `country` 'Wales', required — Full country names (ISO 3166) - `language` 'cy', required — Language represented by 2 letter ISO Code (639-1) - `line_1` string, required — First Address Line. Often contains premise and thoroughfare information. In the case of a commercial premise, the first line is always the full name of the registered organisation. Never empty. - `line_2` string, required — Second Address Line. Often contains thoroughfare and locality information. May be empty - `line_3` string, required — Third address line. May be empty. - `post_town` string, required — **Filter by Town or City" A Post Town is mandatory for delivery of mail to a Delivery Point. This is not necessarily the nearest town geographically, but a routing instruction to the Royal Mail delivery office sorting mail for that Delivery Point. A Post Town will always be present in every address, and for some Localities the Post Town will be the only locality element present. - `postcode` string, required — Correctly formatted postcode. Capitalised and spaced. - `county` string, required — Since postal, administrative or traditional counties may not apply to some addresses, the county field is designed to return whatever county data is available. Normally, the postal county is returned. If this is not present, the county field will fall back to the administrative county. If the administrative county is also not present, the county field will fall back to the traditional county. May be empty in cases where no administrative, postal or traditional county present. - `county_code` string, required — Short code representing the county or province. May be empty (`""`) - `uprn` string, required — UPRN stands for Unique Property Reference Number and is maintained by the Ordnance Survey (OS). Local governments in the UK have allocated a unique number for each land or property. Up to 12 digits in length. Multiple Residence premises currently share the same UPRN as the parent premise. May not be available for a small number of Great Britain addresses due to longer update cycles for Ordnance Survey's AddressBase datasets. Returns empty string "" in these instances. Although UPRN takes an integer format, we encode and transmit this data as strings. As a 12 digit number, the UPRN can exceed the maximum safe integer `Number.MAX_SAFE_INTEGER` in most browsers causing this datapoint to be corrupted. Take special care when storing UPRN. As a 12 digit identifier, you will need 64 bits to encode every possible UPRN value. This means applications like Excel will corrupt cells containing UPRN values. - `udprn` integer, required — UDPRN stands for ‘Unique Delivery Point Reference Number’. Royal Mail assigns a unique UDPRN code for each premise on PAF. Simple, unique reference number for each Delivery Point. Unlikely to be reused when an address expires. Up to 8-digit numeric code. A new UDPRN is automatically assigned to each new Delivery Point added to PAF. - `umprn` union, required — A small minority of individual premises (as identified by a UDPRN) may have multiple occupants behind the same letterbox. These are known as Multiple Residence occupants and can be queried via the Multiple Residence dataset. Simple, unique reference number for each Multiple Residence occupant. Note: this will be an empty string `""` when not used. - string — If premise is not multiple occupancy, this will be an empty string - number — If premise is multiple occupancy, this will be an integer - `postcode_outward` string, required — The first part of a postcode is known as the outward code. e.g. The outward code of ID1 1QD is ID1. Enables mail to be sorted to the correct local area for delivery. This part of the code contains the area and the district to which the mail is to be delivered, e.g. ‘PO1’, ‘SW1A’ or ‘B23’. - `postcode_inward` string, required — The second part of a postcode is known as the inward code. e.g. The inward code of ID1 1QD is 1QD. The number identifies the sector in the postal district. The number is followed by 2 letters. The letters then define one or more properties in that sector. - `dependant_locality` string, required — When the same thoroughfare name reoccurs in a Post town, it may not be possible to make it dependant on a dependant thoroughfare. In this case the thoroughfare is dependant on a locality. For example if we want to find 1 Back Lane in Huddersfield we see that there are three. - `double_dependant_locality` string, required — Used to supplement Dependant Locality. A Double Dependant Locality supplied along with a Dependant Locality if the Dependant Locality exists twice in the same locality. - `thoroughfare` string, required — Also known as the street or road name. In general each Thoroughfare Name will have a separate Postcode. Longer Thoroughfares with high number ranges often have multiple Postcodes covering the entire length of the road, with breaks at suitable points e.g. junctions or natural breaks in the road. - `dependant_thoroughfare` string, required — Used to supplement thoroughfare. When a thoroughfare name is used twice in the same Post Town, the dependant thoroughfare is added to uniquely indentify a delivery point. - `building_number` string, required — Number to identify premise on a thoroughfare or dependant thoroughfare. - `building_name` string, required — Name of residential or commercial premise. Examples: - The Manor - 1-2 - A - 12A - K - Victoria House - `sub_building_name` string, required — When a premise is split into individual units such as flats, apartments or business units. Cannot be present without either building_name or building_number. E.g. Flat 1, A, 10B - `po_box` string, required — When the PO Box Number field is populated it will contain PO BOX nnnnnn where n represents the PO Box number. Note that the PO Box details can occasionally consist of a combination of numbers and letters. PO Box Numbers are only allocated to Large Users. - `department_name` string, required — Used to supplment Organisation Name to identify a deparment within the organisation. - `organisation_name` string, required — Used to supplment Organisation Name to identify a deparment within the organisation - `postcode_type` 'S' | 'L' | '', required — This indicates the type of user. It can only take the values 'S' or 'L' indicating small or large respectively. Large User Postcodes. These are assigned to one single address either due to the large volume of mail received at that address, or because a PO Box or Selectapost service has been set up. Small User Postcodes. These identify a group of Delivery Points. On average there are 19 Delivery Points per Postcode. However this can vary between 1 and, in some cases, 100. There will never be more than 100 Delivery Points on a Postcode. - `su_organisation_indicator` string, required — Small User Organisation Indicator can have the values 'Y' or space. A value of 'Y' indicates that a Small User Organisation is present at this address. - `delivery_point_suffix` string, required — A unique Royal Mail 2-character code (the first numeric & the second alphabetical), which, when added to the Postcode, enables each live Delivery Point to be uniquely identified. Once the Delivery Point is deleted from PAF the DPS may be reused (although they aren’t reused until all remaining Delivery Points in the range have been allocated). The DPS for a Large User is always '1A' as each Large User has its own Postcode. - `premise` string, required — A pre-computed string which sensibly combines building_number, building_name and sub_building_name. building_number, building_name and sub_building_name represent raw data from Royal Mail's and can be difficult to parse if you are unaware of how the Postcode Address File premise fields work together. For this reason, we also provide a pre-computed premise field which intelligently gathers these points into a single, simple premise string. This field is ideal if you want to pull premise information and thoroughfare information separately instead of using our address lines data. - `administrative_county` string, required — The current administrative county to which the postcode has been assigned. A Unitary Authority name, where one is present. If there is no Unitary Authority, the County name is used. This information is not static, because County boundaries may change due to administrative changes. Data source: ONS - `postal_county` string, required — Postal counties were used for the distribution of mail before the Postcode system was introduced in the 1970s. The Former Postal County was the Administrative County at the time. This data rarely changes. May be empty. - `traditional_county` string, required — Traditional counties are provided by the Association of British Counties. It is historical data, and can date from the 1800s. May be empty. - `district` string, required — The current district/unitary authority to which the postcode has been assigned. - `ward` string, required — The current administrative/electoral area to which the postcode has been assigned. May be empty for a small number of addresses. - `longitude` union, required — The longitude of the postcode (WGS84/ETRS89). Can be a positive or negative decimal. E.g. -0.1283983 Returns an empty string if no location data is available. - string — Empty string `""` if not available - number — Represents longitude - `latitude` union, required — The latitude of the postcode (WGS84/ETRS89). Can be a positive or negative decimal. E.g. `51.5083983`. Returns an empty string if no location data is available. - string — Empty string `""` if not available - number — Represents latitude - `eastings` union, required — Eastings reference using the [Ordnance Survey National Grid reference system](https://en.wikipedia.org/wiki/Ordnance_Survey_National_Grid). Northern Ireland Eastings uses the [Irish Grid Reference System](https://en.wikipedia.org/wiki/Irish_grid_reference_system). Metres from origin. E.g. `550458` Returns an empty string if no location data is available. Otherwise a number is returned. - string — Empty string `""` if not available - number — Metres offset east from origin - `northings` union, required — Northings reference using the [Ordnance Survey National Grid reference system](https://en.wikipedia.org/wiki/Ordnance_Survey_National_Grid) Northern Ireland Northings uses the [Irish Grid Reference System](https://en.wikipedia.org/wiki/Irish_grid_reference_system) Metres from origin. E.g. `180458` Returns an empty string if no location data is available. Otherwise a number is returned - string — Empty string `""` if not available - number — Metres offset north from origin - UsaCassVerifiedAddress — Address retrieved using CASS compliant address verification process - `address1` string, required — Primary delivery address - `address2` string, required — Secondary address information - `address3` string, required — Additional secondary address information - `area_code` string, required — Area code. Also known as Numbering Plan Area (NPA) https://en.wikipedia.org/wiki/List_of_North_American_Numbering_Plan_area_codes - `carrier_route` string, required — Data required to perform a Carrier Route sort - `check_digit` string, required — Character following the 5 or 9 digit ZIP Code. Part of the 11-digit barcode - `city` string, required — City name example: "Alamogordo" - `city_abbreviation` string, required — City Abbreviation. Empty string if not present - `congressional_district` string, required — Identifies the Congressional District. Empty string if not present - `country_code` string, required — ISO3166 country code. Empty string if not present - `county` string, required — Name of the county - `day_light_savings` boolean, required — Daylight saving time indicator - `delivery_point` string, required — Last 2 digits of the primary street address number or Post Office box - `dpv` 'Y' | 'S' | 'D' | 'N' | '', required — Delivery Point Validation (DPV) Confirmation code. Possible values: - 'Y' Primary and secondary address information was validated - 'S' Extraneous or incorrect secondary address present - 'D' Secondary address information missing - 'N' Primary and secondary address information was not validated - '' Address was not submitted to DPV lookup. Address was not ZIP+4 matched. - `dpv_cmra` 'Y' | 'N' | '', required — Delivery Point Validation (DPV) CMRA code. Indicates if the address is linked to a Commercial Mail Receiving Agency (CMRA), such as the UPS Store or Mailboxes Etc., where USPS mail can be sent or received. Possible values: - 'Y' Address is associated with a CMRA - 'N' Address is not associated with a CMRA - '' Empty string if address is not DPV validated. - `dpv_footnotes` string, required — Delivery Point Validation (DPV) Footnotes. Empty string if not present Possible values: - 'AA' ZIP+4 matched. - 'A1' ZIP+4 did not match. - 'BB' Primary and secondary address information was DPV validated. - 'CC' Primary address information was DPV validated. Input secondary address information dropped. - 'F1' Military address. - 'G1' General delivery address. - 'N1' Primary address information was DPV validated. Highrise address with missing secondary address information. - 'M1' Primary number missing from address. - 'M3' Primary number invalid. - 'P1' Box number missing. - 'P3' Box number invalid. - 'RR' Validated CMRA address with PMB information. - 'R1' Validated CMRA address without PMB information. - 'U1' Unique 5-digit ZIP code. - `dpv_no_stat` 'Y' | 'N' | '', required — Delivery Point Validation (DPV) NoStat code. Indicates whether the address is a vacant property, it receives mail as a part of a drop, or it does not have an established delivery yet. Possible values: - 'Y' Confirmed - 'N' Not confirmed - '' Empty string if address is not DPV validated. - `dpv_vacant` 'Y' | 'N' | '', required — Delivery Point Validation (DPV) Vacant code. USPS records indicate that although this may be a valid address, the residence or business is vacant. Possible values: - 'Y' Confirmed vacant - 'N' Not confirmed vacant - '' Empty string if address is not DPV validated. - `elot` string, required — Enhanced Line of Travel. For arranging records in the order that a route is served by a carrier. eLOT sequencing, when combined with Carrier Route codes, may allow Enhanced Carrier Route (ECR) discounts to be claimed. - `finance_number` union, required — Internal accounting number used by the USPS® when Post Offices or ZIP Codes are discontinued and reassigned. The finance number reflects the geographic grouping of ZIP + 4 areas in which these changes can be made. Empty string if not present - string - number - `fips_county_code` string, required — Federal Information Processing Standard code for a county. Empty string if not present - `firm` string, required — Company name in a business address - `footnotes` string, required — Letter codes returned by ZIP+4 encoding. Empty string if not present - `geo_coded` boolean, required — Indicates whether the address was geo-coded - `lacs_indicator` 'L' | '', required — Indicates whether a record may benefit from LACS processing. Possible values: - 'L' Yes - '' No - `lacs_link_footnote` 'A' | '00' | '09' | '14' | '92' | '', required — LACSLink Footnote. Return Code returned by the LACSLink process when an accurate address match could not be made. These codes help identify the type of move and the type of deficiency in the record which prevents a match. Possible values: - 'A' Address matched - '00' No match - '09' The input record matched to a record in the master file, but the old address is a highrise default - '14' The input record matched to a record in the master file. The new address could not be converted to a deliverable address - '92' LACSLink Record: Secondary Number Dropped from Input Address - The input record matched to a master file record, but the input address had a secondary number and the master file record did not. The record is a ZIP + 4 street level or high-rise match - '' Address not submitted to LACSLink lookup - `lacs_link_indicator` 'Y' | 'S' | 'N' | '', required — LACSLink Indicator. Indicates whether the input address matched a record in the LACSLink database. Possible values: - 'Y' Matched a record in the master file - 'S' The input record matched a master file record, but the input address included a secondary number that the master file record lacked - 'N' No match - '' Empty string if not prese - `latitude` union, required — Latitude of the encoded address. Empty string if not present - string - number - `longitude` union, required — Longitude of the encoded address. Empty string if not present - string - number - `parsed_pmb_designator` string, required — Information if a Private Mail Box (PMB) is found in an address. Empty string if not present - `parsed_pmb_number` union, required — Information if a Private Mail Box (PMB) is found in an address. Empty string if not present - string - number - `parsed_post_directional` union, required — Notation following the street name indicating street direction. Empty string if not present - string - number - `parsed_pre_directional` string, required — Notation preceding the street name indicating street direction. Empty string if not present - `parsed_primary_number` union, required — Number preceding the street name. Empty string if not present - string - number - `parsed_street_name` string, required — Street name. Empty string if not present - `parsed_suffix` string, required — Part of the delivery address line following the street name. Empty string if not present - `parsed_unit_designator` string, required — Identification of the secondary address unit. Empty string if not present - `parsed_unit_number` string, required — Apartment or suite number. Empty string if not present - `rdi` string, required — Reserved for future use. Empty string if not present - `record_type` 'C' | 'F' | 'G' | 'H' | 'M' | 'P' | 'R' | 'S' | 'U' | '', required — Type of address record. Possible values: - 'C' Multi-Carrier - 'F' Firm - 'G' General Delivery - 'H' High-rise or Apartment Building - 'M' Military - 'P' PO Box - 'R' Route (Rural Route/Highway Contract) - 'S' Street - 'U' Unique 5-Digit - `state` string, required — Standard two-letter state abbreviation - `suite_link_footnote` '' | '00' | 'A', required — Results of the SuiteLink lookup. Possible values: ' ' (Space), '00' (Double Zero), 'A' (A). Empty string if not present - `time_zone` string, required — Time zone. Empty string if not present - `urbanization` string, required — Urban name required in the address of all mail being delivered to Puerto Rico. Empty string if not present - `zip_code` string, required — 5-digit ZIP Code and the four additional digits - `country_iso_2` string — 2 letter country ISO code - `count` number, required — The number of addresses we matched to the input. We return the closest match by default. - `fit` number, required — A score represented as number between 1 and 0. Fit compares the address elements present in your query against the matching address elements. It does not incorporate elements you have not presented in the score. A partial address (e.g. 12 Pye Green Road) will have a fit of 1 even though it is missing post town and postcode. Its confidence score will be less than 1 however because it is missing some crucial elements. - `confidence` number, required — A confidence score represented as number between 1 and 0. 1 indicates a full match. 0 indicates no complete matching elements. - `organisation_match` 'FULL' | 'PARTIAL' | 'INCORRECT' | 'MISSING' | 'NA', required — Match indicator for the organisation - `premise_match` 'FULL' | 'PARTIAL' | 'INCORRECT' | 'MISSING' | 'NA', required — Match indicator for the premise - `postcode_match` 'FULL' | 'PARTIAL' | 'INCORRECT' | 'MISSING' | 'NA', required — Match indicator for the postcode - `thoroughfare_match` 'FULL' | 'PARTIAL' | 'INCORRECT' | 'MISSING' | 'NA', required — Match indicator for the street - `locality_match` 'FULL' | 'PARTIAL' | 'INCORRECT' | 'MISSING' | 'NA', required — Match indicator for the locality - `post_town_match` 'FULL' | 'PARTIAL' | 'INCORRECT' | 'MISSING' | 'NA', required — Match indicator for the post_town - GbrCleanseNoMatch - `query` string, required — Originally submitted query - `match` null, nullable, required — Nearest matching address - `count` 0, required - `fit` 0, float, required - `confidence` 0, float, required - `organisation_match` 'NO_MATCH', required - `premise_match` 'NO_MATCH', required - `postcode_match` 'NO_MATCH', required - `thoroughfare_match` 'NO_MATCH', required - `locality_match` 'NO_MATCH', required - `post_town_match` 'NO_MATCH', required ## Other responses - `400` — Bad Request - `401` — Unauthorized - `429` — Rate Limited --- [API](https://skmtc.net/ideal-postcodes/apis/api-reference.md) · [All operations](https://skmtc.net/ideal-postcodes/apis/api-reference/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/ideal-postcodes/api-reference/revisions/295dd3238f22/schema)