diff --git a/dist/openapi.json b/dist/openapi.json index 012fbf3..dcec9b1 100644 --- a/dist/openapi.json +++ b/dist/openapi.json @@ -6783,6 +6783,249 @@ } } }, + "UsaCassVerifiedAddress": { + "title": "United States CASS Verified Address", + "description": "Address retrieved using CASS compliant address verification process", + "required": [ + "address1", + "address2", + "address3", + "area_code", + "carrier_route", + "check_digit", + "city", + "city_abbreviation", + "congressional_district", + "country_code", + "county", + "day_light_savings", + "delivery_point", + "dpv", + "dpvcmra", + "dpv_footnotes", + "dpvfp", + "dpv_no_stat", + "dpv_vacant", + "elot", + "finance_number", + "fips_county_code", + "firm", + "footnotes", + "geo_coded", + "lacs_indicator", + "lacs_link_footnote", + "lacs_link_indicator", + "latitude", + "longitude", + "parsed_pmb_designator", + "parsed_pmb_number", + "parsed_post_directional", + "parsed_pre_directional", + "parsed_primary_number", + "parsed_street_name", + "parsed_suffix", + "parsed_unit_designator", + "parsed_unit_number", + "rdi", + "record_type", + "secondary_address_info", + "state", + "suite_link_footnote", + "time_zone", + "urbanization", + "zip_code" + ], + "properties": { + "address1": { + "type": "string", + "description": "Primary delivery address\n" + }, + "address2": { + "type": "string", + "description": "Secondary address information\n" + }, + "address3": { + "type": "string", + "description": "Additional secondary address information\n" + }, + "area_code": { + "type": "string", + "description": "Area code\n" + }, + "carrier_route": { + "type": "string", + "description": "Data required to perform a Carrier Route sort\n" + }, + "check_digit": { + "type": "string", + "description": "Character following the 5- or 9-digit ZIP Code\n" + }, + "city": { + "type": "string", + "description": "City name\n" + }, + "city_abbreviation": { + "type": "string", + "description": "City Abbreviation\n" + }, + "congressional_district": { + "type": "string", + "description": "Identifies the Congressional District\n" + }, + "country_code": { + "type": "string", + "description": "ISO3166 country code\n" + }, + "county": { + "type": "string", + "description": "Name of the county\n" + }, + "day_light_savings": { + "type": "string", + "description": "Daylight saving time indicator\n" + }, + "delivery_point": { + "type": "string", + "description": "Last 2 digits of the primary street address number or Post Office™ box\n" + }, + "dpv": { + "type": "string", + "description": "DPV Confirmation code. Possible values: 'Y' (Yes), 'S' (Suspicious), 'D' (No).\n" + }, + "dpv_cmra": { + "type": "string", + "description": "DPV CMRA code. Possible values: 'Y' (Yes), 'N' (No).\n" + }, + "dpv_footnotes": { + "type": "string", + "description": "DPV Footnotes\n" + }, + "dpv_fp": { + "type": "string", + "description": "False Positive Indicator from the DPV lookup. Possible values: 'Y' (Yes), 'N' (No), ' ' (Space).\n" + }, + "dpv_no_stat": { + "type": "string", + "description": "DPV NoStat code\n" + }, + "dpv_vacant": { + "type": "string", + "description": "DPV Vacant code\n" + }, + "elot": { + "type": "string", + "description": "Enhanced Line of Travel\n" + }, + "finance_number": { + "type": "number", + "description": "Internal accounting number used by the USPS\n" + }, + "fips_county_code": { + "type": "string", + "description": "Federal Information Processing Standard code for a county\n" + }, + "firm": { + "type": "string", + "description": "Company name in a business address\n" + }, + "footnotes": { + "type": "string", + "description": "Letter codes returned by ZIP + 4® encoding\n" + }, + "geo_coded": { + "type": "string", + "description": "Indicates whether the address was geo-coded. Possible values: 'Y' (Yes), 'N' (No).\n" + }, + "lacs_indicator": { + "type": "string", + "description": "Indicates whether a record may benefit from LACS processing. Possible values: 'L' (Yes), ' ' (No).\n" + }, + "lacs_link_footnote": { + "type": "string", + "description": "LACSLink Footnote\n" + }, + "lacs_link_indicator": { + "type": "string", + "description": "LACSLink Indicator\n" + }, + "latitude": { + "type": "number", + "description": "Latitude of the encoded address\n" + }, + "longitude": { + "type": "number", + "description": "Longitude of the encoded address\n" + }, + "parsed_pmb_designator": { + "type": "string", + "description": "Information if a PMB is found in an address\n" + }, + "parsed_pmb_number": { + "type": "string", + "description": "Information if a PMB is found in an address\n" + }, + "parsed_post_directional": { + "type": "string", + "description": "Notation following the street name indicating street direction\n" + }, + "parsed_pre_directional": { + "type": "string", + "description": "Notation preceding the street name indicating street direction\n" + }, + "parsed_primary_number": { + "type": "number", + "description": "Number preceding the street name\n" + }, + "parsed_street_name": { + "type": "string", + "description": "Street name\n" + }, + "parsed_suffix": { + "type": "string", + "description": "Part of the delivery address line following the street name\n" + }, + "parsed_unit_designator": { + "type": "string", + "description": "Identification of the secondary address unit\n" + }, + "parsed_unit_number": { + "type": "number", + "description": "Apartment or suite number\n" + }, + "rdi": { + "type": "string", + "description": "Reserved for future use\n" + }, + "record_type": { + "type": "string", + "description": "Type of address record (Street, PO Box, High-rise, etc.)\n" + }, + "secondary_address_info": { + "type": "string", + "description": "Additional secondary address information\n" + }, + "state": { + "type": "string", + "description": "Standard two-letter state abbreviation\n" + }, + "suite_link_footnote": { + "type": "string", + "description": "Results of the SuiteLink lookup. Possible values: ' ' (Space), '00' (Double Zero), 'A' (A).\n" + }, + "time_zone": { + "type": "string", + "description": "Time zone\n" + }, + "urbanization": { + "type": "string", + "description": "Urban name required in the address of all mail being delivered to Puerto Rico\n" + }, + "zip_code": { + "type": "string", + "description": "5-digit ZIP Code™ and the four additional digits\n" + } + } + }, "GbrCleanseMatch": { "title": "Address Match", "type": "object", @@ -6821,6 +7064,9 @@ }, { "$ref": "#/components/schemas/WelshPafAddress" + }, + { + "$ref": "#/components/schemas/UsaCassVerifiedAddress" } ] }, diff --git a/dist/openapi.yaml b/dist/openapi.yaml index 616a96f..a417883 100644 --- a/dist/openapi.yaml +++ b/dist/openapi.yaml @@ -5835,6 +5835,246 @@ components: type: string enum: - Success + UsaCassVerifiedAddress: + title: United States CASS Verified Address + description: Address retrieved using CASS compliant address verification process + required: + - address1 + - address2 + - address3 + - area_code + - carrier_route + - check_digit + - city + - city_abbreviation + - congressional_district + - country_code + - county + - day_light_savings + - delivery_point + - dpv + - dpvcmra + - dpv_footnotes + - dpvfp + - dpv_no_stat + - dpv_vacant + - elot + - finance_number + - fips_county_code + - firm + - footnotes + - geo_coded + - lacs_indicator + - lacs_link_footnote + - lacs_link_indicator + - latitude + - longitude + - parsed_pmb_designator + - parsed_pmb_number + - parsed_post_directional + - parsed_pre_directional + - parsed_primary_number + - parsed_street_name + - parsed_suffix + - parsed_unit_designator + - parsed_unit_number + - rdi + - record_type + - secondary_address_info + - state + - suite_link_footnote + - time_zone + - urbanization + - zip_code + properties: + address1: + type: string + description: | + Primary delivery address + address2: + type: string + description: | + Secondary address information + address3: + type: string + description: | + Additional secondary address information + area_code: + type: string + description: | + Area code + carrier_route: + type: string + description: | + Data required to perform a Carrier Route sort + check_digit: + type: string + description: | + Character following the 5- or 9-digit ZIP Code + city: + type: string + description: | + City name + city_abbreviation: + type: string + description: | + City Abbreviation + congressional_district: + type: string + description: | + Identifies the Congressional District + country_code: + type: string + description: | + ISO3166 country code + county: + type: string + description: | + Name of the county + day_light_savings: + type: string + description: | + Daylight saving time indicator + delivery_point: + type: string + description: | + Last 2 digits of the primary street address number or Post Office™ box + dpv: + type: string + description: | + DPV Confirmation code. Possible values: 'Y' (Yes), 'S' (Suspicious), 'D' (No). + dpv_cmra: + type: string + description: | + DPV CMRA code. Possible values: 'Y' (Yes), 'N' (No). + dpv_footnotes: + type: string + description: | + DPV Footnotes + dpv_fp: + type: string + description: | + False Positive Indicator from the DPV lookup. Possible values: 'Y' (Yes), 'N' (No), ' ' (Space). + dpv_no_stat: + type: string + description: | + DPV NoStat code + dpv_vacant: + type: string + description: | + DPV Vacant code + elot: + type: string + description: | + Enhanced Line of Travel + finance_number: + type: number + description: | + Internal accounting number used by the USPS + fips_county_code: + type: string + description: | + Federal Information Processing Standard code for a county + firm: + type: string + description: | + Company name in a business address + footnotes: + type: string + description: | + Letter codes returned by ZIP + 4® encoding + geo_coded: + type: string + description: | + Indicates whether the address was geo-coded. Possible values: 'Y' (Yes), 'N' (No). + lacs_indicator: + type: string + description: | + Indicates whether a record may benefit from LACS processing. Possible values: 'L' (Yes), ' ' (No). + lacs_link_footnote: + type: string + description: | + LACSLink Footnote + lacs_link_indicator: + type: string + description: | + LACSLink Indicator + latitude: + type: number + description: | + Latitude of the encoded address + longitude: + type: number + description: | + Longitude of the encoded address + parsed_pmb_designator: + type: string + description: | + Information if a PMB is found in an address + parsed_pmb_number: + type: string + description: | + Information if a PMB is found in an address + parsed_post_directional: + type: string + description: | + Notation following the street name indicating street direction + parsed_pre_directional: + type: string + description: | + Notation preceding the street name indicating street direction + parsed_primary_number: + type: number + description: | + Number preceding the street name + parsed_street_name: + type: string + description: | + Street name + parsed_suffix: + type: string + description: | + Part of the delivery address line following the street name + parsed_unit_designator: + type: string + description: | + Identification of the secondary address unit + parsed_unit_number: + type: number + description: | + Apartment or suite number + rdi: + type: string + description: | + Reserved for future use + record_type: + type: string + description: | + Type of address record (Street, PO Box, High-rise, etc.) + secondary_address_info: + type: string + description: | + Additional secondary address information + state: + type: string + description: | + Standard two-letter state abbreviation + suite_link_footnote: + type: string + description: | + Results of the SuiteLink lookup. Possible values: ' ' (Space), '00' (Double Zero), 'A' (A). + time_zone: + type: string + description: | + Time zone + urbanization: + type: string + description: | + Urban name required in the address of all mail being delivered to Puerto Rico + zip_code: + type: string + description: | + 5-digit ZIP Code™ and the four additional digits GbrCleanseMatch: title: Address Match type: object @@ -5862,6 +6102,7 @@ components: - $ref: '#/components/schemas/NybAddress' - $ref: '#/components/schemas/PafAliasAddress' - $ref: '#/components/schemas/WelshPafAddress' + - $ref: '#/components/schemas/UsaCassVerifiedAddress' count: type: number description: | diff --git a/openapi.ts b/openapi.ts index fc529d0..d8f538d 100644 --- a/openapi.ts +++ b/openapi.ts @@ -3195,6 +3195,109 @@ export interface components { /** @enum {string} */ message: "Success"; }; + /** + * United States CASS Verified Address + * @description Address retrieved using CASS compliant address verification process + */ + UsaCassVerifiedAddress: { + /** @description Primary delivery address */ + address1: string; + /** @description Secondary address information */ + address2: string; + /** @description Additional secondary address information */ + address3: string; + /** @description Area code */ + area_code: string; + /** @description Data required to perform a Carrier Route sort */ + carrier_route: string; + /** @description Character following the 5- or 9-digit ZIP Code */ + check_digit: string; + /** @description City name */ + city: string; + /** @description City Abbreviation */ + city_abbreviation: string; + /** @description Identifies the Congressional District */ + congressional_district: string; + /** @description ISO3166 country code */ + country_code: string; + /** @description Name of the county */ + county: string; + /** @description Daylight saving time indicator */ + day_light_savings: string; + /** @description Last 2 digits of the primary street address number or Post Office™ box */ + delivery_point: string; + /** @description DPV Confirmation code. Possible values: 'Y' (Yes), 'S' (Suspicious), 'D' (No). */ + dpv: string; + /** @description DPV CMRA code. Possible values: 'Y' (Yes), 'N' (No). */ + dpv_cmra?: string; + /** @description DPV Footnotes */ + dpv_footnotes: string; + /** @description False Positive Indicator from the DPV lookup. Possible values: 'Y' (Yes), 'N' (No), ' ' (Space). */ + dpv_fp?: string; + /** @description DPV NoStat code */ + dpv_no_stat: string; + /** @description DPV Vacant code */ + dpv_vacant: string; + /** @description Enhanced Line of Travel */ + elot: string; + /** @description Internal accounting number used by the USPS */ + finance_number: number; + /** @description Federal Information Processing Standard code for a county */ + fips_county_code: string; + /** @description Company name in a business address */ + firm: string; + /** @description Letter codes returned by ZIP + 4® encoding */ + footnotes: string; + /** @description Indicates whether the address was geo-coded. Possible values: 'Y' (Yes), 'N' (No). */ + geo_coded: string; + /** @description Indicates whether a record may benefit from LACS processing. Possible values: 'L' (Yes), ' ' (No). */ + lacs_indicator: string; + /** @description LACSLink Footnote */ + lacs_link_footnote: string; + /** @description LACSLink Indicator */ + lacs_link_indicator: string; + /** @description Latitude of the encoded address */ + latitude: number; + /** @description Longitude of the encoded address */ + longitude: number; + /** @description Information if a PMB is found in an address */ + parsed_pmb_designator: string; + /** @description Information if a PMB is found in an address */ + parsed_pmb_number: string; + /** @description Notation following the street name indicating street direction */ + parsed_post_directional: string; + /** @description Notation preceding the street name indicating street direction */ + parsed_pre_directional: string; + /** @description Number preceding the street name */ + parsed_primary_number: number; + /** @description Street name */ + parsed_street_name: string; + /** @description Part of the delivery address line following the street name */ + parsed_suffix: string; + /** @description Identification of the secondary address unit */ + parsed_unit_designator: string; + /** @description Apartment or suite number */ + parsed_unit_number: number; + /** @description Reserved for future use */ + rdi: string; + /** @description Type of address record (Street, PO Box, High-rise, etc.) */ + record_type: string; + /** @description Additional secondary address information */ + secondary_address_info: string; + /** @description Standard two-letter state abbreviation */ + state: string; + /** @description Results of the SuiteLink lookup. Possible values: ' ' (Space), '00' (Double Zero), 'A' (A). */ + suite_link_footnote: string; + /** @description Time zone */ + time_zone: string; + /** @description Urban name required in the address of all mail being delivered to Puerto Rico */ + urbanization: string; + /** @description 5-digit ZIP Code™ and the four additional digits */ + zip_code: string; + } & { + dpvcmra: unknown; + dpvfp: unknown; + }; /** Address Match */ GbrCleanseMatch: { /** @description Originally submitted query */ @@ -3205,7 +3308,8 @@ export interface components { | components["schemas"]["MrAddress"] | components["schemas"]["NybAddress"] | components["schemas"]["PafAliasAddress"] - | components["schemas"]["WelshPafAddress"]; + | components["schemas"]["WelshPafAddress"] + | components["schemas"]["UsaCassVerifiedAddress"]; /** @description The number of addresses we matched to the input. We return the closest match by default. */ count: number; /** @description A score represented as number between 1 and 0. Fit compares the address elements present in your query against the matching address elements. It does not incorporate elements you have not presented in the score. A partial address (e.g. 12 Pye Green Road) will have a fit of 1 even though it is missing post town and postcode. Its confidence score will be less than 1 however because it is missing some crucial elements. */