> For the complete documentation index, see [llms.txt](https://docs.tonic.ai/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.tonic.ai/app/generation/generators/generator-reference/international-address.md).

# International Address

Generates an address-like string to replace either:

* For a Canadian postal address:
  * Street name
  * Postal code
* For a United Kingdom (UK) mailing address:
  * City
  * County
  * District
  * Country
  * Postal code

To replace a Canadian postal code:

* The generator selects a real postal code that starts with the same three digits - has the same Forward Sortation Area (FSA) -  as the original postal code, but that has a different Local Delivery Unit (LDU).
* For a postal code whose FSA is not on the list that the generator uses, you can provide a fallback value to use.

To replace a UK address components, the generator selects real values.

## Characteristics <a href="#international-address-characteristics" id="international-address-characteristics"></a>

<table data-header-hidden><thead><tr><th valign="top"></th><th valign="top"></th></tr></thead><tbody><tr><td valign="top"><strong>Consistency</strong></td><td valign="top">Yes, can be made self-consistent.</td></tr><tr><td valign="top"><strong>Linking</strong></td><td valign="top">No, cannot be linked.</td></tr><tr><td valign="top"><strong>Differential privacy</strong></td><td valign="top">Yes, if consistency is not enabled.</td></tr><tr><td valign="top"><strong>Data-free</strong></td><td valign="top">Yes, if consistency is not enabled.</td></tr><tr><td valign="top"><strong>Allowed for primary keys</strong></td><td valign="top">No</td></tr><tr><td valign="top"><strong>Allowed for unique columns</strong></td><td valign="top">No</td></tr><tr><td valign="top"><strong>Uses format-preserving encryption (FPE)</strong></td><td valign="top">No</td></tr><tr><td valign="top"><strong>Privacy ranking</strong></td><td valign="top"><ul><li>1 if not consistent</li><li>4 if consistent</li></ul></td></tr><tr><td valign="top"><strong>Generator ID (for the API)</strong></td><td valign="top"><a href="/app/api/quick-start-guide/tonic-api-generator-assignment/generator-api-reference/international-address-internationaladdressgenerator.md"><code>InternationalAddressGenerator</code></a></td></tr></tbody></table>

## How to configure <a href="#international-address-configure" id="international-address-configure"></a>

To configure the generator:

1. From the **Generator Type** dropdown list, select International Address.
2. From the **Country** dropdown list, select the country (Canada or United Kingdom).
3. From the **Address Component** dropdown list, select the address component that this column contains.\
   \
   For Canada, the available options are:

   * Street Name
   * Postal Code

   \
   For the UK, the available options are:

   * Postal code
   * City
   * County
   * District
   * Country
4. For a Canadian postal code, in the **Fallback Value** field, type the FSA to use if the value in the data does not exist.\
   \
   For example, the FSA in the data might be new and not yet in the list that Structural uses, or the FSA might be invalid.\
   \
   By default, the fallback value is `NULL`, meaning that in the destination data, the postal code value is the string literal "NULL".
5. Toggle the **Consistency** setting to indicate whether to make the column self-consistent.\
   \
   By default, consistency is disabled.
6. When consistency is enabled, use the **Case-sensitive** toggle to indicate whether the consistency is case-sensitive.\
   \
   By default, consistency is case-sensitive. For example, the values `Anytown` and `ANYTOWN` are considered different values. `Anytown` might always be replaced with `London`, and `ANYTOWN` might be replaced with `Bristol`.\
   \
   To make the consistency case-insensitive, toggle **Case-sensitive** to the off position. When the consistency is case-insensitive, `Anytown` and `ANYTOWN` are considered the same value and have the same replacement.
7. If [Structural data encryption](/app/generation/generators-assign-config/generators-data-encryption-config.md) is enabled, then to use it for this column, in the advanced options section, toggle **Use data encryption process** to the on position.


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://docs.tonic.ai/app/generation/generators/generator-reference/international-address.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
