# `UkUtr`

A UK Unique Taxpayer Reference, ten digits. Personal data.

[Tax and identity numbers](types.md#tax-and-identity-numbers); not ordered; personal data (government_id); since Jadpo 0.1.0.

## Make one

Build one from its text, `UkUtr("1234567890")`, which checks it: text that isn't one breaks `format`.

`text.parse(raw, as: UkUtr)` reads one from its text; text that isn't one at all fails `malformed`, such as `123456789`, `12345 67890` or `12345678901`.

## Text, JSON and storage

`text.from` writes its canonical text, the one form `text.parse` reads back. JSON sends its canonical text as a string.

| Text | JSON |
|---|---|
| `1234567890` | `"1234567890"` |
| `9876543210` | `"9876543210"` |

It is stored in one column named for the field, of type `text`. `9876543210` is stored as `'9876543210'`.

## Shown to people

`text.format(value, locale:)` shows it to people in their locale.

With `locale: Locale.en_gb`:

| Value | Shown |
|---|---|
| `1234567890` | `1234567890` |
| `9876543210` | `9876543210` |

## Operations

It has the contract's own operations: `text.parse`, `text.from`, `text.format`, `json.read`, `json.write` and `==`. It isn't ordered, so `<` and sorting don't take it. [Every standard type meets one contract](../topics/every-standard-type-meets-one-contract.md) says how they work.
