Skip to main content

AddressValidationData Object

Represents address validation rules for a country.

type AddressValidationData {
  countryCode: String!
  countryName: String!
  addressFormat: String!
  addressLatinFormat: String!
  allowedFields: [String!]!
  requiredFields: [String!]!
  upperFields: [String!]!
  countryAreaType: String!
  countryAreaChoices: [ChoiceValue!]!
  cityType: String!
  cityChoices: [ChoiceValue!]!
  cityAreaType: String!
  cityAreaChoices: [ChoiceValue!]!
  postalCodeType: String!
  postalCodeMatchers: [String!]!
  postalCodeExamples: [String!]!
  postalCodePrefix: String!
}
Expand ▼

Fields​

AddressValidationData.countryCode ● String! non-null scalar miscellaneous​

The country code of the address validation rule.

AddressValidationData.countryName ● String! non-null scalar miscellaneous​

The country name of the address validation rule.

AddressValidationData.addressFormat ● String! non-null scalar miscellaneous​

The address format of the address validation rule.

Many fields in the JSON refer to address fields by one-letter abbreviations. These are defined as follows:

  • N: Name
  • O: Organization
  • A: Street Address Line(s)
  • D: Dependent locality (may be an inner-city district or a suburb)
  • C: City or Locality
  • S: Administrative area such as a state, province, island etc
  • Z: Zip or postal code
  • X: Sorting code

Click here for more information.

AddressValidationData.addressLatinFormat ● String! non-null scalar miscellaneous​

The latin address format of the address validation rule.

Many fields in the JSON refer to address fields by one-letter abbreviations. These are defined as follows:

  • N: Name
  • O: Organization
  • A: Street Address Line(s)
  • D: Dependent locality (may be an inner-city district or a suburb)
  • C: City or Locality
  • S: Administrative area such as a state, province, island etc
  • Z: Zip or postal code
  • X: Sorting code

Click here for more information.

AddressValidationData.allowedFields ● [String!]! non-null scalar miscellaneous​

The allowed fields to use in address.

AddressValidationData.requiredFields ● [String!]! non-null scalar miscellaneous​

The required fields to create a valid address.

AddressValidationData.upperFields ● [String!]! non-null scalar miscellaneous​

The list of fields that should be in upper case for address validation rule.

AddressValidationData.countryAreaType ● String! non-null scalar miscellaneous​

The formal name of the county area of the address validation rule.

AddressValidationData.countryAreaChoices ● [ChoiceValue!]! non-null object miscellaneous​

The available choices for the country area of the address validation rule.

AddressValidationData.cityType ● String! non-null scalar miscellaneous​

The formal name of the city of the address validation rule.

AddressValidationData.cityChoices ● [ChoiceValue!]! non-null object miscellaneous​

The available choices for the city of the address validation rule.

AddressValidationData.cityAreaType ● String! non-null scalar miscellaneous​

The formal name of the city area of the address validation rule.

AddressValidationData.cityAreaChoices ● [ChoiceValue!]! non-null object miscellaneous​

The available choices for the city area of the address validation rule.

AddressValidationData.postalCodeType ● String! non-null scalar miscellaneous​

The formal name of the postal code of the address validation rule.

AddressValidationData.postalCodeMatchers ● [String!]! non-null scalar miscellaneous​

The regular expression for postal code validation.

AddressValidationData.postalCodeExamples ● [String!]! non-null scalar miscellaneous​

The example postal code of the address validation rule.

AddressValidationData.postalCodePrefix ● String! non-null scalar miscellaneous​

The postal code prefix of the address validation rule.

Returned By​

addressValidationRules query