Skip to main content

Fields

cleanedDescriptor : AddressFieldDescriptorType

The address field descriptor with cleaned/normalised values and per-field validation errors populated. Each field's errors list is empty when valid. Returned on both success and failure.

isValid : Boolean! required

Whether the address passed all validation checks.

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.

Example

{ "cleanedDescriptor": AddressFieldDescriptorType, "isValid": true }