Validate a postal-code policy
validate_postal_policyValidate an address's postal code against US, GB, DE, FR, or JP format policies, returning compliance status and descriptive policy errors for invalid or missing codes.
Instructions
Validate an address's post_code against a country's format policy.
Supported policies: US (5-digit ZIP or ZIP+4), GB (alphanumeric UK
postcode), DE and FR (5 digits), JP (3-then-4 digits). The address is a
canonical-field JSON object; only its ``post_code`` is inspected.
Args:
address: The structured address whose post_code to validate.
country_code: The alpha-2 code selecting the policy.
Returns ``{"is_compliant": bool, "policy_errors": [...]}``. An unknown
country or a missing post_code is reported as non-compliant with a
descriptive error rather than raising.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| address | Yes | An ISO 20022 postal address as a JSON object using canonical field names, e.g. {'street_name': 'Downing St', 'building_number': '10', 'post_code': 'SW1A 2AA', 'town_name': 'London', 'country': 'GB'} or {'address_lines': ['10 Downing St', 'London SW1A 2AA'], 'country': 'GB'}. | |
| country_code | Yes | The ISO 3166-1 alpha-2 code whose post_code policy to apply (US, GB, DE, FR, JP). |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
No arguments | |||