diff --git a/dist/openapi.json b/dist/openapi.json index 4b9ba32..b9aa8c7 100644 --- a/dist/openapi.json +++ b/dist/openapi.json @@ -745,6 +745,9 @@ }, { "$ref": "#/components/parameters/TagsParam" + }, + { + "$ref": "#/components/parameters/ContextParam" } ], "requestBody": { @@ -3647,7 +3650,7 @@ "Dataset": { "title": "Dataset", "type": "string", - "description": "Indicates the provenance of an address.\n\n - `paf` (GBR) Postcode Address File\n - `mr` (GBR) Multiple Residence File\n - `nyb` (GBR) Not Yet Built File\n - `pafa` (GBR) Alias File\n - `pafw` (GBR) Welsh File\n - `ab` (GBR) AddressBase Core\n - `ecaf` (IRL) Eircode ECAF\n - `ecad` (IRL) Eircode ECAD\n - `usps` (USA) USPS Zip+4\n - `herewe` (Western Europe) Western Europe Dataset\n - `gnaf` (Australia) Geoscape Geocoded National Address File", + "description": "Indicates the provenance of an address.\n\n - `paf` (GBR) Postcode Address File\n - `mr` (GBR) Multiple Residence File\n - `nyb` (GBR) Not Yet Built File\n - `pafa` (GBR) Alias File\n - `pafw` (GBR) Welsh File\n - `ab` (GBR) AddressBase Core\n - `ecaf` (IRL) Eircode ECAF\n - `ecad` (IRL) Eircode ECAD\n - `usps` (USA) USPS Zip+4\n - `herewe` (Western Europe) Western Europe Dataset\n - `gnaf` (Australia) Geoscape Geocoded National Address File\n - `kadaster` (NLD) Kadaster BAG 2.0 Address File", "enum": [ "paf", "pafw", @@ -3670,7 +3673,8 @@ "herehk", "hereee", "hereap", - "gnaf" + "gnaf", + "kadaster" ] }, "CountryISO": { @@ -6341,6 +6345,521 @@ } } }, + "KadasterAddress": { + "required": [ + "id", + "dataset", + "country", + "country_iso", + "country_iso_2", + "line_1", + "language", + "address", + "identificatie", + "latitude", + "longitude", + "gebruiksdoel", + "oppervlakte", + "status", + "geconstateerd", + "documentdatum", + "documentnummer", + "voorkomenidentificatie", + "begin_geldigheid", + "eind_geldigheid", + "tijdstip_registratie", + "eind_registratie", + "tijdstip_registratie_lv", + "tijdstip_eind_registratie_lv", + "nummeraanduidingen_identificatie", + "nummeraanduidingen_huisnummer", + "nummeraanduidingen_huisnummertoevoeging", + "nummeraanduidingen_huisletter", + "nummeraanduidingen_postcode", + "nummeraanduidingen_type_adresseerbaar_object", + "nummeraanduidingen_status", + "nummeraanduidingen_geconstateerd", + "nummeraanduidingen_documentdatum", + "nummeraanduidingen_documentnummer", + "nummeraanduidingen_voorkomenidentificatie", + "nummeraanduidingen_begin_geldigheid", + "nummeraanduidingen_eind_geldigheid", + "nummeraanduidingen_tijdstip_registratie", + "nummeraanduidingen_eind_registratie", + "nummeraanduidingen_tijdstip_registratie_lv", + "nummeraanduidingen_tijdstip_eind_registratie_lv", + "pand_identificatie", + "pand_oorspronkelijk_bouwjaar", + "pand_status", + "pand_geconstateerd", + "pand_documentdatum", + "pand_documentnummer", + "pand_voorkomenidentificatie", + "pand_begin_geldigheid", + "pand_eind_geldigheid", + "pand_tijdstip_registratie", + "pand_eind_registratie", + "pand_tijdstip_registratie_lv", + "pand_tijdstip_eind_registratie_lv", + "openbare_ruimte_identificatie", + "openbare_ruimte_naam", + "openbare_ruimte_type", + "openbare_ruimte_status", + "openbare_ruimte_geconstateerd", + "openbare_ruimte_documentdatum", + "openbare_ruimte_documentnummer", + "openbare_ruimte_voorkomenidentificatie", + "openbare_ruimte_begin_geldigheid", + "openbare_ruimte_eind_geldigheid", + "openbare_ruimte_tijdstip_registratie", + "openbare_ruimte_eind_registratie", + "openbare_ruimte_tijdstip_registratie_lv", + "openbare_ruimte_tijdstip_eind_registratie_lv", + "openbare_ruimte_verkorte_naam", + "woonplaats_identificatie", + "woonplaats_naam", + "woonplaats_status", + "woonplaats_geconstateerd", + "woonplaats_documentdatum", + "woonplaats_documentnummer", + "woonplaats_voorkomenidentificatie", + "woonplaats_begin_geldigheid", + "woonplaats_eind_geldigheid", + "woonplaats_tijdstip_registratie", + "woonplaats_eind_registratie", + "woonplaats_tijdstip_registratie_lv", + "woonplaats_tijdstip_eind_registratie_lv", + "provincie" + ], + "properties": { + "id": { + "$ref": "#/components/schemas/ID" + }, + "dataset": { + "type": "string", + "enum": [ + "kadaster" + ] + }, + "country_iso": { + "description": " 3 letter country code (ISO 3166-1)\n", + "enum": [ + "NLD" + ] + }, + "country_iso_2": { + "type": "string", + "description": " 2 letter country code (ISO 3166-1)\n", + "enum": [ + "NL" + ] + }, + "country": { + "type": "string", + "description": " Full country names (ISO 3166)\n", + "enum": [ + "Netherlands" + ] + }, + "line_1": { + "type": "string", + "description": "First address line.\n\nCan be empty string `\"\"` if not present.\n", + "example": "Herengracht 255" + }, + "language": { + "enum": [ + "nl" + ], + "description": "Language represented by 2 letter ISO Code (639-1)\n" + }, + "address": { + "type": "string", + "description": "Address / House Number uniquely identifying the address along the specified street.\n\nCan be empty string `\"\"` if not present.\n", + "example": "255" + }, + "longitude": { + "$ref": "#/components/schemas/Longitude" + }, + "latitude": { + "$ref": "#/components/schemas/Latitude" + }, + "identificatie": { + "type": "string", + "description": "The unique identifier of a BAG verblijfsobject.\n" + }, + "gebruiksdoel": { + "type": "string", + "description": "The purpose of use of the verblijfsobject.\n" + }, + "oppervlakte": { + "type": "number", + "description": "The area of the verblijfsobject in square metres.\n" + }, + "status": { + "type": "string", + "description": "Verblijfsobject status.\n" + }, + "geconstateerd": { + "type": "boolean", + "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.\n" + }, + "documentdatum": { + "type": "string", + "format": "date", + "description": "Date on which the verblijfsobject source document was created.\n" + }, + "documentnummer": { + "type": "string", + "description": "The unique identifier of the verblijfsobject source document.\n" + }, + "voorkomenidentificatie": { + "oneOf": [ + { + "type": "string", + "description": "Empty string `\"\"` if not available" + }, + { + "type": "number", + "description": "The identifier of this instance of the verblijfsobject history.\n" + } + ] + }, + "begin_geldigheid": { + "type": "string", + "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.\n" + }, + "eind_geldigheid": { + "type": "string", + "format": "date", + "description": "The time at which a version of a verblijfsobject is no longer valid in reality. Empty string `\"\"` if not applicable.\n" + }, + "tijdstip_registratie": { + "type": "string", + "format": "date", + "description": "The time at which a version of a verblijfsobject is registered by the bronhouder.\n" + }, + "eind_registratie": { + "type": "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.\n" + }, + "tijdstip_registratie_lv": { + "type": "string", + "format": "date", + "description": "The time at which a version of a verblijfsobject is registered in the Landelijke Voorziening BAG.\n" + }, + "tijdstip_eind_registratie_lv": { + "type": "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.\n" + }, + "nummeraanduidingen_identificatie": { + "type": "string", + "description": "The unique identifier of a BAG nummeraanduiding object.\n" + }, + "nummeraanduidingen_huisnummer": { + "type": "string", + "description": "The house number assigned to a nummeraanduiding object by or on behalf of the municipal council.\n" + }, + "nummeraanduidingen_huisnummertoevoeging": { + "type": "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.\n" + }, + "nummeraanduidingen_huisletter": { + "type": "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.\n" + }, + "nummeraanduidingen_postcode": { + "type": "string", + "description": "A code determined by PostNL associated with a specific combination of a street name and a house number.\n" + }, + "nummeraanduidingen_type_adresseerbaar_object": { + "type": "string", + "description": "The nature of the nummeraanduiding object.\n" + }, + "nummeraanduidingen_status": { + "type": "string", + "description": "The status of the nummeraanduiding object.\n" + }, + "nummeraanduidingen_geconstateerd": { + "type": "boolean", + "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.\n" + }, + "nummeraanduidingen_documentdatum": { + "type": "string", + "format": "date", + "description": "Date on which the nummeraanduidingen object source document was created.\n" + }, + "nummeraanduidingen_documentnummer": { + "type": "string", + "description": "The unique identifier of the nummeraanduidingen object source document.\n" + }, + "nummeraanduidingen_voorkomenidentificatie": { + "oneOf": [ + { + "type": "string", + "description": "Empty string `\"\"` if not available" + }, + { + "type": "number", + "description": "The identifier of this instance of the nummeraanduidingen object history.\n" + } + ] + }, + "nummeraanduidingen_begin_geldigheid": { + "type": "string", + "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.\n" + }, + "nummeraanduidingen_eind_geldigheid": { + "type": "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.\n" + }, + "nummeraanduidingen_tijdstip_registratie": { + "type": "string", + "format": "date", + "description": "The time at which a version of a nummeraanduidingen object is registered by the bronhouder.\n" + }, + "nummeraanduidingen_eind_registratie": { + "type": "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.\n" + }, + "nummeraanduidingen_tijdstip_registratie_lv": { + "type": "string", + "format": "date", + "description": "The time at which a version of a nummeraanduidingen object is registered in the Landelijke Voorziening BAG.\n" + }, + "nummeraanduidingen_tijdstip_eind_registratie_lv": { + "type": "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.\n" + }, + "pand_identificatie": { + "type": "string", + "description": "The unique identifier of a BAG pand object.\n" + }, + "pand_oorspronkelijk_bouwjaar": { + "oneOf": [ + { + "type": "string", + "description": "Empty string `\"\"` if not available" + }, + { + "type": "number", + "description": "The year in which a building was or will be originally completed.\n" + } + ] + }, + "pand_status": { + "type": "string", + "description": "The status of the pand object.\n" + }, + "pand_geconstateerd": { + "type": "boolean", + "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.\n" + }, + "pand_documentdatum": { + "type": "string", + "format": "date", + "description": "Date on which the pand object source document was created.\n" + }, + "pand_documentnummer": { + "type": "string", + "description": "The unique identifier of the pand object source document.\n" + }, + "pand_voorkomenidentificatie": { + "oneOf": [ + { + "type": "string", + "description": "Empty string `\"\"` if not available" + }, + { + "type": "number", + "description": "The identifier of this instance of the pand object history.\n" + } + ] + }, + "pand_begin_geldigheid": { + "type": "string", + "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.\n" + }, + "pand_eind_geldigheid": { + "type": "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.\n" + }, + "pand_tijdstip_registratie": { + "type": "string", + "format": "date", + "description": "The time at which a version of a pand object is registered by the bronhouder.\n" + }, + "pand_eind_registratie": { + "type": "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.\n" + }, + "pand_tijdstip_registratie_lv": { + "type": "string", + "format": "date", + "description": "The time at which a version of a pand object is registered in the Landelijke Voorziening BAG.\n" + }, + "pand_tijdstip_eind_registratie_lv": { + "type": "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.\n" + }, + "openbare_ruimte_identificatie": { + "type": "string", + "description": "The unique identifier of a BAG openbare ruimte object.\n" + }, + "openbare_ruimte_naam": { + "type": "string", + "description": "The name assigned to an openbare ruimte object by or on behalf of the municipal council.\n" + }, + "openbare_ruimte_type": { + "type": "string", + "description": "The nature of the openbare ruimte object.\n" + }, + "openbare_ruimte_status": { + "type": "string", + "description": "The status of the openbare ruimte object.\n" + }, + "openbare_ruimte_geconstateerd": { + "type": "boolean", + "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.\n" + }, + "openbare_ruimte_documentdatum": { + "type": "string", + "format": "date", + "description": "Date on which the openbare ruimte object source document was created.\n" + }, + "openbare_ruimte_documentnummer": { + "type": "string", + "description": "The unique identifier of the openbare ruimte object source document.\n" + }, + "openbare_ruimte_voorkomenidentificatie": { + "oneOf": [ + { + "type": "string", + "description": "Empty string `\"\"` if not available" + }, + { + "type": "number", + "description": "The identifier of this instance of the openbare ruimte object history.\n" + } + ] + }, + "openbare_ruimte_begin_geldigheid": { + "type": "string", + "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.\n" + }, + "openbare_ruimte_eind_geldigheid": { + "type": "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.\n" + }, + "openbare_ruimte_tijdstip_registratie": { + "type": "string", + "format": "date", + "description": "The time at which a version of an openbare ruimte object is registered by the bronhouder.\n" + }, + "openbare_ruimte_eind_registratie": { + "type": "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.\n" + }, + "openbare_ruimte_tijdstip_registratie_lv": { + "type": "string", + "format": "date", + "description": "The time at which a version of an openbare ruimte object is registered in the Landelijke Voorziening BAG.\n" + }, + "openbare_ruimte_tijdstip_eind_registratie_lv": { + "type": "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.\n" + }, + "openbare_ruimte_verkorte_naam": { + "type": "string", + "description": "An abbreviated name assigned to an openbare ruimte object if its name is longer than 24 characters.\n" + }, + "woonplaats_identificatie": { + "type": "string", + "description": "The unique identifier of a BAG woonplaats object.\n" + }, + "woonplaats_naam": { + "type": "string", + "description": "The name assigned to a woonplaats object by or on behalf of the municipal council.\n" + }, + "woonplaats_status": { + "type": "string", + "description": "The status of the woonplaats object.\n" + }, + "woonplaats_geconstateerd": { + "type": "boolean", + "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.\n" + }, + "woonplaats_documentdatum": { + "type": "string", + "format": "date", + "description": "Date on which the woonplaats object source document was created.\n" + }, + "woonplaats_documentnummer": { + "type": "string", + "description": "The unique identifier of the woonplaats object source document.\n" + }, + "woonplaats_voorkomenidentificatie": { + "oneOf": [ + { + "type": "string", + "description": "Empty string `\"\"` if not available" + }, + { + "type": "number", + "description": "The identifier of this instance of the woonplaats object history.\n" + } + ] + }, + "woonplaats_begin_geldigheid": { + "type": "string", + "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.\n" + }, + "woonplaats_eind_geldigheid": { + "type": "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.\n" + }, + "woonplaats_tijdstip_registratie": { + "type": "string", + "format": "date", + "description": "The time at which a version of a woonplaats object is registered by the bronhouder.\n" + }, + "woonplaats_eind_registratie": { + "type": "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.\n" + }, + "woonplaats_tijdstip_registratie_lv": { + "type": "string", + "format": "date", + "description": "The time at which a version of a woonplaats object is registered in the Landelijke Voorziening BAG.\n" + }, + "woonplaats_tijdstip_eind_registratie_lv": { + "type": "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.\n" + }, + "provincie": { + "type": "string", + "description": "The province name.\n" + } + } + }, "GbrGlobalAddress": { "title": "Global Address", "description": "Global (non-UK) address in the UK address format", @@ -6469,6 +6988,9 @@ }, { "$ref": "#/components/schemas/GnafAddress" + }, + { + "$ref": "#/components/schemas/KadasterAddress" } ] }, @@ -7240,7 +7762,8 @@ "heret", "email", "phone", - "gnaf" + "gnaf", + "kadaster" ], "properties": { "paf": { @@ -7367,6 +7890,11 @@ "type": "boolean", "description": "Email validation is enabled", "example": true + }, + "kadaster": { + "type": "boolean", + "description": "Kadaster BAG 2.0 Address File", + "example": true } } }, @@ -7675,6 +8203,11 @@ "type": "boolean", "description": "Australia Geoscape Geocoded National Address File", "example": true + }, + "kadaster": { + "type": "boolean", + "description": "Kadaster BAG 2.0 Address File", + "example": true } } } @@ -8878,6 +9411,9 @@ }, { "$ref": "#/components/schemas/GnafAddress" + }, + { + "$ref": "#/components/schemas/KadasterAddress" } ] } @@ -9913,7 +10449,8 @@ "role", "free", "disposable", - "catchall" + "catchall", + "suggestions" ], "properties": { "result": { @@ -9942,6 +10479,16 @@ "catchall": { "type": "boolean", "description": "Returns `true` if this domain accepts all emails regardless of username" + }, + "suggestions": { + "type": "array", + "items": { + "type": "string" + }, + "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" + ] } } }, @@ -9954,7 +10501,8 @@ "role", "free", "disposable", - "catchall" + "catchall", + "suggestions" ], "properties": { "result": { @@ -10007,6 +10555,13 @@ "enum": [ null ] + }, + "suggestions": { + "type": "array", + "items": { + "type": "string" + }, + "description": "Suggestions will be empty" } } }, diff --git a/dist/openapi.yaml b/dist/openapi.yaml index 3a89d44..69f35ec 100644 --- a/dist/openapi.yaml +++ b/dist/openapi.yaml @@ -795,6 +795,7 @@ paths: parameters: - $ref: '#/components/parameters/ApiKeyParam' - $ref: '#/components/parameters/TagsParam' + - $ref: '#/components/parameters/ContextParam' requestBody: required: true content: @@ -3057,6 +3058,7 @@ components: - `usps` (USA) USPS Zip+4 - `herewe` (Western Europe) Western Europe Dataset - `gnaf` (Australia) Geoscape Geocoded National Address File + - `kadaster` (NLD) Kadaster BAG 2.0 Address File enum: - paf - pafw @@ -3080,6 +3082,7 @@ components: - hereee - hereap - gnaf + - kadaster CountryISO: title: ISO Country Code (3) type: string @@ -5588,6 +5591,483 @@ components: type: string description: | Abbreviation of street type + KadasterAddress: + required: + - id + - dataset + - country + - country_iso + - country_iso_2 + - line_1 + - language + - address + - identificatie + - latitude + - longitude + - gebruiksdoel + - oppervlakte + - status + - geconstateerd + - documentdatum + - documentnummer + - voorkomenidentificatie + - begin_geldigheid + - eind_geldigheid + - tijdstip_registratie + - eind_registratie + - tijdstip_registratie_lv + - tijdstip_eind_registratie_lv + - nummeraanduidingen_identificatie + - nummeraanduidingen_huisnummer + - nummeraanduidingen_huisnummertoevoeging + - nummeraanduidingen_huisletter + - nummeraanduidingen_postcode + - nummeraanduidingen_type_adresseerbaar_object + - nummeraanduidingen_status + - nummeraanduidingen_geconstateerd + - nummeraanduidingen_documentdatum + - nummeraanduidingen_documentnummer + - nummeraanduidingen_voorkomenidentificatie + - nummeraanduidingen_begin_geldigheid + - nummeraanduidingen_eind_geldigheid + - nummeraanduidingen_tijdstip_registratie + - nummeraanduidingen_eind_registratie + - nummeraanduidingen_tijdstip_registratie_lv + - nummeraanduidingen_tijdstip_eind_registratie_lv + - pand_identificatie + - pand_oorspronkelijk_bouwjaar + - pand_status + - pand_geconstateerd + - pand_documentdatum + - pand_documentnummer + - pand_voorkomenidentificatie + - pand_begin_geldigheid + - pand_eind_geldigheid + - pand_tijdstip_registratie + - pand_eind_registratie + - pand_tijdstip_registratie_lv + - pand_tijdstip_eind_registratie_lv + - openbare_ruimte_identificatie + - openbare_ruimte_naam + - openbare_ruimte_type + - openbare_ruimte_status + - openbare_ruimte_geconstateerd + - openbare_ruimte_documentdatum + - openbare_ruimte_documentnummer + - openbare_ruimte_voorkomenidentificatie + - openbare_ruimte_begin_geldigheid + - openbare_ruimte_eind_geldigheid + - openbare_ruimte_tijdstip_registratie + - openbare_ruimte_eind_registratie + - openbare_ruimte_tijdstip_registratie_lv + - openbare_ruimte_tijdstip_eind_registratie_lv + - openbare_ruimte_verkorte_naam + - woonplaats_identificatie + - woonplaats_naam + - woonplaats_status + - woonplaats_geconstateerd + - woonplaats_documentdatum + - woonplaats_documentnummer + - woonplaats_voorkomenidentificatie + - woonplaats_begin_geldigheid + - woonplaats_eind_geldigheid + - woonplaats_tijdstip_registratie + - woonplaats_eind_registratie + - woonplaats_tijdstip_registratie_lv + - woonplaats_tijdstip_eind_registratie_lv + - provincie + properties: + id: + $ref: '#/components/schemas/ID' + dataset: + type: string + enum: + - kadaster + country_iso: + description: |2 + 3 letter country code (ISO 3166-1) + enum: + - NLD + country_iso_2: + type: string + description: |2 + 2 letter country code (ISO 3166-1) + enum: + - NL + country: + type: string + description: |2 + Full country names (ISO 3166) + enum: + - Netherlands + line_1: + type: string + description: | + First address line. + + Can be empty string `""` if not present. + example: Herengracht 255 + language: + enum: + - nl + description: | + Language represented by 2 letter ISO Code (639-1) + address: + type: string + description: | + Address / House Number uniquely identifying the address along the specified street. + + Can be empty string `""` if not present. + example: '255' + longitude: + $ref: '#/components/schemas/Longitude' + latitude: + $ref: '#/components/schemas/Latitude' + identificatie: + type: string + description: | + The unique identifier of a BAG verblijfsobject. + gebruiksdoel: + type: string + description: | + The purpose of use of the verblijfsobject. + oppervlakte: + type: number + description: | + The area of the verblijfsobject in square metres. + status: + type: string + description: | + Verblijfsobject status. + geconstateerd: + type: boolean + 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. + documentdatum: + type: string + format: date + description: | + Date on which the verblijfsobject source document was created. + documentnummer: + type: string + description: | + The unique identifier of the verblijfsobject source document. + voorkomenidentificatie: + oneOf: + - type: string + description: Empty string `""` if not available + - type: number + description: | + The identifier of this instance of the verblijfsobject history. + begin_geldigheid: + type: string + 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. + eind_geldigheid: + type: string + format: date + description: | + The time at which a version of a verblijfsobject is no longer valid in reality. Empty string `""` if not applicable. + tijdstip_registratie: + type: string + format: date + description: | + The time at which a version of a verblijfsobject is registered by the bronhouder. + eind_registratie: + type: 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. + tijdstip_registratie_lv: + type: string + format: date + description: | + The time at which a version of a verblijfsobject is registered in the Landelijke Voorziening BAG. + tijdstip_eind_registratie_lv: + type: 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. + nummeraanduidingen_identificatie: + type: string + description: | + The unique identifier of a BAG nummeraanduiding object. + nummeraanduidingen_huisnummer: + type: string + description: | + The house number assigned to a nummeraanduiding object by or on behalf of the municipal council. + nummeraanduidingen_huisnummertoevoeging: + type: 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_huisletter: + type: 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_postcode: + type: string + description: | + A code determined by PostNL associated with a specific combination of a street name and a house number. + nummeraanduidingen_type_adresseerbaar_object: + type: string + description: | + The nature of the nummeraanduiding object. + nummeraanduidingen_status: + type: string + description: | + The status of the nummeraanduiding object. + nummeraanduidingen_geconstateerd: + type: boolean + 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_documentdatum: + type: string + format: date + description: | + Date on which the nummeraanduidingen object source document was created. + nummeraanduidingen_documentnummer: + type: string + description: | + The unique identifier of the nummeraanduidingen object source document. + nummeraanduidingen_voorkomenidentificatie: + oneOf: + - type: string + description: Empty string `""` if not available + - type: number + description: | + The identifier of this instance of the nummeraanduidingen object history. + nummeraanduidingen_begin_geldigheid: + type: string + 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_eind_geldigheid: + type: 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_tijdstip_registratie: + type: string + format: date + description: | + The time at which a version of a nummeraanduidingen object is registered by the bronhouder. + nummeraanduidingen_eind_registratie: + type: 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_tijdstip_registratie_lv: + type: string + format: date + description: | + The time at which a version of a nummeraanduidingen object is registered in the Landelijke Voorziening BAG. + nummeraanduidingen_tijdstip_eind_registratie_lv: + type: 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. + pand_identificatie: + type: string + description: | + The unique identifier of a BAG pand object. + pand_oorspronkelijk_bouwjaar: + oneOf: + - type: string + description: Empty string `""` if not available + - type: number + description: | + The year in which a building was or will be originally completed. + pand_status: + type: string + description: | + The status of the pand object. + pand_geconstateerd: + type: boolean + 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_documentdatum: + type: string + format: date + description: | + Date on which the pand object source document was created. + pand_documentnummer: + type: string + description: | + The unique identifier of the pand object source document. + pand_voorkomenidentificatie: + oneOf: + - type: string + description: Empty string `""` if not available + - type: number + description: | + The identifier of this instance of the pand object history. + pand_begin_geldigheid: + type: string + 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_eind_geldigheid: + type: 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_tijdstip_registratie: + type: string + format: date + description: | + The time at which a version of a pand object is registered by the bronhouder. + pand_eind_registratie: + type: 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_tijdstip_registratie_lv: + type: string + format: date + description: | + The time at which a version of a pand object is registered in the Landelijke Voorziening BAG. + pand_tijdstip_eind_registratie_lv: + type: 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. + openbare_ruimte_identificatie: + type: string + description: | + The unique identifier of a BAG openbare ruimte object. + openbare_ruimte_naam: + type: string + description: | + The name assigned to an openbare ruimte object by or on behalf of the municipal council. + openbare_ruimte_type: + type: string + description: | + The nature of the openbare ruimte object. + openbare_ruimte_status: + type: string + description: | + The status of the openbare ruimte object. + openbare_ruimte_geconstateerd: + type: boolean + 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_documentdatum: + type: string + format: date + description: | + Date on which the openbare ruimte object source document was created. + openbare_ruimte_documentnummer: + type: string + description: | + The unique identifier of the openbare ruimte object source document. + openbare_ruimte_voorkomenidentificatie: + oneOf: + - type: string + description: Empty string `""` if not available + - type: number + description: | + The identifier of this instance of the openbare ruimte object history. + openbare_ruimte_begin_geldigheid: + type: string + 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_eind_geldigheid: + type: 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_tijdstip_registratie: + type: string + format: date + description: | + The time at which a version of an openbare ruimte object is registered by the bronhouder. + openbare_ruimte_eind_registratie: + type: 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_tijdstip_registratie_lv: + type: 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_eind_registratie_lv: + type: 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_verkorte_naam: + type: string + description: | + An abbreviated name assigned to an openbare ruimte object if its name is longer than 24 characters. + woonplaats_identificatie: + type: string + description: | + The unique identifier of a BAG woonplaats object. + woonplaats_naam: + type: string + description: | + The name assigned to a woonplaats object by or on behalf of the municipal council. + woonplaats_status: + type: string + description: | + The status of the woonplaats object. + woonplaats_geconstateerd: + type: boolean + 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_documentdatum: + type: string + format: date + description: | + Date on which the woonplaats object source document was created. + woonplaats_documentnummer: + type: string + description: | + The unique identifier of the woonplaats object source document. + woonplaats_voorkomenidentificatie: + oneOf: + - type: string + description: Empty string `""` if not available + - type: number + description: | + The identifier of this instance of the woonplaats object history. + woonplaats_begin_geldigheid: + type: string + 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_eind_geldigheid: + type: 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_tijdstip_registratie: + type: string + format: date + description: | + The time at which a version of a woonplaats object is registered by the bronhouder. + woonplaats_eind_registratie: + type: 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_tijdstip_registratie_lv: + type: string + format: date + description: | + The time at which a version of a woonplaats object is registered in the Landelijke Voorziening BAG. + woonplaats_tijdstip_eind_registratie_lv: + type: 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. + provincie: + type: string + description: | + The province name. GbrGlobalAddress: title: Global Address description: Global (non-UK) address in the UK address format @@ -5692,6 +6172,7 @@ components: - $ref: '#/components/schemas/UspsAddress' - $ref: '#/components/schemas/HereAddress' - $ref: '#/components/schemas/GnafAddress' + - $ref: '#/components/schemas/KadasterAddress' postcode_outward: type: string description: Not available for non-UK addresses @@ -6295,6 +6776,7 @@ components: - email - phone - gnaf + - kadaster properties: paf: type: boolean @@ -6396,6 +6878,10 @@ components: type: boolean description: Email validation is enabled example: true + kadaster: + type: boolean + description: Kadaster BAG 2.0 Address File + example: true ApiKeyAutomatedTopup: title: API Key Automated Topup description: Automated topup status @@ -6645,6 +7131,10 @@ components: type: boolean description: Australia Geoscape Geocoded National Address File example: true + kadaster: + type: boolean + description: Kadaster BAG 2.0 Address File + example: true KeyUsageResult: title: Key Usage type: object @@ -7552,6 +8042,7 @@ components: - $ref: '#/components/schemas/AbAddress' - $ref: '#/components/schemas/HereAddress' - $ref: '#/components/schemas/GnafAddress' + - $ref: '#/components/schemas/KadasterAddress' UsaResolveAddressResponse: title: Address Retrieve Response (USA) type: object @@ -8371,6 +8862,7 @@ components: - free - disposable - catchall + - suggestions properties: result: type: string @@ -8392,6 +8884,13 @@ components: catchall: type: boolean description: Returns `true` if this domain accepts all emails regardless of username + suggestions: + type: array + items: + type: string + 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 UnknownEmail: title: Unknown Email Object type: object @@ -8402,6 +8901,7 @@ components: - free - disposable - catchall + - suggestions properties: result: type: string @@ -8442,6 +8942,11 @@ components: description: Catch-all status is not known enum: - null + suggestions: + type: array + items: + type: string + description: Suggestions will be empty EmailResponse: title: Email Verification Response type: object diff --git a/openapi.ts b/openapi.ts index 46bd56f..71c3b3b 100644 --- a/openapi.ts +++ b/openapi.ts @@ -412,6 +412,7 @@ export interface components { /** * Line 3 * @description Third address line. May be empty. + * @example */ paf_line3: string; /** @@ -483,11 +484,13 @@ export interface components { /** * 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; /** @@ -499,6 +502,7 @@ export interface components { /** * 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; /** @@ -518,6 +522,7 @@ export interface components { * - 12A * - K * - Victoria House + * @example */ paf_building_name: string; /** @@ -535,6 +540,7 @@ export interface components { /** * Department Name * @description Used to supplment Organisation Name to identify a deparment within the organisation. + * @example */ paf_department_name: string; /** @@ -576,6 +582,7 @@ export interface components { * 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; /** @@ -658,6 +665,7 @@ export interface components { /** * County Code * @description Short code representing the county or province. May be empty (`""`) + * @example */ county_code: string; uprn: components["schemas"]["paf_uprn"]; @@ -1081,6 +1089,7 @@ export interface components { * - `usps` (USA) USPS Zip+4 * - `herewe` (Western Europe) Western Europe Dataset * - `gnaf` (Australia) Geoscape Geocoded National Address File + * - `kadaster` (NLD) Kadaster BAG 2.0 Address File * @enum {string} */ Dataset: @@ -1105,7 +1114,8 @@ export interface components { | "herehk" | "hereee" | "hereap" - | "gnaf"; + | "gnaf" + | "kadaster"; /** * ISO Country Code (3) * @description 3 letter country code (ISO 3166-1) @@ -2673,24 +2683,32 @@ export interface components { * @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; /** @@ -2715,6 +2733,8 @@ export interface components { * @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; @@ -2746,7 +2766,10 @@ export interface components { * @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. */ + /** + * @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: { @@ -2787,6 +2810,8 @@ export interface components { * @description Second address line. * * Can be empty string `""` if not present. + * + * @example */ line_2: string; /** @@ -2962,6 +2987,298 @@ export interface components { /** @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; + }; /** * Global Address * @description Global (non-UK) address in the UK address format @@ -2981,11 +3298,13 @@ export interface components { /** * 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; /** @@ -3019,7 +3338,8 @@ export interface components { | components["schemas"]["EcafAddress"] | components["schemas"]["UspsAddress"] | components["schemas"]["HereAddress"] - | components["schemas"]["GnafAddress"]; + | components["schemas"]["GnafAddress"] + | components["schemas"]["KadasterAddress"]; /** * @description Not available for non-UK addresses * @enum {string} @@ -3150,7 +3470,58 @@ export interface components { }; /** * Postcode Response - * @example [object Object] + * @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: { /** @@ -3171,6 +3542,7 @@ export interface components { code: 2000; /** @enum {string} */ message: "Success"; + /** @default 0 */ page: number; /** @default 100 */ limit: number; @@ -3224,7 +3596,53 @@ export interface components { }; /** * UDPRN Response - * @example [object Object] + * @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: @@ -3240,7 +3658,53 @@ export interface components { }; /** * Multiple Residence (UMPRN) Address Response - * @example [object Object] + * @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"]; @@ -3373,29 +3837,50 @@ export interface components { * @example true */ paf: boolean; - /** @description UK Property Alias dataset */ + /** + * @description UK Property Alias dataset + * @example false + */ pafa: boolean; - /** @description UK Welsh Language Dataset */ + /** + * @description UK Welsh Language Dataset + * @example false + */ pafw: boolean; /** * @description UK Multiple Residence Dataset * @example true */ mr: boolean; - /** @description UK Not Yet Built Dataset */ + /** + * @description UK Not Yet Built Dataset + * @example false + */ nyb: boolean; - /** @description UK AddressBase dataset */ + /** + * @description UK AddressBase dataset + * @example false + */ ab: boolean; - /** @description Northern Ireland Pointer Dataset */ + /** + * @description Northern Ireland Pointer Dataset + * @example false + */ nip: boolean; /** * @description US Address Dataset * @example true */ usps: boolean; - /** @description IE Address File. Eircode Address Database */ + /** + * @description IE Address File. Eircode Address Database + * @example false + */ ecad: boolean; - /** @description IE Base Address File. Eircode Address File */ + /** + * @description IE Base Address File. Eircode Address File + * @example false + */ ecaf: boolean; /** * @description Australia Geocoded National Address File @@ -3472,6 +3957,11 @@ export interface components { * @example true */ email: boolean; + /** + * @description Kadaster BAG 2.0 Address File + * @example true + */ + kadaster: boolean; }; /** * API Key Automated Topup @@ -3528,7 +4018,10 @@ export interface components { 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 */ + /** + * @description Accept IP addresses forwarded in the `IDPC-Source-IP` header + * @default false + */ ip_forwarding: boolean; }; /** API Key Details Response */ @@ -3579,16 +4072,25 @@ export interface components { /** @description Indicates whether email notifications are enabled. */ enabled?: boolean; }; - /** @description Accept IP addresses forwarded in the `IDPC-Source-IP` header */ + /** + * @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 */ + /** + * @description UK Property Alias dataset + * @example false + */ pafa?: boolean; - /** @description UK Welsh Language Dataset */ + /** + * @description UK Welsh Language Dataset + * @example false + */ pafw?: boolean; /** * @description US Address Dataset @@ -3670,6 +4172,11 @@ export interface components { * @example true */ gnaf?: boolean; + /** + * @description Kadaster BAG 2.0 Address File + * @example true + */ + kadaster?: boolean; }; }; /** Key Usage */ @@ -3931,7 +4438,11 @@ export interface components { /** * Address Suggestion * @description Represents an address suggestion for any address in the world - * @example [object Object] + * @example { + * "id": "usps_V210079628|10||3797", + * "suggestion": "10 Downing St, Montpelier, VT, 05602", + * "urls": null + * } */ AddressSuggestion: { id: components["schemas"]["ID"]; @@ -3950,7 +4461,14 @@ export interface components { * * UK Address Suggestion will return a UMPRN if it references a multiple occupancy premise found on Royal Mail's Multiple Residence dataset. * - * @example [object Object] + * @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"]; @@ -3981,7 +4499,26 @@ export interface components { }; /** Address Autocomplete Response */ AutocompleteResponse: { - /** @example [object Object],[object Object] */ + /** + * @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"] @@ -4190,7 +4727,8 @@ export interface components { | components["schemas"]["WelshPafAddress"] | components["schemas"]["AbAddress"] | components["schemas"]["HereAddress"] - | components["schemas"]["GnafAddress"]; + | components["schemas"]["GnafAddress"] + | components["schemas"]["KadasterAddress"]; }; /** Address Retrieve Response (USA) */ UsaResolveAddressResponse: { @@ -4232,7 +4770,11 @@ export interface components { * @example 10 */ limit: number; - /** Format: int32 */ + /** + * Format: int32 + * @default 0 + * @example 0 + */ page: number; }; }; @@ -4276,7 +4818,32 @@ export interface components { }; /** * Place Search Response - * @example [object Object] + * @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: { /** @@ -4463,7 +5030,159 @@ export interface components { }; /** * Place Resolution Response - * @example [object Object] + * @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: { /** @@ -4679,6 +5398,13 @@ export interface components { 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: { @@ -4709,10 +5435,23 @@ export interface components { * @enum {boolean|null} */ catchall: null | null; + /** @description Suggestions will be empty */ + suggestions: string[]; }; /** * Email Verification Response - * @example [object Object] + * @example { + * "result": { + * "result": "deliverable", + * "deliverable": true, + * "catchall": false, + * "free": false, + * "role": true, + * "disposable": false + * }, + * "code": 2000, + * "message": "Success" + * } */ EmailResponse: { /** @@ -4843,7 +5582,30 @@ export interface components { }; /** * Phone Number Verification Response - * @example [object Object] + * @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: { /** @@ -5670,6 +6432,12 @@ export interface operations { * 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"]; + /** + * **Context** + * + * Limits search results, typically within g country. + */ + context?: components["parameters"]["ContextParam"]; }; }; responses: {