AddressVerificationData

  • The JSON object represents address fields used for Address Verification Service (AVS).

  • Address fields include address lines, locality name, administrative area, postal code, and country code in ISO-3166-1 Alpha-2 format.

  • While all fields are optional, providing complete and accurate information improves AVS verification success.

  • For regions with less defined localities, like Japan and China, utilize the addressLine field instead of localityName.

  • When specifying the administrativeAreaName for the US, use the 2-character state abbreviation.

Contains address fields to be verified by AVS.

JSON representation 
{
  "addressLine": [
    string
  ],
  "localityName": string,
  "administrativeAreaName": string,
  "postalCodeNumber": string,
  "countryCode": string
}
Fields
addressLine[]

string

OPTIONAL: This holds unstructured Address text.
localityName

string

OPTIONAL: This is something of a fuzzy term, but it generally refers to the city/town portion of an address. In regions of the world where localities are not well defined or do not fit into this structure well (for example, Japan and China), leave localityName empty and use addressLine.

Examples: US city, IT comune, UK post town.
administrativeAreaName

string

OPTIONAL: The top-level administrative subdivision of this country for the user's billing address.

Examples: US state, IT region, UK constituent nation, JP prefecture

When country == US, this is expected to be the 2-character abbreviation for the US State.
postalCodeNumber

string

OPTIONAL: The user's billing postal code.
countryCode

string

OPTIONAL: The country code of the user's billing address in ISO-3166-1 Alpha-2 format.