Input fields

administrativeArea : String! required

Top-level administrative subdivision, e.g. NZ region.
country : String

ISO 3166-1 alpha-2 code of the country this address belongs to, e.g. AU, GB, JP, NZ.
deliveryPointIdentifier : String

Identifier used by the local postal service for this address, e.g. AU DPID, GB postcode + Delivery Point Suffix, US Zip-9 + Delivery Point.

This is the value that gets encoded in the barcode printed on the envelope by large-volume bulk mail providers.
dependentLocality : String

UK dependent localities, or neighbourhoods or boroughs in some other locations.
geographicalId : String

Identifier for this address in its territory's official address register, e.g. DAR ID in DK, UPRN in GB, G-NAF ID in AU.
locality : String! required

City or town portion of an address, e.g. NZ suburb or town.
name : String

A personal name.
organization : String

The name of a business or organisation.
postalCode : String! required

The post code associated with the address.
sortingCode : String

Sorting code, e.g. FR CEDEX code. This field is not used in many countries.
streetAddress : String

At most one of this field and structured_street_address can be supplied.

This is a divergence from RichAddressType.street_address, where the field is always supplied; if structured_street_address is present, it's generated from that.
structuredStreetAddress : NzlRichStructuredAddressInput! required

At most, only one of this field and street_address should be supplied.

NZ: New Zealand

The following keys may be present; all are optional. If keys are empty, they may be omitted from the response entirely.

  • flat_or_unit_type
  • flat_or_unit_number
  • floor_or_level_type
  • floor_or_level_number
  • property_name
  • building_name
  • house_number_1
  • house_number_suffix_1
  • house_number_2
  • house_number_suffix_2
  • street_prefix
  • street_name
  • street_type
  • street_suffix
  • rural_delivery_number
  • mailtown
  • postal_delivery_type
  • postal_delivery_location
  • postal_delivery_number_prefix
  • postal_delivery_number_value
  • postal_delivery_number_suffix
subAdministrativeArea : String

Second-level administrative subdivision, e.g. US county.

Only populated for addresses in countries where this concept is relevant. For all other countries this field will be blank.
The example data in the variables and responses below are autogenerated values designed to resemble real inputs. They do not represent actual customer data, and in some cases may require additional validation.

Example

{ "administrativeArea": "audience-baby-true-fear-citizen", "country": "north-candidate-night-sure-opportunity", "deliveryPointIdentifier": "39204480", "dependentLocality": "while-now-commercial-test-wind", "geographicalId": "93612653", "locality": "meeting-her-get-day-purpose", "name": "item-create-bit-program-fast", "organization": "matter-foot-the-tonight-adult", "postalCode": "cut-foreign-would-situation-fund", "sortingCode": "defense-purpose-study-usually-gas", "streetAddress": "think-reach-machine-world-doctor", "structuredStreetAddress": NzlRichStructuredAddressInput, "subAdministrativeArea": "rise-be-college-treat-defense" }