bankid 0.2.0

BankID API SDK
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

use derive_builder::Builder;
use serde::{Deserialize, Serialize};

#[derive(Clone, Debug, Serialize, Deserialize, PartialEq, Eq)]
#[serde(rename_all = "camelCase")]
pub enum Status {
    Pending,
    Complete,
    Failed,
}

#[derive(Clone, Debug, Deserialize, Serialize, PartialEq, Eq)]
#[serde(rename_all = "camelCase")]
pub enum HintCode {
    // Pending
    OutstandingTransaction,
    NoClient,
    Started,
    UserMRTD,
    UserCallConfirm,
    UserSign,
    // Failed
    ExpiredTransaction,
    CertificateErr,
    UserCancel,
    Cancelled,
    StartFailed,
    UserDeclinedCall,
}

#[derive(Clone, Debug, Serialize, Deserialize, PartialEq, Eq, Builder)]
#[serde(rename_all = "camelCase")]
#[builder(setter(strip_option))]
pub struct Collect {
    /// The orderRef in question.
    pub order_ref: String,
    /// The status of the order in question.
    ///
    /// # Status
    /// pending - The order is being processed. hintCode describes the status of the order.
    /// failed - Something went wrong with the order. hintCode describes the error.
    /// complete - The order is complete. completionData holds user information.
    pub status: Status,
    /// Describes the status of the order.
    pub hint_code: Option<HintCode>,
    /// Only present for complete orders.
    pub completion_data: Option<CompletionData>,
}

#[derive(Clone, Debug, Serialize, Deserialize, PartialEq, Eq, Builder)]
#[serde(rename_all = "camelCase")]
pub struct CollectPayload {
    /// Used to collect the status of the order.
    pub order_ref: String,
}

#[derive(Clone, Debug, Serialize, Deserialize, PartialEq, Eq)]
#[serde(rename_all = "camelCase")]
pub struct CompletionData {
    /// Information related to the user.
    pub user: User,
    /// Information related to the device.
    pub device: Device,
    /// The date the BankID was issued to the user.
    pub bank_id_issue_date: String,
    /// Information about extra verifications that were part of the transaction.
    /// mrtd: Indicate if there was a check of the mrtd (machine readable travel document).
    /// True if the mrtd check was performed and passed.
    pub step_up: Option<bool>,
    /// The signature. Base64-encoded
    pub signature: String,
    pub ocsp_response: String,
}

#[derive(Clone, Debug, Serialize, Deserialize, PartialEq, Eq, Builder)]
#[serde(rename_all = "camelCase")]
pub struct User {
    /// The personal number
    pub personal_number: String,
    /// The given name and surname of the user
    pub name: String,
    /// The given name of the user.
    pub given_name: String,
    /// The surname of the user.
    pub surname: String,
}

#[derive(Clone, Debug, Serialize, Deserialize, PartialEq, Eq, Builder)]
#[serde(rename_all = "camelCase")]
pub struct Device {
    /// The IP address of the user agent as the BankID server discovers it
    pub ip_address: String,
    /// Unique hardware identifier for the user’s device.
    pub uhi: String,
}

#[derive(Clone, Debug, Serialize, Deserialize, PartialEq, Eq, Builder)]
#[serde(rename_all = "camelCase")]
pub struct Cert {
    ///  Start of validity of the users BankID
    pub not_before: String,
    /// End of validity of the Users BankID
    pub not_after: String,
}