# `IdentityDocumentKind`

What kind of identity document one is: `passport`, `identity_card`, `driving_licence` or `residence_permit`.

Use it as part of an [`IdentityDocument`](/docs/types/type-identity-document.md), or to list which kinds your app accepts.

## Shape

One of these 4 values:

`IdentityDocumentKind.passport`, `IdentityDocumentKind.identity_card`, `IdentityDocumentKind.driving_licence`, `IdentityDocumentKind.residence_permit`.

## Example

```jadpo
IdentityDocumentKind.passport
```

`text.parse(raw, as: IdentityDocumentKind)` reads one from text that comes from outside. Text that isn't one at all fails `malformed`, such as `passports`, `visa` or `id_card`.

## Good to know

- `==` tells you whether two are the same. `<` and `list.sort_by` don't take it.

## In JSON

A string, in a request, a response or `json.write`:

```json
"passport"
"driving_licence"
```

## Details

<details>
<summary>Text form, storage, how it is shown, and operations</summary>

`IdentityDocumentKind` is in the group Tax and identity numbers, and has been in Jadpo since 0.1.0.

### Text form

`text.from` writes one standard text form, the same form `text.parse` reads back: `passport` and `driving_licence`.

### How it is stored

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

### How it is shown to people

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

With `locale: Locale.en_gb`:

| Value | Shown |
|---|---|
| `passport` | `passport` |
| `driving_licence` | `driving_licence` |

### Operations

It also takes `text.parse`, `text.from`, `text.format`, `json.read`, `json.write` and `==`. [How every standard type behaves](/docs/every-standard-type-meets-one-contract.md) says how they work.

</details>