credential-exchange-format 0.3.0

Credential Exchange Format (CXF) rust types
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235

//! # Identity Credentials

use serde::{Deserialize, Serialize};

use crate::{
    EditableField, EditableFieldConcealedString, EditableFieldCountryCode, EditableFieldDate,
    EditableFieldString, EditableFieldSubdivisionCode, EditableFieldYearMonth,
};

/// An [AddressCredential] provides information for autofilling address forms.
#[derive(Clone, Debug, Default, Serialize, Deserialize)]
#[serde(rename_all = "camelCase", bound(deserialize = "E: Deserialize<'de>"))]
pub struct AddressCredential<E = ()> {
    /// The address line for the address. This is intentionally flexible to accommodate different
    /// address formats. Implementers MUST support multi-line addresses for this field, where each
    /// line is separated by a `\n` line feed.
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub street_address: Option<EditableField<EditableFieldString, E>>,
    /// The ZIP or postal code for the address.
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub postal_code: Option<EditableField<EditableFieldString, E>>,
    /// The city for the address.
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub city: Option<EditableField<EditableFieldString, E>>,
    /// The province, state, or territory for the address.
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub territory: Option<EditableField<EditableFieldSubdivisionCode, E>>,
    /// The country for the address. This MUST conform to the
    /// [ISO 3166-1 alpha-2](https://www.iso.org/iso-3166-country-codes.html) format.
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub country: Option<EditableField<EditableFieldCountryCode, E>>,
    /// The phone number associated with the address.
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub tel: Option<EditableField<EditableFieldString, E>>,
}

#[derive(Clone, Debug, Default, Serialize, Deserialize)]
#[serde(rename_all = "camelCase", bound(deserialize = "E: Deserialize<'de>"))]
pub struct CreditCardCredential<E = ()> {
    /// The credit card number.
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub number: Option<EditableField<EditableFieldConcealedString, E>>,
    /// The full name printed on the card.
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub full_name: Option<EditableField<EditableFieldString, E>>,
    /// The vendor of the card.
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub card_type: Option<EditableField<EditableFieldString, E>>,
    /// The verification number/value/code (CVV, CVC).
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub verification_number: Option<EditableField<EditableFieldConcealedString, E>>,
    /// The personal identification number (PIN).
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub pin: Option<EditableField<EditableFieldConcealedString, E>>,
    /// The expiration date of the card.
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub expiry_date: Option<EditableField<EditableFieldYearMonth, E>>,
    /// The date from which the card is valid.
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub valid_from: Option<EditableField<EditableFieldYearMonth, E>>,
}

/// A [DriversLicenseCredential] contains information about a person’s driver’s license. The fields
/// reflect the relevant set of mandatory data fields defined by
/// [ISO 18013-1](https://www.iso.org/standard/63798.html).
#[derive(Clone, Debug, Default, Serialize, Deserialize)]
#[serde(rename_all = "camelCase", bound(deserialize = "E: Deserialize<'de>"))]
pub struct DriversLicenseCredential<E = ()> {
    /// The full name of the license holder.
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub full_name: Option<EditableField<EditableFieldString, E>>,
    /// Day, month, and year on which the license holder was born.
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub birth_date: Option<EditableField<EditableFieldDate, E>>,
    /// The date on which the license was issued.
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub issue_date: Option<EditableField<EditableFieldDate, E>>,
    /// The date on which the license expires.
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub expiry_date: Option<EditableField<EditableFieldDate, E>>,
    /// The official body or government agency responsible for issuing the license.
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub issuing_authority: Option<EditableField<EditableFieldString, E>>,
    /// The principal administrative subdivision of the license’s country of origin. Examples of
    /// administrative subdivisions are states or provinces. This MUST conform to the ISO 3166-2
    /// format.
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub territory: Option<EditableField<EditableFieldSubdivisionCode, E>>,
    /// The license’s country of origin. This MUST conform to the ISO 3166-1 alpha-2 format.
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub country: Option<EditableField<EditableFieldCountryCode, E>>,
    /// The number assigned by the issuing authority.
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub license_number: Option<EditableField<EditableFieldString, E>>,
    ///  The vehicle types the license holder is authorized to operate.
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub license_class: Option<EditableField<EditableFieldString, E>>,
}

/// An [IdentityDocumentCredential] is for any document, card, or number identifying a person or
/// entity. Examples include national ID cards, Social Security Numbers (SSN), Tax Identification
/// Numbers (TIN), health insurance cards, or Value-Added Tax (VAT) numbers.
///
/// Credentials like the SSN can still be encoded as an IdentityDocument by only providing the
/// identificationNumber field, since the others are generally considered to be undefined in its
/// case.
///
/// Note: Driver’s licenses and passports may be accepted as identity verification in some
/// countries, but they are specified separately in the [DriversLicenseCredential] and
/// [PassportCredential] types, respectively.
#[derive(Clone, Debug, Default, Serialize, Deserialize)]
#[serde(rename_all = "camelCase", bound(deserialize = "E: Deserialize<'de>"))]
pub struct IdentityDocumentCredential<E = ()> {
    /// The document’s issuing country. This MUST conform to the ISO 3166-1 alpha-2 format.
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub issuing_country: Option<EditableField<EditableFieldCountryCode, E>>,
    /// The document’s identifying number. This identifying number is tied to the issuance of the
    /// document and is expected to change upon its reissuance, even when the person’s information
    /// might remain the same.
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub document_number: Option<EditableField<EditableFieldString, E>>,
    /// The person’s or other entity’s identification number. This identifying number is generally
    /// expected to remain stable across reissuances of the identity document itself. For
    /// identification numbers that are not an identity document (e.g., SSN, TIN, or VAT), this
    /// field is generally the only one that’s expected to be present in the credential.
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub identification_number: Option<EditableField<EditableFieldString, E>>,
    /// The person’s nationality.
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub nationality: Option<EditableField<EditableFieldString, E>>,
    /// The person’s full name.
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub full_name: Option<EditableField<EditableFieldString, E>>,
    /// The person’s date of birth.
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub birth_date: Option<EditableField<EditableFieldDate, E>>,
    /// The person’s place of birth.
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub birth_place: Option<EditableField<EditableFieldString, E>>,
    /// The person’s sex or gender.
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub sex: Option<EditableField<EditableFieldString, E>>,
    /// The date on which the document was issued.
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub issue_date: Option<EditableField<EditableFieldDate, E>>,
    /// The date on which the document expires.
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub expiry_date: Option<EditableField<EditableFieldDate, E>>,
    /// The official body or government agency responsible for issuing the document.
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub issuing_authority: Option<EditableField<EditableFieldString, E>>,
}

/// A [PassportCredential] contains the details of a person’s passport. The fields reflect the
/// relevant set of data elements defined by ICAO Doc 9303 Part 4.
#[derive(Clone, Debug, Default, Serialize, Deserialize)]
#[serde(rename_all = "camelCase", bound(deserialize = "E: Deserialize<'de>"))]
pub struct PassportCredential<E = ()> {
    /// The passport’s issuing country. This MUST conform to the ISO 3166-1 alpha-2 format.
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub issuing_country: Option<EditableField<EditableFieldCountryCode, E>>,
    /// The passport’s document type. This MUST be a valid document code as defined in ICAO Doc
    /// 9303 Part 4.
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub passport_type: Option<EditableField<EditableFieldString, E>>,
    /// The passport’s identifying number.
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub passport_number: Option<EditableField<EditableFieldString, E>>,
    /// The person’s national identification number.
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub national_identification_number: Option<EditableField<EditableFieldString, E>>,
    /// The person’s nationality.
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub nationality: Option<EditableField<EditableFieldString, E>>,
    /// The person’s full name.
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub full_name: Option<EditableField<EditableFieldString, E>>,
    /// The person’s date of birth.
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub birth_date: Option<EditableField<EditableFieldDate, E>>,
    /// The person’s place of birth.
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub birth_place: Option<EditableField<EditableFieldString, E>>,
    #[serde(default, skip_serializing_if = "Option::is_none")]
    /// The person’s sex or gender.
    pub sex: Option<EditableField<EditableFieldString, E>>,
    #[serde(default, skip_serializing_if = "Option::is_none")]
    /// The date on which the passport was issued.
    pub issue_date: Option<EditableField<EditableFieldDate, E>>,
    /// The date on which the passport expires.
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub expiry_date: Option<EditableField<EditableFieldDate, E>>,
    /// The official body or government agency responsible for issuing the passport.
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub issuing_authority: Option<EditableField<EditableFieldString, E>>,
}

/// A [PersonNameCredential] represents a person’s name as fields derived from Unicode Locale Data
/// Markup Language Part 8: Person Names.
///
/// All fields are marked as optional because an exporting provider SHOULD refrain from making
/// decisions about splitting up a name into any parts that were not explicitly provided as such,
/// since that often introduces errors.
#[derive(Clone, Debug, Default, Serialize, Deserialize)]
#[serde(rename_all = "camelCase", bound(deserialize = "E: Deserialize<'de>"))]
pub struct PersonNameCredential<E = ()> {
    /// This field contains a title or honorific qualifier. For example, "Ms.", "Mr.", or "Dr".
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub title: Option<EditableField<EditableFieldString, E>>,
    /// This field the person’s given name.
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub given: Option<EditableField<EditableFieldString, E>>,
    /// This field contains a nickname or preferred name.
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub given_informal: Option<EditableField<EditableFieldString, E>>,
    /// This field contains additional names or middle names.
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub given2: Option<EditableField<EditableFieldString, E>>,
    /// This field contains the prefix of the surname. For example, "van der" in "van der Poel" or
    /// "bint" in "bint Fadi".
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub surname_prefix: Option<EditableField<EditableFieldString, E>>,
    /// This field contains the person’s family name.
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub surname: Option<EditableField<EditableFieldString, E>>,
    /// This field contains the person’s secondary surname, which is used in some cultures.
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub surname2: Option<EditableField<EditableFieldString, E>>,
    /// This field contains a credential or accreditation qualifier. For example, "PhD" or "MBA".
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub credentials: Option<EditableField<EditableFieldString, E>>,
    /// This field contains a generation qualifier. For example, "Jr." or "III".
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub generation: Option<EditableField<EditableFieldString, E>>,
}