Assess a postal address
assess_addressScore a postal address against a compliance policy. Returns findings to address issues for the 2026 structured-address cutover.
Instructions
Score a single address against a policy and return its findings.
Args:
address: The postal address to assess.
policy_id: The policy to assess against (defaults to cbpr-2026).
as_of: The assessment date (YYYY-MM-DD); defaults to today.
country_hint: Country to assume when the address has none.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| as_of | No | The assessment date as an ISO 8601 string (YYYY-MM-DD). Decides cliff wording; defaults to today. | |
| 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'}. | |
| policy_id | No | The policy to assess against (see list_policies). Defaults to 'cbpr-2026' when omitted. | |
| country_hint | No | ISO 3166-1 alpha-2 hint when the address has no country of its own. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
No arguments | |||