Skip to main content

AddressLookupResult Object

Description​

A structured address resolved from a lookup suggestion, ready to prefill an address form.

Declaration​

type AddressLookupResult {
description: String
addressLine1: String
streetNumber: String
city: String
state: String
stateCode: String
postCode: String
country: String
alpha2: String
}

Fields​

NameTypeDescription
descriptionStringFull formatted address text.
addressLine1StringPrimary street address line (street name).
streetNumberStringStreet number component.
cityStringCity or locality name.
stateStringState or province name.
stateCodeStringState or province code abbreviation.
postCodeStringPostal or ZIP code.
countryStringFull country name.
alpha2StringTwo-letter ISO 3166-1 alpha-2 country code.