An internationalized Address. The amount of data available depends on what has been set. Use status to determine how much of the address should be populated.

GraphQL Schema definition

  • type Address {
  • # The street address lines, generally this will
  • # be one or two entries although some addresses will have three.
  • streetAddressLines: [String!]
  • # The administrative area, exact definition varies based on location, but for US
  • # addresses this is the state.
  • administrativeArea: String
  • # The locality, exact definition varies based on location, but for US addresses
  • # this is the city.
  • locality: String
  • # The dependent locality, more specific than city, not often used in US addresses.
  • dependentLocality: String
  • postalCode: String
  • sortingCode: String
  • # Two character ISO-3166 country code.
  • countryCode: String
  • # The US display name for the country.
  • countryName: String
  • # The address formatted to the specification of
  • # the country.
  • # Each entry in the array represents an address line.
  • lines: [String!]
  • # The raw address as a single line.
  • address: String
  • # Describes how reliable the address information is.
  • status: AddressStatus
  • }