validateAddress
Validate an address without persisting it. Accepts address form values (matching the structure from the addressFields query), runs validation, and returns the full descriptor with cleaned/normalised values and per-field errors so the client can compare submitted vs. normalised data.
Arguments
The address field values to validate.
Returns
ValidateAddressValidate an address without persisting it. Accepts address form values (matching the structure from the addressFields query), runs validation, and returns the full descriptor with cleaned/normalised values and per-field errors so the client can compare submitted vs. normalised data.
Possible Errors
Allowed Viewers
Customer
Partner User
Third party
Query Complexity
1Examples
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.
mutation ValidateAddress($input: ValidateAddressInput!) {
validateAddress(input: $input) {
cleanedDescriptor {
...AddressFieldDescriptorTypeFragment
}
isValid
}
}
Variables
{
"input": ValidateAddressInput
}
Response
{
"data": {
"validateAddress": {
"cleanedDescriptor": AddressFieldDescriptorType,
"isValid": true
}
}
}