/*
* Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
*/
import * as z from "zod/v3";
import { remap as remap$ } from "../lib/primitives.js";
import { safeParse } from "../lib/schemas.js";
import { Result as SafeParseResult } from "../types/fp.js";
import { SDKValidationError } from "./errors/sdkvalidationerror.js";
export type CleansingInternationalBatchServiceResponseItemMatch = {
/**
* Address Quality Index. Offers a view of overall address quality (see the [AQI page](https://support.loqate.com/documentation/reportcodes/address-quality-index/) for more information), but is not used as a metric for deciding whether to accept an address which has been processed via Verify. **Please use the AVC to verify addresses**.
*/
aqi?: string | undefined;
aqiStatus?: string | undefined;
/**
* Address Verification Code. A response code which includes information associated with the parsing and matching of the address record. Use this to identify the level to which an address has been verified. See the [AVC page](https://support.loqate.com/documentation/reportcodes/address-verification-code/) for more information.
*/
avc?: string | undefined;
avcStatus?: string | undefined;
/**
* This field is available when adding "SERP" to the Loqate engine. Sometimes a site specification and compartment is assigned for delivery to a rural address that does not have a civic address. Example value: SITE 6 COMP 10.
*/
additionalContent?: string | undefined;
additionalContentStatus?: string | undefined;
/**
* The full address, correctly formatted for mailing in the relevant country, including line breaks specified using the AddressLineSeparator option. Do not use 'Address' as input when running CASS. The preferred input for CASS is (Address1 + Locality + AdministrativeArea + PostalCode + Country). However, (Address1 + Address2 + Country) will also work.
*/
address?: string | undefined;
addressStatus?: string | undefined;
/**
* The Address1-8 fields can be used to specify input address line data, and on output will contain the correctly formatted address split into individual address lines for mailing in the relevant country.
*/
address1?: string | undefined;
address1Status?: string | undefined;
address2?: string | undefined;
address2Status?: string | undefined;
address3?: string | undefined;
address3Status?: string | undefined;
address4?: string | undefined;
address4Status?: string | undefined;
address5?: string | undefined;
address5Status?: string | undefined;
address6?: string | undefined;
address6Status?: string | undefined;
address7?: string | undefined;
address7Status?: string | undefined;
address8?: string | undefined;
address8Status?: string | undefined;
/**
* If Server Option "OutputAddressFormat" is "Yes", then this field will contain the fields used to construct the "Address" Field. For example, "Organization
DeliveryAddress
Locality AdministrativeArea PostalCode". The default "
" line breaks can be changed with the AddressLineSeparator Server Option.
*/
addressFormat?: string | undefined;
addressFormatStatus?: string | undefined;
/**
* Every address in the Royal Mail Postal Address File (PAF) is assigned an 8-digit value that serves as a persistent reference to a building or delivery point, even when there are changes to a postcode.
*/
addressKey?: string | undefined;
addressKeyStatus?: string | undefined;
/**
* The most common geographic data element within a country. For instance, USA State, and Canadian Province.
*/
administrativeArea?: string | undefined;
administrativeAreaStatus?: string | undefined;
/**
* See [here](https://support.loqate.com/support/data-enhancement-administrativearea-iso-2-code/) for full details.
*/
administrativeAreaIso2?: string | undefined;
administrativeAreaIso2Status?: string | undefined;
/**
* The name indicator within the AdministrativeArea field, should one exist. For example, Taipai where the AdministrativeArea is Taipai City.
*/
administrativeAreaName?: string | undefined;
administrativeAreaNameStatus?: string | undefined;
/**
* The trailing AdministrativeArea type, should one exist. For example, City where the AdministrativeArea is Taipai City.
*/
administrativeAreaTrailingType?: string | undefined;
administrativeAreaTrailingTypeStatus?: string | undefined;
/**
* The AdministrativeArea type, should one exist. For example, City where the AdministrativeArea is Taipai City.
*/
administrativeAreaType?: string | undefined;
administrativeAreaTypeStatus?: string | undefined;
/**
* Alternative value for AdministrativeArea, or County, in the United Kingdom. Defined and supplied by Royal Mail. This is the Unitary Authority name (where one is present), and provided by the Office for National Statistics. This field can change more frequently due to administrative changes in the respective area. E.g. "Bristol, City Of".
*/
administrativeCounty?: string | undefined;
administrativeCountyStatus?: string | undefined;
/**
* Automated Zone Indicator: specifies if carrier sort rates apply, and if a merge is allowed. This field will be blank due to performance reasons unless the server option CassZipFields is set to "Yes". See [here](https://support.loqate.com/cass2-output-field-descriptions/) for more details.
*/
autoZoneIndicator?: string | undefined;
autoZoneIndicatorStatus?: string | undefined;
/**
* Standard barcode based on the DPID.
*/
barcode?: string | undefined;
barcodeStatus?: string | undefined;
/**
* Defines the census data that represent the smallest geographic unit used by the US Census Bureau. See [here](https://support.loqate.com/us-census-data-enhancement/) for full details.
*/
blockCode?: string | undefined;
blockCodeStatus?: string | undefined;
/**
* Defines the census data that represent the group of Blocks. See [here](https://support.loqate.com/us-census-data-enhancement/) for full details.
*/
blockGroupCode?: string | undefined;
blockGroupCodeStatus?: string | undefined;
/**
* The utility unit number consists of a letter followed by four numbers (Norway/NO/NOR only). Examples include: H0001, L0002, U0004, K0032.
*/
bolignummer?: string | undefined;
bolignummerStatus?: string | undefined;
/**
* Box lobby name or New Zealand Post shop name (New Zealand/NZ/NZL only). Examples include: MAUNGATAPERE POSTCENTRE, NEWMARKET POSTSHOP, MOUNT COOK.
*/
boxBagLobbyName?: string | undefined;
boxBagLobbyNameStatus?: string | undefined;
/**
* Branch name of Department field (Canada/CA/CAN only). Examples include: Agence De Parcs Canada, Fisheries and Oceans, Ottawa District Office.
*/
branchName?: string | undefined;
branchNameStatus?: string | undefined;
/**
* The descriptive name identifying an individual location, should one exist.
*/
building?: string | undefined;
buildingStatus?: string | undefined;
/**
* The leading building type indicator within the Building field, should one exist. For instance, if Building contains "BLOC C" BuildingLeadingType contains "BLOC" if a sufficient level of parsing detail exists for the particular country.
*/
buildingLeadingType?: string | undefined;
buildingLeadingTypeStatus?: string | undefined;
/**
* The name indicator within the Building field, should one exist. For instance, if Building contains "WESTMINSTER HOUSE" BuildingName contains "WESTMINSTER" if a sufficient level of parsing detail exists for the particular country.
*/
buildingName?: string | undefined;
buildingNameStatus?: string | undefined;
/**
* The trailing building type indicator within the Building field, should one exist. For instance, if Building contains "WESTMINSTER HOUSE" BuildingTrailingType contains "HOUSE" if a sufficient level of parsing detail exists within a particular country.
*/
buildingTrailingType?: string | undefined;
buildingTrailingTypeStatus?: string | undefined;
/**
* The Building indicator within the Building field, should one exist. Examples include Place, 城.
*/
buildingType?: string | undefined;
buildingTypeStatus?: string | undefined;
/**
* The carrier route code assigned to a mail delivery or collection route within a 5-digit ZIP Code. This is also referred to as CRID. See [here](https://support.loqate.com/cass2-output-field-descriptions/) for more details.
*/
carrierRoute?: string | undefined;
carrierRouteStatus?: string | undefined;
/**
* Defines that the Census data is referencing the Core-Based Statistical Area (CBSA), in typically 5-digits value. See [here](https://support.loqate.com/us-census-data-enhancement/) for full details.
*/
cbsaCode?: string | undefined;
cbsaCodeStatus?: string | undefined;
/**
* Defines that the Census data is referencing the Core Based Statistical Area (CBSA). See [here](https://support.loqate.com/support/data-enhancement-us-census-data-fields/) for full details.
*/
cbsaMetropolitanStatisticalArea?: string | undefined;
cbsaMetropolitanStatisticalAreaStatus?: string | undefined;
/**
* CBSA Micropolitan Statistical Area. See [here](https://support.loqate.com/support/data-enhancement-us-census-data-fields/) for full details.
*/
cbsaMicropolitanStatisticalArea?: string | undefined;
cbsaMicropolitanStatisticalAreaStatus?: string | undefined;
/**
* Refers to the official name given to the CBSAs which complements the CBSACode field value as defined above. For definition of CBSA, please refer to the CBSACode field definition above.
*/
cbsaName?: string | undefined;
cbsaNameStatus?: string | undefined;
/**
* Census Class Code defines the census classification of a place. Census Class Code corresponding to the FIPS 55-3 standard. Census Class Codes are alphanumeric and can be referred at https://www.census.gov/library/reference/code-lists/class-codes.html. Census Class Codes are published only for level 3 and 4 Administrative Areas and Zones. See [here](https://support.loqate.com/us-census-data-enhancement/) for more details.
*/
censusClassCode?: string | undefined;
censusClassCodeStatus?: string | undefined;
/**
* Census Code defines that the Census data is referencing the Census Codes, previously known as the Federal Information Processing Standard (FIPS) code. Unlike its previous FIPS code value, Census Codes are currently used as the government code to represent Admin Places in the U.S. Census Codes are published for Administrative Areas (Admin Level 1-4 in the U.S.) and all Zones with official government codes.
*/
censusCode?: string | undefined;
censusCodeStatus?: string | undefined;
/**
* The address level for which the census data was returned. In Census Plus, this field will show the value "Premise", the most accurate address level in Census Plus data, when there is Premise level match found. Otherwise, the value field would not be visible.
*/
censusIndicator?: string | undefined;
censusIndicatorStatus?: string | undefined;
/**
* Delivery Point Bar Code check digit. This is the last character of the DeliveryPointBarCode.
*/
checkDigit?: string | undefined;
checkDigitStatus?: string | undefined;
/**
* This field refers to a residential grouping commonly used in Indonesian addresses, similar to neighbourhood or resident association information. See [here](https://support.loqate.com/documentation/fielddescrip/addfields/) for more details.
*/
cluster?: string | undefined;
clusterStatus?: string | undefined;
/**
* Indicates whether the address is associated with a Commercial Mail Receiving Agency(CMRA). See [here](https://support.loqate.com/cass2-output-field-descriptions/) for more details.
*/
cmraIndicator?: string | undefined;
cmraIndicatorStatus?: string | undefined;
/**
* The congressional district to which the address belongs.
*/
congressionalDistrict?: string | undefined;
congressionalDistrictStatus?: string | undefined;
/**
* Contact name information.
*/
contact?: string | undefined;
contactStatus?: string | undefined;
/**
* This field is used to supply the country name or code (ISO 3166 2-character country code and ISO 3166 3-character country code).
*/
country?: string | undefined;
countryStatus?: string | undefined;
/**
* The ISO 3166 official country name.
*/
countryName?: string | undefined;
countryNameStatus?: string | undefined;
countyFIPS?: string | undefined;
countyFIPSStatus?: string | undefined;
/**
* The primary legal divisions of most states are termed counties. See [here](https://support.loqate.com/us-census-data-enhancement/) for full details.
*/
countyCode?: string | undefined;
countyCodeStatus?: string | undefined;
/**
* A value of "Y" indicates that the record matched to a high-rise default, rural route default, or street default record in the ZIP+4 file. Blank = not a default.
*/
defaultFlag?: string | undefined;
defaultFlagStatus?: string | undefined;
/**
* The full address minus the Organization, Locality, AdministrativeArea hierarchy and PostalCode hierarchy fields, correctly formatted for mailing in the relevant country, including line breaks specified using the AddressLineSeparator option.
*/
deliveryAddress?: string | undefined;
deliveryAddressStatus?: string | undefined;
/**
* The DeliveryAddress1-8 fields contain the individual lines contained within the DeliveryAddress field.
*/
deliveryAddress1?: string | undefined;
deliveryAddress1Status?: string | undefined;
deliveryAddress2?: string | undefined;
deliveryAddress2Status?: string | undefined;
deliveryAddress3?: string | undefined;
deliveryAddress3Status?: string | undefined;
deliveryAddress4?: string | undefined;
deliveryAddress4Status?: string | undefined;
deliveryAddress5?: string | undefined;
deliveryAddress5Status?: string | undefined;
deliveryAddress6?: string | undefined;
deliveryAddress6Status?: string | undefined;
deliveryAddress7?: string | undefined;
deliveryAddress7Status?: string | undefined;
deliveryAddress8?: string | undefined;
deliveryAddress8Status?: string | undefined;
/**
* If Server Option "OutputAddressFormat" is "Yes", then this field will contain the fields used to construct the "DeliveryAddress" Field. For example, "Organization
DeliveryAddress
Locality AdministrativeArea PostalCode". The default "
" line breaks can be changed with the AddressLineSeparator Server Option.
*/
deliveryAddressFormat?: string | undefined;
deliveryAddressFormatStatus?: string | undefined;
/**
* This field is available when adding "SERP" to the Loqate engine. It contains the Station Information to direct mail to the proper postal installation for non-civic addresses. Example value: STN A.
*/
deliveryInstallation?: string | undefined;
deliveryInstallationStatus?: string | undefined;
/**
* The name of a village, town, municipality, city, or metropolitan area that forms part of a Delivery Installation Name (Canada/CA/CAN only). Examples include: Ladysmith, Roxton Pond.
*/
deliveryInstallationAreaName?: string | undefined;
deliveryInstallationAreaNameStatus?: string | undefined;
/**
* When more than one delivery installation serves an area described by the Delivery Installation Area Name, the qualifier name uniquely identifies the delivery installation (Canada/CA/CAN only). Examples include: Cap-A-L'aigle, B, St Michel, 32, Bank Hunt Club.
*/
deliveryInstallationQualifierName?: string | undefined;
deliveryInstallationQualifierNameStatus?: string | undefined;
/**
* An abbreviation that represents the type of installation (Canada/CA/CAN only). Examples include: STN - Postal Station, PO - Post Office, BDP - Bureau De Poste.
*/
deliveryInstallationType?: string | undefined;
deliveryInstallationTypeStatus?: string | undefined;
/**
* A 3-digit code which consists of the 2-digit delivery point code and 1-digit check digit. This is used to create the 12-digit POSTNET barcode which consists of the 5-digit ZIP Code, 4-digit ZIP+4 addon code, and this 3-digit code.
*/
deliveryPointBarCode?: string | undefined;
deliveryPointBarCodeStatus?: string | undefined;
/**
* Organizational department information.
*/
department?: string | undefined;
departmentStatus?: string | undefined;
/**
* A smaller population center data element, dependent on the contents of the Locality field. For instance, Turkish Neighborhood.
*/
dependentLocality?: string | undefined;
dependentLocalityStatus?: string | undefined;
/**
* The leading dependent locality type indicator, should one exist. For example, "Rancheria San Jose Cacahuatepec" where the DependentLocality is Ciudad Renacimiento.
*/
dependentLocalityLeadingType?: string | undefined;
dependentLocalityLeadingTypeStatus?: string | undefined;
/**
* The name indicator within the DependentLocality field, should one exist. For instance, if DependentLocality contains "Dong Cheng Qu" DependentLocalityName contains "Dong Cheng" if a sufficient level of parsing detail exists for the particular country.
*/
dependentLocalityName?: string | undefined;
dependentLocalityNameStatus?: string | undefined;
/**
* The DependentLocality indicator within the DependentLocality field, should one exist. For instance, if DependentLocality contains "Dong Cheng Qu" DependentLocalityType contains "Qu" if a sufficient level of parsing detail exists for the particular country.
*/
dependentLocalityType?: string | undefined;
dependentLocalityTypeStatus?: string | undefined;
/**
* The dependent street or block data element within a country. For instance, UK Dependent Street.
*/
dependentThoroughfare?: string | undefined;
dependentThoroughfareStatus?: string | undefined;
/**
* The leading thoroughfare type indicator within the DependentThoroughfare field, should one exist. For instance, if DependentThoroughfare contains "RUE DE LA GARE" DependentThoroughfareLeadingType contains "RUE" if a sufficient level of parsing detail exists for the particular country.
*/
dependentThoroughfareLeadingType?: string | undefined;
dependentThoroughfareLeadingTypeStatus?: string | undefined;
/**
* The name indicator within the DependentThoroughfare field, should one exist. For instance, if DependentThoroughfare contains "N MAIN ST" DependentThoroughfareName contains "MAIN" if a sufficient level of parsing detail exists for the particular country.
*/
dependentThoroughfareName?: string | undefined;
dependentThoroughfareNameStatus?: string | undefined;
/**
* The postfix directional contained within the DependentThoroughfare field, should one exist. For instance, if DependentThoroughfare contains "MAIN ST N" DependentThoroughfarePostDirection contains "N" if a sufficient level of parsing detail exists for the particular country.
*/
dependentThoroughfarePostDirection?: string | undefined;
dependentThoroughfarePostDirectionStatus?: string | undefined;
/**
* The prefix directional contained within the DependentThoroughfare field, should one exist. For instance, if DependentThoroughfare contains "N MAIN ST" DependentThoroughfarePreDirection contains "N" if a sufficient level of parsing detail exists for the particular country.
*/
dependentThoroughfarePreDirection?: string | undefined;
dependentThoroughfarePreDirectionStatus?: string | undefined;
dependentThoroughfareTrailingType?: string | undefined;
dependentThoroughfareTrailingTypeStatus?: string | undefined;
dna?: string | undefined;
dnaStatus?: string | undefined;
/**
* The smallest population center data element, dependent on both the contents of the Locality and DependentLocality fields. For instance, UK Village.
*/
doubleDependentLocality?: string | undefined;
doubleDependentLocalityStatus?: string | undefined;
/**
* The name indicator within the DoubleDependentLocality field, should one exist. For instance, if DoubleDependentLocality contains "Xin Zhuang Zhen" DoubleDependentLocalityName contains "Xin Zhuang" if a sufficient level of parsing detail exists for the particular country.
*/
doubleDependentLocalityName?: string | undefined;
doubleDependentLocalityNameStatus?: string | undefined;
/**
* The DoubleDependentLocality indicator within the DoubleDependentLocality field, should one exist. For instance, if DoubleDependentLocality contains "Xin Zhuang Zhen" DoubleDependentLocalityType contains "Zhen" if a sufficient level of parsing detail exists for the particular country.
*/
doubleDependentLocalityType?: string | undefined;
doubleDependentLocalityTypeStatus?: string | undefined;
/**
* The Delivery Point Suffix (DPS) is used with a postcode to generate a machine-readable barcode (RM4SCC), which then serves as a unique reference to an active property or delivery point. It is made up of one number (1-9) and one character (A-T), and is assigned by Royal Mail. It is possible that an address is not assigned a DPS value, in which case a default value of 9U or 9Z is used. 1A is also reserved for postcodes that have PostCodeType = L (Large User). See [here](https://support.loqate.com/gb-enhancement-data-fields/) for more details.
*/
dps?: string | undefined;
dpsStatus?: string | undefined;
/**
* A unique 8-digit number which is assigned for every new address to the source address database.
*/
dpid?: string | undefined;
dpidStatus?: string | undefined;
/**
* Delivery Point Validation (DPV) Confirmed Indicator: specifies the deliverability of the address. See [here](https://support.loqate.com/cass2-output-field-descriptions/) for more details.
*/
dpvConfirmedIndicator?: string | undefined;
dpvConfirmedIndicatorStatus?: string | undefined;
/**
* Delivery Point Validation footnotes. There can be one or more two-character footnotes. This field is used together with the DPVConfirmedIndicator field to understand the input address' validity and deliverability. See [here](https://support.loqate.com/cass2-output-field-descriptions/) for more details.
*/
dpvFootnotes?: string | undefined;
dpvFootnotesStatus?: string | undefined;
/**
* This field will always be empty.
*/
dpvlacsIndicator?: string | undefined;
dpvlacsIndicatorStatus?: string | undefined;
/**
* A flag that indicates mail is delivered to a single receptible at a site. See [here](https://support.loqate.com/cass2-output-field-descriptions/) for more details.
*/
dropSiteIndicator?: string | undefined;
dropSiteIndicatorStatus?: string | undefined;
/**
* eLOT directional indicator. See the eLOTNumber field for additional information. See [here](https://support.loqate.com/cass2-output-field-descriptions/) for more details.
*/
eLOTCode?: string | undefined;
eLOTCodeStatus?: string | undefined;
/**
* 4-digit sequence number for eLOT (Enhanced Line of Travel): gives mailers the ability to sort their mailings in approximate carrier-casing sequence. eLOT sorting allows for carrier route presort discounts. Blank = address not submitted for eLOT. See [here](https://support.loqate.com/cass2-output-field-descriptions/) for more details.
*/
eLOTNumber?: string | undefined;
eLOTNumberStatus?: string | undefined;
/**
* Enhanced DPV Return Code. This is populated when there is more than one valid DPVConfirmedIndicator. When present, this should take precedence over DPVConfirmedIndicator. See [here](https://support.loqate.com/cass2-output-field-descriptions/) for more details.
*/
enhancedReturnCode?: string | undefined;
enhancedReturnCodeStatus?: string | undefined;
/**
* A value of "Y" indicates that the address matched a record in the EWS (Early Warning System) file, thus resulting in a ZIP+4 no match. Blank = address was not flagged by EWS.
*/
ewsFlag?: string | undefined;
ewsFlagStatus?: string | undefined;
/**
* The False Positive table flags the False Positive addresses. This is a flag to determine whether a mailing list is being generated or created during validation. Creating a mailing list through DPV certification is not allowed by the USPS. See [here](https://support.loqate.com/cass2-output-field-descriptions/) for more details.
*/
falsePositiveIndicator?: string | undefined;
falsePositiveIndicatorStatus?: string | undefined;
/**
* A code assigned to Postal Service™ facilities (primarily Post Offices) to collect cost and statistical data and compile revenue and expense data. An example output for 805 Veterans Blvd, Redwood City, CA 94063 is 056378. Note that the reference for this information can be found [here](https://postalpro.usps.com/address-quality/AIS_Products_Technical_Guide). This field will be blank due to performance reasons unless the server option CassZipFields is set to "Yes".
*/
finance?: string | undefined;
financeStatus?: string | undefined;
/**
* The 5 digit FIPS (Federal Information Processing Standard) code which uniquely identifies counties. The first two will be the state code and the last three are the county. For example, San Francisco, CA is 06075.
*/
fipsCountyCode?: string | undefined;
fipsCountyCodeStatus?: string | undefined;
/**
* Floor or level number (including alpha characters).
*/
floorNumber?: string | undefined;
floorNumberStatus?: string | undefined;
/**
* Type of floor or level.
*/
floorType?: string | undefined;
floorTypeStatus?: string | undefined;
/**
* Default value for AdministrativeArea, or County, in the United Kingdom. Defined and supplied by Royal Mail. These values were used prior to the postcode system introduced in the 1970s to differentiate Locality names that were the same, or similar (e.g. 'Avon'). This field is assigned as the AdministrativeArea default as it remains static and provides a consistent geographic boundary.
*/
formerPostalCounty?: string | undefined;
formerPostalCountyStatus?: string | undefined;
/**
* Function or job title information.
*/
function?: string | undefined;
functionStatus?: string | undefined;
/**
* This field is available when adding "SERP" to the Loqate engine. It identifies a General Delivery type address - Example value: GD.
*/
generalDelivery?: string | undefined;
generalDeliveryStatus?: string | undefined;
/**
* The [GeoAccuracy](https://support.loqate.com/geoaccuracy) code.
*/
geoAccuracy?: string | undefined;
geoAccuracyStatus?: string | undefined;
/**
* The radius of accuracy in meters, giving an indication of the likely maximum distance between the given geocode and the physical location. Please note that this field is derived from and therefore dependent on the accuracy and coverage of the underlying reference data.
*/
geoDistance?: string | undefined;
geoDistanceStatus?: string | undefined;
/**
* GNIS Feature ID defines the census data that is referencing the Geographic Names Information System (GNIS) Feature ID. See [here](https://support.loqate.com/us-census-data-enhancement/) for full details.
*/
gnisFeatureID?: string | undefined;
gnisFeatureIDStatus?: string | undefined;
hasSubPremise?: string | undefined;
hasSubPremiseStatus?: string | undefined;
/**
* [https://support.loqate.com/documentation/fielddescrip/objfeilds/](https://support.loqate.com/documentation/fielddescrip/objfeilds/)
*/
hyphenClass?: string | undefined;
hyphenClassStatus?: string | undefined;
/**
* Optional. This field will be passed through to the output unchanged.
*/
id?: string | undefined;
idStatus?: string | undefined;
/**
* The ISO 3166 2-character country code.
*/
iso31662?: string | undefined;
iso31662Status?: string | undefined;
/**
* The ISO 3166 3-character country code.
*/
iso31663?: string | undefined;
iso31663Status?: string | undefined;
/**
* The ISO 3166 3-digit numeric country code.
*/
iso3166N?: string | undefined;
iso3166NStatus?: string | undefined;
/**
* Code returned by LACSLink® after querying the LACSLink® database. See [here](https://support.loqate.com/cass2-output-field-descriptions/) for more details.
*/
lacsLinkCode?: string | undefined;
lacsLinkCodeStatus?: string | undefined;
/**
* Indicator returned by LACSLink® after querying the LACSLink® database. See [here](https://support.loqate.com/cass2-output-field-descriptions/) for more details.
*/
lacsLinkIndicator?: string | undefined;
lacsLinkIndicatorStatus?: string | undefined;
/**
* A value of "L" indicates that the input address matched an entry in the Locatable Address Conversion Service database and the input address has been converted from a rural-style address to a city-style address. Blank = no LACS Status returned.
*/
lacsStatus?: string | undefined;
lacsStatusStatus?: string | undefined;
/**
* The WGS 84 latitude in decimal degrees format.
*/
latitude?: string | undefined;
/**
* Each of the following '-Status' fields is an indicator to show if a field is Verified or Identified.
*/
latitudeStatus?: string | undefined;
/**
* The most common population center data element within a country. For instance, USA City, Canadian Municipality.
*/
locality?: string | undefined;
localityStatus?: string | undefined;
/**
* Information that could be present along with the Locality. This information is not considered as part of the Postal authority data but is still necessary for parsing the address in order to obtain a complete delivery address. Available if a sufficient level of parsing detail exists within a particular country. Example: 12 rue de la Gare, 75019 PARIS CEDEX, France. CEDEX will be considered as Locality Extra.
*/
localityExtra?: string | undefined;
localityExtraStatus?: string | undefined;
/**
* The name indicator within the Locality field, should one exist. For example: Jeju where the Locality is Jeju-Si.
*/
localityName?: string | undefined;
localityNameStatus?: string | undefined;
/**
* This field combines both the Locality and LocalityExtra components, to capture specific locality information that includes essential details for accurate address parsing and delivery. For example, in the address "12 rue de la Gare, 75019 PARIS CEDEX, France," the term "Paris CEDEX" represents the LocalitySpecial. It encompasses both the primary locality (Paris) and the additional locality information (CEDEX) that is necessary for a complete and precise delivery address.
*/
localitySpecial?: string | undefined;
localitySpecialStatus?: string | undefined;
/**
* The type indicator for Locality, should one exist. For example: Dist. where the Locality is Da'an Dist.
*/
localityTrailingType?: string | undefined;
localityTrailingTypeStatus?: string | undefined;
/**
* The type indicator for Locality, should one exist. For example: Dist. where the Locality is Da'an Dist.
*/
localityType?: string | undefined;
localityTypeStatus?: string | undefined;
/**
* The WGS 84 longitude in decimal degrees format.
*/
longitude?: string | undefined;
longitudeStatus?: string | undefined;
/**
* Allotment number.
*/
lotNumber?: string | undefined;
lotNumberStatus?: string | undefined;
/**
* A Makani number is a 10-digit number which gives you the exact location of the entrance of a building (United Arab Emirates/AE/ARE only). For example: 3000595279.
*/
makaniNumber?: string | undefined;
makaniNumberStatus?: string | undefined;
/**
* The Loqate Engine uses a set of rules to match the input with the reference data. Each rule is identified by a match rule label. Please refer to the [Match Process](https://support.loqate.com/support/available-processes/match-process/) and [Match Rule Syntax](https://support.loqate.com/support/options/match-rules-syntax/) pages for more information regarding the Match Rules.
*/
matchRuleLabel?: string | undefined;
matchRuleLabelStatus?: string | undefined;
/**
* Defines the census data that is referring to a county or group of closely tied contiguous counties that serve as a distinct employment region within a metropolitan statistical area that has a population core of at least 2.5 million. See [here](https://support.loqate.com/us-census-data-enhancement/) for full details.
*/
metroDivisionCode?: string | undefined;
metroDivisionCodeStatus?: string | undefined;
/**
* MetroDivisionName refers to the official name given to the Metropolitan Division which complements the MetroDivisionCode field value as defined above. For definition of Metropolitan Division, please refer to the MetroDivisionCode field definition above.
*/
metroDivisionName?: string | undefined;
metroDivisionNameStatus?: string | undefined;
/**
* Defines that the Census data is referring to a county or group of closely tied contiguous counties that serve as a distinct employment region within a metropolitan statistical area that has a population core of at least 2.5 million. See [here](https://support.loqate.com/support/data-enhancement-us-census-data-fields/) for full details.
*/
metropolitanDivision?: string | undefined;
metropolitanDivisionStatus?: string | undefined;
/**
* DPV Non-Delivery Day Flag that indicates mail delivery is not performed every day of the week. See [here](https://support.loqate.com/cass2-output-field-descriptions/) for more details.
*/
nddFlag?: string | undefined;
nddFlagStatus?: string | undefined;
/**
* DPV Non-Delivery Day Values. This seven-character field represents Sunday-Saturday and will contain an **N** for the days where mail **can** be delivered. For example, "YNNNNNY" means mail is is not received on Saturday or Sunday (e.g. the business is closed).
*/
nddValues?: string | undefined;
nddValuesStatus?: string | undefined;
/**
* NECTACode refers to a set of geographic areas that are defined using cities and towns in the six New England states, in typically 5-digits value. See [here](https://support.loqate.com/us-census-data-enhancement/) for full details.
*/
nectaCode?: string | undefined;
nectaCodeStatus?: string | undefined;
/**
* Defines NECTAs (see definition above) containing a single core with a population of at least 2.5 million that are subdivided to form smaller groupings of cities and towns referred to as NECTA Divisions.
*/
nectaDivision?: string | undefined;
nectaDivisionStatus?: string | undefined;
/**
* NECTA Division defines NECTAs (see definition under NECTACode field above) containing a single core with a population of at least 2.5 million that are subdivided to form smaller groupings of cities and towns referred to as NECTA Divisions. NECTADivisionCode is typically represented in a 5-digits value.
*/
nectaDivisionCode?: string | undefined;
nectaDivisionCodeStatus?: string | undefined;
/**
* NECTADivisionName refers to the official name given to the NECTA Divisions which complements the NECTADivisionCode field value as defined above. For definition of NECTA Division, please refer to the NECTADivisionCode field definition above.
*/
nectaDivisionName?: string | undefined;
nectaDivisionNameStatus?: string | undefined;
/**
* Defines a set of geographic areas that are defined using cities and towns in the six New England states. See [here](https://support.loqate.com/support/data-enhancement-us-census-data-fields/) for full details.
*/
nectaMetropolitanStatisticalArea?: string | undefined;
nectaMetropolitanStatisticalAreaStatus?: string | undefined;
/**
* NECTA Micropolitan Statistical Area. See [here](https://support.loqate.com/support/data-enhancement-us-census-data-fields/) for full details.
*/
nectaMicropolitanStatisticalArea?: string | undefined;
nectaMicropolitanStatisticalAreaStatus?: string | undefined;
/**
* NECTAName refers to the official name given to the NECTAs which complements the NECTACode field value as defined above. See [here](https://support.loqate.com/us-census-data-enhancement/) for full details.
*/
nectaName?: string | undefined;
nectaNameStatus?: string | undefined;
/**
* Indicates the address is not receiving delivery, and the address is not counted as a possible delivery. These addresses are not receiving delivery because A) delivery has not been established; B) customer receives mail as a part of a drop; or C) the address is no longer a possible delivery because the carrier destroys or returns all the mail. See [here](https://support.loqate.com/cass2-output-field-descriptions/) for more details.
*/
noStatIndicator?: string | undefined;
noStatIndicatorStatus?: string | undefined;
/**
* The reason mail delivery was not provided. See [here](https://support.loqate.com/cass2-output-field-descriptions/) for more details.
*/
noStatReason?: string | undefined;
noStatReasonStatus?: string | undefined;
/**
* DPV No Secure Location. The door is accessible, but a package will not be left due to security concerns. See [here](https://support.loqate.com/cass2-output-field-descriptions/) for more details.
*/
nsl?: string | undefined;
nslStatus?: string | undefined;
/**
* OldMSACode represents an obsolete value of MSA (metropolitan areas) that were defined by the OMB in 1990. See [here](https://support.loqate.com/us-census-data-enhancement/) for full details.
*/
oldMSACode?: string | undefined;
oldMSACodeStatus?: string | undefined;
/**
* OldMSAName refers to the official name given to the MSA (metropolitan areas) which complements the OldMSACode field value as defined above. For definition of MSA, please refer to the OldMSACode field definition above.
*/
oldMSAName?: string | undefined;
oldMSANameStatus?: string | undefined;
/**
* Each Organization that is added to PAF is assigned an 8-digit number that serves as a unique delivery point when used alongside the AddressKey and PostcodeType. This is useful to identify small businesses that share an address (the address will appear multiple times in the PAF). For residential addresses, OrganisationKey is set to 0.
*/
organisationKey?: string | undefined;
organisationKeyStatus?: string | undefined;
/**
* The business name associated with a particular delivery point, should one exist.
*/
organization?: string | undefined;
organizationStatus?: string | undefined;
/**
* The name indicator within the Organization field, should one exist. For instance, if Organization contains 'Loqate Inc" OrganizationName contains "Loqate" if a sufficient level of parsing detail exists for the particular country.
*/
organizationName?: string | undefined;
organizationNameStatus?: string | undefined;
/**
* The type indicator contained within the Organization field, should one exist. For instance, if Organization contains "Loqate Inc" OrganizationType contains "Inc" if a sufficient level of parsing detail exists for the particular country.
*/
organizationType?: string | undefined;
organizationTypeStatus?: string | undefined;
/**
* The trailing type indicator contained within the Organization field, should one exist. For example: Corp., Gmbh.
*/
organizationTrailingType?: string | undefined;
organizationTrailingTypeStatus?: string | undefined;
/**
* The Owning UDPRN is an eight-digit UDPRN key of the 'shell' or 'owning' PAF building record of a Multiple Residence (flat, unit or apartment). For example, if "Ground Floor Flat, Princes House" is a Multiple Residence record, then "Princes House" would be its owning building.
*/
owningUDPRN?: string | undefined;
owningUDPRNStatus?: string | undefined;
/**
* The Parent UPRN is a twelve-digit UPRN of the 'shell' or 'owning' building of a Multiple Residence (flat, unit or apartment). Note that this is inferred from the relationships of an Multi Residence with a PAF parent address record.
*/
parentUPRN?: string | undefined;
parentUPRNStatus?: string | undefined;
/**
* This field will capture information that the CASS engine is able to parse out of the input during the matching process.
*/
parsedGarbage?: string | undefined;
parsedGarbageStatus?: string | undefined;
/**
* PO Box Street Address (PBSA) Indicator: specifies that the mailing address is a PO box. For example, 131 S Center St # 3094, Collierville TN 38027 is a PO box in the USPS facility at that address. See [here](https://support.loqate.com/cass2-output-field-descriptions/) for more details.
*/
pbsaIndicator?: string | undefined;
pbsaIndicatorStatus?: string | undefined;
/**
* Private Mailbox Value will be appended to the PrimaryAddressLine field. This information used to be in SecondaryAddressLine. For example, this will be the "252" in "PMB 252".
*/
pmbNumber?: string | undefined;
pmbNumberStatus?: string | undefined;
/**
* Private Mailbox Type will be appended to the PrimaryAddressLine field. For example, if the Private Mailbox Value was "PMB 100", then PMBType would be "PMB". PMBs allow individuals or offices a private mailbox to simplify internal mail distribution, retain privacy, or have convenient hours of mail pickup. They can be rented as needed through a commercial mail receiving agency (CMRA), which may be more cost-effective than renting a box at the post office.
*/
pmbType?: string | undefined;
pmbTypeStatus?: string | undefined;
/**
* There is only one ZIP Code for a given facility and the facility has no other form of postal delivery other than a PO Box. See [here](https://support.loqate.com/cass2-output-field-descriptions/) for more details.
*/
poBoxOnly?: string | undefined;
poBoxOnlyStatus?: string | undefined;
/**
* The complete postal code for a particular delivery point, should such detail be able to be determined.
*/
postalCode?: string | undefined;
postalCodeStatus?: string | undefined;
/**
* The primary postal code used for a particular country. For instance, USA Zip, Canadian Postcode, Indian PINcode.
*/
postalCodePrimary?: string | undefined;
postalCodePrimaryStatus?: string | undefined;
/**
* Secondary postal code information, if used in a particular country and if such detail is able to be determined and reference data is available. For instance, USA Zip Plus 4.
*/
postalCodeSecondary?: string | undefined;
postalCodeSecondaryStatus?: string | undefined;
/**
* The post box for a particular delivery point, should one exist.
*/
postBox?: string | undefined;
postBoxStatus?: string | undefined;
/**
* Postal delivery number if the address is a postal delivery type.
*/
postBoxNum?: string | undefined;
postBoxNumStatus?: string | undefined;
/**
* The alphanumeric indicator within the PostBox field, should one exist. For instance, if PostBox contains "PO BOX 1234" PostBoxNumber contains "1234" if a sufficient level of parsing detail exists for the particular country.
*/
postBoxNumber?: string | undefined;
postBoxNumberStatus?: string | undefined;
/**
* Postal delivery number prefix related to the postal delivery number.
*/
postBoxNumberPrefix?: string | undefined;
postBoxNumberPrefixStatus?: string | undefined;
/**
* Postal delivery number suffix related to the postal delivery number.
*/
postBoxNumberSuffix?: string | undefined;
postBoxNumberSuffixStatus?: string | undefined;
/**
* The type indicator contained within the PostBox field, should one exist. For instance, if PostBox contains "PO BOX 1234" PostBoxType contains "PO BOX" if a sufficient level of parsing detail exists for the particular country.
*/
postBoxType?: string | undefined;
postBoxTypeStatus?: string | undefined;
/**
* This can be one of two values - see [here](https://support.loqate.com/gb-enhancement-data-fields/) for full details. This value can also be empty (not assigned).
*/
postcodeType?: string | undefined;
postcodeTypeStatus?: string | undefined;
/**
* Also known as Barcode Sort Plan (BSP) number. The number of one of 54 individual sort regions around Australia. To qualify for Australia Post's PreSort Letters Service, letters must be sorted based on this number.
*/
preSortZone?: string | undefined;
preSortZoneStatus?: string | undefined;
/**
* The alphanumeric code identifying an individual location, should one exist.
*/
premise?: string | undefined;
premiseStatus?: string | undefined;
/**
* Information that could be present as part of the Premise field. This information is not considered as part of the Postal authority data but is still necessary for parsing the address in order to obtain a complete delivery address. Available if a sufficient level of parsing detail exists within a particular country. Example: In French address, the Premise number could be followed by words bis and ter which will be considered as Premise Extra . 25 bis rue Emile Zola, 91190 GIF SUR YVETTE, France. Bis will be considered as PremiseExtra.
*/
premiseExtra?: string | undefined;
premiseExtraStatus?: string | undefined;
/**
* The alphanumeric indicator within the Premise field, should one exist. For instance, if Premise contains "Plot 7/7A" PremiseNumber contains "7/7A" if a sufficient level of parsing detail exists within a particular country.
*/
premiseNumber?: string | undefined;
premiseNumberStatus?: string | undefined;
/**
* The leading premise type indicator within the Premise field, should one exist. For instance, if Premise contains "Plot 7/7A" PremiseType contains "Plot" if a sufficient level of parsing detail exists within a particular country.
*/
premiseType?: string | undefined;
premiseTypeStatus?: string | undefined;
/**
* Primary address line in standardized format.
*/
primaryAddressLine?: string | undefined;
primaryAddressLineStatus?: string | undefined;
/**
* Thoroughfare number for a property (first number in a property ranged address).
*/
primaryPremise?: string | undefined;
primaryPremiseStatus?: string | undefined;
/**
* Suffix for the thoroughfare number.
*/
primaryPremiseSuffix?: string | undefined;
primaryPremiseSuffixStatus?: string | undefined;
/**
* Also known as a PreSort Indicator. To qualify for Australia Post's Print Post Service, letters must be sorted based on this number.
*/
printPostZone?: string | undefined;
printPostZoneStatus?: string | undefined;
/**
* See [here](https://support.loqate.com/documentation/fielddescrip/serp-fields/) for full details.
*/
questionable?: string | undefined;
questionableStatus?: string | undefined;
/**
* Record type of address that is confirmed as a valid delivery address. See [here](https://support.loqate.com/cass2-output-field-descriptions/) for more details.
*/
recordType?: string | undefined;
recordTypeStatus?: string | undefined;
/**
* See [here](https://support.loqate.com/residential-commercial-flag/) for full details.
*/
resComFlag?: string | undefined;
resComFlagStatus?: string | undefined;
/**
* A flag indicating if the address is known to be residential or commercial. Values are "R" (residential), "C" (commercial), or blank (unknown).
*/
residentialCommercialFlag?: string | undefined;
residentialCommercialFlagStatus?: string | undefined;
/**
* This field indicates whether the input address is a residential address or a business address. See [here](https://support.loqate.com/cass2-output-field-descriptions/) for more details.
*/
residentialDelivery?: string | undefined;
residentialDeliveryStatus?: string | undefined;
/**
* "VALID" for valid addresses. Otherwise, internal error code.
*/
result?: string | undefined;
resultStatus?: string | undefined;
/**
* Provides information about the process and output address. [View all possible values for this field](https://support.loqate.com/usa-cass-v2/resultsstring/).
*/
resultsString?: string | undefined;
resultsStringStatus?: string | undefined;
/**
* See [here](https://support.loqate.com/cass2-output-field-descriptions/) for full details.
*/
returnCode?: string | undefined;
returnCodeStatus?: string | undefined;
/**
* This field is available when adding "SERP" to the Loqate engine. It identifies a Route Address, such as Rural Route, Military Route. Example value: RR 6.
*/
route?: string | undefined;
routeStatus?: string | undefined;
/**
* A number that identifies the specific Delivery Mode (Canada/CA/CAN only). Examples include: 22, 62, 404.
*/
routeNumber?: string | undefined;
routeNumberStatus?: string | undefined;
/**
* A code that identifies the type of route service (Canada/CA/CAN only). Examples include: RR - Rural Route, SS - Suburban Service.
*/
routeType?: string | undefined;
routeTypeStatus?: string | undefined;
/**
* Secondary address line in standardized format.
*/
secondaryAddressLine?: string | undefined;
secondaryAddressLineStatus?: string | undefined;
/**
* Second thoroughfare number (only used if the property has a ranged address eg 23-25).
*/
secondaryPremise?: string | undefined;
secondaryPremiseStatus?: string | undefined;
/**
* Suffix for the second thoroughfare number.
*/
secondaryPremiseSuffix?: string | undefined;
secondaryPremiseSuffixStatus?: string | undefined;
/**
* When multiple addresses are included in a single Verify request this counter will show the order of the addresses from the input. For example: 7 represents the 7th address in the input request.
*/
sequence?: string | undefined;
sequenceStatus?: string | undefined;
/**
* See [here](https://support.loqate.com/documentation/fielddescrip/serp-fields/) for full details.
*/
serpStatusEx?: string | undefined;
serpStatusExStatus?: string | undefined;
/**
* A short address that consists of four letters followed by four numbers (Saudi Arabia/SA/SAU only). For example: RGSA3808.
*/
shortAddressCode?: string | undefined;
shortAddressCodeStatus?: string | undefined;
/**
* StateCode refers to the census data that defines the official geographic (FIPS) code given to a US state. See [here](https://support.loqate.com/us-census-data-enhancement/) for full details.
*/
stateCode?: string | undefined;
stateCodeStatus?: string | undefined;
/**
* The smallest geographic data element within a country. For instance, USA County.
*/
subAdministrativeArea?: string | undefined;
subAdministrativeAreaStatus?: string | undefined;
/**
* The secondary identifiers for a particular delivery point. For instance, "FLAT 1" or "SUITE 212".
*/
subBuilding?: string | undefined;
subBuildingStatus?: string | undefined;
/**
* The secondary identifiers for a particular delivery point. For instance - BLOQUE 7.
*/
subBuildingBlock?: string | undefined;
subBuildingBlockStatus?: string | undefined;
/**
* The secondary identifiers for a particular delivery point. For instance PUERTA D.
*/
subBuildingDoor?: string | undefined;
subBuildingDoorStatus?: string | undefined;
/**
* The parsed floor information within the SubBuilding field, and includes the floor label (or type) and a numeric where applicable. For example, "L7" or "Fl 12".
*/
subBuildingFloor?: string | undefined;
subBuildingFloorStatus?: string | undefined;
/**
* The sub-building type indicator within the SubBuilding field, should one exist. For instance, if SubBuilding contains "FLAT 1" SubBuildingLeadingType contains "FLAT" if a sufficient level of parsing detail exists within a particular country.
*/
subBuildingLeadingType?: string | undefined;
subBuildingLeadingTypeStatus?: string | undefined;
/**
* The descriptive name within the SubBuilding field. For instance, if SubBuilding contains "BASEMENT FLAT" SubBuildingName contains "BASEMENT FLAT".
*/
subBuildingName?: string | undefined;
subBuildingNameStatus?: string | undefined;
/**
* The alphanumeric indicator within the SubBuilding field, should one exist. For instance, if SubBuilding contains "FLAT 1" SubBuildingNumber contains "1" if a sufficient level of parsing detail exists within a particular country.
*/
subBuildingNumber?: string | undefined;
subBuildingNumberStatus?: string | undefined;
/**
* The secondary identifiers for a particular delivery point. For instance PUERTA D.
*/
subBuildingStaircase?: string | undefined;
subBuildingStaircaseStatus?: string | undefined;
/**
* The leading sub-building type indicator within the SubBuilding field, should one exist. For instance, if SubBuilding contains "FLAT 1" SubBuildingType contains "FLAT" if a sufficient level of parsing detail exists within a particular country.
*/
subBuildingType?: string | undefined;
subBuildingTypeStatus?: string | undefined;
/**
* Code returned by SuiteLink® after querying the SuiteLink® database. See [here](https://support.loqate.com/cass2-output-field-descriptions/) for more details.
*/
suiteLinkFootnote?: string | undefined;
suiteLinkFootnoteStatus?: string | undefined;
/**
* The largest geographic data element within a country.
*/
superAdministrativeArea?: string | undefined;
superAdministrativeAreaStatus?: string | undefined;
/**
* Residence and business that choose to receive delivery through PO Boxes. No delivery is made to the street address. See [here](https://support.loqate.com/cass2-output-field-descriptions/) for more details.
*/
throwbackIndicator?: string | undefined;
throwbackIndicatorStatus?: string | undefined;
/**
* The most common street or block data element within a country. For instance, USA Street.
*/
thoroughfare?: string | undefined;
thoroughfareStatus?: string | undefined;
/**
* The leading thoroughfare type indicator within the Thoroughfare field, should one exist. For instance, if Thoroughfare contains "RUE DE LA GARE" ThoroughfareLeadingType contains "RUE" if a sufficient level of parsing detail exists for the particular country.
*/
thoroughfareLeadingType?: string | undefined;
thoroughfareLeadingTypeStatus?: string | undefined;
/**
* The name indicator within the Thoroughfare field, should one exist. For instance, if Thoroughfare contains "N MAIN ST" ThoroughfareName contains "MAIN" if a sufficient level of parsing detail exists for the particular country.
*/
thoroughfareName?: string | undefined;
thoroughfareNameStatus?: string | undefined;
/**
* The postfix directional contained within the Thoroughfare field, should one exist. For instance, if Thoroughfare contains "MAIN ST N" ThoroughfarePostDirection contains "N" if a sufficient level of parsing detail exists for the particular country.
*/
thoroughfarePostDirection?: string | undefined;
thoroughfarePostDirectionStatus?: string | undefined;
/**
* The prefix directional contained within the Thoroughfare field, should one exist. For instance, if Thoroughfare contains "N MAIN ST" ThoroughfarePreDirection contains "N" if a sufficient level of parsing detail exists for the particular country.
*/
thoroughfarePreDirection?: string | undefined;
thoroughfarePreDirectionStatus?: string | undefined;
/**
* The trailing thoroughfare type indicator within the Thoroughfare field, should one exist. For instance, if Thoroughfare contains "N MAIN ST" ThoroughfareTrailingType contains "ST" if a sufficient level of parsing detail exists for the particular country.
*/
thoroughfareTrailingType?: string | undefined;
thoroughfareTrailingTypeStatus?: string | undefined;
/**
* The type of thoroughfare should one exist. Examples include Road, Vei, St, Rua, Avenita, Pereulok, 路
*/
thoroughfareType?: string | undefined;
thoroughfareTypeStatus?: string | undefined;
/**
* DST defines the Daylight Saving Time. Example: 2869 S County Road 210, Knox IN 46534-7969, USA Returned DST values: -06:00
*/
timeZoneDST?: string | undefined;
timeZoneDSTStatus?: string | undefined;
/**
* For more information about accessing or using the Time Zone data please contact you account manager or support.
*/
timeZoneName?: string | undefined;
timeZoneNameStatus?: string | undefined;
/**
* UTC defines the Coordinated Universal Time. Example: 2869 S County Road 210, Knox IN 46534-7969, USA. Returned UTC values: -05:00
*/
timeZoneUTC?: string | undefined;
timeZoneUTCStatus?: string | undefined;
/**
* TractCode represents the census data that defines geographic entities within counties, where each TractCode is typically a 6-digit codes (including any leading zeros, and also two "trailing" zeros in the many cases in which the basic tract codes has no suffix). See [here](https://support.loqate.com/us-census-data-enhancement/) for full details.
*/
tractCode?: string | undefined;
tractCodeStatus?: string | undefined;
/**
* Alternative value for AdministrativeArea, or County, in the United Kingdom. Defined and supplied by Royal Mail. These values date from the 1800s and were assigned by the Association of British Counties. E.g. "Gloucestershire".
*/
traditionalCounty?: string | undefined;
traditionalCountyStatus?: string | undefined;
/**
* The Royal Mail UDPRN, or Unique Delivery Point Reference Number, is an eight-digit numeric key that is unique to every delivery point record in the PAF. There are some cases where AddressKeys or OrganisationKeys will change or be re-used, so the UDPRN key is a more permanent reference to a given delivery point.
*/
udprnKey?: string | undefined;
udprnKeyStatus?: string | undefined;
/**
* The Unique Multiple Residence Reference Number (UMRRN) is an eight-digit numeric key that is unique to every Multiple Residence (MR).
*/
umrrn?: string | undefined;
umrrnStatus?: string | undefined;
/**
* Any information in the input address fields that is unable to be parsed to a particular address field. Read more about the Unmatched field [here](https://support.loqate.com/documentation/fielddescrip/unmatched-field).
*/
unmatched?: string | undefined;
unmatchedStatus?: string | undefined;
/**
* The Unique Property Reference Number (UPRN) is the twelve-digit Ordnance Survey's unique record ID for a property and is a persistent ID for a property.
*/
uprn?: string | undefined;
uprnStatus?: string | undefined;
/**
* Indicates that the delivery point was active in the past, but is currently vacant (in most cases, unoccupied over 90 days) and is not receiving deliveries. See [here](https://support.loqate.com/cass2-output-field-descriptions/) for more details.
*/
vacantIndicator?: string | undefined;
vacantIndicatorStatus?: string | undefined;
/**
* ZIP5 Valid Flag: indicates whether the ZIP Code is included in the "Total 5-Digital Coded" field on the USPS Form 3553. See [here](https://support.loqate.com/cass2-output-field-descriptions/) for more details.
*/
zip5Valid?: string | undefined;
zip5ValidStatus?: string | undefined;
surname?: string | undefined;
forename?: string | undefined;
middleName?: string | undefined;
fullName?: string | undefined;
deceasedFlag?: string | undefined;
goneawaysFlag?: string | undefined;
matchedForenameDeceased?: string | undefined;
matchedSurnameDeceased?: string | undefined;
matchedMiddleNameDeceased?: string | undefined;
matchedForenameGoneaways?: string | undefined;
matchedSurnameGoneaways?: string | undefined;
matchedMiddleNameGoneaways?: string | undefined;
};
/** @internal */
export const CleansingInternationalBatchServiceResponseItemMatch$inboundSchema:
z.ZodType<
CleansingInternationalBatchServiceResponseItemMatch,
z.ZodTypeDef,
unknown
> = z.object({
AQI: z.string().optional(),
AQIStatus: z.string().optional(),
AVC: z.string().optional(),
AVCStatus: z.string().optional(),
AdditionalContent: z.string().optional(),
AdditionalContentStatus: z.string().optional(),
Address: z.string().optional(),
AddressStatus: z.string().optional(),
Address1: z.string().optional(),
Address1Status: z.string().optional(),
Address2: z.string().optional(),
Address2Status: z.string().optional(),
Address3: z.string().optional(),
Address3Status: z.string().optional(),
Address4: z.string().optional(),
Address4Status: z.string().optional(),
Address5: z.string().optional(),
Address5Status: z.string().optional(),
Address6: z.string().optional(),
Address6Status: z.string().optional(),
Address7: z.string().optional(),
Address7Status: z.string().optional(),
Address8: z.string().optional(),
Address8Status: z.string().optional(),
AddressFormat: z.string().optional(),
AddressFormatStatus: z.string().optional(),
AddressKey: z.string().optional(),
AddressKeyStatus: z.string().optional(),
AdministrativeArea: z.string().optional(),
AdministrativeAreaStatus: z.string().optional(),
AdministrativeAreaISO2: z.string().optional(),
AdministrativeAreaISO2Status: z.string().optional(),
AdministrativeAreaName: z.string().optional(),
AdministrativeAreaNameStatus: z.string().optional(),
AdministrativeAreaTrailingType: z.string().optional(),
AdministrativeAreaTrailingTypeStatus: z.string().optional(),
AdministrativeAreaType: z.string().optional(),
AdministrativeAreaTypeStatus: z.string().optional(),
AdministrativeCounty: z.string().optional(),
AdministrativeCountyStatus: z.string().optional(),
AutoZoneIndicator: z.string().optional(),
AutoZoneIndicatorStatus: z.string().optional(),
Barcode: z.string().optional(),
BarcodeStatus: z.string().optional(),
BlockCode: z.string().optional(),
BlockCodeStatus: z.string().optional(),
BlockGroupCode: z.string().optional(),
BlockGroupCodeStatus: z.string().optional(),
Bolignummer: z.string().optional(),
BolignummerStatus: z.string().optional(),
BoxBagLobbyName: z.string().optional(),
BoxBagLobbyNameStatus: z.string().optional(),
BranchName: z.string().optional(),
BranchNameStatus: z.string().optional(),
Building: z.string().optional(),
BuildingStatus: z.string().optional(),
BuildingLeadingType: z.string().optional(),
BuildingLeadingTypeStatus: z.string().optional(),
BuildingName: z.string().optional(),
BuildingNameStatus: z.string().optional(),
BuildingTrailingType: z.string().optional(),
BuildingTrailingTypeStatus: z.string().optional(),
BuildingType: z.string().optional(),
BuildingTypeStatus: z.string().optional(),
CarrierRoute: z.string().optional(),
CarrierRouteStatus: z.string().optional(),
CBSACode: z.string().optional(),
CBSACodeStatus: z.string().optional(),
CBSAMetropolitanStatisticalArea: z.string().optional(),
CBSAMetropolitanStatisticalAreaStatus: z.string().optional(),
CBSAMicropolitanStatisticalArea: z.string().optional(),
CBSAMicropolitanStatisticalAreaStatus: z.string().optional(),
CBSAName: z.string().optional(),
CBSANameStatus: z.string().optional(),
CensusClassCode: z.string().optional(),
CensusClassCodeStatus: z.string().optional(),
CensusCode: z.string().optional(),
CensusCodeStatus: z.string().optional(),
CensusIndicator: z.string().optional(),
CensusIndicatorStatus: z.string().optional(),
CheckDigit: z.string().optional(),
CheckDigitStatus: z.string().optional(),
Cluster: z.string().optional(),
ClusterStatus: z.string().optional(),
CMRAIndicator: z.string().optional(),
CMRAIndicatorStatus: z.string().optional(),
CongressionalDistrict: z.string().optional(),
CongressionalDistrictStatus: z.string().optional(),
Contact: z.string().optional(),
ContactStatus: z.string().optional(),
Country: z.string().optional(),
CountryStatus: z.string().optional(),
CountryName: z.string().optional(),
CountryNameStatus: z.string().optional(),
County_FIPS: z.string().optional(),
County_FIPSStatus: z.string().optional(),
CountyCode: z.string().optional(),
CountyCodeStatus: z.string().optional(),
DefaultFlag: z.string().optional(),
DefaultFlagStatus: z.string().optional(),
DeliveryAddress: z.string().optional(),
DeliveryAddressStatus: z.string().optional(),
DeliveryAddress1: z.string().optional(),
DeliveryAddress1Status: z.string().optional(),
DeliveryAddress2: z.string().optional(),
DeliveryAddress2Status: z.string().optional(),
DeliveryAddress3: z.string().optional(),
DeliveryAddress3Status: z.string().optional(),
DeliveryAddress4: z.string().optional(),
DeliveryAddress4Status: z.string().optional(),
DeliveryAddress5: z.string().optional(),
DeliveryAddress5Status: z.string().optional(),
DeliveryAddress6: z.string().optional(),
DeliveryAddress6Status: z.string().optional(),
DeliveryAddress7: z.string().optional(),
DeliveryAddress7Status: z.string().optional(),
DeliveryAddress8: z.string().optional(),
DeliveryAddress8Status: z.string().optional(),
DeliveryAddressFormat: z.string().optional(),
DeliveryAddressFormatStatus: z.string().optional(),
DeliveryInstallation: z.string().optional(),
DeliveryInstallationStatus: z.string().optional(),
DeliveryInstallationAreaName: z.string().optional(),
DeliveryInstallationAreaNameStatus: z.string().optional(),
DeliveryInstallationQualifierName: z.string().optional(),
DeliveryInstallationQualifierNameStatus: z.string().optional(),
DeliveryInstallationType: z.string().optional(),
DeliveryInstallationTypeStatus: z.string().optional(),
DeliveryPointBarCode: z.string().optional(),
DeliveryPointBarCodeStatus: z.string().optional(),
Department: z.string().optional(),
DepartmentStatus: z.string().optional(),
DependentLocality: z.string().optional(),
DependentLocalityStatus: z.string().optional(),
DependentLocalityLeadingType: z.string().optional(),
DependentLocalityLeadingTypeStatus: z.string().optional(),
DependentLocalityName: z.string().optional(),
DependentLocalityNameStatus: z.string().optional(),
DependentLocalityType: z.string().optional(),
DependentLocalityTypeStatus: z.string().optional(),
DependentThoroughfare: z.string().optional(),
DependentThoroughfareStatus: z.string().optional(),
DependentThoroughfareLeadingType: z.string().optional(),
DependentThoroughfareLeadingTypeStatus: z.string().optional(),
DependentThoroughfareName: z.string().optional(),
DependentThoroughfareNameStatus: z.string().optional(),
DependentThoroughfarePostDirection: z.string().optional(),
DependentThoroughfarePostDirectionStatus: z.string().optional(),
DependentThoroughfarePreDirection: z.string().optional(),
DependentThoroughfarePreDirectionStatus: z.string().optional(),
DependentThoroughfareTrailingType: z.string().optional(),
DependentThoroughfareTrailingTypeStatus: z.string().optional(),
DNA: z.string().optional(),
DNAStatus: z.string().optional(),
DoubleDependentLocality: z.string().optional(),
DoubleDependentLocalityStatus: z.string().optional(),
DoubleDependentLocalityName: z.string().optional(),
DoubleDependentLocalityNameStatus: z.string().optional(),
DoubleDependentLocalityType: z.string().optional(),
DoubleDependentLocalityTypeStatus: z.string().optional(),
DPS: z.string().optional(),
DPSStatus: z.string().optional(),
DPID: z.string().optional(),
DPIDStatus: z.string().optional(),
DPVConfirmedIndicator: z.string().optional(),
DPVConfirmedIndicatorStatus: z.string().optional(),
DPVFootnotes: z.string().optional(),
DPVFootnotesStatus: z.string().optional(),
DPVLACSIndicator: z.string().optional(),
DPVLACSIndicatorStatus: z.string().optional(),
DropSiteIndicator: z.string().optional(),
DropSiteIndicatorStatus: z.string().optional(),
eLOTCode: z.string().optional(),
eLOTCodeStatus: z.string().optional(),
eLOTNumber: z.string().optional(),
eLOTNumberStatus: z.string().optional(),
EnhancedReturnCode: z.string().optional(),
EnhancedReturnCodeStatus: z.string().optional(),
EWSFlag: z.string().optional(),
EWSFlagStatus: z.string().optional(),
FalsePositiveIndicator: z.string().optional(),
FalsePositiveIndicatorStatus: z.string().optional(),
Finance: z.string().optional(),
FinanceStatus: z.string().optional(),
FIPSCountyCode: z.string().optional(),
FIPSCountyCodeStatus: z.string().optional(),
FloorNumber: z.string().optional(),
FloorNumberStatus: z.string().optional(),
FloorType: z.string().optional(),
FloorTypeStatus: z.string().optional(),
FormerPostalCounty: z.string().optional(),
FormerPostalCountyStatus: z.string().optional(),
Function: z.string().optional(),
FunctionStatus: z.string().optional(),
GeneralDelivery: z.string().optional(),
GeneralDeliveryStatus: z.string().optional(),
GeoAccuracy: z.string().optional(),
GeoAccuracyStatus: z.string().optional(),
GeoDistance: z.string().optional(),
GeoDistanceStatus: z.string().optional(),
GNISFeatureID: z.string().optional(),
GNISFeatureIDStatus: z.string().optional(),
HasSubPremise: z.string().optional(),
HasSubPremiseStatus: z.string().optional(),
HyphenClass: z.string().optional(),
HyphenClassStatus: z.string().optional(),
ID: z.string().optional(),
IDStatus: z.string().optional(),
"ISO3166-2": z.string().optional(),
"ISO3166-2Status": z.string().optional(),
"ISO3166-3": z.string().optional(),
"ISO3166-3Status": z.string().optional(),
"ISO3166-N": z.string().optional(),
"ISO3166-NStatus": z.string().optional(),
LACSLinkCode: z.string().optional(),
LACSLinkCodeStatus: z.string().optional(),
LACSLinkIndicator: z.string().optional(),
LACSLinkIndicatorStatus: z.string().optional(),
LACSStatus: z.string().optional(),
LACSStatusStatus: z.string().optional(),
Latitude: z.string().optional(),
LatitudeStatus: z.string().optional(),
Locality: z.string().optional(),
LocalityStatus: z.string().optional(),
LocalityExtra: z.string().optional(),
LocalityExtraStatus: z.string().optional(),
LocalityName: z.string().optional(),
LocalityNameStatus: z.string().optional(),
LocalitySpecial: z.string().optional(),
LocalitySpecialStatus: z.string().optional(),
LocalityTrailingType: z.string().optional(),
LocalityTrailingTypeStatus: z.string().optional(),
LocalityType: z.string().optional(),
LocalityTypeStatus: z.string().optional(),
Longitude: z.string().optional(),
LongitudeStatus: z.string().optional(),
LotNumber: z.string().optional(),
LotNumberStatus: z.string().optional(),
MakaniNumber: z.string().optional(),
MakaniNumberStatus: z.string().optional(),
MatchRuleLabel: z.string().optional(),
MatchRuleLabelStatus: z.string().optional(),
MetroDivisionCode: z.string().optional(),
MetroDivisionCodeStatus: z.string().optional(),
MetroDivisionName: z.string().optional(),
MetroDivisionNameStatus: z.string().optional(),
MetropolitanDivision: z.string().optional(),
MetropolitanDivisionStatus: z.string().optional(),
NDDFlag: z.string().optional(),
NDDFlagStatus: z.string().optional(),
NDDValues: z.string().optional(),
NDDValuesStatus: z.string().optional(),
NECTACode: z.string().optional(),
NECTACodeStatus: z.string().optional(),
NECTADivision: z.string().optional(),
NECTADivisionStatus: z.string().optional(),
NECTADivisionCode: z.string().optional(),
NECTADivisionCodeStatus: z.string().optional(),
NECTADivisionName: z.string().optional(),
NECTADivisionNameStatus: z.string().optional(),
NECTAMetropolitanStatisticalArea: z.string().optional(),
NECTAMetropolitanStatisticalAreaStatus: z.string().optional(),
NECTAMicropolitanStatisticalArea: z.string().optional(),
NECTAMicropolitanStatisticalAreaStatus: z.string().optional(),
NECTAName: z.string().optional(),
NECTANameStatus: z.string().optional(),
NoStatIndicator: z.string().optional(),
NoStatIndicatorStatus: z.string().optional(),
NoStatReason: z.string().optional(),
NoStatReasonStatus: z.string().optional(),
NSL: z.string().optional(),
NSLStatus: z.string().optional(),
OldMSACode: z.string().optional(),
OldMSACodeStatus: z.string().optional(),
OldMSAName: z.string().optional(),
OldMSANameStatus: z.string().optional(),
OrganisationKey: z.string().optional(),
OrganisationKeyStatus: z.string().optional(),
Organization: z.string().optional(),
OrganizationStatus: z.string().optional(),
OrganizationName: z.string().optional(),
OrganizationNameStatus: z.string().optional(),
OrganizationType: z.string().optional(),
OrganizationTypeStatus: z.string().optional(),
OrganizationTrailingType: z.string().optional(),
OrganizationTrailingTypeStatus: z.string().optional(),
OwningUDPRN: z.string().optional(),
OwningUDPRNStatus: z.string().optional(),
ParentUPRN: z.string().optional(),
ParentUPRNStatus: z.string().optional(),
ParsedGarbage: z.string().optional(),
ParsedGarbageStatus: z.string().optional(),
PBSAIndicator: z.string().optional(),
PBSAIndicatorStatus: z.string().optional(),
PMBNumber: z.string().optional(),
PMBNumberStatus: z.string().optional(),
PMBType: z.string().optional(),
PMBTypeStatus: z.string().optional(),
POBoxOnly: z.string().optional(),
POBoxOnlyStatus: z.string().optional(),
PostalCode: z.string().optional(),
PostalCodeStatus: z.string().optional(),
PostalCodePrimary: z.string().optional(),
PostalCodePrimaryStatus: z.string().optional(),
PostalCodeSecondary: z.string().optional(),
PostalCodeSecondaryStatus: z.string().optional(),
PostBox: z.string().optional(),
PostBoxStatus: z.string().optional(),
PostBoxNum: z.string().optional(),
PostBoxNumStatus: z.string().optional(),
PostBoxNumber: z.string().optional(),
PostBoxNumberStatus: z.string().optional(),
PostBoxNumberPrefix: z.string().optional(),
PostBoxNumberPrefixStatus: z.string().optional(),
PostBoxNumberSuffix: z.string().optional(),
PostBoxNumberSuffixStatus: z.string().optional(),
PostBoxType: z.string().optional(),
PostBoxTypeStatus: z.string().optional(),
PostcodeType: z.string().optional(),
PostcodeTypeStatus: z.string().optional(),
PreSortZone: z.string().optional(),
PreSortZoneStatus: z.string().optional(),
Premise: z.string().optional(),
PremiseStatus: z.string().optional(),
PremiseExtra: z.string().optional(),
PremiseExtraStatus: z.string().optional(),
PremiseNumber: z.string().optional(),
PremiseNumberStatus: z.string().optional(),
PremiseType: z.string().optional(),
PremiseTypeStatus: z.string().optional(),
PrimaryAddressLine: z.string().optional(),
PrimaryAddressLineStatus: z.string().optional(),
PrimaryPremise: z.string().optional(),
PrimaryPremiseStatus: z.string().optional(),
PrimaryPremiseSuffix: z.string().optional(),
PrimaryPremiseSuffixStatus: z.string().optional(),
PrintPostZone: z.string().optional(),
PrintPostZoneStatus: z.string().optional(),
Questionable: z.string().optional(),
QuestionableStatus: z.string().optional(),
RecordType: z.string().optional(),
RecordTypeStatus: z.string().optional(),
ResCom_Flag: z.string().optional(),
ResCom_FlagStatus: z.string().optional(),
ResidentialCommercialFlag: z.string().optional(),
ResidentialCommercialFlagStatus: z.string().optional(),
ResidentialDelivery: z.string().optional(),
ResidentialDeliveryStatus: z.string().optional(),
Result: z.string().optional(),
ResultStatus: z.string().optional(),
ResultsString: z.string().optional(),
ResultsStringStatus: z.string().optional(),
ReturnCode: z.string().optional(),
ReturnCodeStatus: z.string().optional(),
Route: z.string().optional(),
RouteStatus: z.string().optional(),
RouteNumber: z.string().optional(),
RouteNumberStatus: z.string().optional(),
RouteType: z.string().optional(),
RouteTypeStatus: z.string().optional(),
SecondaryAddressLine: z.string().optional(),
SecondaryAddressLineStatus: z.string().optional(),
SecondaryPremise: z.string().optional(),
SecondaryPremiseStatus: z.string().optional(),
SecondaryPremiseSuffix: z.string().optional(),
SecondaryPremiseSuffixStatus: z.string().optional(),
Sequence: z.string().optional(),
SequenceStatus: z.string().optional(),
SerpStatusEx: z.string().optional(),
SerpStatusExStatus: z.string().optional(),
ShortAddressCode: z.string().optional(),
ShortAddressCodeStatus: z.string().optional(),
StateCode: z.string().optional(),
StateCodeStatus: z.string().optional(),
SubAdministrativeArea: z.string().optional(),
SubAdministrativeAreaStatus: z.string().optional(),
SubBuilding: z.string().optional(),
SubBuildingStatus: z.string().optional(),
SubBuildingBlock: z.string().optional(),
SubBuildingBlockStatus: z.string().optional(),
SubBuildingDoor: z.string().optional(),
SubBuildingDoorStatus: z.string().optional(),
SubBuildingFloor: z.string().optional(),
SubBuildingFloorStatus: z.string().optional(),
SubBuildingLeadingType: z.string().optional(),
SubBuildingLeadingTypeStatus: z.string().optional(),
SubBuildingName: z.string().optional(),
SubBuildingNameStatus: z.string().optional(),
SubBuildingNumber: z.string().optional(),
SubBuildingNumberStatus: z.string().optional(),
SubBuildingStaircase: z.string().optional(),
SubBuildingStaircaseStatus: z.string().optional(),
SubBuildingType: z.string().optional(),
SubBuildingTypeStatus: z.string().optional(),
SUITELinkFootnote: z.string().optional(),
SUITELinkFootnoteStatus: z.string().optional(),
SuperAdministrativeArea: z.string().optional(),
SuperAdministrativeAreaStatus: z.string().optional(),
ThrowbackIndicator: z.string().optional(),
ThrowbackIndicatorStatus: z.string().optional(),
Thoroughfare: z.string().optional(),
ThoroughfareStatus: z.string().optional(),
ThoroughfareLeadingType: z.string().optional(),
ThoroughfareLeadingTypeStatus: z.string().optional(),
ThoroughfareName: z.string().optional(),
ThoroughfareNameStatus: z.string().optional(),
ThoroughfarePostDirection: z.string().optional(),
ThoroughfarePostDirectionStatus: z.string().optional(),
ThoroughfarePreDirection: z.string().optional(),
ThoroughfarePreDirectionStatus: z.string().optional(),
ThoroughfareTrailingType: z.string().optional(),
ThoroughfareTrailingTypeStatus: z.string().optional(),
ThoroughfareType: z.string().optional(),
ThoroughfareTypeStatus: z.string().optional(),
TimeZone_DST: z.string().optional(),
TimeZone_DSTStatus: z.string().optional(),
TimeZone_Name: z.string().optional(),
TimeZone_NameStatus: z.string().optional(),
TimeZone_UTC: z.string().optional(),
TimeZone_UTCStatus: z.string().optional(),
TractCode: z.string().optional(),
TractCodeStatus: z.string().optional(),
TraditionalCounty: z.string().optional(),
TraditionalCountyStatus: z.string().optional(),
UDPRNKey: z.string().optional(),
UDPRNKeyStatus: z.string().optional(),
UMRRN: z.string().optional(),
UMRRNStatus: z.string().optional(),
Unmatched: z.string().optional(),
UnmatchedStatus: z.string().optional(),
UPRN: z.string().optional(),
UPRNStatus: z.string().optional(),
VacantIndicator: z.string().optional(),
VacantIndicatorStatus: z.string().optional(),
Zip5Valid: z.string().optional(),
Zip5ValidStatus: z.string().optional(),
Surname: z.string().optional(),
Forename: z.string().optional(),
MiddleName: z.string().optional(),
FullName: z.string().optional(),
DeceasedFlag: z.string().optional(),
GoneawaysFlag: z.string().optional(),
MatchedForenameDeceased: z.string().optional(),
MatchedSurnameDeceased: z.string().optional(),
MatchedMiddleNameDeceased: z.string().optional(),
MatchedForenameGoneaways: z.string().optional(),
MatchedSurnameGoneaways: z.string().optional(),
MatchedMiddleNameGoneaways: z.string().optional(),
}).transform((v) => {
return remap$(v, {
"AQI": "aqi",
"AQIStatus": "aqiStatus",
"AVC": "avc",
"AVCStatus": "avcStatus",
"AdditionalContent": "additionalContent",
"AdditionalContentStatus": "additionalContentStatus",
"Address": "address",
"AddressStatus": "addressStatus",
"Address1": "address1",
"Address1Status": "address1Status",
"Address2": "address2",
"Address2Status": "address2Status",
"Address3": "address3",
"Address3Status": "address3Status",
"Address4": "address4",
"Address4Status": "address4Status",
"Address5": "address5",
"Address5Status": "address5Status",
"Address6": "address6",
"Address6Status": "address6Status",
"Address7": "address7",
"Address7Status": "address7Status",
"Address8": "address8",
"Address8Status": "address8Status",
"AddressFormat": "addressFormat",
"AddressFormatStatus": "addressFormatStatus",
"AddressKey": "addressKey",
"AddressKeyStatus": "addressKeyStatus",
"AdministrativeArea": "administrativeArea",
"AdministrativeAreaStatus": "administrativeAreaStatus",
"AdministrativeAreaISO2": "administrativeAreaIso2",
"AdministrativeAreaISO2Status": "administrativeAreaIso2Status",
"AdministrativeAreaName": "administrativeAreaName",
"AdministrativeAreaNameStatus": "administrativeAreaNameStatus",
"AdministrativeAreaTrailingType": "administrativeAreaTrailingType",
"AdministrativeAreaTrailingTypeStatus":
"administrativeAreaTrailingTypeStatus",
"AdministrativeAreaType": "administrativeAreaType",
"AdministrativeAreaTypeStatus": "administrativeAreaTypeStatus",
"AdministrativeCounty": "administrativeCounty",
"AdministrativeCountyStatus": "administrativeCountyStatus",
"AutoZoneIndicator": "autoZoneIndicator",
"AutoZoneIndicatorStatus": "autoZoneIndicatorStatus",
"Barcode": "barcode",
"BarcodeStatus": "barcodeStatus",
"BlockCode": "blockCode",
"BlockCodeStatus": "blockCodeStatus",
"BlockGroupCode": "blockGroupCode",
"BlockGroupCodeStatus": "blockGroupCodeStatus",
"Bolignummer": "bolignummer",
"BolignummerStatus": "bolignummerStatus",
"BoxBagLobbyName": "boxBagLobbyName",
"BoxBagLobbyNameStatus": "boxBagLobbyNameStatus",
"BranchName": "branchName",
"BranchNameStatus": "branchNameStatus",
"Building": "building",
"BuildingStatus": "buildingStatus",
"BuildingLeadingType": "buildingLeadingType",
"BuildingLeadingTypeStatus": "buildingLeadingTypeStatus",
"BuildingName": "buildingName",
"BuildingNameStatus": "buildingNameStatus",
"BuildingTrailingType": "buildingTrailingType",
"BuildingTrailingTypeStatus": "buildingTrailingTypeStatus",
"BuildingType": "buildingType",
"BuildingTypeStatus": "buildingTypeStatus",
"CarrierRoute": "carrierRoute",
"CarrierRouteStatus": "carrierRouteStatus",
"CBSACode": "cbsaCode",
"CBSACodeStatus": "cbsaCodeStatus",
"CBSAMetropolitanStatisticalArea": "cbsaMetropolitanStatisticalArea",
"CBSAMetropolitanStatisticalAreaStatus":
"cbsaMetropolitanStatisticalAreaStatus",
"CBSAMicropolitanStatisticalArea": "cbsaMicropolitanStatisticalArea",
"CBSAMicropolitanStatisticalAreaStatus":
"cbsaMicropolitanStatisticalAreaStatus",
"CBSAName": "cbsaName",
"CBSANameStatus": "cbsaNameStatus",
"CensusClassCode": "censusClassCode",
"CensusClassCodeStatus": "censusClassCodeStatus",
"CensusCode": "censusCode",
"CensusCodeStatus": "censusCodeStatus",
"CensusIndicator": "censusIndicator",
"CensusIndicatorStatus": "censusIndicatorStatus",
"CheckDigit": "checkDigit",
"CheckDigitStatus": "checkDigitStatus",
"Cluster": "cluster",
"ClusterStatus": "clusterStatus",
"CMRAIndicator": "cmraIndicator",
"CMRAIndicatorStatus": "cmraIndicatorStatus",
"CongressionalDistrict": "congressionalDistrict",
"CongressionalDistrictStatus": "congressionalDistrictStatus",
"Contact": "contact",
"ContactStatus": "contactStatus",
"Country": "country",
"CountryStatus": "countryStatus",
"CountryName": "countryName",
"CountryNameStatus": "countryNameStatus",
"County_FIPS": "countyFIPS",
"County_FIPSStatus": "countyFIPSStatus",
"CountyCode": "countyCode",
"CountyCodeStatus": "countyCodeStatus",
"DefaultFlag": "defaultFlag",
"DefaultFlagStatus": "defaultFlagStatus",
"DeliveryAddress": "deliveryAddress",
"DeliveryAddressStatus": "deliveryAddressStatus",
"DeliveryAddress1": "deliveryAddress1",
"DeliveryAddress1Status": "deliveryAddress1Status",
"DeliveryAddress2": "deliveryAddress2",
"DeliveryAddress2Status": "deliveryAddress2Status",
"DeliveryAddress3": "deliveryAddress3",
"DeliveryAddress3Status": "deliveryAddress3Status",
"DeliveryAddress4": "deliveryAddress4",
"DeliveryAddress4Status": "deliveryAddress4Status",
"DeliveryAddress5": "deliveryAddress5",
"DeliveryAddress5Status": "deliveryAddress5Status",
"DeliveryAddress6": "deliveryAddress6",
"DeliveryAddress6Status": "deliveryAddress6Status",
"DeliveryAddress7": "deliveryAddress7",
"DeliveryAddress7Status": "deliveryAddress7Status",
"DeliveryAddress8": "deliveryAddress8",
"DeliveryAddress8Status": "deliveryAddress8Status",
"DeliveryAddressFormat": "deliveryAddressFormat",
"DeliveryAddressFormatStatus": "deliveryAddressFormatStatus",
"DeliveryInstallation": "deliveryInstallation",
"DeliveryInstallationStatus": "deliveryInstallationStatus",
"DeliveryInstallationAreaName": "deliveryInstallationAreaName",
"DeliveryInstallationAreaNameStatus":
"deliveryInstallationAreaNameStatus",
"DeliveryInstallationQualifierName": "deliveryInstallationQualifierName",
"DeliveryInstallationQualifierNameStatus":
"deliveryInstallationQualifierNameStatus",
"DeliveryInstallationType": "deliveryInstallationType",
"DeliveryInstallationTypeStatus": "deliveryInstallationTypeStatus",
"DeliveryPointBarCode": "deliveryPointBarCode",
"DeliveryPointBarCodeStatus": "deliveryPointBarCodeStatus",
"Department": "department",
"DepartmentStatus": "departmentStatus",
"DependentLocality": "dependentLocality",
"DependentLocalityStatus": "dependentLocalityStatus",
"DependentLocalityLeadingType": "dependentLocalityLeadingType",
"DependentLocalityLeadingTypeStatus":
"dependentLocalityLeadingTypeStatus",
"DependentLocalityName": "dependentLocalityName",
"DependentLocalityNameStatus": "dependentLocalityNameStatus",
"DependentLocalityType": "dependentLocalityType",
"DependentLocalityTypeStatus": "dependentLocalityTypeStatus",
"DependentThoroughfare": "dependentThoroughfare",
"DependentThoroughfareStatus": "dependentThoroughfareStatus",
"DependentThoroughfareLeadingType": "dependentThoroughfareLeadingType",
"DependentThoroughfareLeadingTypeStatus":
"dependentThoroughfareLeadingTypeStatus",
"DependentThoroughfareName": "dependentThoroughfareName",
"DependentThoroughfareNameStatus": "dependentThoroughfareNameStatus",
"DependentThoroughfarePostDirection":
"dependentThoroughfarePostDirection",
"DependentThoroughfarePostDirectionStatus":
"dependentThoroughfarePostDirectionStatus",
"DependentThoroughfarePreDirection": "dependentThoroughfarePreDirection",
"DependentThoroughfarePreDirectionStatus":
"dependentThoroughfarePreDirectionStatus",
"DependentThoroughfareTrailingType": "dependentThoroughfareTrailingType",
"DependentThoroughfareTrailingTypeStatus":
"dependentThoroughfareTrailingTypeStatus",
"DNA": "dna",
"DNAStatus": "dnaStatus",
"DoubleDependentLocality": "doubleDependentLocality",
"DoubleDependentLocalityStatus": "doubleDependentLocalityStatus",
"DoubleDependentLocalityName": "doubleDependentLocalityName",
"DoubleDependentLocalityNameStatus": "doubleDependentLocalityNameStatus",
"DoubleDependentLocalityType": "doubleDependentLocalityType",
"DoubleDependentLocalityTypeStatus": "doubleDependentLocalityTypeStatus",
"DPS": "dps",
"DPSStatus": "dpsStatus",
"DPID": "dpid",
"DPIDStatus": "dpidStatus",
"DPVConfirmedIndicator": "dpvConfirmedIndicator",
"DPVConfirmedIndicatorStatus": "dpvConfirmedIndicatorStatus",
"DPVFootnotes": "dpvFootnotes",
"DPVFootnotesStatus": "dpvFootnotesStatus",
"DPVLACSIndicator": "dpvlacsIndicator",
"DPVLACSIndicatorStatus": "dpvlacsIndicatorStatus",
"DropSiteIndicator": "dropSiteIndicator",
"DropSiteIndicatorStatus": "dropSiteIndicatorStatus",
"EnhancedReturnCode": "enhancedReturnCode",
"EnhancedReturnCodeStatus": "enhancedReturnCodeStatus",
"EWSFlag": "ewsFlag",
"EWSFlagStatus": "ewsFlagStatus",
"FalsePositiveIndicator": "falsePositiveIndicator",
"FalsePositiveIndicatorStatus": "falsePositiveIndicatorStatus",
"Finance": "finance",
"FinanceStatus": "financeStatus",
"FIPSCountyCode": "fipsCountyCode",
"FIPSCountyCodeStatus": "fipsCountyCodeStatus",
"FloorNumber": "floorNumber",
"FloorNumberStatus": "floorNumberStatus",
"FloorType": "floorType",
"FloorTypeStatus": "floorTypeStatus",
"FormerPostalCounty": "formerPostalCounty",
"FormerPostalCountyStatus": "formerPostalCountyStatus",
"Function": "function",
"FunctionStatus": "functionStatus",
"GeneralDelivery": "generalDelivery",
"GeneralDeliveryStatus": "generalDeliveryStatus",
"GeoAccuracy": "geoAccuracy",
"GeoAccuracyStatus": "geoAccuracyStatus",
"GeoDistance": "geoDistance",
"GeoDistanceStatus": "geoDistanceStatus",
"GNISFeatureID": "gnisFeatureID",
"GNISFeatureIDStatus": "gnisFeatureIDStatus",
"HasSubPremise": "hasSubPremise",
"HasSubPremiseStatus": "hasSubPremiseStatus",
"HyphenClass": "hyphenClass",
"HyphenClassStatus": "hyphenClassStatus",
"ID": "id",
"IDStatus": "idStatus",
"ISO3166-2": "iso31662",
"ISO3166-2Status": "iso31662Status",
"ISO3166-3": "iso31663",
"ISO3166-3Status": "iso31663Status",
"ISO3166-N": "iso3166N",
"ISO3166-NStatus": "iso3166NStatus",
"LACSLinkCode": "lacsLinkCode",
"LACSLinkCodeStatus": "lacsLinkCodeStatus",
"LACSLinkIndicator": "lacsLinkIndicator",
"LACSLinkIndicatorStatus": "lacsLinkIndicatorStatus",
"LACSStatus": "lacsStatus",
"LACSStatusStatus": "lacsStatusStatus",
"Latitude": "latitude",
"LatitudeStatus": "latitudeStatus",
"Locality": "locality",
"LocalityStatus": "localityStatus",
"LocalityExtra": "localityExtra",
"LocalityExtraStatus": "localityExtraStatus",
"LocalityName": "localityName",
"LocalityNameStatus": "localityNameStatus",
"LocalitySpecial": "localitySpecial",
"LocalitySpecialStatus": "localitySpecialStatus",
"LocalityTrailingType": "localityTrailingType",
"LocalityTrailingTypeStatus": "localityTrailingTypeStatus",
"LocalityType": "localityType",
"LocalityTypeStatus": "localityTypeStatus",
"Longitude": "longitude",
"LongitudeStatus": "longitudeStatus",
"LotNumber": "lotNumber",
"LotNumberStatus": "lotNumberStatus",
"MakaniNumber": "makaniNumber",
"MakaniNumberStatus": "makaniNumberStatus",
"MatchRuleLabel": "matchRuleLabel",
"MatchRuleLabelStatus": "matchRuleLabelStatus",
"MetroDivisionCode": "metroDivisionCode",
"MetroDivisionCodeStatus": "metroDivisionCodeStatus",
"MetroDivisionName": "metroDivisionName",
"MetroDivisionNameStatus": "metroDivisionNameStatus",
"MetropolitanDivision": "metropolitanDivision",
"MetropolitanDivisionStatus": "metropolitanDivisionStatus",
"NDDFlag": "nddFlag",
"NDDFlagStatus": "nddFlagStatus",
"NDDValues": "nddValues",
"NDDValuesStatus": "nddValuesStatus",
"NECTACode": "nectaCode",
"NECTACodeStatus": "nectaCodeStatus",
"NECTADivision": "nectaDivision",
"NECTADivisionStatus": "nectaDivisionStatus",
"NECTADivisionCode": "nectaDivisionCode",
"NECTADivisionCodeStatus": "nectaDivisionCodeStatus",
"NECTADivisionName": "nectaDivisionName",
"NECTADivisionNameStatus": "nectaDivisionNameStatus",
"NECTAMetropolitanStatisticalArea": "nectaMetropolitanStatisticalArea",
"NECTAMetropolitanStatisticalAreaStatus":
"nectaMetropolitanStatisticalAreaStatus",
"NECTAMicropolitanStatisticalArea": "nectaMicropolitanStatisticalArea",
"NECTAMicropolitanStatisticalAreaStatus":
"nectaMicropolitanStatisticalAreaStatus",
"NECTAName": "nectaName",
"NECTANameStatus": "nectaNameStatus",
"NoStatIndicator": "noStatIndicator",
"NoStatIndicatorStatus": "noStatIndicatorStatus",
"NoStatReason": "noStatReason",
"NoStatReasonStatus": "noStatReasonStatus",
"NSL": "nsl",
"NSLStatus": "nslStatus",
"OldMSACode": "oldMSACode",
"OldMSACodeStatus": "oldMSACodeStatus",
"OldMSAName": "oldMSAName",
"OldMSANameStatus": "oldMSANameStatus",
"OrganisationKey": "organisationKey",
"OrganisationKeyStatus": "organisationKeyStatus",
"Organization": "organization",
"OrganizationStatus": "organizationStatus",
"OrganizationName": "organizationName",
"OrganizationNameStatus": "organizationNameStatus",
"OrganizationType": "organizationType",
"OrganizationTypeStatus": "organizationTypeStatus",
"OrganizationTrailingType": "organizationTrailingType",
"OrganizationTrailingTypeStatus": "organizationTrailingTypeStatus",
"OwningUDPRN": "owningUDPRN",
"OwningUDPRNStatus": "owningUDPRNStatus",
"ParentUPRN": "parentUPRN",
"ParentUPRNStatus": "parentUPRNStatus",
"ParsedGarbage": "parsedGarbage",
"ParsedGarbageStatus": "parsedGarbageStatus",
"PBSAIndicator": "pbsaIndicator",
"PBSAIndicatorStatus": "pbsaIndicatorStatus",
"PMBNumber": "pmbNumber",
"PMBNumberStatus": "pmbNumberStatus",
"PMBType": "pmbType",
"PMBTypeStatus": "pmbTypeStatus",
"POBoxOnly": "poBoxOnly",
"POBoxOnlyStatus": "poBoxOnlyStatus",
"PostalCode": "postalCode",
"PostalCodeStatus": "postalCodeStatus",
"PostalCodePrimary": "postalCodePrimary",
"PostalCodePrimaryStatus": "postalCodePrimaryStatus",
"PostalCodeSecondary": "postalCodeSecondary",
"PostalCodeSecondaryStatus": "postalCodeSecondaryStatus",
"PostBox": "postBox",
"PostBoxStatus": "postBoxStatus",
"PostBoxNum": "postBoxNum",
"PostBoxNumStatus": "postBoxNumStatus",
"PostBoxNumber": "postBoxNumber",
"PostBoxNumberStatus": "postBoxNumberStatus",
"PostBoxNumberPrefix": "postBoxNumberPrefix",
"PostBoxNumberPrefixStatus": "postBoxNumberPrefixStatus",
"PostBoxNumberSuffix": "postBoxNumberSuffix",
"PostBoxNumberSuffixStatus": "postBoxNumberSuffixStatus",
"PostBoxType": "postBoxType",
"PostBoxTypeStatus": "postBoxTypeStatus",
"PostcodeType": "postcodeType",
"PostcodeTypeStatus": "postcodeTypeStatus",
"PreSortZone": "preSortZone",
"PreSortZoneStatus": "preSortZoneStatus",
"Premise": "premise",
"PremiseStatus": "premiseStatus",
"PremiseExtra": "premiseExtra",
"PremiseExtraStatus": "premiseExtraStatus",
"PremiseNumber": "premiseNumber",
"PremiseNumberStatus": "premiseNumberStatus",
"PremiseType": "premiseType",
"PremiseTypeStatus": "premiseTypeStatus",
"PrimaryAddressLine": "primaryAddressLine",
"PrimaryAddressLineStatus": "primaryAddressLineStatus",
"PrimaryPremise": "primaryPremise",
"PrimaryPremiseStatus": "primaryPremiseStatus",
"PrimaryPremiseSuffix": "primaryPremiseSuffix",
"PrimaryPremiseSuffixStatus": "primaryPremiseSuffixStatus",
"PrintPostZone": "printPostZone",
"PrintPostZoneStatus": "printPostZoneStatus",
"Questionable": "questionable",
"QuestionableStatus": "questionableStatus",
"RecordType": "recordType",
"RecordTypeStatus": "recordTypeStatus",
"ResCom_Flag": "resComFlag",
"ResCom_FlagStatus": "resComFlagStatus",
"ResidentialCommercialFlag": "residentialCommercialFlag",
"ResidentialCommercialFlagStatus": "residentialCommercialFlagStatus",
"ResidentialDelivery": "residentialDelivery",
"ResidentialDeliveryStatus": "residentialDeliveryStatus",
"Result": "result",
"ResultStatus": "resultStatus",
"ResultsString": "resultsString",
"ResultsStringStatus": "resultsStringStatus",
"ReturnCode": "returnCode",
"ReturnCodeStatus": "returnCodeStatus",
"Route": "route",
"RouteStatus": "routeStatus",
"RouteNumber": "routeNumber",
"RouteNumberStatus": "routeNumberStatus",
"RouteType": "routeType",
"RouteTypeStatus": "routeTypeStatus",
"SecondaryAddressLine": "secondaryAddressLine",
"SecondaryAddressLineStatus": "secondaryAddressLineStatus",
"SecondaryPremise": "secondaryPremise",
"SecondaryPremiseStatus": "secondaryPremiseStatus",
"SecondaryPremiseSuffix": "secondaryPremiseSuffix",
"SecondaryPremiseSuffixStatus": "secondaryPremiseSuffixStatus",
"Sequence": "sequence",
"SequenceStatus": "sequenceStatus",
"SerpStatusEx": "serpStatusEx",
"SerpStatusExStatus": "serpStatusExStatus",
"ShortAddressCode": "shortAddressCode",
"ShortAddressCodeStatus": "shortAddressCodeStatus",
"StateCode": "stateCode",
"StateCodeStatus": "stateCodeStatus",
"SubAdministrativeArea": "subAdministrativeArea",
"SubAdministrativeAreaStatus": "subAdministrativeAreaStatus",
"SubBuilding": "subBuilding",
"SubBuildingStatus": "subBuildingStatus",
"SubBuildingBlock": "subBuildingBlock",
"SubBuildingBlockStatus": "subBuildingBlockStatus",
"SubBuildingDoor": "subBuildingDoor",
"SubBuildingDoorStatus": "subBuildingDoorStatus",
"SubBuildingFloor": "subBuildingFloor",
"SubBuildingFloorStatus": "subBuildingFloorStatus",
"SubBuildingLeadingType": "subBuildingLeadingType",
"SubBuildingLeadingTypeStatus": "subBuildingLeadingTypeStatus",
"SubBuildingName": "subBuildingName",
"SubBuildingNameStatus": "subBuildingNameStatus",
"SubBuildingNumber": "subBuildingNumber",
"SubBuildingNumberStatus": "subBuildingNumberStatus",
"SubBuildingStaircase": "subBuildingStaircase",
"SubBuildingStaircaseStatus": "subBuildingStaircaseStatus",
"SubBuildingType": "subBuildingType",
"SubBuildingTypeStatus": "subBuildingTypeStatus",
"SUITELinkFootnote": "suiteLinkFootnote",
"SUITELinkFootnoteStatus": "suiteLinkFootnoteStatus",
"SuperAdministrativeArea": "superAdministrativeArea",
"SuperAdministrativeAreaStatus": "superAdministrativeAreaStatus",
"ThrowbackIndicator": "throwbackIndicator",
"ThrowbackIndicatorStatus": "throwbackIndicatorStatus",
"Thoroughfare": "thoroughfare",
"ThoroughfareStatus": "thoroughfareStatus",
"ThoroughfareLeadingType": "thoroughfareLeadingType",
"ThoroughfareLeadingTypeStatus": "thoroughfareLeadingTypeStatus",
"ThoroughfareName": "thoroughfareName",
"ThoroughfareNameStatus": "thoroughfareNameStatus",
"ThoroughfarePostDirection": "thoroughfarePostDirection",
"ThoroughfarePostDirectionStatus": "thoroughfarePostDirectionStatus",
"ThoroughfarePreDirection": "thoroughfarePreDirection",
"ThoroughfarePreDirectionStatus": "thoroughfarePreDirectionStatus",
"ThoroughfareTrailingType": "thoroughfareTrailingType",
"ThoroughfareTrailingTypeStatus": "thoroughfareTrailingTypeStatus",
"ThoroughfareType": "thoroughfareType",
"ThoroughfareTypeStatus": "thoroughfareTypeStatus",
"TimeZone_DST": "timeZoneDST",
"TimeZone_DSTStatus": "timeZoneDSTStatus",
"TimeZone_Name": "timeZoneName",
"TimeZone_NameStatus": "timeZoneNameStatus",
"TimeZone_UTC": "timeZoneUTC",
"TimeZone_UTCStatus": "timeZoneUTCStatus",
"TractCode": "tractCode",
"TractCodeStatus": "tractCodeStatus",
"TraditionalCounty": "traditionalCounty",
"TraditionalCountyStatus": "traditionalCountyStatus",
"UDPRNKey": "udprnKey",
"UDPRNKeyStatus": "udprnKeyStatus",
"UMRRN": "umrrn",
"UMRRNStatus": "umrrnStatus",
"Unmatched": "unmatched",
"UnmatchedStatus": "unmatchedStatus",
"UPRN": "uprn",
"UPRNStatus": "uprnStatus",
"VacantIndicator": "vacantIndicator",
"VacantIndicatorStatus": "vacantIndicatorStatus",
"Zip5Valid": "zip5Valid",
"Zip5ValidStatus": "zip5ValidStatus",
"Surname": "surname",
"Forename": "forename",
"MiddleName": "middleName",
"FullName": "fullName",
"DeceasedFlag": "deceasedFlag",
"GoneawaysFlag": "goneawaysFlag",
"MatchedForenameDeceased": "matchedForenameDeceased",
"MatchedSurnameDeceased": "matchedSurnameDeceased",
"MatchedMiddleNameDeceased": "matchedMiddleNameDeceased",
"MatchedForenameGoneaways": "matchedForenameGoneaways",
"MatchedSurnameGoneaways": "matchedSurnameGoneaways",
"MatchedMiddleNameGoneaways": "matchedMiddleNameGoneaways",
});
});
export function cleansingInternationalBatchServiceResponseItemMatchFromJSON(
jsonString: string,
): SafeParseResult<
CleansingInternationalBatchServiceResponseItemMatch,
SDKValidationError
> {
return safeParse(
jsonString,
(x) =>
CleansingInternationalBatchServiceResponseItemMatch$inboundSchema.parse(
JSON.parse(x),
),
`Failed to parse 'CleansingInternationalBatchServiceResponseItemMatch' from JSON`,
);
}