IdentityDocument

An identity document: its kind, the country, its number and when it expires.

Use it for identity checks that accept several kinds of document. When you take only one kind, PassportNumber or DrivingLicenceNumber says so.

Shape

Write every field when you build one, and give a field that isn't required as none.

Its parts keep these rules, and a value that breaks one fails with the rule's name:

• number_of_kind_and_country: number is in the form of its kind of document from its country

Example

IdentityDocument {    kind: IdentityDocumentKind.passport    country: Country.gb    number: "123456789"    expires: "2031-05-01"}

Good to know

• The number is checked against the form for that kind from that country.
• Give expires: none for a document with no expiry date.
• text.format shows only the last four characters.
• == tells you whether two are the same. < and list.sort_by don't take it, so sort by one of its parts instead.
• A field that holds one counts as personal data (government_id), so you don't mark it yourself.

In JSON

An object of its parts, in a request, a response or json.write:

{"kind":"passport","country":"GB","number":"123456789","expires":"2030-01-31"}{"kind":"identity_card","country":"DE","number":"L01X00T47","expires":null}

When you read one, a field that isn't required may be left out, or sent as null.

Details