We currently use cookies to improve and customize your experience on our site. If you accept, we’ll also use marketing cookies to show you personalized ads. Manage your cookies and learn more.
Address
Base address schema used for both shipping and billing addresses. Maps to AddressValidationMetadata and HTML 5.1 Autofilling form controls the autocomplete attribute.
address_line_1stringOptional
The first line of the address, such as number and street, for example, `173 Drury Lane`. Needed for data entry, and Compliance and Risk checks. This field needs to pass the full address.
Match^.*$Length0 <= length <= 300
address_line_2stringOptional
The second line of the address, for example, a suite or apartment number.
Match^.*$Length0 <= length <= 300
admin_area_2stringOptional
A city, town, or village. Smaller than `admin_area_level_1`.
Match^.*$Length0 <= length <= 120
admin_area_1stringOptional
The highest-level sub-division in a country, which is usually a province, state, or ISO-3166-2 subdivision. This data is formatted for postal delivery, for example, `CA` and not `California`. Value, by country, is UK. A county. US. A state. Canada. A province. Japan. A prefecture. Switzerland. A *kanton*.
Match^.*$Length0 <= length <= 300
postal_codestringOptional
The postal code, which is the ZIP code or equivalent. Typically required for countries with a postal code or an equivalent. See postal code.