Package google.maps.addressvalidation.v1

string

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

PostalAddress

The post-processed address represented as a postal address.

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.

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 formatted_address, postal_address, or address_components. An example might be ['street_number', 'route'] for an input like "Boulder, Colorado, 80301, USA". The list of possible types can be found here.

string

The types of the components that are present in the address_components 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 address_components to find the types of all the components where the confirmation_level is not CONFIRMED or the inferred flag is not set to true. The list of possible types can be found here.

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 in an input like "123235253253 Main St, San Francisco, CA, 94105", the unresolved tokens may look like ["123235253253"] since that does not look like a valid street number.

ComponentName

The name for this component.

string

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

ConfirmationLevel

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

bool

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.

bool

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

bool

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.

bool

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.

bool

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

bool

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

bool

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

string

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

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.

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

The plus code corresponding to the location.

Viewport

The bounds of the geocoded place.

float

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.

string

The PlaceID of the place this input geocodes to.

For more information about Place IDs see here.

string

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

bool

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

string

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

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.

ValidationConclusion

Required. The outcome of the sequence of validation attempts.

If this field is set to VALIDATION_CONCLUSION_UNSPECIFIED, an INVALID_ARGUMENT error will be returned.

string

Required. The ID of the response that this feedback is for. This should be the [response_id][google.maps.addressvalidation.v1.ValidateAddressRequest.response_id] from the first response in a series of address validation attempts.

string

First address line.

string

Firm name.

string

Second address line.

string

Puerto Rican urbanization name.

string

City + state + postal code.

string

City name.

string

2 letter state code.

string

Postal code e.g. 10009.

string

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

UspsAddress

USPS standardized address.

string

2 digit delivery point code

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

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

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

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

string

Is this place vacant? Returns a single character.

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

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

int32

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.

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.

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.

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.

int32

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

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.

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.

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.

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.

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

string

Carrier route rate sort indicator.

bool

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

string

Main post office city.

string

Main post office state.

string

Abbreviated city.

string

FIPS county code.

string

County name.

string

Enhanced Line of Travel (eLOT) number.

string

eLOT Ascending/Descending Flag (A/D).

string

LACSLink return code.

string

LACSLink indicator.

bool

PO Box only postal code.

string

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.

string

PMB (Private Mail Box) unit designator.

string

PMB (Private Mail Box) number;

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.

bool

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

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.

bool

Indicator that the request has been CASS processed.

PostalAddress

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

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

Supported regions can be found here.

The language_code 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.

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 response_id from the very first response in the validation sequence.

bool

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

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.

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.

ValidationResult

The result of the address validation.

string

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

Verdict

Overall verdict flags

Address

Information about the address itself as opposed to the geocode.

Geocode

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

AddressMetadata

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

UspsData

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

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 english_latin_address and the google.maps.addressvalidation.v1.AddressComponent.confirmation_level fields in english_latin_address.address_components are not populated.

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 validation_granularity below.

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

Granularity

The granularity level that the API can fully validate the address to. For example, an validation_granularity 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.

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 validation_granularity 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 validation_granularity will be SUB_PREMISE but the geocode_granularity will be PREMISE.

bool

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 missing_component_types, unresolved_tokens or unexpected fields for more details.

bool

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

bool

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

bool

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