Skip to main content

addressValidationRules Query

Returns address validation rules.

addressValidationRules(
countryCode: CountryCode!
countryArea: String
city: String
cityArea: String
): AddressValidationData
Details
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!
}

Arguments

countryCode ● CountryCode!

Two-letter ISO 3166-1 country code.

countryArea ● String

Designation of a region, province or state.

city ● String

City or a town name.

cityArea ● String

Sublocality like a district.

Type

AddressValidationData

Represents address validation rules for a country.