/** * This file was auto-generated by openapi-typescript. * Do not make direct changes to the file. */ export interface paths { "/postcodes/{postcode}": { /** * Returns the complete list of addresses for a postcode. Postcode searches are space and case insensitive. * * The Postcode Lookup API provides a JSON interface to search UK addresses from a postcode. It can be used to power Postcode Lookup driven address searches, like [Postcode Lookup](/postcode-lookup). * * ## Postcode Not Found * * Lookup balance is unaffected by invalid postcodes. The API returns a `404` response with response body: * * ```json * { * "code": 4040, * "message": "Postcode not found", * "suggestions": ["SW1A 0AA"] * } * ``` * * ### Suggestions * * If a postcode cannot be found, the API will provide up to 5 closest matching postcodes. Common errors will be corrected first (e.g. mixing up `O` and `0` or `I` and `1`). * * If the suggestion list is small (fewer than 3), there is a high probability the correct postcode is there. You may notify the user or immediately trigger new searches. * * The suggestion list will be empty if the postcode has deviated too far from a valid postcode format. * * ## Multiple Residence * * A small number of postcodes will return more than 100 premises. These may require pagination. Use `page` to paginate the result set. */ get: operations["Postcodes"]; }; "/udprn/{udprn}": { /** * Returns an address as identified by its Unique Delivery Point Reference Number (UDPRN). * * You may find it useful to store UDPRN information as it can be used to retrieve the most recent information for an address. It can also be used to test for a deleted address. * * UDPRNs are an eight digit unique numeric code (e.g. `25962203`) for any premise on the Postcode Address File. It's essentially a unique identifier for every address in the UK that Royal Mail has in its database. * * ## Testing * * To test your implementation of our API we have a range of test UDPRNs that yield both successful and unsuccessful responses to your request. * * They are the following: * * - `0` Returns a successful UDPRN lookup response * `2000` * - `-1` Returns "UDPRN not found", error `4044` * - `-2` Returns "no lookups remaining", error `4020` * - `-3` Returns "daily (or individual) lookup limit breached", * error `4021` * * Test request undergo the usual authentication and restriction rules. This is to help surface any issues that occur during implementation and does not cost you a lookup. */ get: operations["UDPRN"]; }; "/umprn/{umprn}": { /** * Returns a multiple occupancy address identifited via its UMPRN (Multiple Residence Unique ID). * * UMPRNs are a unique numeric code for any Multiple Residence household on the optional Multiple Residence dataset. * * ## Testing * * To test your implementation of our API we have a range of test UMPRNs that yield both successful and unsuccessful responses to your request. They are the following * * - `0` Returns a successful UMPRN lookup response `2000` * - `-1` Returns "UMPRN not found", error `4044` * - `-2` Returns "no lookups remaining", error `4020` * - `-3` Returns "daily (or individual) lookup limit breached", error `4021` * * Test request undergo the usual authentication and restriction rules. This is to help surface any issues that occur during implementation and does not cost you a lookup. * * ### Pricing * * Per lookup charges apply. Empty responses are not charged. */ get: operations["UMPRN"]; }; "/keys/{key}": { /** * Returns public information on your API Key. * * This endpoint can be used for the following: * - Determine if the key is currently useable via the `available` property * - Determine available contexts for a an API Key * - Identify the currently likely context of a user given their location * * You may pass both API Keys (beginning `ak_`) and Sub-licensed Keys (beginning `sl_`). */ get: operations["KeyAvailability"]; }; "/keys/{key}/details": { /** Returns private data on the key including remaining lookups, available datasets and usage limits. */ get: operations["KeyDetails"]; /** Update API Key Details */ put: operations["UpdateKeyDetails"]; }; "/keys/{key}/usage": { /** * Reports the number of lookups consumed on a key for a range of days. * * A maximum interval of 90 days can be provided for analysis. If no start or end date is provided, the last 21 days will be used as the default interval. * * If no `start` time is provided, the start time will be set to 21 days prior to the current time. * * If no `end` time is provided, the current time will be used. * * Append `tags` to scope the number of lookups to those with matching tag values. E.g. `tags=foo,bar` will only count transactions that match `foo` and `bar`. */ get: operations["KeyUsage"]; }; "/keys/{key}/lookups": { /** * Reports lookup information on a key for paid lookups. * * This method requires a `user_token`, which can be found on your [accounts page](https://ideal-postcodes.co.uk/account). * * A maximum interval of 90 days can be provided for analysis. If no start or end date is provided, the last 21 days will be used as the default interval. * * ## Download Usage History (CSV) * * `GET /keys/:key/lookups` * * Returns a CSV download of lookups performed and associated information. * * Note that the Content-Type returned will be CSV (text/csv). For a non 200 response, the `Content-Type` will revert to JSON with the error code and message embedded. * * ## Data Redaction * * Personally Identifiable Data (PII) caught in this your usage log (including IP, search term and URL data) will be redacted on a weekly basis. * * By default, PII will be redacted if it is older than 21 days. This timeframe can be configured from your dashboard. * * You may prevent PII collection altogether by setting the interval to `0` days. */ get: operations["KeyLogs"]; }; "/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 organistation 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 ambigious 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 throroughfare or building name only? Are accurate organisation names an important feature? */ post: operations["AddressCleanse"]; }; "/verify/addresses": { /** * The address verify API validates, corrects, and standardizes individual addresses based on USPS's Coding Accuracy Support System (CASS). * * The address verify API accepts the 3 combination of inputs: * * - Free-form address submitted as a single string in `query` * - Example: "123 Main St, Springfield, CO 81073-1119" * - Only free-form and zip code address components submitted as separate parameters: * - `query` for the street address * - `zip_code` for the ZIP code * - Example: * - `query`: "123 Main St, Springfield CO" * - `zip_code`: "81073-1119" * - Only free-form, city and state address components submitted as separate parameters: * - `query` for the street address * - `city` for the city * - `state` for the state * - Example: * - `query`: "123 Main St" * - `city`: "Springfield" * - `state`: "CO" */ post: operations["AddressVerify"]; }; "/autocomplete/addresses": { /** * The Address Autocomplete API delivers address suggestions in order of relevance based on a provided query. It aids real-time address autofill implementations. * * Consider using our Address Autocomplete JavaScript libraries to add address lookup to a form in moments rather than interacting with this API directly. * * ## API Usage * * Implementing our Address Autocomplete API involves: * * 1. Fetch address suggestions with `/autocomplete/addresses` * 2. Acquire the complete address using the ID from the suggestion * * Step 2 will decrement your lookup balance. * * Note that step 1 is not a free standalone resource. Integrations that consistently make autocomplete requests without a paid Step 2 request will be rate limited and then suspended. * * ## Query Filters * * Refine results by appending filters to your querystring, e.g., `postcode=sw1a2aa` for postcode `SW1A 2AA`. Invalid filters return an empty set without affecting your lookup count. * * To apply multiple filter terms, use a comma-separated list, e.g., `postcode_outward=e1,e2,e3` combines result sets for E1, E2, and E3. Unless otherwise specified, all filters support multiple terms. * * Combine filters by `AND` logic, for instance, `su_organisation_indicator=Y&postcode_area=n`. The maximum allowed filter terms is **10**. * * ## Address Bias * * Preface bias searches with `bias_` to boost certain address results. Unlike filters, biasing allows unmatched addresses to appear with lower priority. * * For example, use `bias_postcode_area=SW,SE` to favor addresses in the `SW` and `SE` postcode areas. Invalid bias terms have no effect. * * Multiple bias terms are allowed unless stated otherwise, with a combined maximum of **5**. * * ## Suggestion Format * * The suggestion format is subject to change. We recommend using the suggestion as-is to prevent potential integration issues. * * ## Rate Limiting and Cost * * The rate limit for the Autocomplete API is 3000 requests per 5 minutes. HTTP Headers inform about the current rate limit. * * Autocomplete API usage does not impact your balance, but resolving a suggestion to a full address requires a paid request. Autocomplete requests without subsequent paid requests may result in rate limitation or suspension. */ get: operations["FindAddress"]; }; "/autocomplete/addresses/{address}/gbr": { /** * Resolves an address autocompletion by its address ID. * * Resolved addresses (including global addresses) are returned in a UK format (up to 3 address lines) using UK nomenclature (like postcode and county). */ get: operations["ResolveAddress"]; }; "/autocomplete/addresses/{address}/usa": { /** * Resolves an address autocompletion by its address ID. * * Resolved addresses (including global addresses) are returned in a US format (up to 2 address lines) using US nomenclature (like zipcode, state and city). */ get: operations["RetrieveAddress"]; }; "/addresses": { /** * Extract a list of complete addresses that match the query ordered by relevance score. This query accepts an optional limit and page query (defaults to 10 and 0 respectively). * * If a valid postcode is passed as the query string, the entire address list for that postcode is passed as a result. Note, in these cases, limit and page parameters are ignored. * * This API is designed as a multi-purpose tool for generating address lists, cleansing and wholesale data extraction according to specific parameters. * * For address autocomplete, see our address finder API - which is designed for speed and address completion. * * ## Reverse Geocoding * * Return a list of addresses around a point using the lon= and lat= querystring arguments. Addresses will be sorted in order of distance to the point. The search radius is 100m. * * ## Filters * * You can strictly narrow your result by adding filters to your query string which correspond with an address attribute. * * For instance, you can restrict to postcode `SW1A 2AA` by appending `postcode=sw1a2aa`. * * If a filter term is invalid, e.g. `postcode=SW1A2AAA`, then an empty result set is returned and no lookup is incurred. * * You can also scope using multiple terms for the same filter with a comma separated list of terms. E.g. Restrict results to E1, E2 and E3 outward codes: `postcode_outward=e1,e2,e3`. Multiple terms are `OR`'ed, i.e. the matching result sets are combined. * * All filters can accept multiple terms unless stated otherwise below. * * Multiple filters can also be combined. E.g. Restrict results to small user organisations in the N postcode area: `su_organisation_indicator=Y&postcode_area=n`. Multiple filters are `AND`'ed, i.e. each additional filter narrows the result set. * * A combined maximum of 5 terms are allowed across all filters. * * ## Biases * * You can boost certain addresses results that correspond with a certain address attribute. All bias searches are prefixed with `bias_`. * * Biased searches, unlike filtered searches, also allow unmatched addresses to appear . These will rank lower. * * For instance, you can boost addresses with postcode areas `SW` and `SE` by appending `bias_postcode_area=SW,SE`. * * If a bias term is invalid, e.g. `bias_postcode=SW1A2AAA` no bias effect is applied. * * You may scope using multiple terms for the same bias with a comma separated list of terms. E.g. Restrict results to `E1`, `E2` and `E3` outward codes: `bias_postcode_outward=e1,e2,e3`. * * All biases can accept multiple terms unless stated otherwise below. * * A combined maximum of 5 terms are allowed across all biases. * * ## Search by Postcode and Building Name or Number * * Search by postcode and building attribute with the postcode filter and query argument. E.g. For "SW1A 2AA Prime Minister" `/v1/addresses?postcode=sw1a2aa&q=prime minister`. * * The advantage of using filters is a postcode mismatch does not result in a lookup as no results are returned. * * #### Search By UPRN * * Search by UPRN using the `uprn` filter and excluding the query argument. E.g. `/v1/addresses?uprn=100`. * * ## Testing * * - **ID1 1QD** Returns a successful query response `2000` * - **ID1 KFA** Returns an empty query response `2000` * - **ID1 CLIP** Returns "no lookups remaining" error `4020` * - **ID1 CHOP** Returns "daily (or individual) lookup limit breached" error `4021` * * Test request undergo the usual authentication and restriction rules. This is to help surface any issues that occur during implementation and does not cost you a lookup. */ get: operations["Addresses"]; }; "/places": { /** * Query for geographical places across countries. Each query will return a list of place suggestions, which consists of a place name, descriptive name and id. * * This API returns geographical information such as countries, capitals, administrative areas and more. It is ideal for correctly identifying a place along with any other details like geolocation. * * ## Implementing Place Autocomplete * * Extracting the full information of a place is a 2 step process: * * 1. Retrieve place suggestions via /places * 2. Retrieve the entire place with the ID provided in the suggestion * * ## Suggestion Format * * Each place suggestion contains a descriptive name which you can provide to users to uniquely idenfity a place. * * ## Rate Limiting and Cost * * The rate limit for the Autocomplete API is 3000 requests per 5 minutes. HTTP Headers inform about the current rate limit. * * Autocomplete API usage does not impact your balance, but resolving a suggestion to a full address requires a paid request. Autocomplete requests without subsequent paid requests may result in rate limitation or suspension. */ get: operations["FindPlace"]; }; "/places/{place}": { /** Resolves a place autocompletion by its place ID. */ get: operations["ResolvePlace"]; }; "/keys/{key}/licensees": { /** Returns a list of licensees for a key. */ get: operations["ListLicensees"]; /** Create a licensee for the specified API Key. */ post: operations["CreateLicensee"]; }; "/keys/{key}/licensees/{licensee}": { /** Returns licensee information as identified by the licensee key. */ get: operations["RetrieveLicensee"]; /** Update Licensee */ put: operations["UpdateLicensee"]; /** Cancels a licensee key. This renders a licensee unusable. This action can be reversed if you get in contact with us. */ delete: operations["DeleteLicensee"]; }; "/keys/{key}/configs": { /** Lists configurations associated with a key */ get: operations["ListConfigs"]; /** Create a configuration */ post: operations["CreateConfig"]; }; "/keys/{key}/configs/{config}": { /** Retrieve configuration object by name */ get: operations["RetrieveConfig"]; /** Updates configuration object */ post: operations["UpdateConfig"]; /** Permanently deletes a configuration object. */ delete: operations["DeleteConfig"]; }; "/emails": { /** Query for and validate email addresses. */ get: operations["EmailValidation"]; }; "/phone_numbers": { /** Query for and validate phone numbers. */ get: operations["PhoneNumberValidation"]; }; } export interface components { schemas: { ecaf: components["schemas"]["EcafAddress"]; ecad: components["schemas"]["EcadAddress"]; geonames: components["schemas"]["GeonamesPlace"]; here: components["schemas"]["HereAddress"]; /** * ID * @description Global unique internally generated identifier for an address * @example paf_8387729 */ ID: string; /** * Dataset * @description Indicates the provenance of an address */ paf_dataset: string; /** * ISO Country Code (3) * @description 3 letter country code (ISO 3166-1) */ paf_country_iso: string; /** * ISO Country Code (2) * @description 2 letter country code (ISO 3166-1) */ paf_country_iso_2: string; /** * Country * @description Full country names (ISO 3166) * * @example England */ paf_country: string; /** * Language * @description Language represented by 2 letter ISO Code (639-1) */ paf_language: string; /** * Line 1 * @description 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. * @example Prime Minister & First Lord of Treasury */ paf_line1: string; /** * Line 2 * @description Second Address Line. Often contains thoroughfare and locality information. May be empty * @example 10 Downing Street */ paf_line2: string; /** * Line 3 * @description Third address line. May be empty. * @example */ paf_line3: string; /** * @description **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. * * @example London */ paf_post_town: string; /** * Postcode * @description Correctly formatted postcode. Capitalised and spaced. * @example SW1A 2AA */ paf_postcode: string; /** * County * @description 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. * @example London */ paf_county: string; /** * Unique Property Reference Number * @description 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. */ paf_uprn: string; /** * Unique Delivery Point Reference Number (UDPRN) * Format: int32 * @description 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. * @example 23747771 */ paf_udprn: number; /** * UMPRN * @description 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. */ paf_umprn: string | number; /** * Postcode Outward * @description 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’. * @example SW1A */ paf_postcode_outward: string; /** * Postcode Inward * @description 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. * @example 2AA */ paf_postcode_inward: string; /** * Dependant Locality * @description 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. * @example */ paf_dependant_locality: string; /** * Double Dependant Locality * @description 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. * @example */ paf_double_dependant_locality: string; /** * Thoroughfare * @description 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. * @example Downing Street */ paf_thoroughfare: string; /** * Dependant Thoroughfare * @description 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. * @example */ paf_dependant_thoroughfare: string; /** * Building Number * @description Number to identify premise on a thoroughfare or dependant thoroughfare. * @example 10 */ paf_building_number: string; /** * Building Name * @description Name of residential or commercial premise. * * Examples: * - The Manor * - 1-2 * - A * - 12A * - K * - Victoria House * @example */ paf_building_name: string; /** * Sub-Building Name * @description 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 * @example Flat 1 */ paf_sub_building_name: string; /** * PO Box * @description 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. * @example 100 */ paf_pobox: string; /** * Department Name * @description Used to supplment Organisation Name to identify a deparment within the organisation. * @example */ paf_department_name: string; /** * Organisation Name * @description Used to supplment Organisation Name to identify a deparment within the organisation * @example Prime Minister & First Lord Of The Treasury */ paf_organisation_name: string; /** * Postcode Type * @description 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. * @enum {undefined} */ paf_postcode_type: "S" | "L" | ""; /** * Small User Organisation Indicator * @description 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. * @example Y */ paf_su_organisation_indicator: string; /** * Delivery Point Suffix * @description 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. * @example 1A */ paf_delivery_point_suffix: string; /** * Premise * @description 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. * @example 10 */ paf_premise: string; /** * Administrative County * @description 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 * @example */ paf_administrative_county: string; /** * Postal County * @description 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. * @example London */ paf_postal_county: string; /** * Traditional County * @description Traditional counties are provided by the Association of British Counties. It is historical data, and can date from the 1800s. May be empty. * @example Greater London */ paf_traditional_county: string; /** * District * @description The current district/unitary authority to which the postcode has been assigned. * @example Westminster */ paf_district: string; /** * Ward * @description The current administrative/electoral area to which the postcode has been assigned. May be empty for a small number of addresses. * @example St. James' */ paf_ward: string; /** * Longitude * @description 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. */ Longitude: string | number; /** * Longitude * @description 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. */ Latitude: string | number; /** * Eastings * @description 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. */ Eastings: string | number; /** * Northings * @description 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 */ Northings: string | number; PafBase: { id: components["schemas"]["ID"]; dataset: components["schemas"]["paf_dataset"]; country_iso: components["schemas"]["paf_country_iso"]; country_iso_2: components["schemas"]["paf_country_iso_2"]; country: components["schemas"]["paf_country"]; language: components["schemas"]["paf_language"]; line_1: components["schemas"]["paf_line1"]; line_2: components["schemas"]["paf_line2"]; line_3: components["schemas"]["paf_line3"]; post_town: components["schemas"]["paf_post_town"]; postcode: components["schemas"]["paf_postcode"]; county: components["schemas"]["paf_county"]; /** * County Code * @description Short code representing the county or province. May be empty (`""`) * @example */ county_code: string; uprn: components["schemas"]["paf_uprn"]; udprn: components["schemas"]["paf_udprn"]; umprn: components["schemas"]["paf_umprn"]; postcode_outward: components["schemas"]["paf_postcode_outward"]; postcode_inward: components["schemas"]["paf_postcode_inward"]; dependant_locality: components["schemas"]["paf_dependant_locality"]; double_dependant_locality: components["schemas"]["paf_double_dependant_locality"]; thoroughfare: components["schemas"]["paf_thoroughfare"]; dependant_thoroughfare: components["schemas"]["paf_dependant_thoroughfare"]; building_number: components["schemas"]["paf_building_number"]; building_name: components["schemas"]["paf_building_name"]; sub_building_name: components["schemas"]["paf_sub_building_name"]; po_box: components["schemas"]["paf_pobox"]; department_name: components["schemas"]["paf_department_name"]; organisation_name: components["schemas"]["paf_organisation_name"]; postcode_type: components["schemas"]["paf_postcode_type"]; su_organisation_indicator: components["schemas"]["paf_su_organisation_indicator"]; delivery_point_suffix: components["schemas"]["paf_delivery_point_suffix"]; premise: components["schemas"]["paf_premise"]; administrative_county: components["schemas"]["paf_administrative_county"]; postal_county: components["schemas"]["paf_postal_county"]; traditional_county: components["schemas"]["paf_traditional_county"]; district: components["schemas"]["paf_district"]; ward: components["schemas"]["paf_ward"]; longitude: components["schemas"]["Longitude"]; latitude: components["schemas"]["Latitude"]; eastings: components["schemas"]["Eastings"]; northings: components["schemas"]["Northings"]; }; /** * Postcode Address File Address * @description 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. */ PafAddress: components["schemas"]["PafBase"] & { /** @enum {undefined} */ country_iso?: "GBR" | "IMN" | "JEY" | "GGY"; /** @enum {string} */ dataset?: "paf"; /** @enum {undefined} */ country_iso_2?: "GB" | "IM" | "JE" | "GG"; /** @enum {undefined} */ language?: "en"; /** @enum {undefined} */ country?: | "England" | "Scotland" | "Wales" | "Northern Ireland" | "Jersey" | "Guernsey" | "Isle of Man"; }; /** * Multiple Residence Address * @description 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. */ MrAddress: components["schemas"]["PafBase"] & { /** @enum {undefined} */ dataset?: "mr"; /** @enum {undefined} */ country_iso?: "GBR" | "IMN" | "JEY" | "GGY"; /** @enum {undefined} */ country_iso_2?: "GB" | "IM" | "JE" | "GG"; /** @enum {undefined} */ language?: "en"; /** @enum {undefined} */ country?: | "England" | "Scotland" | "Wales" | "Northern Ireland" | "Jersey" | "Guernsey" | "Isle of Man"; }; /** * Not Yet Built Address * @description A UK premise under construction and currently not occupied. * * This dataset is updated by Royal Mail on a monthly cadence. */ NybAddress: components["schemas"]["PafBase"] & { /** @enum {undefined} */ dataset?: "nyb"; /** @enum {undefined} */ country_iso?: "GBR" | "IMN" | "JEY" | "GGY"; /** @enum {undefined} */ country_iso_2?: "GB" | "IM" | "JE" | "GG"; /** @enum {undefined} */ language?: "en"; /** @enum {undefined} */ country?: | "England" | "Scotland" | "Wales" | "Northern Ireland" | "Jersey" | "Guernsey" | "Isle of Man"; }; /** * PAF Alias Address * @description 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. */ PafAliasAddress: components["schemas"]["PafBase"] & { /** @enum {undefined} */ dataset?: "pafa"; /** @enum {undefined} */ country_iso?: "GBR" | "IMN" | "JEY" | "GGY"; /** @enum {undefined} */ country_iso_2?: "GB" | "IM" | "JE" | "GG"; /** @enum {undefined} */ language?: "en"; /** @enum {undefined} */ country?: | "England" | "Scotland" | "Wales" | "Northern Ireland" | "Jersey" | "Guernsey" | "Isle of Man"; }; /** * Welsh PAF Address * @description Welsh language alternative for a PAF Address */ WelshPafAddress: components["schemas"]["PafBase"] & { /** @enum {undefined} */ dataset?: "pafw"; /** @enum {undefined} */ country_iso?: "GBR"; /** @enum {undefined} */ country_iso_2?: "GB"; /** @enum {undefined} */ language?: "cy"; /** @enum {undefined} */ country?: "Wales"; }; /** * Language * @description Language represented by 2 letter ISO Code (639-1) * * @enum {string} */ Language: | "en" | "ar" | "as" | "az" | "be" | "bg" | "bn" | "bs" | "ca" | "cs" | "cy" | "da" | "de" | "el" | "es" | "et" | "eu" | "fi" | "fo" | "fr" | "ga" | "gl" | "gn" | "he" | "hi" | "hr" | "hu" | "hy" | "id" | "is" | "it" | "ka" | "kk" | "km" | "kn" | "lt" | "lv" | "mk" | "mn" | "ms" | "mt" | "my" | "nl" | "no" | "pl" | "pt" | "ro" | "ru" | "sk" | "sl" | "sq" | "sr" | "sv" | "ta" | "th" | "tr" | "uk" | "uz" | "vi" | "wa" | "zh"; /** * AddressBase Core * @description Represents a GB address in Ordnance Survey's AddressBase Core dataset */ AddressBaseCore: { id: components["schemas"]["ID"]; /** * Dataset * @description Indicates the provenance of an address * @enum {string} */ dataset: "ab"; language: components["schemas"]["Language"]; line_1: components["schemas"]["paf_line1"]; line_2: components["schemas"]["paf_line2"]; line_3: components["schemas"]["paf_line3"]; premise: components["schemas"]["paf_premise"]; /** * UPRN * @description Unique Property Reference Number (UPRN) assigned by the LLPG Custodian or Ordnance Survey. */ uprn: string; /** * UDPRN * @description Royal Mail's Unique Delivery Point Reference Number (UDPRN). */ udprn: number; /** * PARENT_UPRN * @description UPRN of the parent Record if a parent-child relationship exists. */ parent_uprn: string; /** * USRN * @description Unique Street Reference Number assigned by the Street Name and Numbering Custodian OR * * Ordnance Survey depending on the address record. */ usrn: number; /** * TOID * @description The Topographic Identifier taken from OS MasterMap Topography Layer. This TOID is assigned to the UPRN by performing a spatial intersection between the two identifiers. It consists of the letters 'osgb' and is followed by up to sixteen digits. */ toid: string; /** * Classification Code * @description A code that describes the classification of the address record to a maximum of a secondary level. */ classification_code: string; /** * Easting * @description A value in metres defining the x location in accordance with the British National Grid. */ eastings: number; /** * Northing * @description A value in metres defining the y location in accordance with the British National Grid. */ northings: number; /** * Latitude * @description A value in metres defining the y location in accordance with the British National Grid. */ latitude: number; /** * Longitude * @description A value defining the Longitude location in accordance with the ETRS89 coordinate reference system. */ longitude: number; /** * Single Line Address * @description A single attribute containing text concatenation of the address elements separated by a comma. */ single_address_line: string; /** * Single Line Address * @description Street / Road name for the address record. */ street_name: string; /** * Locality * @description A locality defines an area or geographical identifier within a town, village or hamlet. Locality represents the lower level geographical area. The locality field should be used in conjunction with the town name and street description fields to uniquely identify geographic area where there may be more than one within an administrative area. */ locality: string; /** * Town Name * @description Geographical town name assigned by the Local Authority. Please note this can be different from the Post Town value assigned by Royal Mail. */ town_name: string; /** * Delivery Point Suffix * @description A two-character code uniquely identifying an individual delivery point within a postcode, assigned by Royal Mail. */ delivery_point_suffix: string; /** * Town Name * @description The town or city in which the Royal Mail sorting office is located which services this address record. * * Condition: * POST_TOWN is not populated if this is the same as TOWN_NAME. */ post_town: string; /** * Governmental Statistical Service * @description The Office for National Statistics Governmental Statistical Service (GSS) code representing the contributing Local Authority. */ gss_code: string; /** * Representative Point Code * @description Representative Point Code describes the accuracy of the coordinate that has been allocated to the UPRN as indicated by the Local Authority and enhanced using large scale OS data. */ rpc: number; /** * Last Update Date * Format: date * @description The latest date on which any of the attributes on this record were last changed. */ last_update_date: string; /** * Island * @description Third level of geographic area name to record island names where appropriate. */ island: string; /** * Change Code * @description This enumeration is used in association with the attribute “CHANGE_CODE”. This enumeration identifies the type of change that has been made to a feature. The change type must be set when a feature is inserted, updated or deleted. Please see section 3 for more information. Example I = Insert, U = Update, D = Delete * @enum {string} */ change_code: "I" | "U" | "D"; /** * Building Name * @description The building name is a description applied to a single address or a group of addresses. */ building_name: string; /** * Building Number * @description The building number is a number or range of numbers given to a single address or a group of addresses. */ building_number: string; /** * Sub-building * @description The sub-building name and/or number for the address record. */ sub_building: string; /** * Postcode * @description A postcode assigned by Royal Mail for the address record. */ postcode: string; /** * PO Box * @description Text concatenation of 'PO BOX' and the Post Office Box (PO Box) number or 'BFPO' and the British Forces Post Office number. */ po_box: string; /** * Organisation * @description The organisation name is the business name given, when appropriate, to an address record. */ organisation: string; country: components["schemas"]["paf_country"]; country_iso: components["schemas"]["paf_country_iso"]; county: components["schemas"]["paf_county"]; district: components["schemas"]["paf_district"]; ward: components["schemas"]["paf_ward"]; traditional_county: components["schemas"]["paf_traditional_county"]; administrative_county: components["schemas"]["paf_administrative_county"]; postal_county: components["schemas"]["paf_postal_county"]; }; /** * AddressBase Core * @description Address from Ordnance Survey AddressBase Core dataset. * * Please contact us to have this enabled on your account. * * All AddressBase Core address have a UPRN and a rooftop geolocation available however they may not have a UDPRN. */ AbAddress: components["schemas"]["PafBase"] & { /** @enum {undefined} */ country_iso?: "GBR"; /** @enum {string} */ dataset?: "ab"; /** @enum {undefined} */ country_iso_2?: "GB"; /** @enum {undefined} */ language?: "en"; /** * Postcode Type * @enum {string} */ postcode_type?: ""; /** @enum {undefined} */ country?: "England" | "Scotland" | "Wales"; native: components["schemas"]["AddressBaseCore"]; }; /** * Dataset * @description Indicates the provenance of an address. * * - `paf` (GBR) Postcode Address File * - `usps` (USA) USPS Zip+4 * - `mr` (GBR) Multiple Residence File * - `nyb` (GBR) Not Yet Built File * - `pafa` (GBR) Alias File * - `pafw` (GBR) Welsh File * - `ab` (GBR) AddressBase Core * - `ecaf` (IRL) Eircode ECAF * - `ecad` (IRL) Eircode ECAD * - `herewe` (Western Europe) Western Europe Dataset * - `heret` (Taiwan) Taiwan Dataset * - `heresa` (South America) South America Dataset * - `hereo` (Oceania) Oceania Dataset * - `herena` (North America) North America Dataset * - `herei` (India) India Dataset * - `heremea` (Middle East and Africa) Middle East and Africa Dataset * - `herem` (Macau) Macau Dataset * - `herehk` (Hong Kong) Hong Kong Dataset * - `hereee` (Eastern Europe) Eastern Europe Dataset * - `hereap` (Asia Pacific) Asia Pacific Dataset * - `gnaf` (AUS) Geoscape Geocoded National Address File * - `kadaster` (NLD) Kadaster BAG 2.0 Address File * - `kartverket` (NOR) Norway Dataset * - `sdfi` (DNK) Denmark Dataset * - `cannar` (CAN) Canada National Address Register Dataset * @enum {string} */ Dataset: | "paf" | "pafw" | "pafa" | "mr" | "nyb" | "usps" | "ecaf" | "ecad" | "ab" | "herewe" | "heret" | "heresa" | "hereo" | "herena" | "heremeas" | "heremea" | "herem" | "herei" | "herehk" | "hereee" | "hereap" | "gnaf" | "kadaster" | "kartverket" | "sdfi" | "cannar"; /** * ISO Country Code (3) * @description 3 letter country code (ISO 3166-1) * * @enum {string} */ CountryISO: | "GBR" | "IMN" | "JEY" | "GGY" | "USA" | "PRI" | "GUM" | "IRL" | "VAT" | "FRA" | "GRL" | "NLD" | "LUX" | "AUT" | "GIB" | "LIE" | "FIN" | "UNI" | "ISL" | "CHE" | "PRT" | "BEL" | "MCO" | "ITA" | "FRO" | "NOR" | "DNK" | "SMR" | "MLT" | "AND" | "SWE" | "DEU" | "ESP" | "SJM" | "BRN" | "IDN" | "KHM" | "MMR" | "MYS" | "PHL" | "SGP" | "THA" | "TLS" | "VNM" | "ALB" | "ARM" | "AZE" | "BGR" | "BIH" | "BLR" | "CYP" | "CZE" | "EST" | "GEO" | "GRC" | "HRV" | "HUN" | "KAZ" | "KGZ" | "KOS" | "LTU" | "LVA" | "MDA" | "MKD" | "MNE" | "POL" | "ROU" | "RUS" | "SRB" | "SVK" | "SVN" | "TUR" | "UKR" | "UZB" | "HKG" | "BGD" | "IND" | "LKA" | "MAC" | "AGO" | "ARE" | "BFA" | "BHR" | "BWA" | "CMR" | "EGY" | "GHA" | "ISR" | "JOR" | "KEN" | "KWT" | "LBN" | "LSO" | "MAR" | "MOZ" | "MUS" | "MYT" | "NAM" | "NGA" | "OMN" | "QAT" | "REU" | "SAU" | "SEN" | "SWZ" | "TUN" | "ZAF" | "ZMB" | "ZWE" | "BHS" | "BLZ" | "BMU" | "CAN" | "CRI" | "CYM" | "DOM" | "GTM" | "HND" | "HTI" | "JAM" | "MEX" | "NIC" | "PAN" | "SLV" | "VGB" | "AUS" | "CCK" | "CXR" | "FJI" | "NCL" | "NFK" | "NZL" | "PYF" | "TON" | "VUT" | "ABW" | "ARG" | "BLM" | "BOL" | "BRA" | "BRB" | "CHL" | "COL" | "CUW" | "DMA" | "ECU" | "GLP" | "GUF" | "GUY" | "MAF" | "MTQ" | "PER" | "PRY" | "SUR" | "TTO" | "URY" | "VEN" | "TWN" | "CHN" | "JPN" | "KOR" | "LAO" | "MNG" | "PNG" | "PRK" | "SLB" | "TJK" | "TKM" | "BTN" | "IOT" | "LKA" | "MDV" | "NPL" | "PAK" | "AFG" | "BDI" | "BEN" | "CAF" | "CIV" | "COD" | "COG" | "COM" | "CPV" | "DJI" | "DZA" | "ERI" | "ESH" | "ETH" | "GAB" | "GIN" | "GMB" | "GNB" | "GNQ" | "IRN" | "IRQ" | "LBR" | "LBY" | "MDG" | "MLI" | "MRT" | "MWI" | "NER" | "RWA" | "SHN" | "SLE" | "SOM" | "SSD" | "STP" | "SYC" | "TCD" | "TGO" | "TZA" | "UGA" | "SDN" | "SYR" | "YEM" | "CUB" | "SPM" | "TCA" | "COK" | "KIR" | "NIU" | "NRU" | "PCN" | "TKL" | "TUV" | "WLF" | "WSM" | "AIA" | "ATG" | "BES" | "FLK" | "GRD" | "KNA" | "LCA" | "MSR" | "SGS" | "SXM" | "VCT" | "ASM" | "FSM" | "MHL" | "MNP" | "PLW" | "VIR"; /** * ISO Country Code (2) * @description 2 letter country code (ISO 3166-1) * * @enum {string} */ CountryISO2: | "GB" | "IM" | "JE" | "GG" | "US" | "PR" | "GU" | "IE" | "VA" | "FR" | "GL" | "NL" | "LU" | "AT" | "GI" | "LI" | "FI" | "GB" | "IS" | "CH" | "PT" | "BE" | "MC" | "IT" | "FO" | "NO" | "DK" | "SM" | "MT" | "AD" | "SE" | "DE" | "ES" | "SJ" | "BS" | "BZ" | "BM" | "CA" | "CR" | "KY" | "DO" | "GT" | "HN" | "HT" | "JM" | "MX" | "NI" | "PA" | "SV" | "VG" | "AU" | "CC" | "CX" | "FJ" | "NC" | "NF" | "NZ" | "PF" | "TO" | "VU" | "AW" | "AR" | "BL" | "BO" | "BR" | "BB" | "CL" | "CO" | "CW" | "DM" | "EC" | "GP" | "GD" | "GF" | "GY" | "MF" | "MQ" | "PE" | "PY" | "SR" | "TT" | "UY" | "VE" | "TW" | "BN" | "ID" | "KH" | "MM" | "MY" | "PH" | "SG" | "TH" | "TL" | "VN" | "AL" | "AM" | "AZ" | "BG" | "BA" | "BY" | "CY" | "CZ" | "EE" | "GE" | "GR" | "HR" | "HU" | "KZ" | "KG" | "XK" | "LT" | "LV" | "MD" | "MK" | "ME" | "PL" | "RO" | "RU" | "RS" | "SK" | "SI" | "TR" | "UA" | "UZ" | "HK" | "BD" | "IN" | "LK" | "MO" | "AO" | "AE" | "BF" | "BH" | "BW" | "CM" | "EG" | "GH" | "IL" | "JO" | "KE" | "KW" | "LB" | "LS" | "MA" | "MZ" | "MU" | "YT" | "NA" | "NG" | "OM" | "QA" | "RE" | "SA" | "SN" | "SZ" | "TN" | "ZA" | "ZM" | "ZW" | "CN" | "JP" | "KR" | "LA" | "MN" | "PG" | "KP" | "SB" | "TJ" | "TM" | "BT" | "IO" | "LK" | "MV" | "NP" | "PK" | "AF" | "BI" | "BJ" | "CF" | "CI" | "CD" | "CG" | "KM" | "CV" | "DJ" | "DZ" | "ER" | "EH" | "ET" | "GA" | "GN" | "GM" | "GW" | "GQ" | "IR" | "IQ" | "LR" | "LY" | "MG" | "ML" | "MR" | "MW" | "NE" | "RW" | "SH" | "SL" | "SO" | "SS" | "ST" | "SC" | "TD" | "TG" | "TZ" | "UG" | "SD" | "SY" | "YE" | "CU" | "PM" | "TC" | "CK" | "KI" | "NU" | "NR" | "PN" | "TK" | "TV" | "WF" | "WS" | "AI" | "AG" | "BQ" | "FK" | "KN" | "LC" | "MS" | "GS" | "SX" | "VC" | "AS" | "FM" | "MH" | "MP" | "PW" | "VI"; /** * Country * @description Full country names (ISO 3166) * * @enum {string} */ Country: | "United Kingdom" | "England" | "Scotland" | "Wales" | "Northern Ireland" | "Isle of Man" | "Jersey" | "Guernsey" | "Guam" | "United States" | "Puerto Rico" | "Ireland" | "Vatican City" | "France" | "Greenland" | "Netherlands" | "Luxembourg" | "Austria" | "Gibraltar" | "Liechtenstein" | "Finland" | "United Kingdom" | "Iceland" | "Switzerland" | "Portugal" | "Belgium" | "Monaco" | "Italy" | "Faroe Islands" | "Norway" | "Denmark" | "San Marino" | "Malta" | "Andorra" | "Sweden" | "Germany" | "Spain" | "Svalbard and Jan Mayen" | "Bahamas" | "Belize" | "Bermuda" | "Canada" | "Costa Rica" | "Cayman Islands" | "Dominican Republic" | "Guatemala" | "Honduras" | "Haiti" | "Jamaica" | "Mexico" | "Nicaragua" | "Panama" | "El Salvador" | "British Virgin Islands" | "Australia" | "Cocos (Keeling) Islands" | "Christmas Island" | "Fiji" | "New Caledonia" | "Norfolk Island" | "New Zealand" | "French Polynesia" | "Tonga" | "Vanuatu" | "Aruba" | "Argentina" | "Saint Barthélemy" | "Bolivia" | "Brazil" | "Barbados" | "Chile" | "Colombia" | "Curaçao" | "Dominica" | "Ecuador" | "Guadeloupe" | "Grenada" | "French Guiana" | "Guyana" | "Saint Martin (French part)" | "Martinique" | "Peru" | "Paraguay" | "Suriname" | "Trinidad and Tobago" | "Uruguay" | "Venezuela" | "Taiwan" | "Brunei Darussalam" | "Indonesia" | "Cambodia" | "Myanmar" | "Malaysia" | "Philippines" | "Singapore" | "Thailand" | "Timor-Leste" | "Vietnam" | "Albania" | "Armenia" | "Azerbaijan" | "Bulgaria" | "Bosnia and Herzegovina" | "Belarus" | "Cyprus" | "Czech Republic" | "Estonia" | "Georgia" | "Greece" | "Croatia" | "Hungary" | "Kazakhstan" | "Kyrgyzstan" | "Kosovo" | "Lithuania" | "Latvia" | "Moldova" | "North Macedonia" | "Montenegro" | "Poland" | "Romania" | "Russia" | "Serbia" | "Slovakia" | "Slovenia" | "Turkey" | "Ukraine" | "Uzbekistan" | "Hong Kong" | "Bangladesh" | "India" | "Sri Lanka" | "Macau" | "Angola" | "United Arab Emirates" | "Burkina Faso" | "Bahrain" | "Botswana" | "Cameroon" | "Egypt" | "Ghana" | "Israel" | "Jordan" | "Kenya" | "Kuwait" | "Lebanon" | "Lesotho" | "Morocco" | "Mozambique" | "Mauritius" | "Mayotte" | "Namibia" | "Nigeria" | "Oman" | "Qatar" | "Réunion" | "Saudi Arabia" | "Senegal" | "Eswatini" | "Tunisia" | "South Africa" | "Zambia" | "Zimbabwe" | "China" | "Japan" | "South Korea" | "Laos" | "Mongolia" | "Papua New Guinea" | "North Korea" | "Solomon Islands" | "Tajikistan" | "Turkmenistan" | "Bhutan" | "British Indian Ocean Territory" | "Sri Lanka" | "Maldives" | "Nepal" | "Pakistan" | "Afghanistan" | "Burundi" | "Benin" | "Central African Republic" | "Côte d'Ivoire" | "Democratic Republic of the Congo" | "Republic of the Congo" | "Comoros" | "Cape Verde" | "Djibouti" | "Algeria" | "Eritrea" | "Western Sahara" | "Ethiopia" | "Gabon" | "Guinea" | "Gambia" | "Guinea-Bissau" | "Equatorial Guinea" | "Iran" | "Iraq" | "Liberia" | "Libya" | "Madagascar" | "Mali" | "Mauritania" | "Malawi" | "Niger" | "Rwanda" | "Saint Helena" | "Sierra Leone" | "Somalia" | "South Sudan" | "São Tomé and Príncipe" | "Seychelles" | "Chad" | "Togo" | "Tanzania" | "Uganda" | "Sudan" | "Syria" | "Yemen" | "Cuba" | "Saint Pierre and Miquelon" | "Turks and Caicos Islands" | "Cook Islands" | "Kiribati" | "Niue" | "Nauru" | "Pitcairn Islands" | "Tokelau" | "Tuvalu" | "Vanuatu" | "Wallis and Futuna" | "Samoa" | "Anguilla" | "Antigua and Barbuda" | "Bonaire, Sint Eustatius and Saba" | "Falkland Islands (Malvinas)" | "Saint Kitts and Nevis" | "Saint Lucia" | "Montserrat" | "South Georgia and the South Sandwich Islands" | "Sint Maarten (Dutch part)" | "Saint Vincent and the Grenadines" | "American Samoa" | "Federated States of Micronesia" | "Marshall Islands" | "Northern Mariana Islands" | "Palau" | "United States Virgin Islands"; EircBase: { id: components["schemas"]["ID"]; /** @description Source of address */ dataset: string; /** * @description 3 letter country code (ISO 3166-1) * * @enum {undefined} */ country_iso: "IRL"; /** * @description 2 letter country code (ISO 3166-1) * * @enum {string} */ country_iso_2: "IE"; /** * @description Full country names (ISO 3166) * * @enum {string} */ country: "Ireland"; /** * @description Language represented by 2 letter ISO Code (639-1) * * @enum {undefined} */ language: "en" | "ga"; /** @description Address Line 1 */ line_1: string; /** @description Address Line 2 */ line_2: string; /** @description Address Line 3 */ line_3: string; /** @description Address Line 4 */ line_4: string; /** @description Address Line 5 */ line_5: string; /** @description Address Line 6 */ line_6: string; /** @description Address Line 7 */ line_7: string; /** @description Address Line 8 */ line_8: string; /** @description Address Line 9 */ line_9: string; /** * @description The department or division within an organisation. If the department element exists, then the organisation must also exist. * @example Accounts Department */ department: string; /** * @description Organisation name * @example Oak Tree Limited */ organisation: string; /** * @description The sub-building refers to an apartment, flat or unit within a building. * @example Flat 1 */ sub_building_name: string; /** * @description The name given to the building. Prepended by sub building, if any, when the sub building does not appear on a line to itself. The building name is omitted if it is the same as either the Organisation or Building Group. * @example Rose Cottage */ building_name: string; /** * @description A number associated with the whole building. The building number may have a numeric and an alphanumeric component, which are concatenated e.g. 2A, or alternatively will have a simple building number or a complex building number. The building number always relates to the whole building and not a sub-unit within it. * A complex building number may be one of the following: * - Dual. Two number separated by '/' e.g. 63/64 = 63, 64 * - Sequence. An odd or even sequence of numbers with lower and upper bound separated by an underscore '_' e.g. `1_5` = 1,3,5 and `2_6` = 2,4,6 * - Range. A range of consecutive numbers with lower and upper bound separated by a dash '-' e.g. `63-66` = 63, 64, 56, 66 * The building number never appears on a line by itself and can prepend Building Group, Primary Thoroughfare or Primary Locality. * @example 22 */ building_number: string; /** * @description A building group is a collection of buildings with a collective name, located on or near the same thoroughfare. * @example Marrian Terrace */ building_group: string; /** * @description The name of the thoroughfare on which premises are located. It may appear on a line by itself or be appended to either a sub building or building number. * * Addresses with thoroughfares can sometimes have the thoroughfare excluded where a Building Group exists, such as a Retail Centre or Business Park, and the thoroughfare is not part of the Postal Address. * @example Griffith Road */ primary_thoroughfare: string; /** * @description It is never present without a primary thoroughfare. The primary thoroughfare is dependent on the secondary thoroughfare and appears before the secondary thoroughfare in any address. * * Secondary thoroughfare are generally used to assist locating a primary thoroughfare. * @example Navan Road */ secondary_thoroughfare: string; /** * @description First locality elements which can refer to areas, districts, industrial estates, towns, etc. * * The primary locality refers to the specific place the address is. * * In urban areas, the primary locality can be required to distinguish between two thoroughfares of the same name in the same district or town. Industrial estates with named thoroughfares are also held as localities. In rural areas the primary locality is generally a townland name. * @example Cookstown Industrial Estate */ primary_locality: string; /** * @description Never present without a primary locality. The secondary locality has a wider geographic scope than the primary locality. * * It is the secondary locality therefore which differentiates addresses with the same primary locality name within the same county. * * Secondary localities are more likely to be required for rural addresses. * * Second locality elements which can refer to areas, districts, industrial estates, towns, etc * * The secondary locality helps identify where the primary locality is located. * @example Manorhamilton */ secondary_locality: string; /** * @description Also known as the Post Town. * * The name of the post town associated with the premises for postal delivery purposes. This includes Dublin Postal Districts "Dublin 1" to "Dublin 24". * * The post town is a significant element of the Postal Address, however it is not always populated in an address. The official post office guide, Eolaí an Phoist4, describes post towns in the following manner: * * "A provincial postal address may include the name of a town or village several miles distant, with which the addressee has little or no connection, and, in some places, especially if this residence happens to be near a county boundary, the name of the neighbouring county instead of the county in which he actually resides. The explanation is that the main mail despatches have to be sent for more detailed sub division to certain centres known as POST TOWNS, chosen because of their accessibility and convenience." * @example Dublin 14 */ tertiary_locality: string; /** * @description One of the 26 Counties in the Republic of Ireland. These counties are sub-national divisions used for the purposes of administrative, geographical and political demarcation. Post County is the County associated with the Post Town, not the geographic county in which the building is located. The Post County is normally used as part of the Postal Address with some exceptions e.g. Dublin Postal Districts where the Post County is not used and some Post Towns (e.g. Tipperary, Kildare, etc.) that have the same name as the Post County. * @example Cork */ post_county: string; /** * @description The seven character Eircode has an A65 F4E2 format. The Eircode is a mandatory address element. The last line of a Postal Address will contain the Eircode, displayed with a space. e.g. `A65 F4E2`. * * The Eircode is always the last line of a Postal Address generated within the state, e.g. if an address has four lines then the Eircode will be on its own on Address Line 5. For inbound international mail the country name IRELAND should be appended as the last line of the Postal Address. * @example A65 R2AF */ eircode: string; /** @description The address reference is the An Post GeoDirectory address reference identifier used by the Universal Service Provider. */ address_reference: string; longitude: components["schemas"]["Longitude"]; latitude: components["schemas"]["Latitude"]; }; /** * Ireland ECAD Address * @description The ECAD contains additional data for each ECAF address. */ EcadAddress: components["schemas"]["EircBase"] & { /** @enum {string} */ dataset?: "ecad"; /** * @description Unique 10 digit ECAD ID * @example 17000000 */ ecad_id?: string; /** * @description Organisation ID * @example 10098783 */ organisation_id?: string; /** * @description Address Point ID * @example 10098783 */ address_point_id?: string; /** * @description Building ID * @example 10098783 */ building_id?: string; /** * @description Building Group ID * @example 10098783 */ building_group_id?: string; /** * @description Primary Thoroughfare ID * @example 10098783 */ primary_thoroughfare_id?: string; /** * @description Secondary Thoroughfare ID * @example 10098783 */ secondary_thoroughfare_id?: string; /** * @description Primary Locality ID * @example 10098783 */ primary_locality_id?: string; /** * @description Secondary Locality ID * @example 10098783 */ secondary_locality_id?: string; /** * @description The post town is a significant element of the Postal Address, however it is not always populated in an address. The official post office guide, Eolaí an Phoist1, describes post towns in the following manner: * * "A provincial postal address may include the name of a town or village several miles distant, with which the addressee has little or no connection, and, in some places, especially if this residence happens to be near a county boundary, the name of the neighbouring county instead of the county in which he actually resides. The explanation is that the main mail despatches have to be sent for more detailed sub division to certain centres known as post towns, chosen because of their accessibility and convenience." */ post_town?: string; /** * @description Post Town ID * @example 10098783 */ post_town_id?: string; /** * @description Post County ID * @example 10098783 */ post_county_id?: string; /** * @description NUA means "non-unique address". * * The NUA field contains `true` when the address is a non-unique address, and `false` when it is a unique address. * * Ireland has a very high level of non-unique addresses (NUA), i.e. the address does not contain a unique building number or name. Approximately 35% of all Irish addresses are non-unique which equates to 600,000 addresses. * * The typical example of NUA addressing is where every address in a townland is the same. The way that post is delivered is by local knowledge of postal delivery personnel of which addressee lives in which house. * * N.B. For a NUA address, it is impossible to match to a unique record in the ECAD and assign an Eircode. */ nua?: boolean; /** * @description Gaeltact refers to a district where the Irish government recognises that the Irish language is the predominant language. * * Returns `true` if address is in a Gaeltacht area and `false` if not. */ gaeltacht?: boolean; /** * @description Addresses points can assume one of the following values: * * - Residential Address Point. This type of address point has one residential addresses associated with it. * - Non-Residential Address Point. This type of address point has one or more non-residential address (business, club or other organisation) associated with it. * - Mixed Address Point. This is a special case where the residential and non residential addresses in the building are essentially the same address. The typical example is a farm house on an active farm. It is important to note that this is a special case. In general a building with both residential and non-residential addresses (e.g. an apartment over a shop) will receive two address points, one commercial and one residential, and hence two Eircodes. * * Buildings can contain multiple address points of type Residential and/or Non-Residential. */ address_type?: string; /** * @description The building type can assume one of the following values: * * - Single Occupancy Residential Building. This type of building contains one residential address. * - Multi Occupancy Residential Building. This type of building contains multiple residential addresses. * - Single Occupancy Non-Residential Building. This type of building contains one non-residential address (business, club or other organisation). * - Multi Occupancy Non-Residential Building. This type of building contains multiple non-residential addresses (business, club or other organisation). * - Multi Occupancy Mixed Use Building. This type of building contains multiple residential and non- residential addresses. * * Buildings can also have a more specific address types such as a Hospital, School, Shopping Centre, etc. */ building_address_type?: string; /** * @description The building group type can be: * * - Residential Building Group. This type of building group contains buildings with residential addresses only. * - Non-Residential Building Group This type of building group contains buildings with non-residential addresses (business, club or other organisation) only. * - Mixed Building Group. This type of building group contains buildings with residential and non-residential addresses. Can also have a more specific address type such as a Hospital, School, Shopping Centre, etc. * * Building groups can also have a more specific address type such as a Hospital, School, Shopping Centre, etc. */ building_group_address_type?: string; /** * @description The locality type can be: * - Rural Locality. This is generally a townland. * - Industrial Estate. Industrial Estate, Industrial Park, Business Campus, etc. * - Shopping District. Shopping Centre. * - Housing Estate. Residential Housing Estate. * - Village. Based on Census 2011 population < 1,500. * - Town. Based on Census 2011 population > 1,500. * - Urban Area. Wholly within a village/town/city e.g. Rathmines. * - Suburban Locality. This is an area that is both rural and urban, as it is both a townland, and also an area name applied to houses in a town, as the town has extended partially into the townland. * * Where the locality is also the post town, the type can be: * - Village. Based on Census 2011 population < 1,500 * - Town. Based on Census 2011 population > 1,500 * - Postal District. Dublin 1 to 24 * - City. Dublin, Cork, Limerick, Galway or Waterford */ primary_locality_address_type?: string; /** * @description The locality type can be: * - Rural Locality. This is generally a townland. * - Industrial Estate. Industrial Estate, Industrial Park, Business Campus, etc. * - Shopping District. Shopping Centre. * - Housing Estate. Residential Housing Estate. * - Village. Based on Census 2011 population < 1,500. * - Town. Based on Census 2011 population > 1,500. * - Urban Area. Wholly within a village/town/city e.g. Rathmines. * - Suburban Locality. This is an area that is both rural and urban, as it is both a townland, and also an area name applied to houses in a town, as the town has extended partially into the townland. * * Where the locality is also the post town, the type can be: * - Village. Based on Census 2011 population < 1,500 * - Town. Based on Census 2011 population > 1,500 * - Postal District. Dublin 1 to 24 * - City. Dublin, Cork, Limerick, Galway or Waterford */ secondary_locality_address_type?: string; /** @description Describes the type of building, e.g. detached, semi-detached, bungalow. */ building_type?: string; /** * @description A Yes/No field, indicating whether or not the building is a holiday home. * @enum {undefined} */ holiday_home?: "N" | "Y" | ""; /** * @description A Yes/No field, indicating whether or not the building is under construction. * @enum {undefined} */ under_construction?: "N" | "Y" | ""; /** * @description Can be one of: * * - `R` Residential * - `C` Commercial * - `B` Both * - `U` Unknown * @enum {undefined} */ building_use?: "R" | "C" | "B" | "U"; /** * @description A Yes/No field, indicating whether the building is vacant. * @enum {undefined} */ vacant?: "Y" | "N" | ""; /** * @description A Yes/No field, indicating whether the organisation is vacant. * @enum {undefined} */ org_vacant?: "Y" | "N" | ""; /** @description The NACE Code for the Category. */ nace_code?: string; /** @description Name of the NACE Category */ nace_category?: string; /** @description Name of local authority */ local_authority?: string; /** * @description Unique Identifier for Electoral Divisions 2017 data. * * Note that this field is subject to breaking changes if a new generation of government data IDs is released. Currently this uses 2017 IDs. Contact us to be notified ahead of his change. */ ded_id?: string; /** * @description Unique Identifier for the Small Area 2017 data. * * Note that this field is subject to breaking changes if a new generation of government data IDs is released. Currently this uses 2017 IDs. Contact us to be notified ahead of his change. */ small_area_id?: string; /** * @description Unique Identifier for townland 2017 data. * * Note that this field is subject to breaking changes if a new generation of government data IDs is released. Currently this uses 2017 IDs. Contact us to be notified ahead of his change. */ townland_id?: string; /** * @description Unique Identifier for the 7 Gaeltacht areas 2017 data. * * Note that this field is subject to breaking changes if a new generation of government data IDs is released. Currently this uses 2017 IDs. Contact us to be notified ahead of his change. */ gaeltacht_id?: string; /** @description An Post sorting information. */ postaim_presort_61?: string; /** @description An Post sorting information. */ postaim_presort_152?: string; /** @description An Post publicity post zone information. */ publicity_post_zone?: string; } & { organisation_id: unknown; address_point_id: unknown; building_id: unknown; building_group_id: unknown; primary_thoroughfare_id: unknown; secondary_thoroughfare_id: unknown; primary_locality_id: unknown; secondary_locality_id: unknown; post_town: unknown; post_town_id: unknown; post_county_id: unknown; nua: unknown; gaeltacht: unknown; address_type: unknown; building_address_type: unknown; building_group_address_type: unknown; primary_locality_address_type: unknown; secondary_locality_address_type: unknown; building_type: unknown; holiday_home: unknown; under_construction: unknown; building_use: unknown; vacant: unknown; org_vacant: unknown; nace_code: unknown; nace_category: unknown; local_authority: unknown; ded_id: unknown; small_area_id: unknown; townland_id: unknown; gaeltacht_id: unknown; postaim_presort_61: unknown; postaim_presort_152: unknown; publicity_post_zone: unknown; }; /** * Ireland ECAF Address * @description ECAF is the Eircode Address File which contains one record for each Postal Address. English language and Irish language versions are available. It is distributed as a flat file, details of data provision and updates are provided in section 2. */ EcafAddress: components["schemas"]["EircBase"] & { /** @enum {string} */ dataset?: "ecaf"; /** @description The unique identifier in the ECAF is the `ecaf_id`. This unique identifier allows each address in the ECAF to be uniquely identified. It can also be used as index once the data has been imported into a relational database. This is a numeric field that can store values from 0 to 2,147,483,647. It is represented as a number up to 10 digits long. All other fields in ECAF are alphanumeric. */ ecaf_id?: string; } & { ecaf_id: unknown; }; /** * USA Dataset * @description Identifies the address as sourced from USPS * @enum {string} */ usps_dataset: "usps"; /** * Country * @description Full country names (ISO 3166) * * @enum {string} */ usps_country: | "American Samoa" | "Federated States of Micronesia" | "Guam" | "Marshall Islands" | "Northern Mariana Islands" | "Palau" | "Puerto Rico" | "United States" | "United States Virgin Islands"; /** * ISO Country Code (3) * @description 3 letter country code (ISO 3166-1) * * @enum {string} */ usps_country_iso: | "ASM" | "FSM" | "GUM" | "MHL" | "MNP" | "PLW" | "PRI" | "USA" | "VIR"; /** * ISO Country Code (2) * @description 2 letter country code (ISO 3166-1) * * @enum {string} */ usps_country_iso_2: | "AS" | "FM" | "GU" | "MH" | "MP" | "PR" | "PW" | "US" | "VI"; /** * Language * @description Language represented by 2 letter ISO Code (639-1) * * @enum {string} */ usps_language: "en"; /** * Primary Number * @description A house, rural route, contract box, or Post Office Box number. The numeric or alphanumeric component of an address preceding the street name. Often referred to as house number. * @example A298 */ primary_number: string; /** * Secondary Number * @description Number of the sub unit, apartment, suite etc * @example 123A */ secondary_number: string; /** * Plus 4 Code * @description 4 digit ZIP add-on code. * @example 1234 */ plus_4_code: string; /** * First Address Line * @description The primary delivery line (usually the street address) of the address. * @example 12 Armstrong Ct Apt 12 */ line_1: string; /** * Second Address Line * @description Secondary delivery line of the address. Typically populated if the first line is the firm or building name. * @example 9450 Pinecroft Dr */ line_2: string; /** * Last Line * @description Last line of the address comprising of city, state, zip code and zip+4 * @example Greenwich CT 06830-1234 */ last_line: string; /** * ZIP Code * @description A 5-digit code that identifies a specific geographic delivery area. ZIP Codes can represent an area within a state, or a single building or company that has a very high mail volume. * @example 1234 */ zip_code: string; /** * ZIP + 4 Code * @description Nine-digit code that identifies a small geographic delivery area that is serviceable by a single carrier; appears in the last line of the address on a mail piece. * @example 12345-6789 */ zip_plus_4_code: string; /** * Update Key Number * @description Field that contains a number that uniquely identifies a record; used to identify the base record to which an add or delete transaction is being directed. The Update Key Number field is used only when applying transactions to the base file; it is not used in address matching and remains fixed for the life of the record. The field is alphanumeric and consists of the database segment code (V1, V2, W1, W2, X1, X2, Y1, Y2, Z1, or Z2) and eight characters containing an alphanumeric value ranging from 00000001 to AAAAAAAA. * @example 00000001 */ update_key_number: string; /** * Record Type Code * @description An alphabetic value that identifies the type of data in the record. - G = General delivery (5-Digit ZIP, ZIP + 4, and Carrier Route products) - H = High-rise (ZIP + 4 only) - F = Firm (ZIP + 4 only) - S = Street (5-Digit ZIP, ZIP + 4, and Carrier Route products) - P = PO Box (5-Digit ZIP, ZIP + 4, and Carrier Route products) - R = Rural route/contract (5-Digit ZIP, ZIP + 4, and Carrier Route products) - M = Multi-carrier (Carrier Route product only) * @enum {string} */ record_type_code: "G" | "H" | "F" | "S" | "P" | "R" | "M" | ""; /** * Carrier Route ID * @description A 4 character ID identifying the postal route for the address. * The first character indicates the route type. Specifically: * - "B" indicates PO Box * - "H" indicates highway * - "C" indicates city * - "G" indicates general * - "R" indicates rural * @example R012 */ carrier_route_id: string; /** * Street Pre-Directional Abbreviation * @description A geographic direction that precedes the street name. */ street_pre_directional_abbreviation: string; /** * Street Name * @description The official name of a street as assigned by a local governing authority. The Street Name field contains only the street name and does not include directionals (EAST, WEST, etc.) or suffixes (ST, DR, BLVD, etc.). This element may also contain literals, such as PO BOX, GENERAL DELIVERY, USS, PSC, or UNIT. * @example GOSHEN */ street_name: string; /** * Street Suffix Abbreviation * @description Code that is the standard USPS abbreviation for the trailing designator in a street address. * @example ST */ street_suffix_abbreviation: string; /** * Street Post Directional Abbreviation * @description A geographic direction that follows the street name. */ street_post_directional_abbreviation: string; /** * Building or Firm Name * @description The name of a company, building, apartment complex, shopping center, or other distinguishing secondary address information. * This field is normally used with firm and highrise records but may also contain literals such as “Postmaster” or “United States Postal Service.” * @example POSTMASTER */ building_or_firm_name: string; /** * Address Secondary Abbreviation * @description A descriptive code used to identify the type of address secondary range information in the Address Secondary Range field. * This code may be useful in address matching, e.g., the secondary address numbers may indicate apartment, suite, or trailer numbers. */ address_secondary_abbreviation: string; /** * Base Alternate Code * @description Code that specifies whether a record is a base (preferred) or alternate record. * Base records (represented as "B") can represent a range of addresses or an individual address, such as a firm record, while alternate records (represented as "A") are individual delivery points. Base records are generally preferred over alternate records. * Government deliveries will only be listed on alternate records with the appropriate government building indicator (federal, state, or city) set. * @enum {string} */ base_alternate_code: "A" | "B" | ""; /** * LACS Status Indicator * @description The Locatable Address Conversion Service (LACS) indicator describes records that have been converted to the LACS system (a product/system in a different USPS® product line that allows mailers to identify and convert a rural route address to a city-style address). Rural route and some city addresses are being modified to city-style addresses so that emergency services (e.g., ambulances, police) can find these addresses more efficiently. * - L = LACS address: The old (usually rural-route) address that has been converted for the LACS system. * - Blank = Not applicable * @enum {string} */ lacs_status_indicator: "" | "L"; /** * Government Building Indicator * @description An alphabetic value that identifies the type of government agency at the delivery point and/or whether a firm is the only delivery at an address. For this purpose, "address" is defined as the complete delivery line (e.g., complete street address and, if included as part of the firm record, the secondary abbreviation and/or address secondary number). * - A = City government building—alternates only * - B = Federal government building—alternates only * - C = State government building—alternates only * - D = Firm only—base and alternates * - E = City government building and firm only—alternates only * - F = Federal government building and firm only—alternates only * - G = State government building and firm only—alternates only * @enum {string} */ government_building_indicator: "" | "A" | "B" | "C" | "D" | "E" | "F" | "G"; /** * State Abbreviation * @description A 2-character abbreviation for the name of a state, U.S. territory, or armed forces ZIP Code designation. If APO/FPO/DPO, then the state abbreviation will be “AA,” “AE,” or “AP.” * @example NY */ state_abbreviation: string; /** * State * @description Full name of a state, U.S. territory, or armed forces ZIP Code designation. * @example New York */ state: string; /** * Municipality City State Key * @description Municipality City State Key. Currently blank. */ municipality_city_state_key: string; /** * Urbanization City State Key * @description An index to the City State file that provides the urbanization name for this delivery range. * @example V18475 */ urbanization_city_state_key: string; /** * Preferred Last Line City State Key * @description In the Carrier Route, Five-Digit ZIP Code, Delivery Statistics, and ZIP + 4 products, an index to the City State product record that provides the preferred last-line name for this address range. In the City State product, the preferred last line city/state key contains the key value of a City State product record that has the default preferred or alternate preferred last-line key for a given ZIP Code. * @example V13916 */ preferred_last_line_city_state_key: string; /** * County Name * @description The name of the county or parish in which the 5-digit ZIP Code resides. If APO/FPO/DPO, then the county name will be blank. * @example Suffolk */ county: string; /** * City Name * @description A valid city name for mailing purposes; appears in the last line of an address on a mail piece. * @example HOLTSVILLE */ city: string; /** * City State Name Abbreviation * @description A standard 13-character abbreviation for a city/state name. This field is only used for names that are greater than 13 characters in length and have a city/state mailing name indicator of "Y." If the field is longer than 13 characters and the city/state mailing name indicator is "N," the field will be blank. * @example W TOWNSHEND */ city_abbreviation: string; /** * Preferred Last Line City State Name * @description Field that contains the default preferred or alternate preferred last-line name for a ZIP Code. * @example AGUADA */ preferred_city: string; /** * City State Name Facility Code * @description The type of locale identified in the city/state name. The facility may be a USPS facility, such as a post office, station, or branch, or it may be a non-postal place name. City/state name facility codes include the following: * - B = Branch * - C = Community post office (CPO) * - N = Non-postal community name, former USPS facility, or place name * - P = Post Office * - S = Station * - U = Urbanization * @enum {string} */ city_state_name_facility_code: "B" | "C" | "N" | "P" | "S" | "U" | "Y" | ""; /** * ZIP Classification Code * @description A field that describes the type of ZIP area that a 5-digit ZIP Code serves, e.g., a single educational institution, post office boxes only, or a single address that has unusually high mail volume or many different addresses. * - M = Military ZIP Code * - P = ZIP Code having only Post Office Boxes * - U = Unique ZIP Code (ZIP assigned to a single organization) * - Blank = Standard ZIP with many addresses assigned to it * @enum {string} */ zip_classification_code: "" | "M" | "P" | "U"; /** * City State Mailing Name Indicator * @description Specifies whether or not the city state name can be used as a last line of address on a mail piece. * - "Y = City/state name is a USPS-approved mailing name." * - "N = City/state name is not approved for mailing purposes." */ city_state_mailing_name_indicator: string; /** * Carrier Route Rate Sortation and Merged 5-Digit Indicator * @description Identifies where automation Carrier Route rates are available and where the commingling of automation and non-automation mail, including Enhanced Carrier Routes and 5-digit presort, on the same pallet or in the same container is allowed. */ carrier_route_rate_sortation: string; /** * Finance Number * @description A code assigned to Postal Service facilities (primarily Post Offices) to collect cost and statistical data and compile revenue and expense data. */ finance_number: string | number; /** * Congressional District Number * @description A standard value identifying a geographic area within the United States served by a member of the U.S. House of Representatives. If Army/Air Force (APO), Fleet Post Office (FPO), or Diplomatic/Defense Post Office (DPO), this field will be blank. If there is only one member of Congress within a state, the code will be "AL" (at large). */ congressional_district_number: string | number; /** * County Number * @description The Federal Information Processing Standard (FIPS) code assigned to a given county or parish within a state. In Alaska, it identifies a region within the state. If APO/FPO/DPO, and the record type is “S,” “H,” or “F,” the county number will be blank. */ county_number: string | number; /** * United States Postal Service Address * @description Standard USA Address */ UspsAddress: { id: components["schemas"]["ID"]; dataset: components["schemas"]["usps_dataset"]; country: components["schemas"]["usps_country"]; country_iso: components["schemas"]["usps_country_iso"]; country_iso_2: components["schemas"]["usps_country_iso_2"]; language: components["schemas"]["usps_language"]; primary_number: components["schemas"]["primary_number"]; secondary_number: components["schemas"]["secondary_number"]; plus_4_code: components["schemas"]["plus_4_code"]; line_1: components["schemas"]["line_1"]; line_2: components["schemas"]["line_2"]; last_line: components["schemas"]["last_line"]; zip_code: components["schemas"]["zip_code"]; zip_plus_4_code: components["schemas"]["zip_plus_4_code"]; update_key_number: components["schemas"]["update_key_number"]; record_type_code: components["schemas"]["record_type_code"]; carrier_route_id: components["schemas"]["carrier_route_id"]; street_pre_directional_abbreviation: components["schemas"]["street_pre_directional_abbreviation"]; street_name: components["schemas"]["street_name"]; street_suffix_abbreviation: components["schemas"]["street_suffix_abbreviation"]; street_post_directional_abbreviation: components["schemas"]["street_post_directional_abbreviation"]; building_or_firm_name: components["schemas"]["building_or_firm_name"]; address_secondary_abbreviation: components["schemas"]["address_secondary_abbreviation"]; base_alternate_code: components["schemas"]["base_alternate_code"]; lacs_status_indicator: components["schemas"]["lacs_status_indicator"]; government_building_indicator: components["schemas"]["government_building_indicator"]; state_abbreviation: components["schemas"]["state_abbreviation"]; state: components["schemas"]["state"]; municipality_city_state_key: components["schemas"]["municipality_city_state_key"]; urbanization_city_state_key: components["schemas"]["urbanization_city_state_key"]; preferred_last_line_city_state_key: components["schemas"]["preferred_last_line_city_state_key"]; county: components["schemas"]["county"]; city: components["schemas"]["city"]; city_abbreviation: components["schemas"]["city_abbreviation"]; preferred_city: components["schemas"]["preferred_city"]; city_state_name_facility_code: components["schemas"]["city_state_name_facility_code"]; zip_classification_code: components["schemas"]["zip_classification_code"]; city_state_mailing_name_indicator: components["schemas"]["city_state_mailing_name_indicator"]; carrier_route_rate_sortation: components["schemas"]["carrier_route_rate_sortation"]; finance_number: components["schemas"]["finance_number"]; congressional_district_number: components["schemas"]["congressional_district_number"]; county_number: components["schemas"]["county_number"]; }; /** * HERE Address * @description Address from the global HERE dataset */ HereAddress: { id: components["schemas"]["ID"]; /** * @description Three character country code based on ISO Standard 3166. * * Can be empty string `""` if not present. * @example ITA */ country_iso: string; /** @enum {string} */ dataset: | "herewe" | "heret" | "heresa" | "hereo" | "herena" | "heremeas" | "heremea" | "herem" | "herei" | "herehk" | "hereee" | "hereap"; /** * @description Language Code of Address and Building Name for the Point Address. * @example it */ language: string; /** * @description First address line. * * Can be empty string `""` if not present. * * @example 16 Via Giuseppe Garibaldi */ line_1: string; /** * @description Second address line. * * Can be empty string `""` if not present. * * @example */ line_2: string; /** * @description Third address line. * * Can be empty string `""` if not present. * * @example */ line_3: string; /** * @description Fourth address line. * * Can be empty string `""` if not present. * * @example */ line_4: string; /** * @description Fifth address line. * * Can be empty string `""` if not present. * * @example */ line_5: string; /** * @description Address / House Number uniquely identifying the address along the specified road link. * * Can be empty string `""` if not present. * * @example 16 */ address: string; /** * @description Address Type defines the type of address represented by the Point Address (e.g., Base, Commercial). * * Can be empty string `""` if not present. * * @example 1 */ address_type?: string; delivery_latitude: string | number; delivery_longitude: string | number; /** * @description Name of the Building to which the Point Address is associated. * * Can be empty string `""` if not present. * * @example */ building_name: string; latitude: string | number; longitude: string | number; /** * @description The full spelling of the street name, including Prefix, Base Name, Suffix, Street Type, and Direction on Sign. * @example Via Giuseppe Garibaldi */ street_name: string; /** * @description Full postal code; could be numeric or alphanumeric postal code. * * Can be empty string `""` if not present. * @example 35020 */ postal_code: string; /** * @description Identifies the highest administrative level in which a country can be subdivided. * @example Veneto */ order1_name: string; /** * @description Identifies an intermediate administrative level of a country and is a sub-division of an Order-1 area. Only countries with a five (or more) level administrative hierarchy have Order-2 administrative levels defined. This feature can be used for destination selection and map display. * @example Padova */ order2_name: string; /** * @description Identifies the lowest level of the country's administrative hierarchy that is present country- wide. (No gaps exist in the coverage.) * @example Brugine */ order8_name: string; /** * @description Identifies the lowest administrative level for a country. This level does not cover the entire country, (as opposed to the Order-8 Area level which does cover the entire country). This feature should be used in conjunction with Zone and Order-8 Area for destination selection. The Built-up Area polygon, as published in RDF_CARTO, can also be used for map display. * @example */ builtup_name: string; }; GnafAddress: { id: components["schemas"]["ID"]; /** @enum {string} */ dataset: "gnaf"; /** * @description 3 letter country code (ISO 3166-1) * * @enum {undefined} */ country_iso: "AUS" | "CCK" | "CXR" | "NFK"; /** * @description 2 letter country code (ISO 3166-1) * * @enum {string} */ country_iso_2: "AU" | "CC" | "CX" | "NF"; /** * @description Full country names (ISO 3166) * * @enum {string} */ country: | "Australia" | "Cocos (Keeling) Islands" | "Christmas Island" | "Norfolk Island"; /** * @description First address line. * * Can be empty string `""` if not present. * * @example 30 Hampton Cct */ line_1: string; /** * @description Second address line. * * Can be empty string `""` if not present. * * @example */ line_2: string; /** * @description Language represented by 2 letter ISO Code (639-1) * * @enum {undefined} */ language: "en"; /** * @description Address / House Number uniquely identifying the address along the specified street. * * Can be empty string `""` if not present. * * @example 16 */ address: string; longitude: components["schemas"]["Longitude"]; latitude: components["schemas"]["Latitude"]; /** @description The Persistent Identifier is unique to the real world feature this record represents. */ address_detail_pid: string; /** * Format: date * @description Date this record was created. */ date_created: string; /** * Format: date * @description Date this record was last modified (not retired/recreated in line with ICSM standard). */ date_last_modified: string; /** * Format: date * @description Date this record was retired. */ date_retired: string; /** @description Combines both building/property name fields. Field length: up to 200 alphanumeric characters (AS4590:2006 5.7). */ building_name: string; /** @description Lot number prefix. Field length: up to two alphanumeric characters (AS4590:2006 5.8.1). */ lot_number_prefix: string; /** @description Lot number. Field length: up to five alphanumeric characters (AS4590:2006 5.8.1). */ lot_number: string; /** @description Lot number suffix. Field length: up to two alphanumeric characters (AS4590:2006 5.8.1). */ lot_number_suffix: string; /** @description Specification of the type of a separately identifiable portion within a building/complex. Field Length: up to seven upper case alpha characters (AS4590:2006 5.5.1.1). */ flat_type_code: string; /** @description Level number prefix. Field length: up to two alphanumeric characters (AS4590:2006 5.5.2.2). */ flat_number_prefix: string; flat_number: string | number; /** @description Flat/unit number suffix Field length: up to two alphanumeric characters (AS4590:2006 5.5.1.2). */ flat_number_suffix: string; /** @description Level type. Field length: up to four alphanumeric characters (AS4590:2006 5.5.2.1). */ level_type_code: string; /** @description Level number prefix. Field length: up to two alphanumeric characters (AS4590:2006 5.5.2.2). */ level_number_prefix: string; level_number: string | number; /** @description Level number suffix. Field length: up to two alphanumeric characters (AS4590:2006 5.5.2.2). */ level_number_suffix: string; /** @description Prefix for the first (or only) number in range. Field length: up to three uppercase alphanumeric characters (AS4590:2006 5.5.3.1). */ number_first_prefix: string; number_first: string | number; /** @description Suffix for the first (or only) number in range. Field length: up to two uppercase alphanumeric characters (AS4590:2006 5.5.3.1). */ number_first_suffix: string; /** @description Prefix for the last number in range. Field length: up to three uppercase alphanumeric characters (AS4590:2006 5.5.3.2). */ number_last_prefix: string; number_last: string | number; /** @description Suffix for the last number in range. Field length: up to two uppercase alphanumeric characters (AS4590:2006 5.5.3.2). */ number_last_suffix: string; /** @description Street/Locality of this address - not mandatory N as some records in G-F may not require street (e.g. remote rural property). */ street_locality_pid: string; /** @description A = Alias record, P = Principal record. */ alias_principal: string; /** @description Postcodes are optional as prescribed by AS4819 and AS4590:2006 5.13. */ postcode: string; /** @description Private street information. This is not broken up into name/type/suffix. Field length: up to 75 alphanumeric characters. This is not currently populated. */ private_street: string; /** @description Generic parcel id field derived from the Geoscape Australia’s Cadastre parcel where available. */ legal_parcel_id: string; confidence: string | number; /** @description Binary indicator of the level of geocoding this address has. e.g. 0 = 000 = (No geocode), 1 = 001 = (No Locality geocode, No Street geocode, Address geocode), etc. */ level_geocoded_code: number; /** @description Indicator that identifies if the address is P (Primary) or S (secondary). */ primary_secondary: string; /** @description Alias type (e.g. "Synonym"). */ alias_type_code: string; /** @description Unique abbreviation for the geocode type. */ geocode_type_code: string; default_latitude: string | number; default_longitude: string | number; /** @description The code indicating the type of change, for example, LOC-STN for locality name and street name change. */ address_change_type_code: string; /** @description Code for mesh block match e.g. 1. */ mb_2016_match_code: string; /** @description Code for mesh block match e.g. 1. */ mb_2021_match_code: string; /** @description Address type (e.g. "Postal", Physical"). */ address_type: string; /** @description Address site name. Field length: 200 alphanumeric characters. */ address_site_name: string; /** @description An identifier that relates to this specific geocoded site (e.g. "Transformer 75658"). */ geocode_site_name: string; /** @description Unique abbreviation for geocode feature. (e.g. "PRCL") (SAWG 7.4.1). */ site_geocode_type_code: string; /** @description Spatial precision of the geocode expressed N as number in the range, 1 (unique identification of feature) to 6 (feature associated to region i.e. postcode). */ reliability_code: string; /** @description Measurement (metres) of a geocode from other geocodes associated with the same address persistent identifier. */ site_boundary_extent: string; /** @description Planimetric accuracy. */ site_planimetric_accuracy: string; /** @description Elevation. This field is not currently populated. */ elevation: string; /** @description Site longitude */ site_longitude: string; /** @description Site latitude */ site_latitude: string; geocode_type_priority_order: string | number; site_geocode_priority_order: string | number; /** @description The name of the locality or suburb. */ locality_name: string; /** @description Required to differentiate localities of the same name within a state. */ primary_postcode: string; /** @description Describes the class of locality (e.g. Gazetted, topographic feature etc.). Lookup to locality class. */ locality_class_code: string; locality_gnaf_reliability_code: string | number; /** @description The alias name for the locality or suburb. */ locality_alias_name: string; /** @description Postcode. */ locality_alias_postcode: string; /** @description Alias type code for the locality. */ locality_alias_type_code: string; locality_planimetric_accuracy: string | number; locality_latitude: string | number; locality_longitude: string | number; /** @description The 2016 mesh block code. */ mb_2016_code: string; /** @description The 2021 mesh block code. */ mb_2021_code: string; /** * @description Code of 1 OR 2 when the root address:- * * Code 1: Automatically generated when the primary and secondary addresses share the same street number, street name (and type) and locality name components. * * Code 2: Manually generated where the primary and secondary addresses MAY or MAY NOT share the same street number, street name (and type) and locality name components */ ps_join_type_code: string; /** @description The state or territory name. All in uppercase. E.g. TASMANIA. */ state_name: string; /** @description The state or territory abbreviation. */ state_abbreviation: string; /** @description Defines whether this street represents a confirmed or unconfirmed street. */ street_class_code: string; /** @description Street name. e.g. "POPLAR". */ street_name: string; /** @description The street type code. e.g. "PLACE". */ street_type_code: string; /** @description The street suffix code. e.g. "WEST". */ street_suffix_code: string; gnaf_street_confidence: string | number; street_locality_gnaf_reliability_code: string | number; /** @description The street alias name. e.g. "POPLAR". */ street_locality_alias_street_name: string; /** @description The street type code. e.g. "PLACE". */ street_locality_alias_street_type_code: string; /** @description The street suffix code. e.g. "WEST". */ street_locality_alias_street_suffix_code: string; /** @description The alias type code. */ street_locality_alias_type_code: string; street_locality_boundary_extent: string | number; street_locality_planimetric_accuracy: string | number; street_locality_latitude: string | number; street_locality_longitude: string | number; /** @description Abbreviation of street type */ street_type_name: string; /** @description Abbreviation of street type */ street_locality_alias_street_type_name: string; }; KadasterAddress: { id: components["schemas"]["ID"]; /** @enum {string} */ dataset: "kadaster"; /** * @description 3 letter country code (ISO 3166-1) * * @enum {undefined} */ country_iso: "NLD"; /** * @description 2 letter country code (ISO 3166-1) * * @enum {string} */ country_iso_2: "NL"; /** * @description Full country names (ISO 3166) * * @enum {string} */ country: "Netherlands"; /** * @description First address line. * * Can be empty string `""` if not present. * * @example Herengracht 255 */ line_1: string; /** * @description Language represented by 2 letter ISO Code (639-1) * * @enum {undefined} */ language: "nl"; /** * @description Address / House Number uniquely identifying the address along the specified street. * * Can be empty string `""` if not present. * * @example 255 */ address: string; longitude: components["schemas"]["Longitude"]; latitude: components["schemas"]["Latitude"]; /** @description The unique identifier of a BAG verblijfsobject. */ identificatie: string; /** @description The purpose of use of the verblijfsobject. */ gebruiksdoel: string; /** @description The area of the verblijfsobject in square metres. */ oppervlakte: number; /** @description Verblijfsobject status. */ status: string; /** @description Indicates that a verblijfsobject has been included in the registry as a result of an observation, without there being a regular source document for this inclusion at the time of registration. */ geconstateerd: boolean; /** * Format: date * @description Date on which the verblijfsobject source document was created. */ documentdatum: string; /** @description The unique identifier of the verblijfsobject source document. */ documentnummer: string; voorkomenidentificatie: string | number; /** * Format: date * @description The time at which a version of a verblijfsobject is valid in reality in accordance with the effective date in the source document. */ begin_geldigheid: string; /** * Format: date * @description The time at which a version of a verblijfsobject is no longer valid in reality. Empty string `""` if not applicable. */ eind_geldigheid: string; /** * Format: date * @description The time at which a version of a verblijfsobject is registered by the bronhouder. */ tijdstip_registratie: string; /** * Format: date * @description The time at which a version of a verblijfsobject is no longer valid according to the bronhouder. Empty string `""` if not applicable. */ eind_registratie: string; /** * Format: date * @description The time at which a version of a verblijfsobject is registered in the Landelijke Voorziening BAG. */ tijdstip_registratie_lv: string; /** * Format: date * @description The time at which a version of a verblijfsobject is no longer valid in the Landelijke Voorziening BAG. Empty string `""` if not applicable. */ tijdstip_eind_registratie_lv: string; /** @description The unique identifier of a BAG nummeraanduiding object. */ nummeraanduidingen_identificatie: string; /** @description The house number assigned to a nummeraanduiding object by or on behalf of the municipal council. */ nummeraanduidingen_huisnummer: string; /** @description A further addition to a house number or a combination of house number and house letter granted by or on behalf of the municipal council with regard to a nummeraanduiding object. */ nummeraanduidingen_huisnummertoevoeging: string; /** @description An addition to a house number in the form of an alphanumeric character assigned by or on behalf of the municipal council with regard to a nummeraanduiding object. */ nummeraanduidingen_huisletter: string; /** @description A code determined by PostNL associated with a specific combination of a street name and a house number. */ nummeraanduidingen_postcode: string; /** @description The nature of the nummeraanduiding object. */ nummeraanduidingen_type_adresseerbaar_object: string; /** @description The status of the nummeraanduiding object. */ nummeraanduidingen_status: string; /** @description Indicates that a nummeraanduidingen object has been included in the registry as a result of an observation, without there being a regular source document for this inclusion at the time of registration. */ nummeraanduidingen_geconstateerd: boolean; /** * Format: date * @description Date on which the nummeraanduidingen object source document was created. */ nummeraanduidingen_documentdatum: string; /** @description The unique identifier of the nummeraanduidingen object source document. */ nummeraanduidingen_documentnummer: string; nummeraanduidingen_voorkomenidentificatie: string | number; /** * Format: date * @description The time at which a version of a nummeraanduidingen object is valid in reality in accordance with the effective date in the source document. */ nummeraanduidingen_begin_geldigheid: string; /** * Format: date * @description The time at which a version of a nummeraanduidingen object is no longer valid in reality. Empty string `""` if not applicable. */ nummeraanduidingen_eind_geldigheid: string; /** * Format: date * @description The time at which a version of a nummeraanduidingen object is registered by the bronhouder. */ nummeraanduidingen_tijdstip_registratie: string; /** * Format: date * @description The time at which a version of a nummeraanduidingen object is no longer valid according to the bronhouder. Empty string `""` if not applicable. */ nummeraanduidingen_eind_registratie: string; /** * Format: date * @description The time at which a version of a nummeraanduidingen object is registered in the Landelijke Voorziening BAG. */ nummeraanduidingen_tijdstip_registratie_lv: string; /** * Format: date * @description The time at which a version of a nummeraanduidingen object is no longer valid in the Landelijke Voorziening BAG. Empty string `""` if not applicable. */ nummeraanduidingen_tijdstip_eind_registratie_lv: string; /** @description The unique identifier of a BAG pand object. */ pand_identificatie: string; pand_oorspronkelijk_bouwjaar: string | number; /** @description The status of the pand object. */ pand_status: string; /** @description Indicates that a pand object has been included in the registry as a result of an observation, without there being a regular source document for this inclusion at the time of registration. */ pand_geconstateerd: boolean; /** * Format: date * @description Date on which the pand object source document was created. */ pand_documentdatum: string; /** @description The unique identifier of the pand object source document. */ pand_documentnummer: string; pand_voorkomenidentificatie: string | number; /** * Format: date * @description The time at which a version of a pand object is valid in reality in accordance with the effective date in the source document. */ pand_begin_geldigheid: string; /** * Format: date * @description The time at which a version of a pand object is no longer valid in reality. Empty string `""` if not applicable. */ pand_eind_geldigheid: string; /** * Format: date * @description The time at which a version of a pand object is registered by the bronhouder. */ pand_tijdstip_registratie: string; /** * Format: date * @description The time at which a version of a pand object is no longer valid according to the bronhouder. Empty string `""` if not applicable. */ pand_eind_registratie: string; /** * Format: date * @description The time at which a version of a pand object is registered in the Landelijke Voorziening BAG. */ pand_tijdstip_registratie_lv: string; /** * Format: date * @description The time at which a version of a pand object is no longer valid in the Landelijke Voorziening BAG. Empty string `""` if not applicable. */ pand_tijdstip_eind_registratie_lv: string; /** @description The unique identifier of a BAG openbare ruimte object. */ openbare_ruimte_identificatie: string; /** @description The name assigned to an openbare ruimte object by or on behalf of the municipal council. */ openbare_ruimte_naam: string; /** @description The nature of the openbare ruimte object. */ openbare_ruimte_type: string; /** @description The status of the openbare ruimte object. */ openbare_ruimte_status: string; /** @description Indicates that an openbare ruimte object has been included in the registry as a result of an observation, without there being a regular source document for this inclusion at the time of registration. */ openbare_ruimte_geconstateerd: boolean; /** * Format: date * @description Date on which the openbare ruimte object source document was created. */ openbare_ruimte_documentdatum: string; /** @description The unique identifier of the openbare ruimte object source document. */ openbare_ruimte_documentnummer: string; openbare_ruimte_voorkomenidentificatie: string | number; /** * Format: date * @description The time at which a version of an openbare ruimte object is valid in reality in accordance with the effective date in the source document. */ openbare_ruimte_begin_geldigheid: string; /** * Format: date * @description The time at which a version of an openbare ruimte object is no longer valid in reality. Empty string `""` if not applicable. */ openbare_ruimte_eind_geldigheid: string; /** * Format: date * @description The time at which a version of an openbare ruimte object is registered by the bronhouder. */ openbare_ruimte_tijdstip_registratie: string; /** * Format: date * @description The time at which a version of an openbare ruimte object is no longer valid according to the bronhouder. Empty string `""` if not applicable. */ openbare_ruimte_eind_registratie: string; /** * Format: date * @description The time at which a version of an openbare ruimte object is registered in the Landelijke Voorziening BAG. */ openbare_ruimte_tijdstip_registratie_lv: string; /** * Format: date * @description The time at which a version of an openbare ruimte object is no longer valid in the Landelijke Voorziening BAG. Empty string `""` if not applicable. */ openbare_ruimte_tijdstip_eind_registratie_lv: string; /** @description An abbreviated name assigned to an openbare ruimte object if its name is longer than 24 characters. */ openbare_ruimte_verkorte_naam: string; /** @description The unique identifier of a BAG woonplaats object. */ woonplaats_identificatie: string; /** @description The name assigned to a woonplaats object by or on behalf of the municipal council. */ woonplaats_naam: string; /** @description The status of the woonplaats object. */ woonplaats_status: string; /** @description Indicates that a woonplaats object has been included in the registry as a result of an observation, without there being a regular source document for this inclusion at the time of registration. */ woonplaats_geconstateerd: boolean; /** * Format: date * @description Date on which the woonplaats object source document was created. */ woonplaats_documentdatum: string; /** @description The unique identifier of the woonplaats object source document. */ woonplaats_documentnummer: string; woonplaats_voorkomenidentificatie: string | number; /** * Format: date * @description The time at which a version of a woonplaats object is valid in reality in accordance with the effective date in the source document. */ woonplaats_begin_geldigheid: string; /** * Format: date * @description The time at which a version of a woonplaats object is no longer valid in reality. Empty string `""` if not applicable. */ woonplaats_eind_geldigheid: string; /** * Format: date * @description The time at which a version of a woonplaats object is registered by the bronhouder. */ woonplaats_tijdstip_registratie: string; /** * Format: date * @description The time at which a version of a woonplaats object is no longer valid according to the bronhouder. Empty string `""` if not applicable. */ woonplaats_eind_registratie: string; /** * Format: date * @description The time at which a version of a woonplaats object is registered in the Landelijke Voorziening BAG. */ woonplaats_tijdstip_registratie_lv: string; /** * Format: date * @description The time at which a version of a woonplaats object is no longer valid in the Landelijke Voorziening BAG. Empty string `""` if not applicable. */ woonplaats_tijdstip_eind_registratie_lv: string; /** @description The province name. */ provincie: string; }; KartverketAddress: { id: components["schemas"]["ID"]; /** @enum {string} */ dataset: "kartverket"; /** * @description 3 letter country code (ISO 3166-1) * * @enum {undefined} */ country_iso: "NOR" | "SJM"; /** * @description 2 letter country code (ISO 3166-1) * * @enum {string} */ country_iso_2: "NO" | "SJ"; /** * @description Full country names (ISO 3166) * * @enum {string} */ country: "Norway" | "Svalbard and Jan Mayen"; /** * @description First address line. * * Can be empty string `""` if not present. * * @example Lerkevegen 5 */ line_1: string; /** * @description Second address line. * * Can be empty string `""` if not present. * * @example */ line_2: string; /** * @description Language represented by 2 letter ISO Code (639-1) * * @enum {undefined} */ language: "no"; /** * @description Address / House Number uniquely identifying the address along the specified street. * * Can be empty string `""` if not present. * * @example 16 */ address: string; longitude: components["schemas"]["Longitude"]; latitude: components["schemas"]["Latitude"]; /** * @description Local identifier assigned by the data supplier. * * Can be empty string `""` if not present. */ lokal_id: string; /** @description Kommune (municipality) number. */ kommunenummer: string; /** @description Kommune (municipality) name. */ kommunenavn: string; /** @description `vegadresse` = street address, `matrikkeladresse` = land registry address */ adressetype: string; /** * @description A local place name used in a road address. * * Can be empty string `""` if not present. */ adressetilleggsnavn: string; /** * @description Code for adressetilleggsnavn origin. * * Can be empty string `""` if not present. */ adressetilleggsnavn_kilde: string; adressekode: string | number; /** * @description Name of street, road, path, place or area entered in the land register. * * Can be empty string `""` if not present. */ adressenavn: string; nummer: string | number; /** * @description A subsequent letter that may be used in addition to a number. * * Can be empty string `""` if not present. */ bokstav: string; /** @description The number of a farm unit in the land register, unique within each municipality. */ gardsnummer: number; /** @description A unique identification number automatically assigned to each individual unit within a farm. */ bruksnummer: number; festenummer: string | number; seksjonsnummer: string | number; undernummer: string | number; /** * @description Official address text without bruksenhetsnummer, unique within a kommune. * * Can be empty string `""` if not present. */ adresse_tekst: string; /** * @description Official address text without bruksenhetsnummer and adressetilleggsnavn, unique within a kommune. * * Can be empty string `""` if not present. */ adresse_tekst_uten_adressetilleggsnavn: string; /** * @description Local identifier for a unit within a building. * * Can be empty string `""` if not present. */ bruksenhet_id: string; /** * @description Unit number, e.g. an apartment in a multi-dwelling building. * * Can be empty string `""` if not present. */ bruksenhetsnummer_tekst: string; /** * @description Official address text with bruksenhetsnummer, unique within a kommune. * * Can be empty string `""` if not present. */ offisiell_adresse_tekst: string; /** * @description Official address text with bruksenhetsnummer and without adressetilleggsnavn, unique within a kommune. * * Can be empty string `""` if not present. */ offisiell_adresse_tekst_uten_adressetilleggsnavn: string; /** @description EPSG code = `25833`. */ epsg_kode: number; /** @description Northward coordinate of address. */ nord: string; /** @description Eastward coordinate of address. */ oest: string; /** @description Postal code. */ postnummer: string; /** @description Name of postal town according to Posten. */ poststed: string; /** * @description Identifier consisting of 8 digits, where the first four are the kommunenummer, the next two are the delområdenummer and the last two indicate the grunnkrets. * * Can be empty string `""` if not present. */ grunnkretsnummer: string; /** * @description Official grunnkrets name from Statistics Norway (SSB). * * Can be empty string `""` if not present. */ grunnkretsnavn: string; /** * @description Unique 8 digit identifier of a parish. * * Can be empty string `""` if not present. */ soknenummer: string; /** * @description Parish name. * * Can be empty string `""` if not present. */ soknenavn: string; /** * @description Unique identifier of organisation in the Brønnøysund Register. * * Can be empty string `""` if not present. */ organisasjonsnummer: string; /** * @description 4 digit code for tettsted (urban settlement). * * Can be empty string `""` if not present. */ tettstednummer: string; /** * @description Name of tettsted (urban settlement). * * Can be empty string `""` if not present. */ tettstednavn: string; valgkretsnummer: string | number; /** * @description Name of constituency. * * Can be empty string `""` if not present. */ valgkretsnavn: string; /** @description Date of last change to the object data. */ oppdateringsdato: string; /** @description Date of extraction from database. */ datauttaksdato: string; /** @description Address local identifier assigned by the data supplier. */ adresse_id: string; /** @description Address identifier realized as UUID managed by the cadastral system. */ uuid_adresse: string; /** * @description Unit of usage identifier realized as UUID managed by the cadastral system. * * Can be empty string `""` if not present. */ uuid_bruksenhet: string; /** * @description Local identifier for means of access to a property. * * Can be empty string `""` if not present. */ atkomst_id: string; /** * @description Identifier of the means of access to a property realized as UUID in the cadastral system. * * Can be empty string `""` if not present. */ uuid_atkomst: string; /** * @description Northward coordinate of the means of access to a property. * * Can be empty string `""` if not present. */ atkomst_nord: string; /** * @description Eastward coordinate of the means of access to a property. * * Can be empty string `""` if not present. */ atkomst_oest: string; /** * @description Local identifier for means of access to a property in summer. * * Can be empty string `""` if not present. */ sommeratkomst_id: string; /** * @description Identifier of the means of access to a property in summer realized as UUID in the cadastral system. * * Can be empty string `""` if not present. */ uuid_sommeratkomst: string; /** * @description Northward coordinate of the means of access to a property in summer. * * Can be empty string `""` if not present. */ sommeratkomst_nord: string; /** * @description Eastward coordinate of the means of access to a property in summer. * * Can be empty string `""` if not present. */ sommeratkomst_oest: string; /** * @description Local identifier for means of access to a property in winter. * * Can be empty string `""` if not present. */ vinteratkomst_id: string; /** * @description Identifier of the means of access to a property in winter realized as UUID in the cadastral system. * * Can be empty string `""` if not present. */ uuid_vinteratkomst: string; /** * @description Northward coordinate of the means of access to a property in winter. * * Can be empty string `""` if not present. */ vinteratkomst_nord: string; /** * @description Eastward coordinate of the means of access to a property in winter. * * Can be empty string `""` if not present. */ vinteratkomst_oest: string; /** @description Name of county. */ fylke: string; /** @description Name of region. */ landsdel: string; }; SdfiAddress: { id: components["schemas"]["ID"]; /** @enum {string} */ dataset: "sdfi"; /** * @description 3 letter country code (ISO 3166-1) * * @enum {undefined} */ country_iso: "DNK"; /** * @description 2 letter country code (ISO 3166-1) * * @enum {string} */ country_iso_2: "DK"; /** * @description Full country names (ISO 3166) * * @enum {string} */ country: "Denmark"; /** * @description First address line. * * Can be empty string `""` if not present. * * @example Bakkevej 3 */ line_1: string; /** * @description Second address line. * * Can be empty string `""` if not present. * * @example Pindstrup */ line_2: string; /** * @description Language represented by 2 letter ISO Code (639-1) * * @enum {undefined} */ language: "da"; /** * @description Address / House Number uniquely identifying the address along the specified street. * * Can be empty string `""` if not present. * * @example 16 */ address: string; longitude: components["schemas"]["Longitude"]; latitude: components["schemas"]["Latitude"]; /** @description Unique address identifier assigned by the data supplier. */ adresse_id: string; /** * @description Unique composite key for the address, containing codes for the municipality, road section, house number, floor and door. * * Can be empty string `""` if not present. */ kvhx: string; /** * @description Composite key for the address, containing codes for the municipality, road section and house number. * * Can be empty string `""` if not present. */ kvh: string; /** @description Indicates whether the address is an access address. */ adgangsadresse: boolean; /** @description `1` = final address, `3` = provisional address. */ status: string; /** @description Status of the address indicated by the status code in Danmarks Adresseregister (DAR): `2` = provisional, `3` = valid, `4` = retired, `5` = suspended. */ darstatus: string; /** * @description Date and time of address creation in Danmarks Adresseregister (DAR). * * Can be empty string `""` if not present. */ oprettet: string; /** * @description Date and time of the last change to the address in Danmarks Adresseregister (DAR). * * Can be empty string `""` if not present. */ ændret: string; /** * @description Date and time at which the address became valid. * * Can be empty string `""` if not present. */ ikrafttrædelse: string; /** * @description Date and time from which the address is retired or suspended (may be in the future). * * Can be empty string `""` if not present. */ nedlagt: string; /** @description Four digit street identifier. */ vejkode: string; /** @description Street name. */ vejnavn: string; /** @description A possibly shortened version of the street name of no more than 20 characters, used where there is no space for the full street name. */ adresseringsvejnavn: string; /** @description House number. */ husnr: string; /** * @description Floor designation. * * Can be empty string `""` if not present. */ etage: string; /** * @description Door designation. * * Can be empty string `""` if not present. */ dør: string; /** * @description Unique identifier in Danmarks Administrative Geografiske Inddeling (DAGI) of the supplementary town or city name. * * Can be empty string `""` if not present. */ supplerendebynavn_dagi_id: string; /** * @description Supplementary city name. * * Can be empty string `""` if not present. */ supplerendebynavn: string; /** @description Postal code. */ postnr: string; /** @description The city or district name associated with the postal code. */ postnrnavn: string; /** * @description Bulk recipient postal code (company postal code) which is associated with the address. * * Can be empty string `""` if not present. */ stormodtagerpostnr: string; /** * @description The city or district name associated with the bulk recipient postal code. * * Can be empty string `""` if not present. */ stormodtagerpostnrnavn: string; /** @description Full text of postal address. */ betegnelse: string; /** * @description Date and time of the last change to the address point. * * Can be empty string `""` if not present. */ adressepunktændringsdato: string; /** @description Easting coordinate for the address in the ETRS89 system. */ etrs89koordinat_øst: string; /** @description Northing coordinate for the address in the ETRS89 system. */ etrs89koordinat_nord: string; /** * @description Latitude of the address in the WGS84 system. * * Can be empty string `""` if not present. */ wgs84koordinat_bredde: string | number; /** * @description Longitude of the address in the WGS84 system. * * Can be empty string `""` if not present. */ wgs84koordinat_længde: string | number; /** * @description Height in metres from the mean water level in the seas on Denmark's coasts to ground level at the address, calculated according to the Danish Vertical Reference 1990 (DVR90). * * Can be empty string `""` if not present. */ højde: string; /** @description Code indicating the accuracy of the address point. `A` = accurate to within 2 metres, `B` = accurate to within 100 metres, `U` = no address point. */ nøjagtighed: string; /** * @description Code indicating the source of the address point. * * Can be empty string `""` if not present. */ kilde: string; /** @description Technical classification code for the location of an address point. */ tekniskstandard: string; /** @description Orientation for an address in gons, where a full circle is divided into 400 gons. */ tekstretning: string; /** @description Identifier of the 100m cell in which the address is located in Det Danske Kvadratnet (DDKN). */ ddkn_m100: string; /** @description Identifier of the 1km cell in which the address is located in Det Danske Kvadratnet (DDKN). */ ddkn_km1: string; /** @description Identifier of the 10km cell in which the address is located in Det Danske Kvadratnet (DDKN). */ ddkn_km10: string; /** @description Four digit identifier of the municipality in which the address is located. */ kommunekode: string; /** @description Name of the municipality in which the address is located. */ kommunenavn: string; /** @description NUTS 3 code of the province in which the address is located. */ landsdelsnuts3: string; /** @description Name of the province in which the address is located. */ landsdelsnavn: string; /** @description Four digit identifier of the region in which the address is located. */ regionskode: string; /** @description Name of the region in which the address is located. */ regionsnavn: string; /** @description Identifier of the polling district in which the address is located. */ afstemningsområdenummer: string; /** @description Unique name of the polling district in which the address is located. */ afstemningsområdenavn: string; /** * @description Identifier of the parish council polling district in which the address is located. * * Can be empty string `""` if not present. */ menighedsrådsafstemningsområdenummer: string; /** * @description Name of the parish council polling district in which the address is located. * * Can be empty string `""` if not present. */ menighedsrådsafstemningsområdenavn: string; /** @description Identifier of the local electoral district in which the address is located. */ opstillingskredskode: string; /** @description Name of the local electoral district in which the address is located. */ opstillingskredsnavn: string; /** @description Identifier of the regional electoral district in which the address is located. */ storkredsnummer: string; /** @description Name of the regional electoral district in which the address is located. */ storkredsnavn: string; /** @description Letter identifier of the national electoral district in which the address is located: `A`, `B` or `C`. */ valglandsdelsbogstav: string; /** @description Name of the national electoral district in which the address is located. */ valglandsdelsnavn: string; /** @description Identifier of the parish in which the address is located. */ sognekode: string; /** @description Name of the parish in which the address is located. */ sognenavn: string; /** @description Identifier of the police district in which the address is located. */ politikredskode: string; /** @description Name of the police district in which the address is located. */ politikredsnavn: string; /** @description Four digit identifier of the judicial district in which the address is located. */ retskredskode: string; /** @description Name of the judicial district in which the address is located. */ retskredsnavn: string; /** * @description Identifier of a cadastral unit with a single owner. * * Can be empty string `""` if not present. */ jordstykke_ejerlavkode: string; /** * @description Name of a cadastral unit with a single owner. * * Can be empty string `""` if not present. */ jordstykke_ejerlavnavn: string; /** * @description Cadastre identifier for the plot of land on which the address is located, consisting of up to 7 characters. * * Can be empty string `""` if not present. */ jordstykke_matrikelnr: string; /** * @description Identifier for the property from the Ejendomsstamregisteret (ESR) property register, corresponding to the plot of land associated with the address, consisting of up to 7 characters. * * Can be empty string `""` if not present. */ jordstykke_esrejendomsnr: string; /** * @description Identifier of a cadastral unit with a single owner (deprecated). * * Can be empty string `""` if not present. */ ejerlavkode: string; /** * @description Name of a cadastral unit with a single owner (deprecated). * * Can be empty string `""` if not present. */ ejerlavnavn: string; /** * @description Cadastre identifier for the plot of land on which the address is located, consisting of up to 7 characters. * * Can be empty string `""` if not present. */ matrikelnr: string; /** * @description Identifier for the property from the Ejendomsstamregisteret (ESR) property register, corresponding to the plot of land associated with the address, consisting of up to 7 characters. * * Can be empty string `""` if not present. */ esrejendomsnr: string; /** @description Status of the address zone: `Byzone`, `Sommerhusområde` or `Landzone`. */ zone: string; /** @description Indicates whether the address is connected by a bridge. */ brofast: boolean; /** * @description Identifier of the access address associated with the address. * * Can be empty string `""` if not present. */ adgangsadresseid: string; /** @description Identifier of the access point for the address. */ adgangspunktid: string; /** @description Identifier of the named road on which the access address is located. */ navngivenvej_id: string; /** @description Status of the access address associated with the address: `1` = final address, `3` = provisional address. */ adgangsadresse_status: string; /** * @description Status of the access address indicated by the status code in Danmarks Adresseregister (DAR): `2` = provisional, `3` = valid, `4` = retired, `5` = suspended. * * Can be empty string `""` if not present. */ adgangsadresse_darstatus: string; /** * @description Date and time of the creation of the access address associated with the address. * * Can be empty string `""` if not present. */ adgangsadresse_oprettet: string; /** * @description Date and time of the last change to the access address associated with the address. * * Can be empty string `""` if not present. */ adgangsadresse_ændret: string; /** * @description Date and time at which the access address became valid. * * Can be empty string `""` if not present. */ adgangsadresse_ikrafttrædelse: string; /** * @description Date and time from which the access address is retired or suspended (may be in the future). * * Can be empty string `""` if not present. */ adgangsadresse_nedlagt: string; /** @description Unique identifier of the geographic point on the road network that represents the starting point of the access route leading to the access point for the address. */ vejpunkt_id: string; /** * @description Date and time of the last change in Danmarks Adresseregister (DAR) to the geographic point on the road network that represents the starting point of the access route leading to the access point for the address. * * Can be empty string `""` if not present. */ vejpunkt_ændret: string; /** @description Source of the geographic point on the road network that represents the starting point of the access route leading to the access point for the address. */ vejpunkt_kilde: string; /** @description Accuracy of the geographic point on the road network that represents the starting point of the access route leading to the access point for the address: `A` = exact, `B` = approximate. */ vejpunkt_nøjagtighed: string; /** @description Technical classification code for the geographic point on the road network that represents the starting point of the access route leading to the access point for the address. */ vejpunkt_tekniskstandard: string; /** @description Longitude in the WGS84 system of the geographic point on the road network that represents the starting point of the access route leading to the access point for the address. */ vejpunkt_x: string; /** @description Latitude in the WGS84 system of the geographic point on the road network that represents the starting point of the access route leading to the access point for the address. */ vejpunkt_y: string; }; CannarAddress: { id: components["schemas"]["ID"]; /** @enum {string} */ dataset: "cannar"; /** * @description 3 letter country code (ISO 3166-1) * * @enum {undefined} */ country_iso: "CAN"; /** * @description 2 letter country code (ISO 3166-1) * * @enum {string} */ country_iso_2: "CA"; /** * @description Full country names (ISO 3166) * * @enum {string} */ country: "Canada"; /** * @description First address line. * * Can be empty string `""` if not present. * * @example 38 Deane St */ line_1: string; /** * @description Second address line. * * Can be empty string `""` if not present. * * @example RR 4 */ line_2: string; /** * @description Language represented by 2 letter ISO Code (639-1) * * @enum {undefined} */ language: "en" | "fr"; /** * @description Address / House Number uniquely identifying the address along the specified street. * * Can be empty string `""` if not present. * * @example 16 */ address: string; longitude: components["schemas"]["Longitude"]; latitude: components["schemas"]["Latitude"]; /** @description Globally unique identifier for location. */ loc_guid: string; /** @description Globally unique identifier for address. */ addr_guid: string; /** * @description Apartment or suite number. * * Can be empty string `""` if not present. */ apt_no_label: string; /** * @description The building number assigned to the address. * * Can be empty string `""` if not present. */ civic_no: string; /** * @description A suffix attached to the civic number. * * Can be empty string `""` if not present. */ civic_no_suffix: string; /** * @description Official street name. * * Can be empty string `""` if not present. */ official_street_name: string; /** * @description Official street designator. * * Can be empty string `""` if not present. */ official_street_type: string; /** * @description Official street direction. * * Can be empty string `""` if not present. */ official_street_dir: string; /** @description Province code. */ prov_code: string; /** * @description Census subdivision English name. * * Can be empty string `""` if not present. */ csd_eng_name: string; /** * @description Census subdivision French name. * * Can be empty string `""` if not present. */ csd_fre_name: string; /** * @description English code indicating the type of Census Subdivision. * * Can be empty string `""` if not present. */ csd_type_eng_code: string; /** * @description French code indicating the type of Census Subdivision. * * Can be empty string `""` if not present. */ csd_type_fre_code: string; /** * @description Name of the street used in the mailing address. * * Can be empty string `""` if not present. */ mail_street_name: string; /** * @description Designator of the street used in the mailing address. * * Can be empty string `""` if not present. */ mail_street_type: string; /** * @description Direction of the street used in the mailing address. * * Can be empty string `""` if not present. */ mail_street_dir: string; /** * @description Municipality name used in the mailing address. * * Can be empty string `""` if not present. */ mail_mun_name: string; /** * @description Province abbreviation used in the mailing address. * * Can be empty string `""` if not present. */ mail_prov_abvn: string; /** * @description Postal code used in the mailing address. * * Can be empty string `""` if not present. */ mail_postal_code: string; /** * @description Legal Subdivision number within the Dominion Land Survey system for the address location. * * Can be empty string `""` if not present. */ bg_dls_lsd: string; /** * @description Quarter section within a section of the Dominion Land Survey system for the address location. * * Can be empty string `""` if not present. */ bg_dls_qtr: string; /** * @description Section number within a township of the Dominion Land Survey system for the address location. * * Can be empty string `""` if not present. */ bg_dls_sctn: string; /** * @description Township number within the Dominion Land Survey system for the address location. * * Can be empty string `""` if not present. */ bg_dls_twnshp: string; /** * @description Range number within a meridian of the Dominion Land Survey system for the address location. * * Can be empty string `""` if not present. */ bg_dls_rng: string; /** * @description Meridian number within the Dominion Land Survey system for the address location. * * Can be empty string `""` if not present. */ bg_dls_mrd: string; /** * @description Spatial X coordinate (GPS) of building. (ESPG 3347) * * Can be empty string `""` if not present. */ bg_x: string; /** * @description Spatial Y coordinate (GPS) of building. (ESPG 3347) * * Can be empty string `""` if not present. */ bg_y: string; /** * @description Additional delivery information for mailing address. * * Can be empty string `""` if not present. * * @example PO Box 377 */ bu_n_civic_add: string; /** * @description Building usage codes. * * Can be empty string `""` if not present. */ bu_use: string; /** * @description Unique identifier code for a Census Subdivision (CSD). * * Can be empty string `""` if not present. */ csd_code: string; /** * @description Unique identifier code for a federal electoral district. * * Can be empty string `""` if not present. */ fed_code: string; /** * @description Name of the federal electoral district in English. * * Can be empty string `""` if not present. */ fed_eng_name: string; /** * @description Name of the federal electoral district in French. * * Can be empty string `""` if not present. */ fed_fre_name: string; /** * @description Unique identifier code for an economic region. * * Can be empty string `""` if not present. */ er_code: string; /** * @description Name of the economic region in English. * * Can be empty string `""` if not present. */ er_eng_name: string; /** * @description Name of the economic region in French. * * Can be empty string `""` if not present. */ er_fre_name: string; reppoint_latitude: components["schemas"]["Latitude"]; reppoint_longitude: components["schemas"]["Longitude"]; }; /** * Global Address * @description Global (non-UK) address in the UK address format */ GbrGlobalAddress: { id: components["schemas"]["ID"]; dataset: components["schemas"]["Dataset"]; country_iso: components["schemas"]["CountryISO"]; country_iso_2: components["schemas"]["CountryISO2"]; language: components["schemas"]["Language"]; /** * Address First Line * @description First line of the address. Typically the building number and street name * @example 10 Georgia Ave */ line_1: string; /** * Address Second Line * @description Second line of the address. Can be blank * @example */ line_2: string; /** * Address Third Line * @description Third line of the address. Can also be blank * @example */ line_3: string; /** * Postal Code * @description Represents the postal or zip code * @example 30529-2320 */ postcode: string; /** * @description The city, town or other primary locality * * @example Commerce */ post_town: string; /** * @description State or county name * @example Georgia */ county: string; /** * @description Code abbreviation for state or county used in some countries. * @example GA */ county_code: string; longitude: components["schemas"]["Longitude"]; latitude: components["schemas"]["Latitude"]; country: components["schemas"]["Country"]; /** @description The native representation of a non-UK address */ native: | components["schemas"]["EcadAddress"] | components["schemas"]["EcafAddress"] | components["schemas"]["UspsAddress"] | components["schemas"]["HereAddress"] | components["schemas"]["GnafAddress"] | components["schemas"]["KadasterAddress"] | components["schemas"]["KartverketAddress"] | components["schemas"]["SdfiAddress"] | components["schemas"]["CannarAddress"]; /** * @description Not available for non-UK addresses * @enum {string} */ postcode_outward: ""; /** * @description Not available for non-UK addresses * @enum {string} */ postcode_inward: ""; /** * @description Not available for non-UK addresses * @enum {string} */ dependant_locality: ""; /** * @description Not available for non-UK addresses * @enum {string} */ double_dependant_locality: ""; /** * @description Not available for non-UK addresses * @enum {string} */ thoroughfare: ""; /** * @description Not available for non-UK addresses * @enum {string} */ dependant_thoroughfare: ""; /** * @description Not available for non-UK addresses * @enum {string} */ building_number: ""; /** * @description Not available for non-UK addresses * @enum {string} */ building_name: ""; /** * @description Not available for non-UK addresses * @enum {string} */ sub_building_name: ""; /** * @description Not available for non-UK addresses * @enum {string} */ premise: ""; /** * @description Not available for non-UK addresses * @enum {string} */ po_box: ""; /** * @description Not available for non-UK addresses * @enum {string} */ department_name: ""; /** * @description Not available for non-UK addresses * @enum {string} */ organisation_name: ""; /** @description Not available for non-UK addresses. See `id` for address identifier */ udprn: string; /** * @description Not available for non-UK addresses. See `id` for address identifier * @enum {string} */ umprn: ""; /** * @description Not available for non-UK addresses * @enum {string} */ postcode_type: ""; /** * @description Not available for non-UK addresses * @enum {string} */ su_organisation_indicator: ""; /** * @description Not available for non-UK addresses * @enum {string} */ delivery_point_suffix: ""; /** * @description Not available for non-UK addresses * @enum {string} */ administrative_county: ""; /** * @description Not available for non-UK addresses * @enum {string} */ postal_county: ""; /** * @description Not available for non-UK addresses * @enum {string} */ traditional_county: ""; /** * @description Not available for non-UK addresses * @enum {string} */ district: ""; /** * @description Not available for non-UK addresses * @enum {string} */ ward: ""; /** * @description Not available for non-UK addresses * @enum {string} */ eastings: ""; /** * @description Not available for non-UK addresses * @enum {string} */ northings: ""; /** * @description Not available for non-UK addresses. See `id` for address identifier * @enum {string} */ uprn: ""; }; /** * Postcode Response * @example { * "result": [ * { * "postcode": "SW1A 2AA", * "postcode_inward": "2AA", * "postcode_outward": "SW1A", * "post_town": "London", * "dependant_locality": "", * "double_dependant_locality": "", * "thoroughfare": "Downing Street", * "dependant_thoroughfare": "", * "building_number": "10", * "building_name": "", * "sub_building_name": "", * "po_box": "", * "department_name": "", * "organisation_name": "Prime Minister & First Lord Of The Treasury", * "udprn": 23747771, * "postcode_type": "L", * "su_organisation_indicator": "", * "delivery_point_suffix": "1A", * "line_1": "Prime Minister & First Lord Of The Treasury", * "line_2": "10 Downing Street", * "line_3": "", * "premise": "10", * "longitude": -0.12767, * "latitude": 51.503541, * "eastings": 530047, * "northings": 179951, * "country": "England", * "traditional_county": "Greater London", * "administrative_county": "", * "postal_county": "London", * "county": "London", * "district": "Westminster", * "ward": "St. James's", * "uprn": "100023336956", * "id": "paf_23747771", * "country_iso": "GBR", * "country_iso_2": "GB", * "county_code": "", * "language": "en", * "umprn": "", * "dataset": "paf" * } * ], * "code": 2000, * "message": "Success", * "limit": 100, * "page": 0, * "total": 1 * } */ PostcodeResponse: { /** * @description All addresses listed at the postcode. * * If Eircode is enabled, addreses for the Republic of Ireland will be returned in the English format. */ result: ( | components["schemas"]["PafAddress"] | components["schemas"]["MrAddress"] | components["schemas"]["NybAddress"] | components["schemas"]["PafAliasAddress"] | components["schemas"]["WelshPafAddress"] | components["schemas"]["AbAddress"] | components["schemas"]["GbrGlobalAddress"] )[]; /** @enum {integer} */ code: 2000; /** @enum {string} */ message: "Success"; /** @default 0 */ page: number; /** @default 100 */ limit: number; total: number; }; /** Basic Error Response */ ErrorResponse: { /** * Format: int32 * @description API Response Code. Non `2xxx` code indicates a failure. This code will provide a more specific reason when a failure occurs and facilitates debugging. */ code: number; /** @description Human readable error message supplied with every error response. */ message: string; }; /** Bad Request Error Response */ BadRequestResponse: components["schemas"]["ErrorResponse"] & { /** * Format: int32 * @description `400X` type error response code */ code: number; /** @description Bad request error description */ message: string; errors?: { /** * @description Indicates location of error in request query or URL parameter * @example should have required property 'type' */ message: string; /** * @description Indicates location of error in request query or URL parameter * @example .query.type */ path: string; /** @example required.openapi.validation */ errorCode?: string; }[]; }; /** Postcode Not Found */ PostcodeNotFoundResponse: { /** * Format: int32 * @enum {integer} */ code: 4040; /** @enum {string} */ message: "Postcode not found"; /** @description A list of alternate nearest matching postcodes you can try */ suggestions: string[]; }; /** * UDPRN Response * @example { * "result": { * "postcode": "SW1A 2AA", * "postcode_inward": "2AA", * "postcode_outward": "SW1A", * "post_town": "London", * "dependant_locality": "", * "double_dependant_locality": "", * "thoroughfare": "Downing Street", * "dependant_thoroughfare": "", * "building_number": "10", * "building_name": "", * "sub_building_name": "", * "po_box": "", * "department_name": "", * "organisation_name": "Prime Minister & First Lord Of The Treasury", * "udprn": 23747771, * "postcode_type": "L", * "su_organisation_indicator": "", * "delivery_point_suffix": "1A", * "line_1": "Prime Minister & First Lord Of The Treasury", * "line_2": "10 Downing Street", * "line_3": "", * "premise": "10", * "longitude": -0.12767, * "latitude": 51.503541, * "eastings": 530047, * "northings": 179951, * "country": "England", * "traditional_county": "Greater London", * "administrative_county": "", * "postal_county": "London", * "county": "London", * "district": "Westminster", * "ward": "St. James's", * "uprn": "100023336956", * "id": "paf_23747771", * "country_iso": "GBR", * "country_iso_2": "GB", * "county_code": "", * "language": "en", * "umprn": "", * "dataset": "paf" * }, * "code": 2000, * "message": "Success" * } */ UDPRNResponse: { result: | components["schemas"]["PafAddress"] | components["schemas"]["NybAddress"]; /** * Format: int32 * @enum {integer} */ code: 2000; /** @enum {string} */ message: "Success"; }; /** * Multiple Residence (UMPRN) Address Response * @example { * "result": { * "postcode": "CV4 7AL", * "postcode_inward": "7AL", * "postcode_outward": "CV4", * "post_town": "Coventry", * "dependant_locality": "", * "double_dependant_locality": "", * "thoroughfare": "Gibbet Hill Road", * "dependant_thoroughfare": "", * "building_number": "", * "building_name": "Block 1 Arthur Vick", * "sub_building_name": "Room 249a", * "po_box": "", * "department_name": "", * "organisation_name": "", * "udprn": 5770157, * "postcode_type": "S", * "su_organisation_indicator": "", * "delivery_point_suffix": "1A", * "line_1": "Room 249a, Block 1 Arthur Vick", * "line_2": "Gibbet Hill Road", * "line_3": "", * "premise": "Room 249a, Block 1 Arthur Vick", * "longitude": -1.5648072, * "latitude": 52.3858227, * "eastings": 429716, * "northings": 276509, * "country": "England", * "traditional_county": "Warwickshire", * "administrative_county": "", * "postal_county": "West Midlands", * "county": "West Midlands", * "district": "Coventry", * "ward": "Wainbody", * "uprn": "200001572050", * "id": "mr_50906058", * "country_iso": "GBR", * "country_iso_2": "GB", * "county_code": "", * "language": "en", * "umprn": 50906058, * "dataset": "mr" * }, * "code": 2000, * "message": "Success" * } */ UMPRNResponse: { result: components["schemas"]["MrAddress"]; /** * Format: int32 * @enum {integer} */ code: 2000; /** @enum {string} */ message: "Success"; }; /** * Available Contexts * @description A list of available contexts for a key */ AvailableContexts: { /** * @description 3 letter ISO code * @example USA */ iso_3: string; /** * @description 2 letter ISO code * @example US */ iso_2: string; /** * @description Country descriptor to show in Address Finder * * @example United States */ description: string; /** * @description Emoji text icon * @example 🇺🇸 */ emoji: string; /** * @description Indicates availability of reverse geolocation search * * @example true */ rgeo: boolean; }[]; /** * Context * @description Limits search results within a geographical boundary or country. */ Context: string; /** * No Context Provided * @description Empty string if no context is provided or key check has failed * @enum {string} */ NoContext: ""; /** Key */ ApiKey: { contexts: components["schemas"]["AvailableContexts"]; /** @description Returns current context if it is in the list of available contexts for this key. */ context: | components["schemas"]["Context"] | components["schemas"]["NoContext"]; /** * @description Determines whether the key can be used by the requesting agent. * * Returns false if one of the following conditions are met: * - Key has no lookups remaining * - Daily limit has been reached on the key * - Daily individual limit has been reached * - Key is not being used via an authorised URL * - (Sublicensed key only) Key has a valid licensee attached * - (Sublicensed key only) Key is not being used via an authorised URL specified by licensee * * @example true */ available: boolean; }; /** API Key Response */ ApiKeyResponse: { result: components["schemas"]["ApiKey"]; /** @enum {string} */ message: "Success"; /** * Format: int32 * @enum {integer} */ code: 2000; }; /** API Key Daily Limit */ ApiKeyDailyLimit: { /** * Format: int32 * @description `number` or `null`. The daily lookup limit currently set on your key. * `null` means the limit is currently disabled. * @example 1000 */ limit: number | null; /** * Format: int32 * @description Number of lookups performed today which count towards your daily limit. * @example 288 */ consumed: number; }; /** API Key Individual Limit */ ApiKeyIndividualLimit: { /** * Format: int32 * @description `number` or `null` Limit set on the number of lookups that can be * performed from a single IP address. `null` means the limit is currently * disabled. * @example 30 */ limit: number | null; }; /** API Key Notifications */ ApiKeyNotifications: { /** @description A list of email addresses designated by you to receive notifications about this key. */ emails: string[]; /** @description Indicates whether email notifications are enabled. */ enabled: boolean; }; /** * API Key Dataset Availability * @description Indicates which datasets are available and added by default to the address responses */ ApiKeyDatasets: { /** * @description UK Main Address File (Postcode Address File) * @example true */ paf: boolean; /** * @description UK Property Alias dataset * @example false */ pafa: boolean; /** * @description UK Welsh Language Dataset * @example false */ pafw: boolean; /** * @description UK Multiple Residence Dataset * @example true */ mr: boolean; /** * @description UK Not Yet Built Dataset * @example false */ nyb: boolean; /** * @description UK AddressBase dataset * @example false */ ab: boolean; /** * @description Northern Ireland Pointer Dataset * @example false */ nip: boolean; /** * @description US Address Dataset * @example true */ usps: boolean; /** * @description Republic of Ireland: Eircode Address Database * @example false */ ecad: boolean; /** * @description Republic of Ireland: Eircode Address File * @example false */ ecaf: boolean; /** * @description Australia: Geocoded National Address File * @example true */ gnaf: boolean; /** * @description Asia Pacific Address File * @example true */ hereap: boolean; /** * @description Hong Kong Address File * @example true */ herehk: boolean; /** * @description India Address File * @example true */ herei: boolean; /** * @description Macau Address File * @example true */ herem: boolean; /** * @description Middle East and Africa Address File * @example true */ heremea: boolean; /** * @description Middle East and Africa Standalone Intermediate Maps Address File * @example true */ heremeas: boolean; /** * @description North America Address File * @example true */ herena: boolean; /** * @description Oceania Address File * @example true */ hereo: boolean; /** * @description South America Address File * @example true */ heresa: boolean; /** * @description Taiwan Address File * @example true */ heret: boolean; /** * @description Eastern Europe Address File * @example true */ hereee: boolean; /** * @description Western Europe Address File * @example true */ herewe: boolean; /** * @description Phone validation is enabled * @example true */ phone: boolean; /** * @description Email validation is enabled * @example true */ email: boolean; /** @description Netherlands: Kadaster BAG 2.0 Address File */ kadaster: boolean; /** * @description Norway: Karverket Address File * @example true */ kartverket: boolean; /** * @description Denmark: Danmarks Adresseregister (DAR) * @example true */ sdfi: boolean; /** * @description Canada: Statistics Canada National Address Register * @example true */ cannar: boolean; }; /** * API Key Automated Topup * @description Automated topup status */ ApiKeyAutomatedTopup: { /** * @description Indicates whether automated top-ups are enabled * @example true */ enabled: boolean; }; /** API Key Batch Purchase */ ApiKeyCurrentPurchase: { /** * @description `string` or `null` The date when this purchase will expire in simplified * extended ISO format (ISO 8601). This is typically 365 days from the time * of first use. This field will be `null` if the purchase has not yet been * used. * @example 2022-01-06T11:41:27.092Z */ expires: string | null; /** * Format: int32 * @description Number of procured lookups from this purchase. * @example 20000 */ purchased: number; /** * Format: int32 * @description Number of consumed lookups off this purchase. * @example 121 */ consumed: number; }; /** API Key Details */ ApiKeyDetails: { /** * Format: int32 * @example 19889 */ lookups_remaining: number; daily_limit: components["schemas"]["ApiKeyDailyLimit"]; individual_limit: components["schemas"]["ApiKeyIndividualLimit"]; /** @description A list of allowed URLs. An empty list means that allowed URLs are disabled. */ allowed_urls: string[]; /** * @description Number of days to preserve personal data stored in your key usage history. Set to 0 to prevent personal data storage * @default 28 */ redact_days: number; notifications: components["schemas"]["ApiKeyNotifications"]; datasets: components["schemas"]["ApiKeyDatasets"]; automated_topups: components["schemas"]["ApiKeyAutomatedTopup"]; /** @description Current balance purchases attached to key. */ current_purchases: components["schemas"]["ApiKeyCurrentPurchase"][]; /** * @description Accept IP addresses forwarded in the `IDPC-Source-IP` header * @default false */ ip_forwarding: boolean; }; /** API Key Details Response */ ApiKeyDetailsResponse: { result: components["schemas"]["ApiKeyDetails"]; /** * Format: int32 * @enum {integer} */ code: 2000; /** @enum {string} */ message: "Success"; }; /** API Key Details Update */ ApiKeyDetailsEditable: { /** Daily Rate Limit */ daily_limit?: { /** * Format: int32 * @description `number` or `null`. The daily lookup limit currently set on your key. * `null` means the limit is currently disabled. * @example 1000 */ limit?: number | null; }; /** API Key Individual Limit */ individual_limit?: { /** * Format: int32 * @description `number` or `null` Limit set on the number of lookups that can be * performed from a single IP address. `null` means the limit is currently * disabled. * @example 30 */ limit?: number | null; }; /** @description A list of allowed URLs. An empty list means that allowed URLs are disabled. Up to 10 allowed. */ allowed_urls?: string[]; /** * @description Number of days to preserve personal data stored in your key usage history. Set to 0 to prevent personal data storage * @default 28 */ redact_days?: number; /** API Key Notifications */ notifications?: { /** @description A list of email addresses designated by you to receive notifications about this key. Up to 5 allowed. */ emails?: string[]; /** @description Indicates whether email notifications are enabled. */ enabled?: boolean; }; /** * @description Accept IP addresses forwarded in the `IDPC-Source-IP` header * @default false */ ip_forwarding?: boolean; /** * API Key Dataset Availability * @description Indicates which datasets are available and added by default to the address responses */ datasets?: { /** * @description UK Property Alias dataset * @example false */ pafa?: boolean; /** * @description UK Welsh Language Dataset * @example false */ pafw?: boolean; /** * @description US Address Dataset * @example true */ usps?: boolean; /** * @description Asia Pacific Address File * @example true */ hereap?: boolean; /** * @description Hong Kong Address File * @example true */ herehk?: boolean; /** * @description India Address File * @example true */ herei?: boolean; /** * @description Macau Address File * @example true */ herem?: boolean; /** * @description Middle East and Africa Address File * @example true */ heremea?: boolean; /** * @description Middle East and Africa Extended File * @example true */ heremeas?: boolean; /** * @description North America Address File * @example true */ herena?: boolean; /** * @description Oceania Address File * @example true */ hereo?: boolean; /** * @description South America Address File * @example true */ heresa?: boolean; /** * @description Taiwan Address File * @example true */ heret?: boolean; /** * @description Eastern Europe Address File * @example true */ hereee?: boolean; /** * @description Western Europe Address File * @example true */ herewe?: boolean; /** * @description Phone validation is enabled * @example true */ phone?: boolean; /** * @description Email validation is enabled * @example true */ email?: boolean; /** * @description Australia: Geoscape Geocoded National Address File * @example true */ gnaf?: boolean; /** * @description Netherlands: Kadaster BAG 2.0 Address File * @example true */ kadaster?: boolean; /** * @description Norway: Kartverket Address File * @example true */ kartverket?: boolean; /** * @description Denmark: SDFI Address File * @example true */ sdfi?: boolean; /** * @description Canada: Statistics Canada National Address Register * @example true */ cannar?: boolean; }; }; /** Key Usage */ KeyUsageResult: { /** * @description Start date in ISO 8601 format. * @example 2015-01-22T15:08:06.609Z */ start: string; /** * @description End date in ISO 8601 format. * @example 2015-01-23T15:08:06.609Z */ end: string; /** * Format: int32 * @description Total of paid lookups performed in specified period. * @example 132 */ total: number; /** @description An array of objects representing number of paid lookups made on specific days, ordered by date. Each object contains a `date` attribute, which represents the day and a `count` attribute, which represents the number of paid lookups made on that day. */ dailyCount: { /** @example 2015-01-22T00:00:00.000Z */ date: string; /** * Format: int32 * @example 132 */ count: number; }[]; }; /** Key Usage Response */ ApiKeyUsageResponse: { result: components["schemas"]["KeyUsageResult"]; /** * Format: int32 * @enum {integer} */ code: 2000; /** @enum {string} */ message: "Success"; }; /** * United States CASS Verified Address * @description Address retrieved using CASS compliant address verification process */ UsaCassVerifiedAddress: { /** * @description Primary delivery address * * @example 101 Cauther Ln */ address1: string; /** * @description Secondary address information * * @example */ address2: string; /** * @description Additional secondary address information * * @example */ address3: string; /** * @description Area code. Also known as Numbering Plan Area (NPA) https://en.wikipedia.org/wiki/List_of_North_American_Numbering_Plan_area_codes * * @example 575 */ area_code: string; /** * @description Data required to perform a Carrier Route sort * * @example C019 */ carrier_route: string; /** * @description Character following the 5 or 9 digit ZIP Code. Part of the 11-digit barcode * * @example 4 */ check_digit: string; /** * @description City name * example: "Alamogordo" */ city: string; /** * @description City Abbreviation. Empty string if not present * * @example */ city_abbreviation: string; /** @description Identifies the Congressional District. Empty string if not present */ congressional_district: string; /** * @description ISO3166 country code. Empty string if not present * * @example US */ country_code: string; /** * @description Name of the county * * @example Otero */ county: string; /** * @description Daylight saving time indicator * * @example true */ day_light_savings: boolean; /** * @description Last 2 digits of the primary street address number or Post Office box * * @example 10 */ delivery_point: string; /** * @description 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. * * @enum {string} */ dpv: "Y" | "S" | "D" | "N" | ""; /** * @description 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. * * @enum {string} */ dpv_cmra: "Y" | "N" | ""; /** * @description 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. * * @example AABB */ dpv_footnotes: string; /** * @description 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. * * @enum {string} */ dpv_no_stat: "Y" | "N" | ""; /** * @description 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. * * @enum {string} */ dpv_vacant: "Y" | "N" | ""; /** * @description 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. * * @example 0133A */ elot: string; /** * @description 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 * * @example 340105 */ finance_number: string | number; /** * @description Federal Information Processing Standard code for a county. Empty string if not present * * @example 035 */ fips_county_code: string; /** * @description Company name in a business address * * @example */ firm: string; /** @description Letter codes returned by ZIP+4 encoding. Empty string if not present */ footnotes: string; /** @description Indicates whether the address was geo-coded */ geo_coded: boolean; /** * @description Indicates whether a record may benefit from LACS processing. * * Possible values: * - 'L' Yes * - '' No * * @enum {string} */ lacs_indicator: "L" | ""; /** * @description 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 * * @enum {string} */ lacs_link_footnote: "A" | "00" | "09" | "14" | "92" | ""; /** * @description 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 * * @enum {string} */ lacs_link_indicator: "Y" | "S" | "N" | ""; /** * @description Latitude of the encoded address. Empty string if not present * * @example 32.91278 */ latitude: string | number; /** * @description Longitude of the encoded address. Empty string if not present * * @example -105.94904 */ longitude: string | number; /** * @description Information if a Private Mail Box (PMB) is found in an address. Empty string if not present * * @example */ parsed_pmb_designator: string; /** * @description Information if a Private Mail Box (PMB) is found in an address. Empty string if not present * * @example */ parsed_pmb_number: string | number; /** * @description Notation following the street name indicating street direction. Empty string if not present * * @example */ parsed_post_directional: string | number; /** * @description Notation preceding the street name indicating street direction. Empty string if not present * * @example */ parsed_pre_directional: string; /** * @description Number preceding the street name. Empty string if not present * * @example */ parsed_primary_number: string | number; /** * @description Street name. Empty string if not present * * @example */ parsed_street_name: string; /** * @description Part of the delivery address line following the street name. Empty string if not present * * @example */ parsed_suffix: string; /** * @description Identification of the secondary address unit. Empty string if not present * * @example */ parsed_unit_designator: string; /** * @description Apartment or suite number. Empty string if not present * * @example */ parsed_unit_number: string; /** * @description Reserved for future use. Empty string if not present * * @example Y */ rdi: string; /** * @description 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 * * @enum {string} */ record_type: "C" | "F" | "G" | "H" | "M" | "P" | "R" | "S" | "U" | ""; /** * @description Standard two-letter state abbreviation * * @example NM */ state: string; /** * @description Results of the SuiteLink lookup. * * Possible values: ' ' (Space), '00' (Double Zero), 'A' (A). Empty string if not present * * @enum {string} */ suite_link_footnote: "" | "00" | "A"; /** * @description Time zone. Empty string if not present * * @example MST */ time_zone: string; /** * @description Urban name required in the address of all mail being delivered to Puerto Rico. Empty string if not present * * @example */ urbanization: string; /** * @description 5-digit ZIP Code and the four additional digits * * @example 88310-5631 */ zip_code: string; /** * @description 2 letter country ISO code * * @example US */ country_iso_2?: string; }; /** Address Match */ GbrCleanseMatch: { /** @description Originally submitted query */ query: string; /** @description Nearest matching address */ match: | components["schemas"]["PafAddress"] | components["schemas"]["MrAddress"] | components["schemas"]["NybAddress"] | components["schemas"]["PafAliasAddress"] | components["schemas"]["WelshPafAddress"] | components["schemas"]["UsaCassVerifiedAddress"]; /** @description The number of addresses we matched to the input. We return the closest match by default. */ count: number; /** @description 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. */ fit: number; /** @description A confidence score represented as number between 1 and 0. 1 indicates a full match. 0 indicates no complete matching elements. */ confidence: number; /** * @description Match indicator for the organisation * @enum {string} */ organisation_match: "FULL" | "PARTIAL" | "INCORRECT" | "MISSING" | "NA"; /** * @description Match indicator for the premise * @enum {string} */ premise_match: "FULL" | "PARTIAL" | "INCORRECT" | "MISSING" | "NA"; /** * @description Match indicator for the postcode * @enum {string} */ postcode_match: "FULL" | "PARTIAL" | "INCORRECT" | "MISSING" | "NA"; /** * @description Match indicator for the street * @enum {string} */ thoroughfare_match: "FULL" | "PARTIAL" | "INCORRECT" | "MISSING" | "NA"; /** * @description Match indicator for the locality * @enum {string} */ locality_match: "FULL" | "PARTIAL" | "INCORRECT" | "MISSING" | "NA"; /** * @description Match indicator for the post_town * @enum {string} */ post_town_match: "FULL" | "PARTIAL" | "INCORRECT" | "MISSING" | "NA"; }; /** No Address Match */ GbrCleanseNoMatch: { /** @description Originally submitted query */ query: string; /** * @description Nearest matching address * @enum {object|null} */ match: null | null; /** @enum {number} */ count: 0; /** * Format: float * @enum {number} */ fit: 0; /** * Format: float * @enum {number} */ confidence: 0; /** @enum {string} */ organisation_match: "NO_MATCH"; /** @enum {string} */ premise_match: "NO_MATCH"; /** @enum {string} */ postcode_match: "NO_MATCH"; /** @enum {string} */ thoroughfare_match: "NO_MATCH"; /** @enum {string} */ locality_match: "NO_MATCH"; /** @enum {string} */ post_town_match: "NO_MATCH"; }; /** Address Cleanse Response */ CleanseResponse: { /** * Format: int32 * @enum {integer} */ code: 2000; /** @enum {string} */ message: "Success"; result: | components["schemas"]["GbrCleanseMatch"] | components["schemas"]["GbrCleanseNoMatch"]; }; /** Unauthorized Request Error Response */ UnauthorizedResponse: components["schemas"]["ErrorResponse"] & { /** * Format: int32 * @description `401X` type error response code */ code: number; /** @description Unauthorized request error description */ message: string; }; /** Unauthorized Request Error Response */ RateLimitedResponse: components["schemas"]["ErrorResponse"] & { /** * Format: int32 * @description `429X` type error response code */ code: number; /** @description Request is being rate limited */ message: string; }; /** Address Match */ UsaVerifyMatch: { /** @description Submitted query */ query: string; /** @description Submitted city */ query_city: string; /** @description Submitted state */ query_state: string; /** @description Submitted zip_code */ query_zip_code: string; /** @description Nearest matching address */ match: | components["schemas"]["UsaCassVerifiedAddress"] | components["schemas"]["PafAddress"] | components["schemas"]["MrAddress"] | components["schemas"]["NybAddress"] | components["schemas"]["PafAliasAddress"] | components["schemas"]["WelshPafAddress"]; /** @description The number of addresses we matched to the input. We return the closest match by default. */ count: number; /** @description 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. */ fit: number; /** @description A confidence score represented as number between 1 and 0. 1 indicates a full match. 0 indicates no complete matching elements. */ confidence: number; /** * @description Additional information about the match. * * This information is for human consumption and may not be present in all responses. * * @example Single Response - The delivery address was found in the National Database and no further information was required. */ match_information: string; /** * @description Primary delivery address * * @example 123 Main St */ address_line_one: string; /** * @description Secondary address information * * @example */ address_line_two: string; /** * @description City name * * @example Springfield */ city: string; /** * @description State name * * @example CO */ state: string; /** * @description Zip code * * @example 81073-1119 */ zip_code: string; /** * @description 2 letter ISO country code * * @example US */ country_iso_2: string; }; /** No Address Match */ UsaVerifyNoMatch: { /** @description Originally submitted query */ query: string; /** @description Originally submitted city */ query_city: string; /** @description Originally submitted state */ query_state: string; /** @description Originally submitted zip_code */ query_zip_code: string; /** * @description Nearest matching address * @enum {object|null} */ match: null | null; /** @enum {number} */ count: 0; /** * Format: float * @enum {number} */ fit: 0; /** * Format: float * @enum {number} */ confidence: 0; /** * @description Empty if no match * * @enum {string} */ address_line_one: ""; /** * @description Empty if no match * * @enum {string} */ address_line_two: ""; /** * @description Empty if no match * * @enum {string} */ city: ""; /** * @description Empty if no match * * @enum {string} */ state: ""; /** * @description Empty if no match * * @enum {string} */ zip_code: ""; /** * @description Empty if no match * * @enum {string} */ country_iso_2: ""; }; /** Address Verify Response */ VerifyResponse: { /** * Format: int32 * @enum {integer} */ code: 2000; /** @enum {string} */ message: "Success"; result: | components["schemas"]["UsaVerifyMatch"] | components["schemas"]["UsaVerifyNoMatch"]; }; /** * Address Suggestion * @description Represents an address suggestion for any address in the world * @example { * "id": "usps_V210079628|10||3797", * "suggestion": "10 Downing St, Montpelier, VT, 05602", * "urls": null * } */ AddressSuggestion: { id: components["schemas"]["ID"]; /** * @description Address Suggestion to be displayed to the user * @example 10 Downing St, Montpelier, VT, 05602 */ suggestion: string; urls: { [key: string]: unknown }; }; /** * UK Address Suggestion * @description Represents a possible address given an autocomplete query. * * UK Address Suggestions will return a UDPRN attribute if it references a deliverable endpoint found on Royal Mail's Postcode Address File dataset. * * UK Address Suggestion will return a UMPRN if it references a multiple occupancy premise found on Royal Mail's Multiple Residence dataset. * * @example { * "id": "paf_23747771", * "suggestion": "Prime Minister & First Lord Of The Treasury, 10 Downing Street, London, SW1A", * "udprn": "23747771,", * "urls": { * "udprn": "/v1/udprn/23747771" * } * } */ UkAddressSuggestion: { id: components["schemas"]["ID"]; /** * @description Address suggestion for a given query. * @example Flat 6, 12 Roskear, Camborne, TR14 */ suggestion: string; udprn: components["schemas"]["paf_udprn"]; /** * Format: int32 * @description Optionally returned field, representing the UMPRN of a Multiple Residence household * @example 51103417 */ umprn?: number; urls: { /** * @description URL to retrieve the entire details for a given address suggestion by the UDPRN * @example /v1/udprn/50985827 */ udprn: string; /** * @description Optionally returned field, to retrieve the entire details for a suggested Multiple Residence household * @example /v1/umprn/51103417 */ umprn?: string; }; }; /** Address Autocomplete Response */ AutocompleteResponse: { /** * @example [ * { * "id": "paf_23747771", * "suggestion": "Prime Minister & First Lord Of The Treasury, 10 Downing Street, London, SW1A", * "udprn": 23747771, * "urls": { * "udprn": "/v1/udprn/23747771" * } * }, * { * "id": "paf_26245117", * "suggestion": "Flat 10, Downing Court, Grenville Street, London, WC1N", * "udprn": 26245117, * "urls": { * "udprn": "/v1/udprn/26245117" * } * } * ] */ result: { hits: ( | components["schemas"]["AddressSuggestion"] | components["schemas"]["UkAddressSuggestion"] )[]; }; /** * Format: int32 * @enum {integer} */ code: 2000; /** @enum {string} */ message: "Success"; }; /** Address Resolution Response (GBR) */ GbrResolveAddressResponse: { /** * Format: int32 * @enum {integer} */ code: 2000; /** @enum {string} */ message: "Success"; result: | components["schemas"]["PafAddress"] | components["schemas"]["MrAddress"] | components["schemas"]["WelshPafAddress"] | components["schemas"]["PafAliasAddress"] | components["schemas"]["NybAddress"] | components["schemas"]["AbAddress"] | components["schemas"]["GbrGlobalAddress"]; }; /** * Global Address * @description Global (non-US) Address in the US address format */ UsaGlobalAddress: { id: components["schemas"]["ID"]; /** @enum {undefined} */ dataset: components["schemas"]["Dataset"]; country: components["schemas"]["Country"]; country_iso: components["schemas"]["CountryISO"]; country_iso_2: components["schemas"]["CountryISO2"]; language: components["schemas"]["Language"]; /** * @description Not available for non-US addresses * @enum {string} */ primary_number: ""; /** * @description Not available for non-US addresses * @enum {string} */ secondary_number: ""; /** * @description Not available for non-US addresses * @enum {string} */ plus_4_code: ""; /** @description First line of address */ line_1: string; /** @description Second line of address */ line_2: string; /** * @description Not available for non-US addresses * @enum {string} */ last_line: ""; /** @description Partial postcode of address */ zip_code: string; /** @description Full postal code of address */ zip_plus_4_code: string; /** * @description Not available for non-US addresses * @enum {string} */ update_key_number: ""; /** * @description Not available for non-US addresses * @enum {string} */ record_type_code: ""; /** * @description Not available for non-US addresses * @enum {string} */ carrier_route_id: ""; /** * @description Not available for non-US addresses * @enum {string} */ street_pre_directional_abbreviation: ""; /** * @description Not available for non-US addresses * @enum {string} */ street_name: ""; /** * @description Not available for non-US addresses * @enum {string} */ street_suffix_abbreviation: ""; /** * @description Not available for non-US addresses * @enum {string} */ street_post_directional_abbreviation: ""; /** * @description Not available for non-US addresses * @enum {string} */ building_or_firm_name: ""; /** * @description Not available for non-US addresses * @enum {string} */ address_secondary_abbreviation: ""; /** * @description Not available for non-US addresses * @enum {string} */ base_alternate_code: ""; /** * @description Not available for non-US addresses * @enum {string} */ lacs_status_indicator: ""; /** * @description Not available for non-US addresses * @enum {string} */ government_building_indicator: ""; /** @description State or province */ state: string; /** @description Code of state or province (if available) */ state_abbreviation: string; /** * @description Not available for non-US addresses * @enum {string} */ municipality_city_state_key: ""; /** * @description Not available for non-US addresses * @enum {string} */ urbanization_city_state_key: ""; /** * @description Not available for non-US addresses * @enum {string} */ preferred_last_line_city_state_key: ""; /** @description County name */ county: string; /** @description City name */ city: string; /** @description City name abbreviation (if available) */ city_abbreviation: string; /** * @description Not available for non-US addresses * @enum {string} */ preferred_city: ""; /** * @description Not available for non-US addresses * @enum {string} */ city_state_name_facility_code: ""; /** * @description Not available for non-US addresses * @enum {string} */ zip_classification_code: ""; /** * @description Not available for non-US addresses * @enum {string} */ city_state_mailing_name_indicator: ""; /** * @description Not available for non-US addresses * @enum {string} */ carrier_route_rate_sortation: ""; /** * @description Not available for non-US addresses * @enum {string} */ finance_number: ""; /** * @description Not available for non-US addresses * @enum {string} */ congressional_district_number: ""; /** * @description Not available for non-US addresses * @enum {string} */ county_number: ""; /** @description The native representation of a non-US address */ native: | components["schemas"]["EcadAddress"] | components["schemas"]["EcafAddress"] | components["schemas"]["PafAddress"] | components["schemas"]["MrAddress"] | components["schemas"]["NybAddress"] | components["schemas"]["PafAliasAddress"] | components["schemas"]["WelshPafAddress"] | components["schemas"]["AbAddress"] | components["schemas"]["HereAddress"] | components["schemas"]["GnafAddress"] | components["schemas"]["KadasterAddress"] | components["schemas"]["KartverketAddress"] | components["schemas"]["SdfiAddress"] | components["schemas"]["CannarAddress"]; }; /** Address Retrieve Response (USA) */ UsaResolveAddressResponse: { /** * Format: int32 * @enum {integer} */ code: 2000; /** @enum {string} */ message: "Success"; result: | components["schemas"]["UspsAddress"] | components["schemas"]["UsaGlobalAddress"]; }; /** Address Search Response */ AddressResponse: { /** * Format: int32 * @enum {integer} */ code: 2000; /** @enum {string} */ message: "Success"; result: { /** @description List of matching addresses */ hits: ( | components["schemas"]["PafAddress"] | components["schemas"]["MrAddress"] | components["schemas"]["NybAddress"] | components["schemas"]["WelshPafAddress"] | components["schemas"]["PafAliasAddress"] | components["schemas"]["AbAddress"] )[]; /** Format: int32 */ total: number; /** * Format: int32 * @default 10 * @example 10 */ limit: number; /** * Format: int32 * @default 0 * @example 0 */ page: number; }; }; /** * Place Name * @description Place name * * @example London */ place_name: string; /** * Descriptive Place Name * @description Longer form description of the place. * * @example London, United Kingdom */ place_descriptive_name: string; /** * Country * @description 3 letter country code (ISO 3166-1) * * @example GBR */ place_country_iso: string; /** * ID * @description Unique identifier for place * * @example geonames_5324 */ place_id: string; /** * Place Description * @description Represents a possible place given an autocomplete query. */ PlaceSuggestion: { name: components["schemas"]["place_name"]; descriptive_name: components["schemas"]["place_descriptive_name"]; country_iso: components["schemas"]["place_country_iso"]; id: components["schemas"]["place_id"]; }; /** * Place Search Response * @example { * "result": { * "hits": [ * { * "id": "geonames_2643743", * "name": "London", * "descriptive_name": "London, Greater London, England", * "country_iso": "GBR" * }, * { * "id": "geonames_4517009", * "name": "London", * "descriptive_name": "London, Madison County, Ohio", * "country_iso": "USA" * }, * { * "id": "geonames_4298960", * "name": "London", * "descriptive_name": "London, Laurel County, Kentucky", * "country_iso": "USA" * } * ] * }, * "code": 2000, * "message": "Success" * } */ PlaceResponse: { /** * Format: int32 * @enum {integer} */ code: 2000; /** @enum {string} */ message: "Success"; result: { /** @description List of up to 10 matching places */ hits: components["schemas"]["PlaceSuggestion"][]; }; }; /** * GeoNames Place * @description Full GeoNames place specification */ GeonamesPlace: { /** * Format: int32 * @description Unique identifier for GeoNames place * @example 5353 */ geonameid?: number; /** * @description Place name (UTF8) * @example London */ name?: string; /** * @description Place Name (ASCII) * @example London */ asciiname?: string; /** @description List of alternate ASCII names */ alternatenames?: string[]; latitude?: components["schemas"]["Latitude"]; longitude?: components["schemas"]["Longitude"]; /** * @description GeoNames single letter feature code * @enum {string} */ feature_class?: "A" | "H" | "L" | "P" | "R" | "S" | "T" | "U" | "V"; /** * @description Full GeoNames feature code (http://www.geonames.org/export/codes.html) * @example ADM1 */ feature_code?: string; /** * @description 2 Letter ISO country code * @example GB */ country_code?: string; /** @description List of other countries codes mapping to this place */ cc2?: string[]; /** * @description Name of first administrative area * @example England */ admin1_name?: string; /** * Format: int32 * @description GeoName ID for first administrative area * @example 5353 */ admin1_geonameid?: number | null; /** * @description Fipscode (subject to change to iso code) * @example ENG */ admin1_code?: string; /** * @description Name of second administrative area * @example England */ admin2_name?: string; /** * Format: int32 * @description GeoName ID for second administrative area * @example 5353 */ admin2_geonameid?: number | null; /** * @description Code for the second administrative division * @example 06 */ admin2_code?: string; /** * @description Code for third level administrative division * @example 08 */ admin3_code?: string; /** * @description Code for fourth level administrative division * @example 07 */ admin4_code?: string; /** * @description Population at place. Represented as string as it could be a larger than a 32bit integer * @example 7392832 */ population?: string; /** * Format: int32 * @description Elevation in meters */ elevation?: number | null; /** * Format: int32 * @description Digital elevation model * @example 32 */ dem?: number | null; /** * @description The IANA timezone ID * @example Europe/London */ timezone?: string; /** * @description Datetime format * @example 2015-03-09 */ modification_date?: string; /** @enum {string} */ dataset?: "geonames"; /** * @description Unique place ID * @example geonames_5353 */ id?: string; } & { geonameid: unknown; name: unknown; asciiname: unknown; alternatenames: unknown; latitude: unknown; longitude: unknown; feature_class: unknown; feature_code: unknown; country_code: unknown; cc2: unknown; admin1_geonameid: unknown; admin2_geonameid: unknown; admin1_name: unknown; admin2_name: unknown; admin1_code: unknown; admin2_code: unknown; admin3_code: unknown; admin4_code: unknown; population: unknown; elevation: unknown; dem: unknown; timezone: unknown; modification_date: unknown; }; /** * Place * @description Represents a geographical place */ Place: { /** * ID * @description Global unique internally generated identifier for a place * @example geonames_5353 */ id: string; /** * Dataset * @description Indicates the provenance of a place. * * - `geonames` GeoNames place * @enum {string} */ dataset: "geonames"; name: components["schemas"]["place_name"]; descriptive_name: components["schemas"]["place_descriptive_name"]; country_iso: components["schemas"]["place_country_iso"]; language: components["schemas"]["Language"]; longitude: components["schemas"]["Longitude"]; latitude: components["schemas"]["Latitude"]; /** @description Native representation of a place */ native?: components["schemas"]["GeonamesPlace"]; }; /** * Place Resolution Response * @example { * "result": { * "id": "geonames_2643743", * "dataset": "geonames", * "name": "London", * "descriptive_name": "London, Greater London, England", * "language": "en", * "longitude": -0.12574, * "latitude": 51.50853, * "country_iso": "GBR", * "native": { * "admin1_code": "ENG", * "admin2_name": "Greater London", * "geonameid": 2643743, * "timezone": "Europe/London", * "latitude": 51.50853, * "language": "en", * "dem": 25, * "admin4_code": "", * "admin1_geonameid": 6269131, * "alternatenames": [ * "ILondon", * "LON", * "Lakana", * "Landan", * "Landen", * "Ljondan", * "Llundain", * "Lodoni", * "Londain", * "Londan", * "Londar", * "Londe", * "Londen", * "Londin", * "Londinium", * "Londino", * "Londn", * "London", * "London osh", * "Londona", * "Londonas", * "Londoni", * "Londono", * "Londons", * "Londonu", * "Londra", * "Londres", * "Londrez", * "Londri", * "Londro", * "Londye", * "Londyn", * "Londýn", * "Lonn", * "Lontoo", * "Loundres", * "Luan GJon", * "Lun-tun", * "Lunden", * "Lundra", * "Lundun", * "Lundunir", * "Lundúnir", * "Lung-dung", * "Lunnainn", * "Lunnin", * "Lunnon", * "Luân Đôn", * "Lùn-tûn", * "Lùng-dŭng", * "Lûn-tun", * "Lākana", * "Lůndůn", * "Lọndọnu", * "Ranana", * "Rānana", * "ilantan", * "ladana", * "landan", * "landana", * "leondeon", * "lndn", * "london", * "londoni", * "lun dui", * "lun dun", * "lwndwn", * "lxndxn", * "rondon", * "Łondra", * "Λονδίνο", * "Лондан", * "Лондон", * "Лондон ош", * "Лондонъ", * "Лёндан", * "Լոնդոն", * "לאנדאן", * "לונדון", * "لأندأن", * "لندن", * "لوندون", * "لەندەن", * "ܠܘܢܕܘܢ", * "लंडन", * "लंदन", * "लण्डन", * "लन्डन्", * "लन्दन", * "লন্ডন", * "ਲੰਡਨ", * "લંડન", * "ଲ୍ଡନ", * "இலண்டன்", * "లండన్", * "ಲಂಡನ್", * "ലണ്ടൻ", * "ලන්ඩන්", * "ลอนดอน", * "ລອນດອນ", * "ལོན་ཊོན།", * "လန်ဒန်မြို့", * "ლონდონი", * "ለንደን", * "ᎫᎴ ᏗᏍᎪᏂᎯᏱ", * "ロンドン", * "伦敦", * "倫敦", * "런던" * ], * "cc2": [], * "admin2_code": "GLA", * "modification_date": "2022-03-09T00:00:00.000Z", * "asciiname": "London", * "id": "geonames_2643743", * "feature_code": "PPLC", * "country_iso": "GBR", * "longitude": -0.12574, * "elevation": null, * "admin2_geonameid": 2648110, * "admin1_name": "England", * "population": "8961989", * "country_code": "GB", * "feature_class": "P", * "name": "London", * "admin3_code": "", * "dataset": "geonames" * } * }, * "code": 2000, * "message": "Success" * } */ ResolvePlaceResponse: { /** * Format: int32 * @enum {integer} */ code: 2000; /** @enum {string} */ message: "Success"; result: components["schemas"]["Place"]; }; /** * Licensee * @description Licensee object which can be defined by user */ LicenseeEditable: { /** * @description Licensee individual or organisation name * @example Qwerty Widgets Limited */ name?: string; /** * @description Licensee's first, second and third line address as well as post town concatenated by commas * @example 12 High Street, Manchester */ address?: string; /** * @description Licensee's postcode * @example ID1 1QD */ postcode?: string; /** @description A list of allowed URLs. An empty list means that whitelisting is disabled */ whitelist?: string[]; daily?: { /** * Format: int32 * @description The maximum number of lookups this licensee can perform in a day. `null` indicates the limit is not active * @example 10000 */ limit?: number | null; }; }; /** Licensee */ Licensee: components["schemas"]["LicenseeEditable"] & ({ /** * @description An immutable ID provided for every licensee. Primarily used for paginated list requests. * * @example 56a11209ebe230380bf104c3 */ id: string; /** * @description Uniquely identifies a licensee for a key. * * Required to perform paid lookups for a specific licensee. Typically begins `sk_`. * * @example sl_ijoiqsxeQgXW2gkiE0X94 */ key: string; /** * @description Timestamp for when the licensee was created * @example 2016-01-21T17:14:49.971Z */ createdAt: string; daily: { /** * Format: int32 * @description The number lookups performed by the licensee on the day represented b `licesees.daily.updatedAt` * @example 232 */ count: number; /** * @description The timestamp when the limit was last used. * @example 2016-08-05T16:43:28.865Z */ updatedAt: string; }; } & { name: unknown; address: unknown; postcode: unknown; whitelist: unknown; }); /** Licensee List Response */ LicenseesResponse: { /** @description List of licensees */ result: { licensees?: components["schemas"]["Licensee"][]; /** @description Returns true if there are more licensees listed after the maximum number of results as implied by `limit` */ hasMore?: boolean; }; /** @enum {string} */ message: "Success"; /** * Format: int32 * @enum {integer} */ code: 2000; }; /** Licensee Response */ LicenseeResponse: { result: components["schemas"]["Licensee"]; /** * Format: int32 * @enum {integer} */ code: 2000; /** @enum {string} */ message: "Success"; }; /** Config Object */ Config: { /** * @description Timestamp for when the config was created * @example 2016-01-21T17:14:49.971Z */ updatedAt: string; /** * @description Timestamp for when the config was updated * @example 2016-01-21T17:14:49.971Z */ createdAt: string; /** * @description A unique name to identify the configuration payload * @example woocommerce */ name: string; /** * @description A serialised payload of up to `4096` characters * @example { * "removeOrganisation": false * } */ payload: string; }; /** Config List Response */ ConfigsResponse: { /** @description List of configurations */ result: { configs: components["schemas"]["Config"][]; }; /** @enum {string} */ message: "Success"; /** * Format: int32 * @enum {integer} */ code: 2000; }; /** * New Config Object * @description Required configuration object parameters */ ConfigNewParam: { /** * @description A unique name to identify the configuration payload * @example woocommerce */ name: string; /** * @description A serialised payload of up to `4096` characters * @example { * "removeOrganisation": false * } */ payload: string; }; /** Config Response */ ConfigResponse: { result: components["schemas"]["Config"]; /** * Format: int32 * @enum {integer} */ code: 2000; /** @enum {string} */ message: "Success"; }; /** Not Found Response */ NotFoundResponse: components["schemas"]["ErrorResponse"] & { /** * Format: int32 * @description `404X` type error response code */ code: number; /** @description Resource not found error description */ message: string; }; /** * Update Config Object * @description Config object update parameters */ ConfigUpdateParam: { /** * @description A serialised payload of up to `4096` characters * @example { * "removeOrganisation": false * } */ payload?: string; }; /** Email Object */ Email: { /** @enum {string} */ result: "deliverable" | "not_deliverable"; /** @description Returns `true` if the email can be delivered */ deliverable: boolean; /** @description Returns `true` if email comes from a disposable email service like temp-mail */ disposable: boolean; /** @description Returns `true` if the email originates from a free service like Outlook or Gmail. */ free: boolean; /** @description Returns `true` if email address represents an organisational role like `admin`, `support`, `postmaster` etc */ role: boolean; /** @description Returns `true` if this domain accepts all emails regardless of username */ catchall: boolean; /** * @description Returns an array of suggested email addresses if the email address is not deliverable. The suggested emails are not validated. * @example [ * "corrected_email@example.com" * ] */ suggestions: string[]; }; /** Unknown Email Object */ UnknownEmail: { /** @enum {string} */ result: "unknown"; /** * @description Deliverability is not known * @enum {boolean|null} */ deliverable: null | null; /** * @description Disposability is not known * @enum {boolean|null} */ disposable: null | null; /** * @description Free email provider is not known * @enum {boolean|null} */ free: null | null; /** * @description Role is not known * @enum {boolean|null} */ role: null | null; /** * @description Catch-all status is not known * @enum {boolean|null} */ catchall: null | null; /** @description Suggestions will be empty */ suggestions: string[]; }; /** * Email Verification Response * @example { * "result": { * "result": "deliverable", * "deliverable": true, * "catchall": false, * "free": false, * "role": true, * "disposable": false, * "suggestions": [] * }, * "code": 2000, * "message": "Success" * } */ EmailResponse: { /** * Format: int32 * @enum {integer} */ code: 2000; /** @enum {string} */ message: "Success"; result: | components["schemas"]["Email"] | components["schemas"]["UnknownEmail"]; }; /** Carrier Object */ Carrier: { /** * Network Code * @description The [Mobile Country Code](https://en.wikipedia.org/wiki/Mobile_country_code) for the carrier. * @example 234 */ network_code: string | null; /** * Name * @description The full name of the carrier that number is associated with. * @example BT Group */ name: string | null; /** * Country ISO Alpha-2 Code * @description Country that number is associated with. In ISO 3166-1 alpha-2 format. * @example GB */ country: string | null; /** * Network Type * @description Type of network that number is associated with. * @enum {string|null} */ network_type: | ( | "mobile" | "landline" | "landline_premium" | "landline_tollfree" | "virtual" | "unknown" | "pager" | "mobile_or_landline" | "shared_cost" | "uan" | "voicemail" ) | null; } | null; /** Phone Number Object */ PhoneNumber: { /** @enum {boolean} */ valid: true; /** * @description Phone number formatted to local standard * @example 020 7112 8019 */ national_format: string; /** * @description Phone number formatted to international standard * @example 442071128019 */ international_format: string; /** * @description Country code in 3 letter ISO format * @example GBR */ iso_country: string; /** * @description Country code in 2 letter ISO format * @example GB */ iso_country_2: string; /** * @description Full country name * @example United Kingdom */ country: string; /** @description Representation of current phone carrier information like network code, name, country, network type */ current_carrier: components["schemas"]["Carrier"]; /** @description Representation of original phone carrier information like network code, name, country, network type */ original_carrier: components["schemas"]["Carrier"]; }; /** Invalid Phone Number Object */ InvalidPhoneNumber: { /** @enum {boolean} */ valid: false; /** * @description Phone number formatted to local standard * @enum {string|null} */ national_format: null | null; /** * @description Phone number formatted to international standard * @enum {string|null} */ international_format: null | null; /** * @description Country code in 3 letter ISO format * @enum {string|null} */ iso_country: null | null; /** * @description Country code in 2 letter ISO format * @enum {string|null} */ iso_country_2: null | null; /** * @description Full country name * @enum {string|null} */ country: null | null; /** * @description Representation of current phone carrier information like network code, name, country, network type * @enum {string|null} */ current_carrier?: null | null; /** * @description Representation of original phone carrier information like network code, name, country, network type * @enum {string|null} */ original_carrier?: null | null; }; /** * Phone Number Verification Response * @example { * "result": { * "valid": true, * "national_format": "020 7112 8019", * "international_format": "+44 20 7112 8019", * "iso_country": "GBR", * "iso_country_2": "GB", * "country": "United Kingdom", * "current_carrier": { * "network_code": null, * "name": "Invomo Ltd", * "country": "GB", * "network_type": "landline" * }, * "original_carrier": { * "network_code": null, * "name": "Invomo Ltd", * "country": "GB", * "network_type": "landline" * } * }, * "code": 2000, * "message": "Success" * } */ PhoneNumberResponse: { /** * Format: int32 * @enum {integer} */ code: 2000; /** @enum {string} */ message: "Success"; result: | components["schemas"]["PhoneNumber"] | components["schemas"]["InvalidPhoneNumber"]; }; }; parameters: { /** * @description **API Key** * * Your unique identifier that allows access to our APIs. * * Begins `ak_`. Available from your dashboard * * @example ak_test */ ApiKeyParam: string; /** * @description **Restrict Result Fields** * * Comma separated whitelist of address elements to return. * * E.g. `filter=line_1,line_2,line_3` returns only `line_1`, `line_2` and `line_3` address elements in your response * * @example line_1,line_2,line_3 */ FilterParam: string; /** * @description **Page** * * 0 indexed indicator of the page of results to receive. Virtually all postcode results are returned on page 0. * * A small number of Multiple Residence postcodes may need pagination (i.e. have more than 100 premises). * * @example 1 */ PageParam: number; /** * @description ** Tags ** * A comma separated list of tags to query over. * * Useful if you want to specify the circumstances in which the request was made. * * If multiple tags are specified, the response will only comprise of requests for which all the tags are satisfied - i.e. searching `"foo,bar"` will only query requests which tagged both `"foo"` and `"bar"`. * * @example foo,bar */ TagsParam: string; /** * @description **API Key** * * The API Key to retrieve. Begins `ak_`. * * @example ak_test */ ApiKeyPathParam: string; /** * @description **Private User Token** * * A secret key used for sensitive operations on your account and API Keys. * * Your user token can be retrieved and managed from your [accounts page](https://ideal-postcodes.co.uk/account). * * Typically beings `uk_...` * * @example uk_B59ScW1p1HHouf1VqclEPZUx */ UserTokenParam: string; /** * @description **Start Timestamp** * * A start date/time in the form of a UNIX Timestamp in milliseconds. E.g. `1418556452651` * * @example 1418556452651 */ StartParam: number; /** * @description **End Timestamp** * * An end date/time in the form of a UNIX Timestamp in milliseconds. E.g. `1418556477882` * * @example 1418556492651 */ EndParam: number; /** * @description **Licensee Key** * * Uniquely identifies a licensee. * * @example sl_hk71kco54zGSGvF9eXXrvvnMOLLNh */ LicenseeParam: string; /** * @description **Context** * * Limits search results, typically within a country. * * @example GBR */ ContextParam: string; /** * @description **Limit** * * Specifies the maximum number of records to retrieve. * * By default the limit is 10. Requesting a larger result set will result in more latency * * @example 5 */ LimitParam: number; /** * @description **Bias by Geolocation** * * Bias search to a geospatial circle determined by an origin and radius in meters. Max radius is `50000`. * Uses the format bias_lonlat=[longitude],[latitude],[radius in metres] * Only one geospatial bias may be provided * * @example -2.095,57.15,100 */ BiasLonLatParam: string; /** * @description **Bias by Geolocation of IP** * * Biases search based on approximate geolocation of IP address. * * Set `bias_ip=true` to enable. */ BiasIpParam: "true"; /** * @description **Filter by Bounding Box** * * Restrict search to a geospatial box determined by the "top-left" and "bottom-right" gelocations. * Only one geospatial box can be provided. * * @example 2.095,57.15,-2.096,57.14 */ BoxParam: string; /** * @description **Filter by Outward Code** * * Restrict result set to addresses with a matching outward code. * * The outward code is the first half of a postcode. E.g. the outward code for `SW1A 2AA` is `SW1A`. * * @example SW1A */ PostcodeOutwardParam: string; /** * @description **Filter by postcode** * Restrict result set to matching postcodes only. * Can be combined with query to perform a postcode and building number or name search. * @example SW1A 2AA */ PostcodeParam: string; /** * @description **Filter by Postcode Area** * * Postcode area represents the first one or two non-numeric characters of a postcode. E.g. the postcode area of `SW1A 2AA` is `SW`. * * Can be combined with query to perform a postcode and building search. * * @example SW */ PostcodeAreaParam: string; /** * @description **Filter by Postcode Sector** * * Postcode sector is the outward code plus first numeric of the inward code. E.g. postcode sector of `SW1A 2AA` is `SW1A 2` * * @example SW1A 2 */ PostcodeSectorParam: string; /** * @description **Filter by Town or City** * * Restrict addresses to matching town, city or other locality identifier. * * @example London */ PostTownParam: string; /** * @description **Filter by UPRN** * * Does not accept comma separated terms. Only a single term is permitted * * @example 100023336956 */ UPRNParam: number; /** * @description **Filter by country** * * Filters by country name. * * In the context of GBR, country values are not United Kingdom. Instead they are England, Scotland, Wales, Northern Ireland, Jersey, Guernsey and Isle of Man. * * @example England */ CountryParam: string; /** * @description **Filter by Postcode Type** * * Filter by Postcode Type. Useful for separating organisational and residential addresses */ PostcodeTypeParam: string; /** * @description **Filter by Organisation Indicator** * * Useful for separating organisational and residential addresses * * @example Y */ SmallUserParam: string; /** * @description **Bias by Outward Code** * Boosts addresses with a matching outward code. * Outward code is the first have of a postcode. For instance, the outward code of `SW1A 2AA` is `SW1A` * @example SW1A */ BiasPostcodeOutwardParam: string; /** * @description **Bias by postcode** * Boost addresses which match postcode. * Can be combined with query to perform a postcode and building number or name search. * @example SW1A2AA */ BiasPostcodeParam: string; /** * @description **Bias by Postcode Area** * * Boosts if the first one or two non-numeric characters of a postcode match * * The postcode area of SW1A 2AA and N1 6RT are SW and N respectively * * @example SW */ BiasPostcodeAreaParam: string; /** * @description **Bias by Postcode Sector** * * Boost postcode sector matches. The postcode sector comprises the outward code plus first numeric of the inward code. * * @example SW1A 2 */ BiasPostcodeSectorParam: string; /** * @description **Bias by Town or City** * * Biases results to matching town, city or other locality name. */ BiasPosttownParam: string; /** * @description **Bias by Street** * * Bias by street or thoroughfare name. */ BiasThoroughfareParam: string; /** * @description **Bias by Country** * * Possible values are England, Scotland, Wales, Northern Ireland, Jersey, Guernsey and Isle of Man. */ BiasCountryParam: string; /** * @description **Longitude** * * Longitude query for reverse geocoding. * * An accompanying latitude (lat=) query must be submitted for a valid reverse geocode query. * * @example -0.12767 */ AddressLongitudeParam: number; /** * @description **Latitude** * * Latitude query for reverse geocoding. * * An accompanying longitude (lon=) query must be submitted for a valid reverse geocode query. * * @example 51.503541 */ AddressLatitudeParam: number; /** * @description **Filter by Country** * * Filter by country ISO code. Uses 3 letter country code (ISO 3166-1) standard. * * Filter by multiple countries with a comma separated list. E.g. `GBR,IRL` * * @example GBR */ CountryIsoParam: string; /** * @description **Bias by Country** * Bias by country ISO code. Uses 3 letter country code (ISO 3166-1) standard. * Bias by multiple countries with a comma separated list. E.g. `GBR,IRL` * @example GBR */ BiasCountryIsoParam: string; /** * @description **Licensee Key** * * Uniquely identifies a licensee. * * @example sl_hk71kco54zGSGvF9eXXrvvnMOLLNh */ LicenseePathParam: string; /** * @description **Configuration Name** * * User provided configuration object name. * * @example idpc-be */ ConfigParam: string; }; } export interface operations { /** * Returns the complete list of addresses for a postcode. Postcode searches are space and case insensitive. * * The Postcode Lookup API provides a JSON interface to search UK addresses from a postcode. It can be used to power Postcode Lookup driven address searches, like [Postcode Lookup](/postcode-lookup). * * ## Postcode Not Found * * Lookup balance is unaffected by invalid postcodes. The API returns a `404` response with response body: * * ```json * { * "code": 4040, * "message": "Postcode not found", * "suggestions": ["SW1A 0AA"] * } * ``` * * ### Suggestions * * If a postcode cannot be found, the API will provide up to 5 closest matching postcodes. Common errors will be corrected first (e.g. mixing up `O` and `0` or `I` and `1`). * * If the suggestion list is small (fewer than 3), there is a high probability the correct postcode is there. You may notify the user or immediately trigger new searches. * * The suggestion list will be empty if the postcode has deviated too far from a valid postcode format. * * ## Multiple Residence * * A small number of postcodes will return more than 100 premises. These may require pagination. Use `page` to paginate the result set. */ Postcodes: { parameters: { path: { /** Postcode to retrieve */ postcode: string; }; query: { /** * **API Key** * * Your unique identifier that allows access to our APIs. * * Begins `ak_`. Available from your dashboard */ api_key?: components["parameters"]["ApiKeyParam"]; /** * **Restrict Result Fields** * * Comma separated whitelist of address elements to return. * * E.g. `filter=line_1,line_2,line_3` returns only `line_1`, `line_2` and `line_3` address elements in your response */ filter?: components["parameters"]["FilterParam"]; /** * **Page** * * 0 indexed indicator of the page of results to receive. Virtually all postcode results are returned on page 0. * * A small number of Multiple Residence postcodes may need pagination (i.e. have more than 100 premises). */ page?: components["parameters"]["PageParam"]; /** * ** Tags ** * A comma separated list of tags to query over. * * Useful if you want to specify the circumstances in which the request was made. * * If multiple tags are specified, the response will only comprise of requests for which all the tags are satisfied - i.e. searching `"foo,bar"` will only query requests which tagged both `"foo"` and `"bar"`. */ tags?: components["parameters"]["TagsParam"]; }; }; responses: { /** Success */ 200: { content: { "application/json": components["schemas"]["PostcodeResponse"]; }; }; /** Bad Request */ 400: { content: { "application/json": components["schemas"]["BadRequestResponse"]; }; }; /** Postcode Not Found */ 404: { content: { "application/json": components["schemas"]["PostcodeNotFoundResponse"]; }; }; }; }; /** * Returns an address as identified by its Unique Delivery Point Reference Number (UDPRN). * * You may find it useful to store UDPRN information as it can be used to retrieve the most recent information for an address. It can also be used to test for a deleted address. * * UDPRNs are an eight digit unique numeric code (e.g. `25962203`) for any premise on the Postcode Address File. It's essentially a unique identifier for every address in the UK that Royal Mail has in its database. * * ## Testing * * To test your implementation of our API we have a range of test UDPRNs that yield both successful and unsuccessful responses to your request. * * They are the following: * * - `0` Returns a successful UDPRN lookup response * `2000` * - `-1` Returns "UDPRN not found", error `4044` * - `-2` Returns "no lookups remaining", error `4020` * - `-3` Returns "daily (or individual) lookup limit breached", * error `4021` * * Test request undergo the usual authentication and restriction rules. This is to help surface any issues that occur during implementation and does not cost you a lookup. */ UDPRN: { parameters: { path: { /** UDPRN to be retrieved */ udprn: string; }; query: { /** * **API Key** * * Your unique identifier that allows access to our APIs. * * Begins `ak_`. Available from your dashboard */ api_key?: components["parameters"]["ApiKeyParam"]; /** * **Restrict Result Fields** * * Comma separated whitelist of address elements to return. * * E.g. `filter=line_1,line_2,line_3` returns only `line_1`, `line_2` and `line_3` address elements in your response */ filter?: components["parameters"]["FilterParam"]; }; }; responses: { /** Success */ 200: { content: { "application/json": components["schemas"]["UDPRNResponse"]; }; }; /** Resource not found */ 404: { content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; }; }; /** * Returns a multiple occupancy address identifited via its UMPRN (Multiple Residence Unique ID). * * UMPRNs are a unique numeric code for any Multiple Residence household on the optional Multiple Residence dataset. * * ## Testing * * To test your implementation of our API we have a range of test UMPRNs that yield both successful and unsuccessful responses to your request. They are the following * * - `0` Returns a successful UMPRN lookup response `2000` * - `-1` Returns "UMPRN not found", error `4044` * - `-2` Returns "no lookups remaining", error `4020` * - `-3` Returns "daily (or individual) lookup limit breached", error `4021` * * Test request undergo the usual authentication and restriction rules. This is to help surface any issues that occur during implementation and does not cost you a lookup. * * ### Pricing * * Per lookup charges apply. Empty responses are not charged. */ UMPRN: { parameters: { path: { /** UMPRN to be retrieved */ umprn: string; }; query: { /** * **API Key** * * Your unique identifier that allows access to our APIs. * * Begins `ak_`. Available from your dashboard */ api_key?: components["parameters"]["ApiKeyParam"]; /** * **Restrict Result Fields** * * Comma separated whitelist of address elements to return. * * E.g. `filter=line_1,line_2,line_3` returns only `line_1`, `line_2` and `line_3` address elements in your response */ filter?: components["parameters"]["FilterParam"]; }; }; responses: { /** Success */ 200: { content: { "application/json": components["schemas"]["UMPRNResponse"]; }; }; /** Resource not found */ 404: { content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; }; }; /** * Returns public information on your API Key. * * This endpoint can be used for the following: * - Determine if the key is currently useable via the `available` property * - Determine available contexts for a an API Key * - Identify the currently likely context of a user given their location * * You may pass both API Keys (beginning `ak_`) and Sub-licensed Keys (beginning `sl_`). */ KeyAvailability: { parameters: { path: { /** * **API Key** * * The API Key to retrieve. Begins `ak_`. */ key: components["parameters"]["ApiKeyPathParam"]; }; }; responses: { /** Success */ 200: { content: { "application/json": components["schemas"]["ApiKeyResponse"]; }; }; /** Invalid Key */ 404: { content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; }; }; /** Returns private data on the key including remaining lookups, available datasets and usage limits. */ KeyDetails: { parameters: { path: { /** * **API Key** * * The API Key to retrieve. Begins `ak_`. */ key: components["parameters"]["ApiKeyPathParam"]; }; query: { /** * **Private User Token** * * A secret key used for sensitive operations on your account and API Keys. * * Your user token can be retrieved and managed from your [accounts page](https://ideal-postcodes.co.uk/account). * * Typically beings `uk_...` */ user_token?: components["parameters"]["UserTokenParam"]; }; }; responses: { /** Success */ 200: { content: { "application/json": components["schemas"]["ApiKeyDetailsResponse"]; }; }; /** Unauthorised */ 401: { content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; /** Resource not found */ 404: { content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; }; }; /** Update API Key Details */ UpdateKeyDetails: { parameters: { path: { /** * **API Key** * * The API Key to retrieve. Begins `ak_`. */ key: components["parameters"]["ApiKeyPathParam"]; }; query: { /** * **Private User Token** * * A secret key used for sensitive operations on your account and API Keys. * * Your user token can be retrieved and managed from your [accounts page](https://ideal-postcodes.co.uk/account). * * Typically beings `uk_...` */ user_token?: components["parameters"]["UserTokenParam"]; }; }; responses: { /** Success */ 200: { content: { "application/json": components["schemas"]["ApiKeyDetailsResponse"]; }; }; /** Bad Request */ 400: { content: { "application/json": components["schemas"]["BadRequestResponse"]; }; }; /** Unauthorised */ 401: { content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; /** Resource not found */ 404: { content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; }; requestBody: { content: { "application/json": components["schemas"]["ApiKeyDetailsEditable"]; }; }; }; /** * Reports the number of lookups consumed on a key for a range of days. * * A maximum interval of 90 days can be provided for analysis. If no start or end date is provided, the last 21 days will be used as the default interval. * * If no `start` time is provided, the start time will be set to 21 days prior to the current time. * * If no `end` time is provided, the current time will be used. * * Append `tags` to scope the number of lookups to those with matching tag values. E.g. `tags=foo,bar` will only count transactions that match `foo` and `bar`. */ KeyUsage: { parameters: { path: { /** * **API Key** * * The API Key to retrieve. Begins `ak_`. */ key: components["parameters"]["ApiKeyPathParam"]; }; query: { /** * **Private User Token** * * A secret key used for sensitive operations on your account and API Keys. * * Your user token can be retrieved and managed from your [accounts page](https://ideal-postcodes.co.uk/account). * * Typically beings `uk_...` */ user_token?: components["parameters"]["UserTokenParam"]; /** * **Start Timestamp** * * A start date/time in the form of a UNIX Timestamp in milliseconds. E.g. `1418556452651` */ start?: components["parameters"]["StartParam"]; /** * **End Timestamp** * * An end date/time in the form of a UNIX Timestamp in milliseconds. E.g. `1418556477882` */ end?: components["parameters"]["EndParam"]; /** * ** Tags ** * A comma separated list of tags to query over. * * Useful if you want to specify the circumstances in which the request was made. * * If multiple tags are specified, the response will only comprise of requests for which all the tags are satisfied - i.e. searching `"foo,bar"` will only query requests which tagged both `"foo"` and `"bar"`. */ tags?: components["parameters"]["TagsParam"]; /** * **Licensee Key** * * Uniquely identifies a licensee. */ licensee?: components["parameters"]["LicenseeParam"]; }; }; responses: { /** Success */ 200: { content: { "application/json": components["schemas"]["ApiKeyUsageResponse"]; }; }; /** Bad Request */ 400: { content: { "application/json": components["schemas"]["BadRequestResponse"]; }; }; }; }; /** * Reports lookup information on a key for paid lookups. * * This method requires a `user_token`, which can be found on your [accounts page](https://ideal-postcodes.co.uk/account). * * A maximum interval of 90 days can be provided for analysis. If no start or end date is provided, the last 21 days will be used as the default interval. * * ## Download Usage History (CSV) * * `GET /keys/:key/lookups` * * Returns a CSV download of lookups performed and associated information. * * Note that the Content-Type returned will be CSV (text/csv). For a non 200 response, the `Content-Type` will revert to JSON with the error code and message embedded. * * ## Data Redaction * * Personally Identifiable Data (PII) caught in this your usage log (including IP, search term and URL data) will be redacted on a weekly basis. * * By default, PII will be redacted if it is older than 21 days. This timeframe can be configured from your dashboard. * * You may prevent PII collection altogether by setting the interval to `0` days. */ KeyLogs: { parameters: { path: { /** * **API Key** * * The API Key to retrieve. Begins `ak_`. */ key: components["parameters"]["ApiKeyPathParam"]; }; query: { /** * **Private User Token** * * A secret key used for sensitive operations on your account and API Keys. * * Your user token can be retrieved and managed from your [accounts page](https://ideal-postcodes.co.uk/account). * * Typically beings `uk_...` */ user_token?: components["parameters"]["UserTokenParam"]; /** * **Start Timestamp** * * A start date/time in the form of a UNIX Timestamp in milliseconds. E.g. `1418556452651` */ start?: components["parameters"]["StartParam"]; /** * **End Timestamp** * * An end date/time in the form of a UNIX Timestamp in milliseconds. E.g. `1418556477882` */ end?: components["parameters"]["EndParam"]; /** * **Licensee Key** * * Uniquely identifies a licensee. */ licensee?: components["parameters"]["LicenseeParam"]; }; }; responses: { /** Success */ 200: { content: { "text/csv": string; }; }; /** Bad Request */ 400: { content: { "application/json": components["schemas"]["BadRequestResponse"]; }; }; }; }; /** * 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 organistation 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 ambigious 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 throroughfare or building name only? Are accurate organisation names an important feature? */ AddressCleanse: { parameters: { query: { /** * **API Key** * * Your unique identifier that allows access to our APIs. * * Begins `ak_`. Available from your dashboard */ api_key?: components["parameters"]["ApiKeyParam"]; /** * ** Tags ** * A comma separated list of tags to query over. * * Useful if you want to specify the circumstances in which the request was made. * * If multiple tags are specified, the response will only comprise of requests for which all the tags are satisfied - i.e. searching `"foo,bar"` will only query requests which tagged both `"foo"` and `"bar"`. */ tags?: components["parameters"]["TagsParam"]; /** Identify the country of the address to cleanse. Defaults to UK (GBR) */ context?: string; }; }; responses: { /** Success */ 200: { content: { "application/json": components["schemas"]["CleanseResponse"]; }; }; /** Bad Request */ 400: { content: { "application/json": components["schemas"]["BadRequestResponse"]; }; }; /** Unauthorized */ 401: { content: { "application/json": components["schemas"]["UnauthorizedResponse"]; }; }; /** Rate Limited */ 429: { content: { "application/json": components["schemas"]["RateLimitedResponse"]; }; }; }; requestBody: { content: { "application/json": { /** * @description Freeform address input to cleanse * * @example 10 Downing Street, London, SW2A 2BN */ query: string; /** * @description Optionally specify postal code for the address. * * @example SW1A 2BN */ postcode?: string; /** * @description 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. * * @example London */ post_town?: string; /** * @description 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. * * @example Kent */ county?: string; }; }; }; }; /** * The address verify API validates, corrects, and standardizes individual addresses based on USPS's Coding Accuracy Support System (CASS). * * The address verify API accepts the 3 combination of inputs: * * - Free-form address submitted as a single string in `query` * - Example: "123 Main St, Springfield, CO 81073-1119" * - Only free-form and zip code address components submitted as separate parameters: * - `query` for the street address * - `zip_code` for the ZIP code * - Example: * - `query`: "123 Main St, Springfield CO" * - `zip_code`: "81073-1119" * - Only free-form, city and state address components submitted as separate parameters: * - `query` for the street address * - `city` for the city * - `state` for the state * - Example: * - `query`: "123 Main St" * - `city`: "Springfield" * - `state`: "CO" */ AddressVerify: { parameters: { query: { /** * **API Key** * * Your unique identifier that allows access to our APIs. * * Begins `ak_`. Available from your dashboard */ api_key?: components["parameters"]["ApiKeyParam"]; /** * ** Tags ** * A comma separated list of tags to query over. * * Useful if you want to specify the circumstances in which the request was made. * * If multiple tags are specified, the response will only comprise of requests for which all the tags are satisfied - i.e. searching `"foo,bar"` will only query requests which tagged both `"foo"` and `"bar"`. */ tags?: components["parameters"]["TagsParam"]; /** Identify the country of the address to verify. Defaults to United States (USA) */ context?: string; }; }; responses: { /** Success */ 200: { content: { "application/json": components["schemas"]["VerifyResponse"]; }; }; /** Bad Request */ 400: { content: { "application/json": components["schemas"]["BadRequestResponse"]; }; }; /** Unauthorized */ 401: { content: { "application/json": components["schemas"]["UnauthorizedResponse"]; }; }; /** Rate Limited */ 429: { content: { "application/json": components["schemas"]["RateLimitedResponse"]; }; }; }; requestBody: { content: { "application/json": { /** * @description Freeform address input to verify. * * Can be submitted standalone, or with the following address components: * - `zip_code` * - `city` and `state` * * @example 123 Main St, Springfield, CO 81073 */ query: string; /** * @description Specify the zip code of an address. The following formats are accepted: `81073-1119`, `810731119`, `81073`. * * @example 81073-1119 */ zip_code?: string; /** * @description City of an address. For the US, this should be the city name. * * @example Springfield */ city?: string; /** * @description State of an address. For the US, this should be in the 2 letter state abbreviation format. * * @example CO */ state?: string; }; }; }; }; /** * The Address Autocomplete API delivers address suggestions in order of relevance based on a provided query. It aids real-time address autofill implementations. * * Consider using our Address Autocomplete JavaScript libraries to add address lookup to a form in moments rather than interacting with this API directly. * * ## API Usage * * Implementing our Address Autocomplete API involves: * * 1. Fetch address suggestions with `/autocomplete/addresses` * 2. Acquire the complete address using the ID from the suggestion * * Step 2 will decrement your lookup balance. * * Note that step 1 is not a free standalone resource. Integrations that consistently make autocomplete requests without a paid Step 2 request will be rate limited and then suspended. * * ## Query Filters * * Refine results by appending filters to your querystring, e.g., `postcode=sw1a2aa` for postcode `SW1A 2AA`. Invalid filters return an empty set without affecting your lookup count. * * To apply multiple filter terms, use a comma-separated list, e.g., `postcode_outward=e1,e2,e3` combines result sets for E1, E2, and E3. Unless otherwise specified, all filters support multiple terms. * * Combine filters by `AND` logic, for instance, `su_organisation_indicator=Y&postcode_area=n`. The maximum allowed filter terms is **10**. * * ## Address Bias * * Preface bias searches with `bias_` to boost certain address results. Unlike filters, biasing allows unmatched addresses to appear with lower priority. * * For example, use `bias_postcode_area=SW,SE` to favor addresses in the `SW` and `SE` postcode areas. Invalid bias terms have no effect. * * Multiple bias terms are allowed unless stated otherwise, with a combined maximum of **5**. * * ## Suggestion Format * * The suggestion format is subject to change. We recommend using the suggestion as-is to prevent potential integration issues. * * ## Rate Limiting and Cost * * The rate limit for the Autocomplete API is 3000 requests per 5 minutes. HTTP Headers inform about the current rate limit. * * Autocomplete API usage does not impact your balance, but resolving a suggestion to a full address requires a paid request. Autocomplete requests without subsequent paid requests may result in rate limitation or suspension. */ FindAddress: { parameters: { query: { /** * **API Key** * * Your unique identifier that allows access to our APIs. * * Begins `ak_`. Available from your dashboard */ api_key?: components["parameters"]["ApiKeyParam"]; /** * **Address Query** * * The partial address string entered by the user to autocomplete. */ query?: string; /** * **Context** * * Limits search results, typically within a country. */ context?: components["parameters"]["ContextParam"]; /** * **Limit** * * Specifies the maximum number of records to retrieve. * * By default the limit is 10. Requesting a larger result set will result in more latency */ limit?: components["parameters"]["LimitParam"]; /** * **Bias by Geolocation** * * Bias search to a geospatial circle determined by an origin and radius in meters. Max radius is `50000`. * Uses the format bias_lonlat=[longitude],[latitude],[radius in metres] * Only one geospatial bias may be provided */ bias_lonlat?: components["parameters"]["BiasLonLatParam"]; /** * **Bias by Geolocation of IP** * * Biases search based on approximate geolocation of IP address. * * Set `bias_ip=true` to enable. */ bias_ip?: components["parameters"]["BiasIpParam"]; /** * **Filter by Bounding Box** * * Restrict search to a geospatial box determined by the "top-left" and "bottom-right" gelocations. * Only one geospatial box can be provided. */ box?: components["parameters"]["BoxParam"]; /** * **Filter by Outward Code** * * Restrict result set to addresses with a matching outward code. * * The outward code is the first half of a postcode. E.g. the outward code for `SW1A 2AA` is `SW1A`. */ postcode_outward?: components["parameters"]["PostcodeOutwardParam"]; /** * **Filter by postcode** * Restrict result set to matching postcodes only. * Can be combined with query to perform a postcode and building number or name search. */ postcode?: components["parameters"]["PostcodeParam"]; /** * **Filter by Postcode Area** * * Postcode area represents the first one or two non-numeric characters of a postcode. E.g. the postcode area of `SW1A 2AA` is `SW`. * * Can be combined with query to perform a postcode and building search. */ postcode_area?: components["parameters"]["PostcodeAreaParam"]; /** * **Filter by Postcode Sector** * * Postcode sector is the outward code plus first numeric of the inward code. E.g. postcode sector of `SW1A 2AA` is `SW1A 2` */ postcode_sector?: components["parameters"]["PostcodeSectorParam"]; /** * **Filter by Town or City** * * Restrict addresses to matching town, city or other locality identifier. */ post_town?: components["parameters"]["PostTownParam"]; /** * **Filter by UPRN** * * Does not accept comma separated terms. Only a single term is permitted */ uprn?: components["parameters"]["UPRNParam"]; /** * **Filter by country** * * Filters by country name. * * In the context of GBR, country values are not United Kingdom. Instead they are England, Scotland, Wales, Northern Ireland, Jersey, Guernsey and Isle of Man. */ country?: components["parameters"]["CountryParam"]; /** * **Filter by Postcode Type** * * Filter by Postcode Type. Useful for separating organisational and residential addresses */ postcode_type?: components["parameters"]["PostcodeTypeParam"]; /** * **Filter by Organisation Indicator** * * Useful for separating organisational and residential addresses */ su_organisation_indicator?: components["parameters"]["SmallUserParam"]; /** * **Bias by Outward Code** * Boosts addresses with a matching outward code. * Outward code is the first have of a postcode. For instance, the outward code of `SW1A 2AA` is `SW1A` */ bias_postcode_outward?: components["parameters"]["BiasPostcodeOutwardParam"]; /** * **Bias by postcode** * Boost addresses which match postcode. * Can be combined with query to perform a postcode and building number or name search. */ bias_postcode?: components["parameters"]["BiasPostcodeParam"]; /** * **Bias by Postcode Area** * * Boosts if the first one or two non-numeric characters of a postcode match * * The postcode area of SW1A 2AA and N1 6RT are SW and N respectively */ bias_postcode_area?: components["parameters"]["BiasPostcodeAreaParam"]; /** * **Bias by Postcode Sector** * * Boost postcode sector matches. The postcode sector comprises the outward code plus first numeric of the inward code. */ bias_postcode_sector?: components["parameters"]["BiasPostcodeSectorParam"]; /** * **Bias by Town or City** * * Biases results to matching town, city or other locality name. */ bias_post_town?: components["parameters"]["BiasPosttownParam"]; /** * **Bias by Street** * * Bias by street or thoroughfare name. */ bias_thoroughfare?: components["parameters"]["BiasThoroughfareParam"]; /** * **Bias by Country** * * Possible values are England, Scotland, Wales, Northern Ireland, Jersey, Guernsey and Isle of Man. */ bias_country?: components["parameters"]["BiasCountryParam"]; }; }; responses: { /** Success */ 200: { headers: { /** The maximum number of requests that can be made in 5 minutes */ "X-RateLimit-Limit"?: number; /** The remaining requests within the current rate limit window */ "X-RateLimit-Remaining"?: number; /** The time when the rate limit window resets in Unix Time (seconds) or UTC Epoch seconds. */ "X-RateLimit-Reset"?: number; }; content: { "application/json": components["schemas"]["AutocompleteResponse"]; }; }; /** Bad Request */ 400: { content: { "application/json": components["schemas"]["BadRequestResponse"]; }; }; }; }; /** * Resolves an address autocompletion by its address ID. * * Resolved addresses (including global addresses) are returned in a UK format (up to 3 address lines) using UK nomenclature (like postcode and county). */ ResolveAddress: { parameters: { path: { /** * **ID of address suggestion** * * ID of address suggestion provided by the API to fully resolve. */ address: string; }; query: { /** * **API Key** * * Your unique identifier that allows access to our APIs. * * Begins `ak_`. Available from your dashboard */ api_key?: components["parameters"]["ApiKeyParam"]; /** * ** Tags ** * A comma separated list of tags to query over. * * Useful if you want to specify the circumstances in which the request was made. * * If multiple tags are specified, the response will only comprise of requests for which all the tags are satisfied - i.e. searching `"foo,bar"` will only query requests which tagged both `"foo"` and `"bar"`. */ tags?: components["parameters"]["TagsParam"]; }; }; responses: { /** Success */ 200: { content: { "application/json": components["schemas"]["GbrResolveAddressResponse"]; }; }; /** Resource not found */ 404: { content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; }; }; /** * Resolves an address autocompletion by its address ID. * * Resolved addresses (including global addresses) are returned in a US format (up to 2 address lines) using US nomenclature (like zipcode, state and city). */ RetrieveAddress: { parameters: { path: { /** * **ID of address suggestion** * * ID of address suggestion provided by the API to fully retrieve. */ address: string; }; query: { /** * **API Key** * * Your unique identifier that allows access to our APIs. * * Begins `ak_`. Available from your dashboard */ api_key?: components["parameters"]["ApiKeyParam"]; /** * ** Tags ** * A comma separated list of tags to query over. * * Useful if you want to specify the circumstances in which the request was made. * * If multiple tags are specified, the response will only comprise of requests for which all the tags are satisfied - i.e. searching `"foo,bar"` will only query requests which tagged both `"foo"` and `"bar"`. */ tags?: components["parameters"]["TagsParam"]; }; }; responses: { /** Success */ 200: { content: { "application/json": components["schemas"]["UsaResolveAddressResponse"]; }; }; /** Resource not found */ 404: { content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; }; }; /** * Extract a list of complete addresses that match the query ordered by relevance score. This query accepts an optional limit and page query (defaults to 10 and 0 respectively). * * If a valid postcode is passed as the query string, the entire address list for that postcode is passed as a result. Note, in these cases, limit and page parameters are ignored. * * This API is designed as a multi-purpose tool for generating address lists, cleansing and wholesale data extraction according to specific parameters. * * For address autocomplete, see our address finder API - which is designed for speed and address completion. * * ## Reverse Geocoding * * Return a list of addresses around a point using the lon= and lat= querystring arguments. Addresses will be sorted in order of distance to the point. The search radius is 100m. * * ## Filters * * You can strictly narrow your result by adding filters to your query string which correspond with an address attribute. * * For instance, you can restrict to postcode `SW1A 2AA` by appending `postcode=sw1a2aa`. * * If a filter term is invalid, e.g. `postcode=SW1A2AAA`, then an empty result set is returned and no lookup is incurred. * * You can also scope using multiple terms for the same filter with a comma separated list of terms. E.g. Restrict results to E1, E2 and E3 outward codes: `postcode_outward=e1,e2,e3`. Multiple terms are `OR`'ed, i.e. the matching result sets are combined. * * All filters can accept multiple terms unless stated otherwise below. * * Multiple filters can also be combined. E.g. Restrict results to small user organisations in the N postcode area: `su_organisation_indicator=Y&postcode_area=n`. Multiple filters are `AND`'ed, i.e. each additional filter narrows the result set. * * A combined maximum of 5 terms are allowed across all filters. * * ## Biases * * You can boost certain addresses results that correspond with a certain address attribute. All bias searches are prefixed with `bias_`. * * Biased searches, unlike filtered searches, also allow unmatched addresses to appear . These will rank lower. * * For instance, you can boost addresses with postcode areas `SW` and `SE` by appending `bias_postcode_area=SW,SE`. * * If a bias term is invalid, e.g. `bias_postcode=SW1A2AAA` no bias effect is applied. * * You may scope using multiple terms for the same bias with a comma separated list of terms. E.g. Restrict results to `E1`, `E2` and `E3` outward codes: `bias_postcode_outward=e1,e2,e3`. * * All biases can accept multiple terms unless stated otherwise below. * * A combined maximum of 5 terms are allowed across all biases. * * ## Search by Postcode and Building Name or Number * * Search by postcode and building attribute with the postcode filter and query argument. E.g. For "SW1A 2AA Prime Minister" `/v1/addresses?postcode=sw1a2aa&q=prime minister`. * * The advantage of using filters is a postcode mismatch does not result in a lookup as no results are returned. * * #### Search By UPRN * * Search by UPRN using the `uprn` filter and excluding the query argument. E.g. `/v1/addresses?uprn=100`. * * ## Testing * * - **ID1 1QD** Returns a successful query response `2000` * - **ID1 KFA** Returns an empty query response `2000` * - **ID1 CLIP** Returns "no lookups remaining" error `4020` * - **ID1 CHOP** Returns "daily (or individual) lookup limit breached" error `4021` * * Test request undergo the usual authentication and restriction rules. This is to help surface any issues that occur during implementation and does not cost you a lookup. */ Addresses: { parameters: { query: { /** * **API Key** * * Your unique identifier that allows access to our APIs. * * Begins `ak_`. Available from your dashboard */ api_key?: components["parameters"]["ApiKeyParam"]; /** Specifies the address you wish to query. */ query?: string; /** * **Limit** * * Specifies the maximum number of records to retrieve. * * By default the limit is 10. Requesting a larger result set will result in more latency */ limit?: components["parameters"]["LimitParam"]; /** * **Page** * * 0 indexed indicator of the page of results to receive. Virtually all postcode results are returned on page 0. * * A small number of Multiple Residence postcodes may need pagination (i.e. have more than 100 premises). */ page?: components["parameters"]["PageParam"]; /** * **Restrict Result Fields** * * Comma separated whitelist of address elements to return. * * E.g. `filter=line_1,line_2,line_3` returns only `line_1`, `line_2` and `line_3` address elements in your response */ filter?: components["parameters"]["FilterParam"]; /** * **Longitude** * * Longitude query for reverse geocoding. * * An accompanying latitude (lat=) query must be submitted for a valid reverse geocode query. */ lon?: components["parameters"]["AddressLongitudeParam"]; /** * **Latitude** * * Latitude query for reverse geocoding. * * An accompanying longitude (lon=) query must be submitted for a valid reverse geocode query. */ lat?: components["parameters"]["AddressLatitudeParam"]; /** * **Filter by Outward Code** * * Restrict result set to addresses with a matching outward code. * * The outward code is the first half of a postcode. E.g. the outward code for `SW1A 2AA` is `SW1A`. */ postcode_outward?: components["parameters"]["PostcodeOutwardParam"]; /** * **Filter by postcode** * Restrict result set to matching postcodes only. * Can be combined with query to perform a postcode and building number or name search. */ postcode?: components["parameters"]["PostcodeParam"]; /** * **Filter by Postcode Area** * * Postcode area represents the first one or two non-numeric characters of a postcode. E.g. the postcode area of `SW1A 2AA` is `SW`. * * Can be combined with query to perform a postcode and building search. */ postcode_area?: components["parameters"]["PostcodeAreaParam"]; /** * **Filter by Postcode Sector** * * Postcode sector is the outward code plus first numeric of the inward code. E.g. postcode sector of `SW1A 2AA` is `SW1A 2` */ postcode_sector?: components["parameters"]["PostcodeSectorParam"]; /** * **Filter by Town or City** * * Restrict addresses to matching town, city or other locality identifier. */ post_town?: components["parameters"]["PostTownParam"]; /** * **Filter by UPRN** * * Does not accept comma separated terms. Only a single term is permitted */ uprn?: components["parameters"]["UPRNParam"]; /** * **Filter by country** * * Filters by country name. * * In the context of GBR, country values are not United Kingdom. Instead they are England, Scotland, Wales, Northern Ireland, Jersey, Guernsey and Isle of Man. */ country?: components["parameters"]["CountryParam"]; /** * **Filter by Postcode Type** * * Filter by Postcode Type. Useful for separating organisational and residential addresses */ postcode_type?: components["parameters"]["PostcodeTypeParam"]; /** * **Filter by Organisation Indicator** * * Useful for separating organisational and residential addresses */ su_organisation_indicator?: components["parameters"]["SmallUserParam"]; /** * **Filter by Bounding Box** * * Restrict search to a geospatial box determined by the "top-left" and "bottom-right" gelocations. * Only one geospatial box can be provided. */ box?: components["parameters"]["BoxParam"]; /** * **Bias by Outward Code** * Boosts addresses with a matching outward code. * Outward code is the first have of a postcode. For instance, the outward code of `SW1A 2AA` is `SW1A` */ bias_postcode_outward?: components["parameters"]["BiasPostcodeOutwardParam"]; /** * **Bias by postcode** * Boost addresses which match postcode. * Can be combined with query to perform a postcode and building number or name search. */ bias_postcode?: components["parameters"]["BiasPostcodeParam"]; /** * **Bias by Postcode Area** * * Boosts if the first one or two non-numeric characters of a postcode match * * The postcode area of SW1A 2AA and N1 6RT are SW and N respectively */ bias_postcode_area?: components["parameters"]["BiasPostcodeAreaParam"]; /** * **Bias by Postcode Sector** * * Boost postcode sector matches. The postcode sector comprises the outward code plus first numeric of the inward code. */ bias_postcode_sector?: components["parameters"]["BiasPostcodeSectorParam"]; /** * **Bias by Town or City** * * Biases results to matching town, city or other locality name. */ bias_post_town?: components["parameters"]["BiasPosttownParam"]; /** * **Bias by Street** * * Bias by street or thoroughfare name. */ bias_thoroughfare?: components["parameters"]["BiasThoroughfareParam"]; /** * **Bias by Country** * * Possible values are England, Scotland, Wales, Northern Ireland, Jersey, Guernsey and Isle of Man. */ bias_country?: components["parameters"]["BiasCountryParam"]; /** * **Bias by Geolocation** * * Bias search to a geospatial circle determined by an origin and radius in meters. Max radius is `50000`. * Uses the format bias_lonlat=[longitude],[latitude],[radius in metres] * Only one geospatial bias may be provided */ bias_lonlat?: components["parameters"]["BiasLonLatParam"]; /** * ** Tags ** * A comma separated list of tags to query over. * * Useful if you want to specify the circumstances in which the request was made. * * If multiple tags are specified, the response will only comprise of requests for which all the tags are satisfied - i.e. searching `"foo,bar"` will only query requests which tagged both `"foo"` and `"bar"`. */ tags?: components["parameters"]["TagsParam"]; }; }; responses: { /** Success */ 200: { content: { "application/json": components["schemas"]["AddressResponse"]; }; }; /** Bad Request */ 400: { content: { "application/json": components["schemas"]["BadRequestResponse"]; }; }; /** Postcode Not Found */ 404: { content: { "application/json": components["schemas"]["PostcodeNotFoundResponse"]; }; }; }; }; /** * Query for geographical places across countries. Each query will return a list of place suggestions, which consists of a place name, descriptive name and id. * * This API returns geographical information such as countries, capitals, administrative areas and more. It is ideal for correctly identifying a place along with any other details like geolocation. * * ## Implementing Place Autocomplete * * Extracting the full information of a place is a 2 step process: * * 1. Retrieve place suggestions via /places * 2. Retrieve the entire place with the ID provided in the suggestion * * ## Suggestion Format * * Each place suggestion contains a descriptive name which you can provide to users to uniquely idenfity a place. * * ## Rate Limiting and Cost * * The rate limit for the Autocomplete API is 3000 requests per 5 minutes. HTTP Headers inform about the current rate limit. * * Autocomplete API usage does not impact your balance, but resolving a suggestion to a full address requires a paid request. Autocomplete requests without subsequent paid requests may result in rate limitation or suspension. */ FindPlace: { parameters: { query: { /** * **API Key** * * Your unique identifier that allows access to our APIs. * * Begins `ak_`. Available from your dashboard */ api_key?: components["parameters"]["ApiKeyParam"]; /** Specifies the place you wish to query. Query can be shortened to `q=` */ query?: string; /** * **Filter by Country** * * Filter by country ISO code. Uses 3 letter country code (ISO 3166-1) standard. * * Filter by multiple countries with a comma separated list. E.g. `GBR,IRL` */ country_iso?: components["parameters"]["CountryIsoParam"]; /** * **Bias by Country** * Bias by country ISO code. Uses 3 letter country code (ISO 3166-1) standard. * Bias by multiple countries with a comma separated list. E.g. `GBR,IRL` */ bias_country_iso?: components["parameters"]["BiasCountryIsoParam"]; /** * **Bias by Geolocation** * * Bias search to a geospatial circle determined by an origin and radius in meters. Max radius is `50000`. * Uses the format bias_lonlat=[longitude],[latitude],[radius in metres] * Only one geospatial bias may be provided */ bias_lonlat?: components["parameters"]["BiasLonLatParam"]; /** * **Bias by Geolocation of IP** * * Biases search based on approximate geolocation of IP address. * * Set `bias_ip=true` to enable. */ bias_ip?: components["parameters"]["BiasIpParam"]; }; }; responses: { /** Success */ 200: { headers: { /** The maximum number of requests that can be made in 5 minutes */ "X-RateLimit-Limit"?: number; /** The remaining requests within the current rate limit window */ "X-RateLimit-Remaining"?: number; /** The time when the rate limit window resets in Unix Time (seconds) or UTC Epoch seconds. */ "X-RateLimit-Reset"?: number; }; content: { "application/json": components["schemas"]["PlaceResponse"]; }; }; /** Bad Request */ 400: { content: { "application/json": components["schemas"]["BadRequestResponse"]; }; }; }; }; /** Resolves a place autocompletion by its place ID. */ ResolvePlace: { parameters: { path: { /** ID of place suggestion */ place: string; }; query: { /** * **API Key** * * Your unique identifier that allows access to our APIs. * * Begins `ak_`. Available from your dashboard */ api_key?: components["parameters"]["ApiKeyParam"]; /** * ** Tags ** * A comma separated list of tags to query over. * * Useful if you want to specify the circumstances in which the request was made. * * If multiple tags are specified, the response will only comprise of requests for which all the tags are satisfied - i.e. searching `"foo,bar"` will only query requests which tagged both `"foo"` and `"bar"`. */ tags?: components["parameters"]["TagsParam"]; }; }; responses: { /** Success */ 200: { content: { "application/json": components["schemas"]["ResolvePlaceResponse"]; }; }; /** Resource not found */ 404: { content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; }; }; /** Returns a list of licensees for a key. */ ListLicensees: { parameters: { path: { /** * **API Key** * * The API Key to retrieve. Begins `ak_`. */ key: components["parameters"]["ApiKeyPathParam"]; }; query: { /** Specify ID of the licensee after which you would like to list results */ starting_after?: number; /** * **Private User Token** * * A secret key used for sensitive operations on your account and API Keys. * * Your user token can be retrieved and managed from your [accounts page](https://ideal-postcodes.co.uk/account). * * Typically beings `uk_...` */ user_token?: components["parameters"]["UserTokenParam"]; /** * **Limit** * * Specifies the maximum number of records to retrieve. * * By default the limit is 10. Requesting a larger result set will result in more latency */ limit?: components["parameters"]["LimitParam"]; /** Filter result by licensee name. Query can be shortened to `q=` */ query?: string; }; }; responses: { /** Success */ 200: { content: { "application/json": components["schemas"]["LicenseesResponse"]; }; }; /** Bad Request */ 400: { content: { "application/json": components["schemas"]["BadRequestResponse"]; }; }; }; }; /** Create a licensee for the specified API Key. */ CreateLicensee: { parameters: { path: { /** * **API Key** * * The API Key to retrieve. Begins `ak_`. */ key: components["parameters"]["ApiKeyPathParam"]; }; query: { /** * **Private User Token** * * A secret key used for sensitive operations on your account and API Keys. * * Your user token can be retrieved and managed from your [accounts page](https://ideal-postcodes.co.uk/account). * * Typically beings `uk_...` */ user_token?: components["parameters"]["UserTokenParam"]; }; }; responses: { /** Success */ 200: { content: { "application/json": components["schemas"]["LicenseeResponse"]; }; }; /** Bad Request */ 400: { content: { "application/json": components["schemas"]["BadRequestResponse"]; }; }; }; requestBody: { content: { "application/json": components["schemas"]["LicenseeEditable"]; }; }; }; /** Returns licensee information as identified by the licensee key. */ RetrieveLicensee: { parameters: { path: { /** * **API Key** * * The API Key to retrieve. Begins `ak_`. */ key: components["parameters"]["ApiKeyPathParam"]; /** * **Licensee Key** * * Uniquely identifies a licensee. */ licensee: components["parameters"]["LicenseePathParam"]; }; query: { /** * **Private User Token** * * A secret key used for sensitive operations on your account and API Keys. * * Your user token can be retrieved and managed from your [accounts page](https://ideal-postcodes.co.uk/account). * * Typically beings `uk_...` */ user_token?: components["parameters"]["UserTokenParam"]; }; }; responses: { /** Success */ 200: { content: { "application/json": components["schemas"]["LicenseeResponse"]; }; }; /** Bad Request */ 400: { content: { "application/json": components["schemas"]["BadRequestResponse"]; }; }; }; }; /** Update Licensee */ UpdateLicensee: { parameters: { path: { /** * **API Key** * * The API Key to retrieve. Begins `ak_`. */ key: components["parameters"]["ApiKeyPathParam"]; /** * **Licensee Key** * * Uniquely identifies a licensee. */ licensee: components["parameters"]["LicenseePathParam"]; }; query: { /** * **Private User Token** * * A secret key used for sensitive operations on your account and API Keys. * * Your user token can be retrieved and managed from your [accounts page](https://ideal-postcodes.co.uk/account). * * Typically beings `uk_...` */ user_token?: components["parameters"]["UserTokenParam"]; }; }; responses: { /** Success */ 200: { content: { "application/json": components["schemas"]["LicenseeResponse"]; }; }; /** Bad Request */ 400: { content: { "application/json": components["schemas"]["BadRequestResponse"]; }; }; }; requestBody: { content: { "application/json": components["schemas"]["LicenseeEditable"]; }; }; }; /** Cancels a licensee key. This renders a licensee unusable. This action can be reversed if you get in contact with us. */ DeleteLicensee: { parameters: { path: { /** * **API Key** * * The API Key to retrieve. Begins `ak_`. */ key: components["parameters"]["ApiKeyPathParam"]; /** * **Licensee Key** * * Uniquely identifies a licensee. */ licensee: components["parameters"]["LicenseePathParam"]; }; query: { /** * **Private User Token** * * A secret key used for sensitive operations on your account and API Keys. * * Your user token can be retrieved and managed from your [accounts page](https://ideal-postcodes.co.uk/account). * * Typically beings `uk_...` */ user_token?: components["parameters"]["UserTokenParam"]; }; }; responses: { /** Success */ 200: { content: { "application/json": { result: { /** * Format: int32 * @example 1 */ deleted: number; }; /** * Format: int32 * @enum {integer} */ code: 2000; /** @enum {string} */ message: "Success"; }; }; }; /** Bad Request */ 400: { content: { "application/json": components["schemas"]["BadRequestResponse"]; }; }; }; }; /** Lists configurations associated with a key */ ListConfigs: { parameters: { path: { /** * **API Key** * * The API Key to retrieve. Begins `ak_`. */ key: components["parameters"]["ApiKeyPathParam"]; }; query: { /** * **Private User Token** * * A secret key used for sensitive operations on your account and API Keys. * * Your user token can be retrieved and managed from your [accounts page](https://ideal-postcodes.co.uk/account). * * Typically beings `uk_...` */ user_token?: components["parameters"]["UserTokenParam"]; }; }; responses: { /** Success */ 200: { content: { "application/json": components["schemas"]["ConfigsResponse"]; }; }; /** Bad Request */ 400: { content: { "application/json": components["schemas"]["BadRequestResponse"]; }; }; /** Unauthorized Request */ 401: { content: { "application/json": components["schemas"]["UnauthorizedResponse"]; }; }; }; }; /** Create a configuration */ CreateConfig: { parameters: { path: { /** * **API Key** * * The API Key to retrieve. Begins `ak_`. */ key: components["parameters"]["ApiKeyPathParam"]; }; query: { /** * **Private User Token** * * A secret key used for sensitive operations on your account and API Keys. * * Your user token can be retrieved and managed from your [accounts page](https://ideal-postcodes.co.uk/account). * * Typically beings `uk_...` */ user_token?: components["parameters"]["UserTokenParam"]; }; }; responses: { /** Success */ 200: { content: { "application/json": components["schemas"]["ConfigResponse"]; }; }; /** Bad Request */ 400: { content: { "application/json": components["schemas"]["BadRequestResponse"]; }; }; /** Unauthorized Request */ 401: { content: { "application/json": components["schemas"]["UnauthorizedResponse"]; }; }; }; requestBody: { content: { "application/json": components["schemas"]["ConfigNewParam"]; }; }; }; /** Retrieve configuration object by name */ RetrieveConfig: { parameters: { path: { /** * **API Key** * * The API Key to retrieve. Begins `ak_`. */ key: components["parameters"]["ApiKeyPathParam"]; /** * **Configuration Name** * * User provided configuration object name. */ config: components["parameters"]["ConfigParam"]; }; }; responses: { /** Success */ 200: { content: { "application/json": components["schemas"]["ConfigResponse"]; }; }; /** Bad Request */ 400: { content: { "application/json": components["schemas"]["BadRequestResponse"]; }; }; /** Not Found */ 404: { content: { "application/json": components["schemas"]["NotFoundResponse"]; }; }; }; }; /** Updates configuration object */ UpdateConfig: { parameters: { path: { /** * **API Key** * * The API Key to retrieve. Begins `ak_`. */ key: components["parameters"]["ApiKeyPathParam"]; /** * **Configuration Name** * * User provided configuration object name. */ config: components["parameters"]["ConfigParam"]; }; query: { /** * **Private User Token** * * A secret key used for sensitive operations on your account and API Keys. * * Your user token can be retrieved and managed from your [accounts page](https://ideal-postcodes.co.uk/account). * * Typically beings `uk_...` */ user_token?: components["parameters"]["UserTokenParam"]; }; }; responses: { /** Success */ 200: { content: { "application/json": components["schemas"]["ConfigResponse"]; }; }; /** Bad Request */ 400: { content: { "application/json": components["schemas"]["BadRequestResponse"]; }; }; /** Unauthorized Request */ 401: { content: { "application/json": components["schemas"]["UnauthorizedResponse"]; }; }; /** Not Found */ 404: { content: { "application/json": components["schemas"]["NotFoundResponse"]; }; }; }; requestBody: { content: { "application/json": components["schemas"]["ConfigUpdateParam"]; }; }; }; /** Permanently deletes a configuration object. */ DeleteConfig: { parameters: { path: { /** * **API Key** * * The API Key to retrieve. Begins `ak_`. */ key: components["parameters"]["ApiKeyPathParam"]; /** * **Configuration Name** * * User provided configuration object name. */ config: components["parameters"]["ConfigParam"]; }; query: { /** * **Private User Token** * * A secret key used for sensitive operations on your account and API Keys. * * Your user token can be retrieved and managed from your [accounts page](https://ideal-postcodes.co.uk/account). * * Typically beings `uk_...` */ user_token?: components["parameters"]["UserTokenParam"]; }; }; responses: { /** Success */ 200: { content: { "application/json": { result: { /** * Format: int32 * @example 1 */ deleted: number; }; /** * Format: int32 * @enum {integer} */ code: 2000; /** @enum {string} */ message: "Success"; }; }; }; /** Bad Request */ 400: { content: { "application/json": components["schemas"]["BadRequestResponse"]; }; }; /** Unauthorized Request */ 401: { content: { "application/json": components["schemas"]["UnauthorizedResponse"]; }; }; /** Not Found */ 404: { content: { "application/json": components["schemas"]["NotFoundResponse"]; }; }; }; }; /** Query for and validate email addresses. */ EmailValidation: { parameters: { query: { /** * **API Key** * * Your unique identifier that allows access to our APIs. * * Begins `ak_`. Available from your dashboard */ api_key?: components["parameters"]["ApiKeyParam"]; /** Specifies the email address to validate */ query: string; /** * ** Tags ** * A comma separated list of tags to query over. * * Useful if you want to specify the circumstances in which the request was made. * * If multiple tags are specified, the response will only comprise of requests for which all the tags are satisfied - i.e. searching `"foo,bar"` will only query requests which tagged both `"foo"` and `"bar"`. */ tags?: components["parameters"]["TagsParam"]; }; }; responses: { /** Success */ 200: { content: { "application/json": components["schemas"]["EmailResponse"]; }; }; /** Bad Request */ 400: { content: { "application/json": components["schemas"]["BadRequestResponse"]; }; }; /** Unauthorized */ 401: { content: { "application/json": components["schemas"]["UnauthorizedResponse"]; }; }; }; }; /** Query for and validate phone numbers. */ PhoneNumberValidation: { parameters: { query: { /** * **API Key** * * Your unique identifier that allows access to our APIs. * * Begins `ak_`. Available from your dashboard */ api_key?: components["parameters"]["ApiKeyParam"]; /** Specifies the phone number to validate. Phone number must include a country code in acceptable format. For instance, UK phone numbers should be suffixed `+44`, `44` or `0044`. */ query: string; /** * When set to `true` the current network of the phone number will be retrieved and populated. * * Note that this operation is potentially slow depending on the network and local conditions. */ current_carrier?: "true"; /** * ** Tags ** * A comma separated list of tags to query over. * * Useful if you want to specify the circumstances in which the request was made. * * If multiple tags are specified, the response will only comprise of requests for which all the tags are satisfied - i.e. searching `"foo,bar"` will only query requests which tagged both `"foo"` and `"bar"`. */ tags?: components["parameters"]["TagsParam"]; }; }; responses: { /** Success */ 200: { content: { "application/json": components["schemas"]["PhoneNumberResponse"]; }; }; /** Bad Request */ 400: { content: { "application/json": components["schemas"]["BadRequestResponse"]; }; }; /** Unauthorized */ 401: { content: { "application/json": components["schemas"]["UnauthorizedResponse"]; }; }; /** Rate Limit Timeout */ 429: { content: { "application/json": components["schemas"]["BadRequestResponse"]; }; }; }; }; } export interface external {}