Input fields

administrativeArea : String

Top-level administrative subdivision, e.g. US state, AU state/territory, NZ region, IT region, JP prefecture.
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.
locality : String

City or town portion of an address, e.g. US city, AU suburb/town, NZ suburb and city/town, IT comune, UK post town.
name : String

A personal name.
organization : String

The name of a business or organisation.
postalCode : String

Postal code (ZIP code in the US).
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 : GenericScalar

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

AU: Australia

The following keys may be present; all are optional. All keys have string values, and their meaning is the same as their aseXML counterparts. (Note that, unlike aseXML, all keys are provided at the top level, rather than being nested.)

  • flat_or_unit_type
  • flat_or_unit_number
  • floor_or_level_type
  • floor_or_level_number
  • building_or_property_name
  • location_descriptor
  • lot_number
  • house_number_1
  • house_number_suffix_1
  • house_number_2
  • house_number_suffix_2
  • street_name
  • street_type
  • street_suffix
  • postal_delivery_type
  • postal_delivery_number_prefix
  • postal_delivery_number_value
  • postal_delivery_number_suffix

JP: Japan

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

  • chome
  • banchi
  • go
  • edaban
  • kana_building_name
  • kanji_building_name
  • building_number
  • room_number
  • address_code
  • physical_location_identifier
  • kana_company_name
  • kanji_company_name

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
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": "rock-paper-energy-money-catch", "country": "catch-resource-guess-seem-drive", "deliveryPointIdentifier": "37674241", "dependentLocality": "responsibility-figure-blood-however-manage", "locality": "beyond-cost-area-our-threat", "name": "describe-alone-region-spring-who", "organization": "party-garden-study-brother-realize", "postalCode": "believe-hundred-manager-help-collection", "sortingCode": "discuss-star-leg-oil-deep", "streetAddress": "resource-form-order-travel-yes", "structuredStreetAddress": "abc123" | 1 | 1.0 | true | ["abc123"] | AccountType }