Class UspsData

The USPS data for the address. uspsData is not guaranteed to be fully populated for every US or PR address sent to the Address Validation API. It's recommended to integrate the backup address fields in the response if you utilize uspsData as the primary part of the response.

Inheritance
object
UspsData
Implements
Inherited Members
Namespace: Google.Maps.AddressValidation.V1
Assembly: Google.Maps.AddressValidation.V1.dll
Syntax
public sealed class UspsData : IMessage<UspsData>, IEquatable<UspsData>, IDeepCloneable<UspsData>, IBufferMessage, IMessage

Constructors

UspsData()

Declaration
public UspsData()

UspsData(UspsData)

Declaration
public UspsData(UspsData other)
Parameters
Type Name Description
UspsData other

Properties

AbbreviatedCity

Abbreviated city.

Declaration
public string AbbreviatedCity { get; set; }
Property Value
Type Description
string

AddressRecordType

Type of the address record that matches the input address.

  • F: FIRM. This is a match to a Firm Record, which is the finest level of match available for an address.
  • G: GENERAL DELIVERY. This is a match to a General Delivery record.
  • H: BUILDING / APARTMENT. This is a match to a Building or Apartment record.
  • P: POST OFFICE BOX. This is a match to a Post Office Box.
  • R: RURAL ROUTE or HIGHWAY CONTRACT: This is a match to either a Rural Route or a Highway Contract record, both of which may have associated Box Number ranges.
  • S: STREET RECORD: This is a match to a Street record containing a valid primary number range.
Declaration
public string AddressRecordType { get; set; }
Property Value
Type Description
string

CarrierRoute

The carrier route code. A four character code consisting of a one letter prefix and a three digit route designator.

Prefixes:

  • C: Carrier route (or city route)
  • R: Rural route
  • H: Highway Contract Route
  • B: Post Office Box Section
  • G: General delivery unit
Declaration
public string CarrierRoute { get; set; }
Property Value
Type Description
string

CarrierRouteIndicator

Carrier route rate sort indicator.

Declaration
public string CarrierRouteIndicator { get; set; }
Property Value
Type Description
string

CassProcessed

Indicator that the request has been CASS processed.

Declaration
public bool CassProcessed { get; set; }
Property Value
Type Description
bool

County

County name.

Declaration
public string County { get; set; }
Property Value
Type Description
string

DefaultAddress

Indicator that a default address was found, but more specific addresses exists.

Declaration
public bool DefaultAddress { get; set; }
Property Value
Type Description
bool

DeliveryPointCheckDigit

The delivery point check digit. This number is added to the end of the delivery_point_barcode for mechanically scanned mail. Adding all the digits of the delivery_point_barcode, delivery_point_check_digit, postal code, and ZIP+4 together should yield a number divisible by 10.

Declaration
public string DeliveryPointCheckDigit { get; set; }
Property Value
Type Description
string

DeliveryPointCode

2 digit delivery point code

Declaration
public string DeliveryPointCode { get; set; }
Property Value
Type Description
string

DpvCmra

Indicates if the address is a CMRA (Commercial Mail Receiving Agency)--a private business receiving mail for clients. Returns a single character.

  • Y: The address is a CMRA
  • N: The address is not a CMRA
Declaration
public string DpvCmra { get; set; }
Property Value
Type Description
string

DpvConfirmation

The possible values for DPV confirmation. Returns a single character or returns no value.

  • N: Primary and any secondary number information failed to DPV confirm.
  • D: Address was DPV confirmed for the primary number only, and the secondary number information was missing.
  • S: Address was DPV confirmed for the primary number only, and the secondary number information was present but not confirmed.
  • Y: Address was DPV confirmed for primary and any secondary numbers.
  • Empty: If the response does not contain a dpv_confirmation value, the address was not submitted for DPV confirmation.
Declaration
public string DpvConfirmation { get; set; }
Property Value
Type Description
string

DpvDoorNotAccessible

Flag indicates addresses where USPS cannot knock on a door to deliver mail. Returns a single character.

  • Y: The door is not accessible.
  • N: No indication the door is not accessible.
Declaration
public string DpvDoorNotAccessible { get; set; }
Property Value
Type Description
string

DpvDrop

Flag indicates mail is delivered to a single receptable at a site. Returns a single character.

  • Y: The mail is delivered to a single receptable at a site.
  • N: The mail is not delivered to a single receptable at a site.
Declaration
public string DpvDrop { get; set; }
Property Value
Type Description
string

DpvEnhancedDeliveryCode

Indicates that more than one DPV return code is valid for the address. Returns a single character.

  • Y: Address was DPV confirmed for primary and any secondary numbers.
  • N: Primary and any secondary number information failed to DPV confirm.
  • S: Address was DPV confirmed for the primary number only, and the secondary number information was present by not confirmed, or a single trailing alpha on a primary number was dropped to make a DPV match and secondary information required.
  • D: Address was DPV confirmed for the primary number only, and the secondary number information was missing.
  • R: Address confirmed but assigned to phantom route R777 and R779 and USPS delivery is not provided.
Declaration
public string DpvEnhancedDeliveryCode { get; set; }
Property Value
Type Description
string

DpvFootnote

The footnotes from delivery point validation. Multiple footnotes may be strung together in the same string.

  • AA: Input address matched to the ZIP+4 file
  • A1: Input address was not matched to the ZIP+4 file
  • BB: Matched to DPV (all components)
  • CC: Secondary number not matched and not required
  • C1: Secondary number not matched but required
  • N1: High-rise address missing secondary number
  • M1: Primary number missing
  • M3: Primary number invalid
  • P1: Input address PO, RR or HC box number missing
  • P3: Input address PO, RR, or HC Box number invalid
  • F1: Input address matched to a military address
  • G1: Input address matched to a general delivery address
  • U1: Input address matched to a unique ZIP code
  • PB: Input address matched to PBSA record
  • RR: DPV confirmed address with PMB information
  • R1: DPV confirmed address without PMB information
  • R7: Carrier Route R777 or R779 record
  • IA: Informed Address identified
  • TA: Primary number matched by dropping a trailing alpha
Declaration
public string DpvFootnote { get; set; }
Property Value
Type Description
string

DpvNoSecureLocation

Flag indicates door is accessible, but package will not be left due to security concerns. Returns a single character.

  • Y: The package will not be left due to security concerns.
  • N: No indication the package will not be left due to security concerns.
Declaration
public string DpvNoSecureLocation { get; set; }
Property Value
Type Description
string

DpvNoStat

Is this a no stat address or an active address? No stat addresses are ones which are not continuously occupied or addresses that the USPS does not service. Returns a single character.

  • Y: The address is not active
  • N: The address is active
Declaration
public string DpvNoStat { get; set; }
Property Value
Type Description
string

DpvNoStatReasonCode

Indicates the NoStat type. Returns a reason code as int.

  • 1: IDA (Internal Drop Address) – Addresses that do not receive mail directly from the USPS but are delivered to a drop address that services them.
  • 2: CDS - Addresses that have not yet become deliverable. For example, a new subdivision where lots and primary numbers have been determined, but no structure exists yet for occupancy.
  • 3: Collision - Addresses that do not actually DPV confirm.
  • 4: CMZ (College, Military and Other Types) - ZIP + 4 records USPS has incorporated into the data.
  • 5: Regular - Indicates addresses not receiving delivery and the addresses are not counted as possible deliveries.
  • 6: Secondary Required - The address requires secondary information.
Declaration
public int DpvNoStatReasonCode { get; set; }
Property Value
Type Description
int

DpvNonDeliveryDays

Flag indicates mail delivery is not performed every day of the week. Returns a single character.

  • Y: The mail delivery is not performed every day of the week.
  • N: No indication the mail delivery is not performed every day of the week.
Declaration
public string DpvNonDeliveryDays { get; set; }
Property Value
Type Description
string

DpvNonDeliveryDaysValues

Integer identifying non-delivery days. It can be interrogated using bit flags: 0x40 – Sunday is a non-delivery day 0x20 – Monday is a non-delivery day 0x10 – Tuesday is a non-delivery day 0x08 – Wednesday is a non-delivery day 0x04 – Thursday is a non-delivery day 0x02 – Friday is a non-delivery day 0x01 – Saturday is a non-delivery day

Declaration
public int DpvNonDeliveryDaysValues { get; set; }
Property Value
Type Description
int

DpvPbsa

Indicates the address was matched to PBSA record. Returns a single character.

  • Y: The address was matched to PBSA record.
  • N: The address was not matched to PBSA record.
Declaration
public string DpvPbsa { get; set; }
Property Value
Type Description
string

DpvThrowback

Indicates that mail is not delivered to the street address. Returns a single character.

  • Y: The mail is not delivered to the street address.
  • N: The mail is delivered to the street address.
Declaration
public string DpvThrowback { get; set; }
Property Value
Type Description
string

DpvVacant

Is this place vacant? Returns a single character.

  • Y: The address is vacant
  • N: The address is not vacant
Declaration
public string DpvVacant { get; set; }
Property Value
Type Description
string

ElotFlag

eLOT Ascending/Descending Flag (A/D).

Declaration
public string ElotFlag { get; set; }
Property Value
Type Description
string

ElotNumber

Enhanced Line of Travel (eLOT) number.

Declaration
public string ElotNumber { get; set; }
Property Value
Type Description
string

ErrorMessage

Error message for USPS data retrieval. This is populated when USPS processing is suspended because of the detection of artificially created addresses.

The USPS data fields might not be populated when this error is present.

Declaration
public string ErrorMessage { get; set; }
Property Value
Type Description
string

EwsNoMatch

The delivery address is matchable, but the EWS file indicates that an exact match will be available soon.

Declaration
public bool EwsNoMatch { get; set; }
Property Value
Type Description
bool

FipsCountyCode

FIPS county code.

Declaration
public string FipsCountyCode { get; set; }
Property Value
Type Description
string

LacsLinkIndicator

LACSLink indicator.

Declaration
public string LacsLinkIndicator { get; set; }
Property Value
Type Description
string

LacsLinkReturnCode

LACSLink return code.

Declaration
public string LacsLinkReturnCode { get; set; }
Property Value
Type Description
string

PmbDesignator

PMB (Private Mail Box) unit designator.

Declaration
public string PmbDesignator { get; set; }
Property Value
Type Description
string

PmbNumber

PMB (Private Mail Box) number;

Declaration
public string PmbNumber { get; set; }
Property Value
Type Description
string

PoBoxOnlyPostalCode

PO Box only postal code.

Declaration
public bool PoBoxOnlyPostalCode { get; set; }
Property Value
Type Description
bool

PostOfficeCity

Main post office city.

Declaration
public string PostOfficeCity { get; set; }
Property Value
Type Description
string

PostOfficeState

Main post office state.

Declaration
public string PostOfficeState { get; set; }
Property Value
Type Description
string

StandardizedAddress

USPS standardized address.

Declaration
public UspsAddress StandardizedAddress { get; set; }
Property Value
Type Description
UspsAddress

SuitelinkFootnote

Footnotes from matching a street or highrise record to suite information. If business name match is found, the secondary number is returned.

  • A: SuiteLink record match, business address improved.
  • 00: No match, business address is not improved.
Declaration
public string SuitelinkFootnote { get; set; }
Property Value
Type Description
string