Method: validateAddress

Validates an address.

HTTP request

POST https://addressvalidation.googleapis.com/v1:validateAddress

The URL uses gRPC Transcoding syntax.

Request body

The request body contains data with the following structure:

JSON representation 
{
  "address": {
    object (PostalAddress)
  },
  "previousResponseId": string,
  "enableUspsCass": boolean,
  "languageOptions": {
    object (LanguageOptions)
  },
  "sessionToken": string
}
Fields
address

object (PostalAddress)

Required. The address being validated. Unformatted addresses should be submitted via addressLines.

The total length of the fields in this input must not exceed 280 characters.

Supported regions can be found here.

The languageCode value in the input address is reserved for future uses and is ignored today. The validated address result will be populated based on the preferred language for the given address, as identified by the system.

The Address Validation API ignores the values in recipients and organization. Any values in those fields will be discarded and not returned. Please do not set them.
previousResponseId

string

This field must be empty for the first address validation request. If more requests are necessary to fully validate a single address (for example if the changes the user makes after the initial validation need to be re-validated), then each followup request must populate this field with the responseId from the very first response in the validation sequence.
enableUspsCass

boolean

Enables USPS CASS compatible mode. This affects only the google.maps.addressvalidation.v1.ValidationResult.usps_data field of google.maps.addressvalidation.v1.ValidationResult. Note: for USPS CASS enabled requests for addresses in Puerto Rico, a google.type.PostalAddress.region_code of the address must be provided as "PR", or an google.type.PostalAddress.administrative_area of the address must be provided as "Puerto Rico" (case-insensitive) or "PR".

It's recommended to use a componentized address, or alternatively specify at least two google.type.PostalAddress.address_lines where the first line contains the street number and name and the second line contains the city, state, and zip code.
languageOptions

object (LanguageOptions)

Optional. Preview: This feature is in Preview (pre-GA). Pre-GA products and features might have limited support, and changes to pre-GA products and features might not be compatible with other pre-GA versions. Pre-GA Offerings are covered by the Google Maps Platform Service Specific Terms. For more information, see the launch stage descriptions.

Enables the Address Validation API to include additional information in the response.
sessionToken

string

Optional. A string which identifies an Autocomplete session for billing purposes. Must be a URL and filename safe base64 string with at most 36 ASCII characters in length. Otherwise an INVALID_ARGUMENT error is returned.

The session begins when the user makes an Autocomplete query, and concludes when they select a place and a call to Place Details or Address Validation is made. Each session can have multiple Autocomplete queries, followed by one Place Details or Address Validation request. The credentials used for each request within a session must belong to the same Google Cloud Console project. Once a session has concluded, the token is no longer valid; your app must generate a fresh token for each session. If the sessionToken parameter is omitted, or if you reuse a session token, the session is charged as if no session token was provided (each request is billed separately).

Note: Address Validation can only be used in sessions with the Autocomplete (New) API, not the Autocomplete API. See https://developers.google.com/maps/documentation/places/web-service/session-pricing for more details.

Response body

The response to an address validation request.

If successful, the response body contains data with the following structure:

JSON representation 
{
  "result": {
    object (ValidationResult)
  },
  "responseId": string
}
Fields
result

object (ValidationResult)

The result of the address validation.
responseId

string

The UUID that identifies this response. If the address needs to be re-validated, this UUID must accompany the new request.

PostalAddress

Represents a postal address, e.g. for postal delivery or payments addresses. Given a postal address, a postal service can deliver items to a premise, P.O. Box or similar. It is not intended to model geographical locations (roads, towns, mountains).

In typical usage an address would be created via user input or from importing existing data, depending on the type of process.

Advice on address input / editing: - Use an internationalization-ready address widget such as https://github.com/google/libaddressinput) - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used.

For more guidance on how to use this schema, please see: https://support.google.com/business/answer/6397478

JSON representation 
{
  "revision": integer,
  "regionCode": string,
  "languageCode": string,
  "postalCode": string,
  "sortingCode": string,
  "administrativeArea": string,
  "locality": string,
  "sublocality": string,
  "addressLines": [
    string
  ],
  "recipients": [
    string
  ],
  "organization": string
}
Fields
revision

integer

The schema revision of the PostalAddress. Any value other than 0 will cause the API to return an INVALID_ARGUMENT error.
regionCode

string

Optional. CLDR region code of the country/region of the address. See https://cldr.unicode.org/ and https://www.unicode.org/cldr/charts/30/supplemental/territory_information.html for details. Example: "CH" for Switzerland. If the region code is not provided, it will be inferred from the address. For best performance, it is recommended to include the region code if you know it. Having inconsistent or repeated regions can lead to poor performance, for example, if the addressLines already includes the region, do not provide the region code again in this field. Supported regions can be found in the FAQ.
languageCode

string

The language code in the input address is reserved for future uses and is ignored today. The API returns the address in the appropriate language for where the address is located.
postalCode

string

Optional. Postal code of the address. Not all countries use or require postal codes to be present, but where they are used, they may trigger additional validation with other parts of the address (e.g. state/zip validation in the U.S.A.).
sortingCode

string

Optional. Additional, country-specific, sorting code. This is not used in most regions. Where it is used, the value is either a string like "CEDEX", optionally followed by a number (e.g. "CEDEX 7"), or just a number alone, representing the "sector code" (Jamaica), "delivery area indicator" (Malawi) or "post office indicator" (e.g. Côte d'Ivoire).
administrativeArea

string

Optional. Highest administrative subdivision which is used for postal addresses of a country or region. For example, this can be a state, a province, an oblast, or a prefecture. Specifically, for Spain this is the province and not the autonomous community (e.g. "Barcelona" and not "Catalonia"). Many countries don't use an administrative area in postal addresses. E.g. in Switzerland this should be left unpopulated.
locality

string

Optional. Generally refers to the city/town portion of the address. Examples: US city, IT comune, UK post town. In regions of the world where localities are not well defined or do not fit into this structure well, leave locality empty and use addressLines.
sublocality

string

Optional. Sublocality of the address. For example, this can be neighborhoods, boroughs, districts.
addressLines[]

string

Required. Unstructured address lines describing the lower levels of an address.

Because values in addressLines do not have type information and may sometimes contain multiple values in a single field (e.g. "Austin, TX"), it is important that the line order is clear. The order of address lines should be "envelope order" for the country/region of the address.

The minimum permitted structural representation of an address consists of all information placed in the addressLines. If a regionCode is not provided, the region is inferred from the address lines.

Creating an address only containing addressLines, and then geocoding is the recommended way to handle completely unstructured addresses (as opposed to guessing which parts of the address should be localities or administrative areas).
recipients[]

string

Please avoid setting this field. The Address Validation API does not currently use it. Although at this time the API will not reject requests with this field set, the information will be discarded and will not be returned in the response.
organization

string

Please avoid setting this field. The Address Validation API does not currently use it. Although at this time the API will not reject requests with this field set, the information will be discarded and will not be returned in the response.

LanguageOptions

Preview: This feature is in Preview (pre-GA). Pre-GA products and features might have limited support, and changes to pre-GA products and features might not be compatible with other pre-GA versions. Pre-GA Offerings are covered by the Google Maps Platform Service Specific Terms. For more information, see the launch stage descriptions.

Enables the Address Validation API to include additional information in the response.

JSON representation 
{
  "returnEnglishLatinAddress": boolean
}
Fields
returnEnglishLatinAddress

boolean

Preview: Return a google.maps.addressvalidation.v1.Address in English. See google.maps.addressvalidation.v1.ValidationResult.english_latin_address for details.

ValidationResult

The result of validating an address.

JSON representation 
{
  "verdict": {
    object (Verdict)
  },
  "address": {
    object (Address)
  },
  "geocode": {
    object (Geocode)
  },
  "metadata": {
    object (AddressMetadata)
  },
  "uspsData": {
    object (UspsData)
  },
  "englishLatinAddress": {
    object (Address)
  }
}
Fields
verdict

object (Verdict)

Overall verdict flags
address

object (Address)

Information about the address itself as opposed to the geocode.
geocode

object (Geocode)

Information about the location and place that the address geocoded to.
metadata

object (AddressMetadata)

Other information relevant to deliverability. metadata is not guaranteed to be fully populated for every address sent to the Address Validation API.
uspsData

object (UspsData)

Extra deliverability flags provided by USPS. Only provided in region US and PR.
englishLatinAddress

object (Address)

Preview: This feature is in Preview (pre-GA). Pre-GA products and features might have limited support, and changes to pre-GA products and features might not be compatible with other pre-GA versions. Pre-GA Offerings are covered by the Google Maps Platform Service Specific Terms. For more information, see the launch stage descriptions.

The address translated to English.

Translated addresses are not reusable as API input. The service provides them so that the user can use their native language to confirm or deny the validation of the originally-provided address.

If part of the address doesn't have an English translation, the service returns that part in an alternate language that uses a Latin script. See here for an explanation of how the alternate language is selected. If part of the address doesn't have any translations or transliterations in a language that uses a Latin script, the service returns that part in the local language associated with the address.

Enable this output by using the google.maps.addressvalidation.v1.LanguageOptions.return_english_latin_address flag.

Note: the google.maps.addressvalidation.v1.Address.unconfirmed_component_types field in the englishLatinAddress and the google.maps.addressvalidation.v1.AddressComponent.confirmation_level fields in englishLatinAddress.address_components are not populated.

Verdict

High level overview of the address validation result and geocode.

JSON representation 
{
  "inputGranularity": enum (Granularity),
  "validationGranularity": enum (Granularity),
  "geocodeGranularity": enum (Granularity),
  "addressComplete": boolean,
  "hasUnconfirmedComponents": boolean,
  "hasInferredComponents": boolean,
  "hasReplacedComponents": boolean
}
Fields
inputGranularity

enum (Granularity)

The granularity of the input address. This is the result of parsing the input address and does not give any validation signals. For validation signals, refer to validationGranularity below.

For example, if the input address includes a specific apartment number, then the inputGranularity here will be SUB_PREMISE. If we cannot match the apartment number in the databases or the apartment number is invalid, the validationGranularity will likely be PREMISE or below.
validationGranularity

enum (Granularity)

The granularity level that the API can fully validate the address to. For example, an validationGranularity of PREMISE indicates all address components at the level of PREMISE or more coarse can be validated.

Per address component validation result can be found in google.maps.addressvalidation.v1.Address.address_components.
geocodeGranularity

enum (Granularity)

Information about the granularity of the geocode. This can be understood as the semantic meaning of how coarse or fine the geocoded location is.

This can differ from the validationGranularity above occasionally. For example, our database might record the existence of an apartment number but do not have a precise location for the apartment within a big apartment complex. In that case, the validationGranularity will be SUB_PREMISE but the geocodeGranularity will be PREMISE.
addressComplete

boolean

The address is considered complete if there are no unresolved tokens, no unexpected or missing address components. If unset, indicates that the value is false. See missingComponentTypes, unresolvedTokens or unexpected fields for more details.
hasUnconfirmedComponents

boolean

At least one address component cannot be categorized or validated, see google.maps.addressvalidation.v1.Address.address_components for details.
hasInferredComponents

boolean

At least one address component was inferred (added) that wasn't in the input, see google.maps.addressvalidation.v1.Address.address_components for details.
hasReplacedComponents

boolean

At least one address component was replaced, see google.maps.addressvalidation.v1.Address.address_components for details.

Granularity

The various granularities that an address or a geocode can have. When used to indicate granularity for an address, these values indicate with how fine a granularity the address identifies a mailing destination. For example, an address such as "123 Main Street, Redwood City, CA, 94061" identifies a PREMISE while something like "Redwood City, CA, 94061" identifies a LOCALITY. However, if we are unable to find a geocode for "123 Main Street" in Redwood City, the geocode returned might be of LOCALITY granularity even though the address is more granular.

Enums
GRANULARITY_UNSPECIFIED Default value. This value is unused.
SUB_PREMISE Below-building level result, such as an apartment.
PREMISE Building-level result.
PREMISE_PROXIMITY A geocode that approximates the building-level location of the address.
BLOCK The address or geocode indicates a block. Only used in regions which have block-level addressing, such as Japan.
ROUTE The geocode or address is granular to route, such as a street, road, or highway.
OTHER All other granularities, which are bucketed together since they are not deliverable.

Address

Details of the post-processed address. Post-processing includes correcting misspelled parts of the address, replacing incorrect parts, and inferring missing parts.

JSON representation 
{
  "formattedAddress": string,
  "postalAddress": {
    object (PostalAddress)
  },
  "addressComponents": [
    {
      object (AddressComponent)
    }
  ],
  "missingComponentTypes": [
    string
  ],
  "unconfirmedComponentTypes": [
    string
  ],
  "unresolvedTokens": [
    string
  ]
}
Fields
formattedAddress

string

The post-processed address, formatted as a single-line address following the address formatting rules of the region where the address is located.

Note: the format of this address may not match the format of the address in the postalAddress field. For example, the postalAddress always represents the country as a 2 letter regionCode, such as "US" or "NZ". By contrast, this field uses a longer form of the country name, such as "USA" or "New Zealand".
postalAddress

object (PostalAddress)

The post-processed address represented as a postal address.
addressComponents[]

object (AddressComponent)

Unordered list. The individual address components of the formatted and corrected address, along with validation information. This provides information on the validation status of the individual components.

Address components are not ordered in a particular way. Do not make any assumptions on the ordering of the address components in the list.
missingComponentTypes[]

string

The types of components that were expected to be present in a correctly formatted mailing address but were not found in the input AND could not be inferred. Components of this type are not present in formattedAddress, postalAddress, or addressComponents. An example might be ['street_number', 'route'] for an input like "Boulder, Colorado, 80301, USA". The list of possible types can be found here.
unconfirmedComponentTypes[]

string

The types of the components that are present in the addressComponents but could not be confirmed to be correct. This field is provided for the sake of convenience: its contents are equivalent to iterating through the addressComponents to find the types of all the components where the confirmationLevel is not CONFIRMED or the inferred flag is not set to true. The list of possible types can be found here.
unresolvedTokens[]

string

Any tokens in the input that could not be resolved. This might be an input that was not recognized as a valid part of an address. For example, for an input such as "Parcel 0000123123 & 0000456456 Str # Guthrie Center IA 50115 US", the unresolved tokens might look like ["Parcel", "0000123123", "&", "0000456456"].

AddressComponent

Represents an address component, such as a street, city, or state.

JSON representation 
{
  "componentName": {
    object (ComponentName)
  },
  "componentType": string,
  "confirmationLevel": enum (ConfirmationLevel),
  "inferred": boolean,
  "spellCorrected": boolean,
  "replaced": boolean,
  "unexpected": boolean
}
Fields
componentName

object (ComponentName)

The name for this component.
componentType

string

The type of the address component. See Table 2: Additional types returned by the Places service for a list of possible types.
confirmationLevel

enum (ConfirmationLevel)

Indicates the level of certainty that we have that the component is correct.
inferred

boolean

Indicates that the component was not part of the input, but we inferred it for the address location and believe it should be provided for a complete address.
spellCorrected

boolean

Indicates a correction to a misspelling in the component name. The API does not always flag changes from one spelling variant to another, such as when changing "centre" to "center". It also does not always flag common misspellings, such as when changing "Amphitheater Pkwy" to "Amphitheatre Pkwy".
replaced

boolean

Indicates the name of the component was replaced with a completely different one, for example a wrong postal code being replaced with one that is correct for the address. This is not a cosmetic change, the input component has been changed to a different one.
unexpected

boolean

Indicates an address component that is not expected to be present in a postal address for the given region. We have retained it only because it was part of the input.

ComponentName

A wrapper for the name of the component.

JSON representation 
{
  "text": string,
  "languageCode": string
}
Fields
text

string

The name text. For example, "5th Avenue" for a street name or "1253" for a street number.
languageCode

string

The BCP-47 language code. This will not be present if the component name is not associated with a language, such as a street number.

ConfirmationLevel

The different possible values for confirmation levels.

Enums
CONFIRMATION_LEVEL_UNSPECIFIED Default value. This value is unused.
CONFIRMED We were able to verify that this component exists and makes sense in the context of the rest of the address.
UNCONFIRMED_BUT_PLAUSIBLE This component could not be confirmed, but it is plausible that it exists. For example, a street number within a known valid range of numbers on a street where specific house numbers are not known.
UNCONFIRMED_AND_SUSPICIOUS This component was not confirmed and is likely to be wrong. For example, a neighborhood that does not fit the rest of the address.

Geocode

Contains information about the place the input was geocoded to.

JSON representation 
{
  "location": {
    object (LatLng)
  },
  "plusCode": {
    object (PlusCode)
  },
  "bounds": {
    object (Viewport)
  },
  "featureSizeMeters": number,
  "placeId": string,
  "placeTypes": [
    string
  ]
}
Fields
location

object (LatLng)

The geocoded location of the input.

Using place IDs is preferred over using addresses, latitude/longitude coordinates, or plus codes. Using coordinates when routing or calculating driving directions will always result in the point being snapped to the road nearest to those coordinates. This may not be a road that will quickly or safely lead to the destination and may not be near an access point to the property. Additionally, when a location is reverse geocoded, there is no guarantee that the returned address will match the original.
plusCode

object (PlusCode)

The plus code corresponding to the location.
bounds

object (Viewport)

The bounds of the geocoded place.
featureSizeMeters

number

The size of the geocoded place, in meters. This is another measure of the coarseness of the geocoded location, but in physical size rather than in semantic meaning.
placeId

string

The PlaceID of the place this input geocodes to.

For more information about Place IDs see here.
placeTypes[]

string

The type(s) of place that the input geocoded to. For example, ['locality', 'political']. The full list of types can be found here.

LatLng

An object that represents a latitude/longitude pair. This is expressed as a pair of doubles to represent degrees latitude and degrees longitude. Unless specified otherwise, this object must conform to the WGS84 standard. Values must be within normalized ranges.

JSON representation 
{
  "latitude": number,
  "longitude": number
}
Fields
latitude

number

The latitude in degrees. It must be in the range [-90.0, +90.0].
longitude

number

The longitude in degrees. It must be in the range [-180.0, +180.0].

PlusCode

Plus code (http://plus.codes) is a location reference with two formats: global code defining a 14mx14m (1/8000th of a degree) or smaller rectangle, and compound code, replacing the prefix with a reference location.

JSON representation 
{
  "globalCode": string,
  "compoundCode": string
}
Fields
globalCode

string

Place's global (full) code, such as "9FWM33GV+HQ", representing an 1/8000 by 1/8000 degree area (~14 by 14 meters).
compoundCode

string

Place's compound code, such as "33GV+HQ, Ramberg, Norway", containing the suffix of the global code and replacing the prefix with a formatted name of a reference entity.

Viewport

A latitude-longitude viewport, represented as two diagonally opposite low and high points. A viewport is considered a closed region, i.e. it includes its boundary. The latitude bounds must range between -90 to 90 degrees inclusive, and the longitude bounds must range between -180 to 180 degrees inclusive. Various cases include:

  • If low = high, the viewport consists of that single point.

  • If low.longitude > high.longitude, the longitude range is inverted (the viewport crosses the 180 degree longitude line).

  • If low.longitude = -180 degrees and high.longitude = 180 degrees, the viewport includes all longitudes.

  • If low.longitude = 180 degrees and high.longitude = -180 degrees, the longitude range is empty.

  • If low.latitude > high.latitude, the latitude range is empty.

Both low and high must be populated, and the represented box cannot be empty (as specified by the definitions above). An empty viewport will result in an error.

For example, this viewport fully encloses New York City:

{ "low": { "latitude": 40.477398, "longitude": -74.259087 }, "high": { "latitude": 40.91618, "longitude": -73.70018 } }

JSON representation 
{
  "low": {
    object (LatLng)
  },
  "high": {
    object (LatLng)
  }
}
Fields
low

object (LatLng)

Required. The low point of the viewport.
high

object (LatLng)

Required. The high point of the viewport.

AddressMetadata

The metadata for the address. metadata is not guaranteed to be fully populated for every address sent to the Address Validation API.

JSON representation 
{
  "business": boolean,
  "poBox": boolean,
  "residential": boolean
}
Fields
business

boolean

Indicates that this is the address of a business. If unset, indicates that the value is unknown.
poBox

boolean

Indicates that the address of a PO box. If unset, indicates that the value is unknown.
residential

boolean

Indicates that this is the address of a residence. If unset, indicates that the value is unknown.

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.

JSON representation 
{
  "standardizedAddress": {
    object (UspsAddress)
  },
  "deliveryPointCode": string,
  "deliveryPointCheckDigit": string,
  "dpvConfirmation": string,
  "dpvFootnote": string,
  "dpvCmra": string,
  "dpvVacant": string,
  "dpvNoStat": string,
  "dpvNoStatReasonCode": integer,
  "dpvDrop": string,
  "dpvThrowback": string,
  "dpvNonDeliveryDays": string,
  "dpvNonDeliveryDaysValues": integer,
  "dpvNoSecureLocation": string,
  "dpvPbsa": string,
  "dpvDoorNotAccessible": string,
  "dpvEnhancedDeliveryCode": string,
  "carrierRoute": string,
  "carrierRouteIndicator": string,
  "ewsNoMatch": boolean,
  "postOfficeCity": string,
  "postOfficeState": string,
  "abbreviatedCity": string,
  "fipsCountyCode": string,
  "county": string,
  "elotNumber": string,
  "elotFlag": string,
  "lacsLinkReturnCode": string,
  "lacsLinkIndicator": string,
  "poBoxOnlyPostalCode": boolean,
  "suitelinkFootnote": string,
  "pmbDesignator": string,
  "pmbNumber": string,
  "addressRecordType": string,
  "defaultAddress": boolean,
  "errorMessage": string,
  "cassProcessed": boolean
}
Fields
standardizedAddress

object (UspsAddress)

USPS standardized address.
deliveryPointCode

string

2 digit delivery point code
deliveryPointCheckDigit

string

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, deliveryPointCheckDigit, postal code, and ZIP+4 together should yield a number divisible by 10.
dpvConfirmation

string

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 dpvConfirmation value, the address was not submitted for DPV confirmation.
dpvFootnote

string

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
dpvCmra

string

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
dpvVacant

string

Is this place vacant? Returns a single character.

  • Y: The address is vacant
  • N: The address is not vacant
dpvNoStat

string

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
dpvNoStatReasonCode

integer

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.
dpvDrop

string

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.
dpvThrowback

string

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.
dpvNonDeliveryDays

string

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.
dpvNonDeliveryDaysValues

integer

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
dpvNoSecureLocation

string

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.
dpvPbsa

string

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.
dpvDoorNotAccessible

string

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.
dpvEnhancedDeliveryCode

string

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 but 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.
carrierRoute

string

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
carrierRouteIndicator

string

Carrier route rate sort indicator.
ewsNoMatch

boolean

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

string

Main post office city.
postOfficeState

string

Main post office state.
abbreviatedCity

string

Abbreviated city.
fipsCountyCode

string

FIPS county code.
county

string

County name.
elotNumber

string

Enhanced Line of Travel (eLOT) number.
elotFlag

string

eLOT Ascending/Descending Flag (A/D).
poBoxOnlyPostalCode

boolean

PO Box only postal code.
pmbDesignator

string

PMB (Private Mail Box) unit designator.
pmbNumber

string

PMB (Private Mail Box) number;
addressRecordType

string

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.
defaultAddress

boolean

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

string

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.
cassProcessed

boolean

Indicator that the request has been CASS processed.

UspsAddress

USPS representation of a US address.

JSON representation 
{
  "firstAddressLine": string,
  "firm": string,
  "secondAddressLine": string,
  "urbanization": string,
  "cityStateZipAddressLine": string,
  "city": string,
  "state": string,
  "zipCode": string,
  "zipCodeExtension": string
}
Fields
firstAddressLine

string

First address line.
firm

string

Firm name.
secondAddressLine

string

Second address line.
urbanization

string

Puerto Rican urbanization name.
cityStateZipAddressLine

string

City + state + postal code.
city

string

City name.
state

string

2 letter state code.
zipCode

string

Postal code e.g. 10009.
zipCodeExtension

string

4-digit postal code extension e.g. 5023.