didit-sdk 1.0.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (234) hide show
  1. checksums.yaml +7 -0
  2. data/CHANGELOG.md +25 -0
  3. data/LICENSE +21 -0
  4. data/README.md +277 -0
  5. data/lib/didit/authentication/base64_url.rb +34 -0
  6. data/lib/didit/authentication/cache.rb +201 -0
  7. data/lib/didit/authentication/http.rb +150 -0
  8. data/lib/didit/authentication/issuer.rb +115 -0
  9. data/lib/didit/authentication/jws.rb +231 -0
  10. data/lib/didit/authentication/key_set.rb +89 -0
  11. data/lib/didit/authentication/pkce.rb +64 -0
  12. data/lib/didit/authentication/types.rb +175 -0
  13. data/lib/didit/authentication.rb +546 -0
  14. data/lib/didit/client.rb +211 -0
  15. data/lib/didit/errors.rb +153 -0
  16. data/lib/didit/file_part.rb +85 -0
  17. data/lib/didit/internal/config.rb +94 -0
  18. data/lib/didit/internal/errors.rb +83 -0
  19. data/lib/didit/internal/log.rb +41 -0
  20. data/lib/didit/internal/multipart.rb +60 -0
  21. data/lib/didit/internal/request.rb +322 -0
  22. data/lib/didit/internal/transport.rb +198 -0
  23. data/lib/didit/internal/util.rb +76 -0
  24. data/lib/didit/internal.rb +15 -0
  25. data/lib/didit/model.rb +199 -0
  26. data/lib/didit/page.rb +130 -0
  27. data/lib/didit/raw_response.rb +57 -0
  28. data/lib/didit/resource.rb +15 -0
  29. data/lib/didit/resources/account.rb +309 -0
  30. data/lib/didit/resources/address_validation.rb +73 -0
  31. data/lib/didit/resources/age_estimation.rb +110 -0
  32. data/lib/didit/resources/aml.rb +166 -0
  33. data/lib/didit/resources/aml_monitoring.rb +30 -0
  34. data/lib/didit/resources/analytics.rb +87 -0
  35. data/lib/didit/resources/bank.rb +65 -0
  36. data/lib/didit/resources/billing.rb +61 -0
  37. data/lib/didit/resources/biometric_templates.rb +234 -0
  38. data/lib/didit/resources/blocklist.rb +130 -0
  39. data/lib/didit/resources/business_sessions.rb +29 -0
  40. data/lib/didit/resources/businesses.rb +471 -0
  41. data/lib/didit/resources/cases.rb +2116 -0
  42. data/lib/didit/resources/customization.rb +153 -0
  43. data/lib/didit/resources/database_validation.rb +327 -0
  44. data/lib/didit/resources/document_ai.rb +145 -0
  45. data/lib/didit/resources/email.rb +254 -0
  46. data/lib/didit/resources/face_match.rb +103 -0
  47. data/lib/didit/resources/face_search.rb +103 -0
  48. data/lib/didit/resources/fraud_checks.rb +130 -0
  49. data/lib/didit/resources/id_verification.rb +163 -0
  50. data/lib/didit/resources/id_wallets.rb +1468 -0
  51. data/lib/didit/resources/investigator.rb +419 -0
  52. data/lib/didit/resources/ip.rb +68 -0
  53. data/lib/didit/resources/kyb.rb +256 -0
  54. data/lib/didit/resources/lists.rb +332 -0
  55. data/lib/didit/resources/monitoring_events.rb +466 -0
  56. data/lib/didit/resources/networks.rb +427 -0
  57. data/lib/didit/resources/passive_liveness.rb +103 -0
  58. data/lib/didit/resources/phone.rb +271 -0
  59. data/lib/didit/resources/pricing.rb +40 -0
  60. data/lib/didit/resources/proof_of_address.rb +167 -0
  61. data/lib/didit/resources/questionnaires.rb +170 -0
  62. data/lib/didit/resources/regulatory_reports.rb +314 -0
  63. data/lib/didit/resources/report_templates.rb +146 -0
  64. data/lib/didit/resources/sessions.rb +2820 -0
  65. data/lib/didit/resources/transactions.rb +981 -0
  66. data/lib/didit/resources/travel_rule.rb +1202 -0
  67. data/lib/didit/resources/users.rb +521 -0
  68. data/lib/didit/resources/wallet_screening.rb +190 -0
  69. data/lib/didit/resources/webhooks.rb +396 -0
  70. data/lib/didit/resources/workflows.rb +214 -0
  71. data/lib/didit/resources.rb +263 -0
  72. data/lib/didit/types/account.rb +11 -0
  73. data/lib/didit/types/account_components.rb +105 -0
  74. data/lib/didit/types/address_validation.rb +8 -0
  75. data/lib/didit/types/age_estimation.rb +89 -0
  76. data/lib/didit/types/aml.rb +193 -0
  77. data/lib/didit/types/aml_monitoring.rb +73 -0
  78. data/lib/didit/types/analytics.rb +62 -0
  79. data/lib/didit/types/bank.rb +8 -0
  80. data/lib/didit/types/billing.rb +18 -0
  81. data/lib/didit/types/biometric_templates.rb +292 -0
  82. data/lib/didit/types/blocklist.rb +31 -0
  83. data/lib/didit/types/businesses.rb +45 -0
  84. data/lib/didit/types/cases.rb +368 -0
  85. data/lib/didit/types/components.rb +12206 -0
  86. data/lib/didit/types/customization.rb +8 -0
  87. data/lib/didit/types/database_validation.rb +177 -0
  88. data/lib/didit/types/document_ai.rb +135 -0
  89. data/lib/didit/types/email.rb +116 -0
  90. data/lib/didit/types/face_match.rb +93 -0
  91. data/lib/didit/types/face_search.rb +129 -0
  92. data/lib/didit/types/fraud_checks.rb +8 -0
  93. data/lib/didit/types/id_verification.rb +231 -0
  94. data/lib/didit/types/id_wallets.rb +8 -0
  95. data/lib/didit/types/investigator.rb +221 -0
  96. data/lib/didit/types/ip.rb +8 -0
  97. data/lib/didit/types/kyb.rb +1391 -0
  98. data/lib/didit/types/lists.rb +111 -0
  99. data/lib/didit/types/monitoring_events.rb +235 -0
  100. data/lib/didit/types/networks.rb +120 -0
  101. data/lib/didit/types/passive_liveness.rb +95 -0
  102. data/lib/didit/types/phone.rb +69 -0
  103. data/lib/didit/types/proof_of_address.rb +166 -0
  104. data/lib/didit/types/questionnaires.rb +29 -0
  105. data/lib/didit/types/regulatory_reports.rb +100 -0
  106. data/lib/didit/types/report_templates.rb +41 -0
  107. data/lib/didit/types/sessions.rb +1441 -0
  108. data/lib/didit/types/transactions.rb +245 -0
  109. data/lib/didit/types/travel_rule.rb +168 -0
  110. data/lib/didit/types/users.rb +180 -0
  111. data/lib/didit/types/wallet_screening.rb +49 -0
  112. data/lib/didit/types/webhooks.rb +355 -0
  113. data/lib/didit/types/workflows.rb +32 -0
  114. data/lib/didit/types.rb +1681 -0
  115. data/lib/didit/version.rb +5 -0
  116. data/lib/didit/webhooks/canonical_json.rb +187 -0
  117. data/lib/didit/webhooks/client_methods.rb +23 -0
  118. data/lib/didit/webhooks/events.rb +221 -0
  119. data/lib/didit/webhooks/headers.rb +83 -0
  120. data/lib/didit/webhooks/verifier.rb +260 -0
  121. data/lib/didit/webhooks.rb +99 -0
  122. data/lib/didit-sdk.rb +4 -0
  123. data/lib/didit.rb +31 -0
  124. data/sig/didit/authentication/base64_url.rbs +10 -0
  125. data/sig/didit/authentication/cache.rbs +60 -0
  126. data/sig/didit/authentication/http.rbs +37 -0
  127. data/sig/didit/authentication/issuer.rbs +17 -0
  128. data/sig/didit/authentication/jws.rbs +41 -0
  129. data/sig/didit/authentication/jwt.rbs +14 -0
  130. data/sig/didit/authentication/key_set.rbs +25 -0
  131. data/sig/didit/authentication/pkce.rbs +20 -0
  132. data/sig/didit/authentication/types.rbs +114 -0
  133. data/sig/didit/authentication.rbs +81 -0
  134. data/sig/didit/client.rbs +61 -0
  135. data/sig/didit/errors.rbs +80 -0
  136. data/sig/didit/file_part.rbs +19 -0
  137. data/sig/didit/internal.rbs +199 -0
  138. data/sig/didit/model.rbs +42 -0
  139. data/sig/didit/page.rbs +34 -0
  140. data/sig/didit/raw_response.rbs +20 -0
  141. data/sig/didit/resource.rbs +8 -0
  142. data/sig/didit/resources/account.rbs +23 -0
  143. data/sig/didit/resources/address_validation.rbs +9 -0
  144. data/sig/didit/resources/age_estimation.rbs +9 -0
  145. data/sig/didit/resources/aml.rbs +10 -0
  146. data/sig/didit/resources/aml_monitoring.rbs +9 -0
  147. data/sig/didit/resources/analytics.rbs +9 -0
  148. data/sig/didit/resources/bank.rbs +9 -0
  149. data/sig/didit/resources/billing.rbs +10 -0
  150. data/sig/didit/resources/biometric_templates.rbs +13 -0
  151. data/sig/didit/resources/blocklist.rbs +11 -0
  152. data/sig/didit/resources/business_sessions.rbs +9 -0
  153. data/sig/didit/resources/businesses.rbs +22 -0
  154. data/sig/didit/resources/cases.rbs +103 -0
  155. data/sig/didit/resources/customization.rbs +10 -0
  156. data/sig/didit/resources/database_validation.rbs +9 -0
  157. data/sig/didit/resources/document_ai.rbs +9 -0
  158. data/sig/didit/resources/email.rbs +11 -0
  159. data/sig/didit/resources/face_match.rbs +9 -0
  160. data/sig/didit/resources/face_search.rbs +9 -0
  161. data/sig/didit/resources/fraud_checks.rbs +11 -0
  162. data/sig/didit/resources/id_verification.rbs +9 -0
  163. data/sig/didit/resources/id_wallets.rbs +37 -0
  164. data/sig/didit/resources/investigator.rbs +23 -0
  165. data/sig/didit/resources/ip.rbs +9 -0
  166. data/sig/didit/resources/kyb.rbs +12 -0
  167. data/sig/didit/resources/lists.rbs +20 -0
  168. data/sig/didit/resources/monitoring_events.rbs +16 -0
  169. data/sig/didit/resources/networks.rbs +25 -0
  170. data/sig/didit/resources/passive_liveness.rbs +9 -0
  171. data/sig/didit/resources/phone.rbs +11 -0
  172. data/sig/didit/resources/pricing.rbs +9 -0
  173. data/sig/didit/resources/proof_of_address.rbs +9 -0
  174. data/sig/didit/resources/questionnaires.rbs +13 -0
  175. data/sig/didit/resources/regulatory_reports.rbs +16 -0
  176. data/sig/didit/resources/report_templates.rbs +13 -0
  177. data/sig/didit/resources/sessions.rbs +78 -0
  178. data/sig/didit/resources/transactions.rbs +43 -0
  179. data/sig/didit/resources/travel_rule.rbs +62 -0
  180. data/sig/didit/resources/users.rbs +21 -0
  181. data/sig/didit/resources/wallet_screening.rbs +11 -0
  182. data/sig/didit/resources/webhooks.rbs +23 -0
  183. data/sig/didit/resources/workflows.rbs +13 -0
  184. data/sig/didit/resources.rbs +50 -0
  185. data/sig/didit/types/account.rbs +22 -0
  186. data/sig/didit/types/account_components.rbs +94 -0
  187. data/sig/didit/types/address_validation.rbs +7 -0
  188. data/sig/didit/types/age_estimation.rbs +80 -0
  189. data/sig/didit/types/aml.rbs +174 -0
  190. data/sig/didit/types/aml_monitoring.rbs +67 -0
  191. data/sig/didit/types/analytics.rbs +57 -0
  192. data/sig/didit/types/bank.rbs +9 -0
  193. data/sig/didit/types/billing.rbs +19 -0
  194. data/sig/didit/types/biometric_templates.rbs +268 -0
  195. data/sig/didit/types/blocklist.rbs +33 -0
  196. data/sig/didit/types/businesses.rbs +54 -0
  197. data/sig/didit/types/cases.rbs +414 -0
  198. data/sig/didit/types/components.rbs +10920 -0
  199. data/sig/didit/types/customization.rbs +7 -0
  200. data/sig/didit/types/database_validation.rbs +152 -0
  201. data/sig/didit/types/document_ai.rbs +123 -0
  202. data/sig/didit/types/email.rbs +112 -0
  203. data/sig/didit/types/face_match.rbs +86 -0
  204. data/sig/didit/types/face_search.rbs +112 -0
  205. data/sig/didit/types/fraud_checks.rbs +9 -0
  206. data/sig/didit/types/id_verification.rbs +196 -0
  207. data/sig/didit/types/id_wallets.rbs +55 -0
  208. data/sig/didit/types/investigator.rbs +212 -0
  209. data/sig/didit/types/ip.rbs +7 -0
  210. data/sig/didit/types/kyb.rbs +1254 -0
  211. data/sig/didit/types/lists.rbs +106 -0
  212. data/sig/didit/types/monitoring_events.rbs +234 -0
  213. data/sig/didit/types/networks.rbs +113 -0
  214. data/sig/didit/types/passive_liveness.rbs +87 -0
  215. data/sig/didit/types/phone.rbs +65 -0
  216. data/sig/didit/types/proof_of_address.rbs +144 -0
  217. data/sig/didit/types/questionnaires.rbs +30 -0
  218. data/sig/didit/types/regulatory_reports.rbs +101 -0
  219. data/sig/didit/types/report_templates.rbs +42 -0
  220. data/sig/didit/types/sessions.rbs +1349 -0
  221. data/sig/didit/types/transactions.rbs +273 -0
  222. data/sig/didit/types/travel_rule.rbs +188 -0
  223. data/sig/didit/types/users.rbs +181 -0
  224. data/sig/didit/types/wallet_screening.rbs +40 -0
  225. data/sig/didit/types/webhooks.rbs +311 -0
  226. data/sig/didit/types/workflows.rbs +30 -0
  227. data/sig/didit/webhooks/canonical_json.rbs +25 -0
  228. data/sig/didit/webhooks/client_methods.rbs +11 -0
  229. data/sig/didit/webhooks/events.rbs +125 -0
  230. data/sig/didit/webhooks/headers.rbs +22 -0
  231. data/sig/didit/webhooks/verifier.rbs +54 -0
  232. data/sig/didit/webhooks.rbs +37 -0
  233. data/sig/didit.rbs +20 -0
  234. metadata +300 -0
@@ -0,0 +1,1468 @@
1
+ # Code generated by codegen from openapi/*.json. DO NOT EDIT.
2
+ # frozen_string_literal: true
3
+
4
+ module Didit
5
+ module Resources
6
+ # The +id_wallets+ resource.
7
+ class IdWallets < Didit::Resource
8
+ # Cancel a wallet verification
9
+ #
10
+ # Withdraw a pending verification: it is declined as cancelled and never billed. A decided one is returned
11
+ # unchanged. Smart-ID and Mobile-ID: a cancel that arrives while a poll is checking the sign-in waits a few
12
+ # seconds for that poll, then declines it, or returns it verified if the user had already confirmed. A
13
+ # verification the user is completing right now cannot be cancelled (409 verification_in_progress with
14
+ # Retry-After): retry after that many seconds to read its outcome.
15
+ #
16
+ # +POST /v3/id-verification/wallets/verifications/{request_id}/cancel/+
17
+ #
18
+ # @param request_id [String] The request_id the start endpoint returned.
19
+ # @param request_options [Hash, nil] :timeout, :max_retries, :extra_headers, :extra_query, :extra_body
20
+ # @return [Didit::Types::DigitalIdWalletApiWalletVerificationResponse]
21
+ def cancel_verification(request_id, request_options: nil)
22
+ @client.request(
23
+ :post,
24
+ "/v3/id-verification/wallets/verifications/{request_id}/cancel/",
25
+ path_params: { "request_id" => request_id },
26
+ response: Types::DigitalIdWalletApiWalletVerificationResponse,
27
+ request_options: request_options
28
+ )
29
+ end
30
+
31
+ # List Digital ID wallets
32
+ #
33
+ # Every Digital ID wallet with its start endpoint, countries, required fields and whether this application can
34
+ # start it in this environment now. Listed does not mean live.
35
+ #
36
+ # +GET /v3/id-verification/wallets/+
37
+ #
38
+ # @param request_options [Hash, nil] :timeout, :max_retries, :extra_headers, :extra_query, :extra_body
39
+ # @return [Didit::Types::DigitalIdWalletApiWalletCatalogResponse]
40
+ def list(request_options: nil)
41
+ @client.request(
42
+ :get,
43
+ "/v3/id-verification/wallets/",
44
+ response: Types::DigitalIdWalletApiWalletCatalogResponse,
45
+ request_options: request_options
46
+ )
47
+ end
48
+
49
+ # Poll a wallet verification
50
+ #
51
+ # Smart-ID and Mobile-ID: ask the provider whether the user confirmed, refused or let the prompt lapse, and
52
+ # verify the signed identity when they confirmed. Redirect wallets complete through the user's browser, so for
53
+ # them this only reads the verification back. Answers the verification as it is afterwards.
54
+ #
55
+ # +POST /v3/id-verification/wallets/verifications/{request_id}/poll/+
56
+ #
57
+ # @param request_id [String] The request_id the start endpoint returned.
58
+ # @param request_options [Hash, nil] :timeout, :max_retries, :extra_headers, :extra_query, :extra_body
59
+ # @return [Didit::Types::DigitalIdWalletApiWalletVerificationResponse]
60
+ def poll_verification(request_id, request_options: nil)
61
+ @client.request(
62
+ :post,
63
+ "/v3/id-verification/wallets/verifications/{request_id}/poll/",
64
+ path_params: { "request_id" => request_id },
65
+ response: Types::DigitalIdWalletApiWalletVerificationResponse,
66
+ request_options: request_options
67
+ )
68
+ end
69
+
70
+ # Get a wallet verification
71
+ #
72
+ # Status and result of a wallet verification: the normalized identity and the wallet's own attributes once
73
+ # verified, the error code once declined, the next action while pending. A verification past expires_at is
74
+ # decided timeout.
75
+ #
76
+ # +GET /v3/id-verification/wallets/verifications/{request_id}/+
77
+ #
78
+ # @param request_id [String] The request_id the start endpoint returned.
79
+ # @param request_options [Hash, nil] :timeout, :max_retries, :extra_headers, :extra_query, :extra_body
80
+ # @return [Didit::Types::DigitalIdWalletApiWalletVerificationResponse]
81
+ def retrieve_verification(request_id, request_options: nil)
82
+ @client.request(
83
+ :get,
84
+ "/v3/id-verification/wallets/verifications/{request_id}/",
85
+ path_params: { "request_id" => request_id },
86
+ response: Types::DigitalIdWalletApiWalletVerificationResponse,
87
+ request_options: request_options
88
+ )
89
+ end
90
+
91
+ # Start Auðkenni verification
92
+ #
93
+ # Start a Auðkenni sign-in (Auðkenni (Icelandic electronic ID); ISL) without any workflow. Billed once, only
94
+ # when the identity is verified. The response carries next_action.type=redirect with the URL to send the user's
95
+ # browser to; the user returns to return_url with request_id and result appended. Read the outcome with GET
96
+ # /v3/id-verification/wallets/verifications/{request_id}/ or from the webhook, never from the URL. Sandbox
97
+ # applications get a deterministic simulation (simulated: true) that never contacts the provider.
98
+ #
99
+ # +POST /v3/id-verification/wallets/audkenni/+
100
+ #
101
+ # @param return_url [String] https URL the user's browser returns to after the wallet, with request_id and
102
+ # result appended. Its host must be registered in the application's allowed_return_hosts (or be its white-label
103
+ # domain). Never trust result on its own: read the outcome with GET .../verifications/{request_id}/ or the
104
+ # webhook.
105
+ # @param vendor_data [String, nil] Your own reference for this verification (e.g. your user id). Returned in
106
+ # results and webhooks.
107
+ # @param metadata [Hash, nil] Optional JSON object stored with the verification and returned in results and
108
+ # webhooks.
109
+ # @param sandbox_scenario [String] Sandbox applications only: the simulated outcome - 'wallet_cancelled',
110
+ # 'wallet_timeout' or 'wallet_provider_error'; any other scenario (or none) verifies. Rejected on live
111
+ # applications. The full catalog is available at GET /v1/sandbox/scenarios/.
112
+ # @param country [String] ISO 3166-1 alpha-3 country of the Auðkenni identity. Defaults to ISL, the only country
113
+ # it serves. * `ISL` - ISL
114
+ # @param device [String] same_device when the user signs in on the device showing your page, cross_device when
115
+ # they use another one (e.g. BankID's QR code). * `same_device` - same_device * `cross_device` - cross_device
116
+ # @param idempotency_key [String] sent as the Idempotency-Key header
117
+ # @param request_options [Hash, nil] :timeout, :max_retries, :extra_headers, :extra_query, :extra_body
118
+ # @return [Didit::Types::DigitalIdWalletApiWalletVerificationResponse]
119
+ def start_audkenni(
120
+ return_url:,
121
+ vendor_data: OMIT,
122
+ metadata: OMIT,
123
+ sandbox_scenario: OMIT,
124
+ country: OMIT,
125
+ device: OMIT,
126
+ idempotency_key: OMIT,
127
+ request_options: nil
128
+ )
129
+ @client.request(
130
+ :post,
131
+ "/v3/id-verification/wallets/audkenni/",
132
+ body: {
133
+ "return_url" => return_url,
134
+ "vendor_data" => vendor_data,
135
+ "metadata" => metadata,
136
+ "sandbox_scenario" => sandbox_scenario,
137
+ "country" => country,
138
+ "device" => device
139
+ },
140
+ headers: { "Idempotency-Key" => idempotency_key },
141
+ response: Types::DigitalIdWalletApiWalletVerificationResponse,
142
+ request_options: request_options
143
+ )
144
+ end
145
+
146
+ # Start Bank iD verification
147
+ #
148
+ # Start a Bank iD sign-in (Bankovní identita, a.s.; CZE) without any workflow. Billed once, only when the
149
+ # identity is verified. The response carries next_action.type=redirect with the URL to send the user's browser
150
+ # to; the user returns to return_url with request_id and result appended. Read the outcome with GET
151
+ # /v3/id-verification/wallets/verifications/{request_id}/ or from the webhook, never from the URL. Sandbox
152
+ # applications get a deterministic simulation (simulated: true) that never contacts the provider.
153
+ #
154
+ # +POST /v3/id-verification/wallets/bankid-cz/+
155
+ #
156
+ # @param return_url [String] https URL the user's browser returns to after the wallet, with request_id and
157
+ # result appended. Its host must be registered in the application's allowed_return_hosts (or be its white-label
158
+ # domain). Never trust result on its own: read the outcome with GET .../verifications/{request_id}/ or the
159
+ # webhook.
160
+ # @param vendor_data [String, nil] Your own reference for this verification (e.g. your user id). Returned in
161
+ # results and webhooks.
162
+ # @param metadata [Hash, nil] Optional JSON object stored with the verification and returned in results and
163
+ # webhooks.
164
+ # @param sandbox_scenario [String] Sandbox applications only: the simulated outcome - 'wallet_cancelled',
165
+ # 'wallet_timeout' or 'wallet_provider_error'; any other scenario (or none) verifies. Rejected on live
166
+ # applications. The full catalog is available at GET /v1/sandbox/scenarios/.
167
+ # @param country [String] ISO 3166-1 alpha-3 country of the Bank iD identity. Defaults to CZE, the only country
168
+ # it serves. * `CZE` - CZE
169
+ # @param device [String] same_device when the user signs in on the device showing your page, cross_device when
170
+ # they use another one (e.g. BankID's QR code). * `same_device` - same_device * `cross_device` - cross_device
171
+ # @param idempotency_key [String] sent as the Idempotency-Key header
172
+ # @param request_options [Hash, nil] :timeout, :max_retries, :extra_headers, :extra_query, :extra_body
173
+ # @return [Didit::Types::DigitalIdWalletApiWalletVerificationResponse]
174
+ def start_bankid_cz(
175
+ return_url:,
176
+ vendor_data: OMIT,
177
+ metadata: OMIT,
178
+ sandbox_scenario: OMIT,
179
+ country: OMIT,
180
+ device: OMIT,
181
+ idempotency_key: OMIT,
182
+ request_options: nil
183
+ )
184
+ @client.request(
185
+ :post,
186
+ "/v3/id-verification/wallets/bankid-cz/",
187
+ body: {
188
+ "return_url" => return_url,
189
+ "vendor_data" => vendor_data,
190
+ "metadata" => metadata,
191
+ "sandbox_scenario" => sandbox_scenario,
192
+ "country" => country,
193
+ "device" => device
194
+ },
195
+ headers: { "Idempotency-Key" => idempotency_key },
196
+ response: Types::DigitalIdWalletApiWalletVerificationResponse,
197
+ request_options: request_options
198
+ )
199
+ end
200
+
201
+ # Start BankID (NOR) verification
202
+ #
203
+ # Start a BankID (NOR) sign-in (BankID BankAxept AS; NOR) without any workflow. Billed once, only when the
204
+ # identity is verified. The response carries next_action.type=redirect with the URL to send the user's browser
205
+ # to; the user returns to return_url with request_id and result appended. Read the outcome with GET
206
+ # /v3/id-verification/wallets/verifications/{request_id}/ or from the webhook, never from the URL. Sandbox
207
+ # applications get a deterministic simulation (simulated: true) that never contacts the provider.
208
+ #
209
+ # +POST /v3/id-verification/wallets/bankid-no/+
210
+ #
211
+ # @param return_url [String] https URL the user's browser returns to after the wallet, with request_id and
212
+ # result appended. Its host must be registered in the application's allowed_return_hosts (or be its white-label
213
+ # domain). Never trust result on its own: read the outcome with GET .../verifications/{request_id}/ or the
214
+ # webhook.
215
+ # @param vendor_data [String, nil] Your own reference for this verification (e.g. your user id). Returned in
216
+ # results and webhooks.
217
+ # @param metadata [Hash, nil] Optional JSON object stored with the verification and returned in results and
218
+ # webhooks.
219
+ # @param sandbox_scenario [String] Sandbox applications only: the simulated outcome - 'wallet_cancelled',
220
+ # 'wallet_timeout' or 'wallet_provider_error'; any other scenario (or none) verifies. Rejected on live
221
+ # applications. The full catalog is available at GET /v1/sandbox/scenarios/.
222
+ # @param country [String] ISO 3166-1 alpha-3 country of the BankID identity. Defaults to NOR, the only country
223
+ # it serves. * `NOR` - NOR
224
+ # @param device [String] same_device when the user signs in on the device showing your page, cross_device when
225
+ # they use another one (e.g. BankID's QR code). * `same_device` - same_device * `cross_device` - cross_device
226
+ # @param idempotency_key [String] sent as the Idempotency-Key header
227
+ # @param request_options [Hash, nil] :timeout, :max_retries, :extra_headers, :extra_query, :extra_body
228
+ # @return [Didit::Types::DigitalIdWalletApiWalletVerificationResponse]
229
+ def start_bankid_no(
230
+ return_url:,
231
+ vendor_data: OMIT,
232
+ metadata: OMIT,
233
+ sandbox_scenario: OMIT,
234
+ country: OMIT,
235
+ device: OMIT,
236
+ idempotency_key: OMIT,
237
+ request_options: nil
238
+ )
239
+ @client.request(
240
+ :post,
241
+ "/v3/id-verification/wallets/bankid-no/",
242
+ body: {
243
+ "return_url" => return_url,
244
+ "vendor_data" => vendor_data,
245
+ "metadata" => metadata,
246
+ "sandbox_scenario" => sandbox_scenario,
247
+ "country" => country,
248
+ "device" => device
249
+ },
250
+ headers: { "Idempotency-Key" => idempotency_key },
251
+ response: Types::DigitalIdWalletApiWalletVerificationResponse,
252
+ request_options: request_options
253
+ )
254
+ end
255
+
256
+ # Start BankID (SWE) verification
257
+ #
258
+ # Start a BankID (SWE) sign-in (Finansiell ID-Teknik / bank consortium; SWE) without any workflow. Billed once,
259
+ # only when the identity is verified. The response carries next_action.type=redirect with the URL to send the
260
+ # user's browser to; the user returns to return_url with request_id and result appended. Read the outcome with
261
+ # GET /v3/id-verification/wallets/verifications/{request_id}/ or from the webhook, never from the URL. Sandbox
262
+ # applications get a deterministic simulation (simulated: true) that never contacts the provider.
263
+ #
264
+ # +POST /v3/id-verification/wallets/bankid-se/+
265
+ #
266
+ # @param return_url [String] https URL the user's browser returns to after the wallet, with request_id and
267
+ # result appended. Its host must be registered in the application's allowed_return_hosts (or be its white-label
268
+ # domain). Never trust result on its own: read the outcome with GET .../verifications/{request_id}/ or the
269
+ # webhook.
270
+ # @param vendor_data [String, nil] Your own reference for this verification (e.g. your user id). Returned in
271
+ # results and webhooks.
272
+ # @param metadata [Hash, nil] Optional JSON object stored with the verification and returned in results and
273
+ # webhooks.
274
+ # @param sandbox_scenario [String] Sandbox applications only: the simulated outcome - 'wallet_cancelled',
275
+ # 'wallet_timeout' or 'wallet_provider_error'; any other scenario (or none) verifies. Rejected on live
276
+ # applications. The full catalog is available at GET /v1/sandbox/scenarios/.
277
+ # @param country [String] ISO 3166-1 alpha-3 country of the BankID identity. Defaults to SWE, the only country
278
+ # it serves. * `SWE` - SWE
279
+ # @param device [String] same_device when the user signs in on the device showing your page, cross_device when
280
+ # they use another one (e.g. BankID's QR code). * `same_device` - same_device * `cross_device` - cross_device
281
+ # @param idempotency_key [String] sent as the Idempotency-Key header
282
+ # @param request_options [Hash, nil] :timeout, :max_retries, :extra_headers, :extra_query, :extra_body
283
+ # @return [Didit::Types::DigitalIdWalletApiWalletVerificationResponse]
284
+ def start_bankid_se(
285
+ return_url:,
286
+ vendor_data: OMIT,
287
+ metadata: OMIT,
288
+ sandbox_scenario: OMIT,
289
+ country: OMIT,
290
+ device: OMIT,
291
+ idempotency_key: OMIT,
292
+ request_options: nil
293
+ )
294
+ @client.request(
295
+ :post,
296
+ "/v3/id-verification/wallets/bankid-se/",
297
+ body: {
298
+ "return_url" => return_url,
299
+ "vendor_data" => vendor_data,
300
+ "metadata" => metadata,
301
+ "sandbox_scenario" => sandbox_scenario,
302
+ "country" => country,
303
+ "device" => device
304
+ },
305
+ headers: { "Idempotency-Key" => idempotency_key },
306
+ response: Types::DigitalIdWalletApiWalletVerificationResponse,
307
+ request_options: request_options
308
+ )
309
+ end
310
+
311
+ # Start Buypass ID verification
312
+ #
313
+ # Start a Buypass ID sign-in (Buypass AS; NOR) without any workflow. Billed once, only when the identity is
314
+ # verified. The response carries next_action.type=redirect with the URL to send the user's browser to; the user
315
+ # returns to return_url with request_id and result appended. Read the outcome with GET
316
+ # /v3/id-verification/wallets/verifications/{request_id}/ or from the webhook, never from the URL. Sandbox
317
+ # applications get a deterministic simulation (simulated: true) that never contacts the provider.
318
+ #
319
+ # +POST /v3/id-verification/wallets/buypass/+
320
+ #
321
+ # @param return_url [String] https URL the user's browser returns to after the wallet, with request_id and
322
+ # result appended. Its host must be registered in the application's allowed_return_hosts (or be its white-label
323
+ # domain). Never trust result on its own: read the outcome with GET .../verifications/{request_id}/ or the
324
+ # webhook.
325
+ # @param vendor_data [String, nil] Your own reference for this verification (e.g. your user id). Returned in
326
+ # results and webhooks.
327
+ # @param metadata [Hash, nil] Optional JSON object stored with the verification and returned in results and
328
+ # webhooks.
329
+ # @param sandbox_scenario [String] Sandbox applications only: the simulated outcome - 'wallet_cancelled',
330
+ # 'wallet_timeout' or 'wallet_provider_error'; any other scenario (or none) verifies. Rejected on live
331
+ # applications. The full catalog is available at GET /v1/sandbox/scenarios/.
332
+ # @param country [String] ISO 3166-1 alpha-3 country of the Buypass ID identity. Defaults to NOR, the only
333
+ # country it serves. * `NOR` - NOR
334
+ # @param device [String] same_device when the user signs in on the device showing your page, cross_device when
335
+ # they use another one (e.g. BankID's QR code). * `same_device` - same_device * `cross_device` - cross_device
336
+ # @param idempotency_key [String] sent as the Idempotency-Key header
337
+ # @param request_options [Hash, nil] :timeout, :max_retries, :extra_headers, :extra_query, :extra_body
338
+ # @return [Didit::Types::DigitalIdWalletApiWalletVerificationResponse]
339
+ def start_buypass(
340
+ return_url:,
341
+ vendor_data: OMIT,
342
+ metadata: OMIT,
343
+ sandbox_scenario: OMIT,
344
+ country: OMIT,
345
+ device: OMIT,
346
+ idempotency_key: OMIT,
347
+ request_options: nil
348
+ )
349
+ @client.request(
350
+ :post,
351
+ "/v3/id-verification/wallets/buypass/",
352
+ body: {
353
+ "return_url" => return_url,
354
+ "vendor_data" => vendor_data,
355
+ "metadata" => metadata,
356
+ "sandbox_scenario" => sandbox_scenario,
357
+ "country" => country,
358
+ "device" => device
359
+ },
360
+ headers: { "Idempotency-Key" => idempotency_key },
361
+ response: Types::DigitalIdWalletApiWalletVerificationResponse,
362
+ request_options: request_options
363
+ )
364
+ end
365
+
366
+ # Start ConnectID verification
367
+ #
368
+ # Start a ConnectID sign-in (Australian Payments Plus; AUS) without any workflow. Billed once, only when the
369
+ # identity is verified. The response carries next_action.type=redirect with the URL to send the user's browser
370
+ # to; the user returns to return_url with request_id and result appended. Read the outcome with GET
371
+ # /v3/id-verification/wallets/verifications/{request_id}/ or from the webhook, never from the URL. Sandbox
372
+ # applications get a deterministic simulation (simulated: true) that never contacts the provider.
373
+ #
374
+ # +POST /v3/id-verification/wallets/connectid/+
375
+ #
376
+ # @param return_url [String] https URL the user's browser returns to after the wallet, with request_id and
377
+ # result appended. Its host must be registered in the application's allowed_return_hosts (or be its white-label
378
+ # domain). Never trust result on its own: read the outcome with GET .../verifications/{request_id}/ or the
379
+ # webhook.
380
+ # @param vendor_data [String, nil] Your own reference for this verification (e.g. your user id). Returned in
381
+ # results and webhooks.
382
+ # @param metadata [Hash, nil] Optional JSON object stored with the verification and returned in results and
383
+ # webhooks.
384
+ # @param sandbox_scenario [String] Sandbox applications only: the simulated outcome - 'wallet_cancelled',
385
+ # 'wallet_timeout' or 'wallet_provider_error'; any other scenario (or none) verifies. Rejected on live
386
+ # applications. The full catalog is available at GET /v1/sandbox/scenarios/.
387
+ # @param country [String] ISO 3166-1 alpha-3 country of the ConnectID identity. Defaults to AUS, the only
388
+ # country it serves. * `AUS` - AUS
389
+ # @param authorisation_server_id [String] Authorisation server ID selected with ConnectID's bank selector.
390
+ # Sandbox defaults to Mock Bank A.
391
+ # @param device [String] same_device when the user signs in on the device showing your page, cross_device when
392
+ # they use another one (e.g. BankID's QR code). * `same_device` - same_device * `cross_device` - cross_device
393
+ # @param idempotency_key [String] sent as the Idempotency-Key header
394
+ # @param request_options [Hash, nil] :timeout, :max_retries, :extra_headers, :extra_query, :extra_body
395
+ # @return [Didit::Types::DigitalIdWalletApiWalletVerificationResponse]
396
+ def start_connectid(
397
+ return_url:,
398
+ vendor_data: OMIT,
399
+ metadata: OMIT,
400
+ sandbox_scenario: OMIT,
401
+ country: OMIT,
402
+ authorisation_server_id: OMIT,
403
+ device: OMIT,
404
+ idempotency_key: OMIT,
405
+ request_options: nil
406
+ )
407
+ @client.request(
408
+ :post,
409
+ "/v3/id-verification/wallets/connectid/",
410
+ body: {
411
+ "return_url" => return_url,
412
+ "vendor_data" => vendor_data,
413
+ "metadata" => metadata,
414
+ "sandbox_scenario" => sandbox_scenario,
415
+ "country" => country,
416
+ "authorisation_server_id" => authorisation_server_id,
417
+ "device" => device
418
+ },
419
+ headers: { "Idempotency-Key" => idempotency_key },
420
+ response: Types::DigitalIdWalletApiWalletVerificationResponse,
421
+ request_options: request_options
422
+ )
423
+ end
424
+
425
+ # Start Diia verification
426
+ #
427
+ # Start a Diia sign-in (Ministry of Digital Transformation of Ukraine; UKR) without any workflow. Billed once,
428
+ # only when the identity is verified. The response carries next_action.type=redirect with the URL to send the
429
+ # user's browser to; the user returns to return_url with request_id and result appended. Read the outcome with
430
+ # GET /v3/id-verification/wallets/verifications/{request_id}/ or from the webhook, never from the URL. Sandbox
431
+ # applications get a deterministic simulation (simulated: true) that never contacts the provider.
432
+ #
433
+ # +POST /v3/id-verification/wallets/diia/+
434
+ #
435
+ # @param return_url [String] https URL the user's browser returns to after the wallet, with request_id and
436
+ # result appended. Its host must be registered in the application's allowed_return_hosts (or be its white-label
437
+ # domain). Never trust result on its own: read the outcome with GET .../verifications/{request_id}/ or the
438
+ # webhook.
439
+ # @param vendor_data [String, nil] Your own reference for this verification (e.g. your user id). Returned in
440
+ # results and webhooks.
441
+ # @param metadata [Hash, nil] Optional JSON object stored with the verification and returned in results and
442
+ # webhooks.
443
+ # @param sandbox_scenario [String] Sandbox applications only: the simulated outcome - 'wallet_cancelled',
444
+ # 'wallet_timeout' or 'wallet_provider_error'; any other scenario (or none) verifies. Rejected on live
445
+ # applications. The full catalog is available at GET /v1/sandbox/scenarios/.
446
+ # @param country [String] ISO 3166-1 alpha-3 country of the Diia identity. Defaults to UKR, the only country it
447
+ # serves. * `UKR` - UKR
448
+ # @param device [String] same_device when the user signs in on the device showing your page, cross_device when
449
+ # they use another one (e.g. BankID's QR code). * `same_device` - same_device * `cross_device` - cross_device
450
+ # @param idempotency_key [String] sent as the Idempotency-Key header
451
+ # @param request_options [Hash, nil] :timeout, :max_retries, :extra_headers, :extra_query, :extra_body
452
+ # @return [Didit::Types::DigitalIdWalletApiWalletVerificationResponse]
453
+ def start_diia(
454
+ return_url:,
455
+ vendor_data: OMIT,
456
+ metadata: OMIT,
457
+ sandbox_scenario: OMIT,
458
+ country: OMIT,
459
+ device: OMIT,
460
+ idempotency_key: OMIT,
461
+ request_options: nil
462
+ )
463
+ @client.request(
464
+ :post,
465
+ "/v3/id-verification/wallets/diia/",
466
+ body: {
467
+ "return_url" => return_url,
468
+ "vendor_data" => vendor_data,
469
+ "metadata" => metadata,
470
+ "sandbox_scenario" => sandbox_scenario,
471
+ "country" => country,
472
+ "device" => device
473
+ },
474
+ headers: { "Idempotency-Key" => idempotency_key },
475
+ response: Types::DigitalIdWalletApiWalletVerificationResponse,
476
+ request_options: request_options
477
+ )
478
+ end
479
+
480
+ # Start eParaksts mobile verification
481
+ #
482
+ # Start a eParaksts mobile sign-in (LVRTC (Latvian State Radio and Television Centre); LVA) without any
483
+ # workflow. Billed once, only when the identity is verified. The response carries next_action.type=redirect with
484
+ # the URL to send the user's browser to; the user returns to return_url with request_id and result appended.
485
+ # Read the outcome with GET /v3/id-verification/wallets/verifications/{request_id}/ or from the webhook, never
486
+ # from the URL. Sandbox applications get a deterministic simulation (simulated: true) that never contacts the
487
+ # provider.
488
+ #
489
+ # +POST /v3/id-verification/wallets/eparaksts-mobile/+
490
+ #
491
+ # @param return_url [String] https URL the user's browser returns to after the wallet, with request_id and
492
+ # result appended. Its host must be registered in the application's allowed_return_hosts (or be its white-label
493
+ # domain). Never trust result on its own: read the outcome with GET .../verifications/{request_id}/ or the
494
+ # webhook.
495
+ # @param vendor_data [String, nil] Your own reference for this verification (e.g. your user id). Returned in
496
+ # results and webhooks.
497
+ # @param metadata [Hash, nil] Optional JSON object stored with the verification and returned in results and
498
+ # webhooks.
499
+ # @param sandbox_scenario [String] Sandbox applications only: the simulated outcome - 'wallet_cancelled',
500
+ # 'wallet_timeout' or 'wallet_provider_error'; any other scenario (or none) verifies. Rejected on live
501
+ # applications. The full catalog is available at GET /v1/sandbox/scenarios/.
502
+ # @param country [String] ISO 3166-1 alpha-3 country of the eParaksts mobile identity. Defaults to LVA, the only
503
+ # country it serves. * `LVA` - LVA
504
+ # @param device [String] same_device when the user signs in on the device showing your page, cross_device when
505
+ # they use another one (e.g. BankID's QR code). * `same_device` - same_device * `cross_device` - cross_device
506
+ # @param idempotency_key [String] sent as the Idempotency-Key header
507
+ # @param request_options [Hash, nil] :timeout, :max_retries, :extra_headers, :extra_query, :extra_body
508
+ # @return [Didit::Types::DigitalIdWalletApiWalletVerificationResponse]
509
+ def start_eparaksts_mobile(
510
+ return_url:,
511
+ vendor_data: OMIT,
512
+ metadata: OMIT,
513
+ sandbox_scenario: OMIT,
514
+ country: OMIT,
515
+ device: OMIT,
516
+ idempotency_key: OMIT,
517
+ request_options: nil
518
+ )
519
+ @client.request(
520
+ :post,
521
+ "/v3/id-verification/wallets/eparaksts-mobile/",
522
+ body: {
523
+ "return_url" => return_url,
524
+ "vendor_data" => vendor_data,
525
+ "metadata" => metadata,
526
+ "sandbox_scenario" => sandbox_scenario,
527
+ "country" => country,
528
+ "device" => device
529
+ },
530
+ headers: { "Idempotency-Key" => idempotency_key },
531
+ response: Types::DigitalIdWalletApiWalletVerificationResponse,
532
+ request_options: request_options
533
+ )
534
+ end
535
+
536
+ # Start EUDI Wallet verification
537
+ #
538
+ # Start a EUDI Wallet sign-in (The user's own member state; the issuer differs per country; AUT, BEL, BGR, HRV,
539
+ # CYP, CZE, DNK, EST, FIN, FRA, DEU, GRC, HUN, IRL, ITA, LVA, LTU, LUX, MLT, NLD, POL, PRT, ROU, SVK, SVN, ESP,
540
+ # SWE, ISL, LIE, NOR) without any workflow. Billed once, only when the identity is verified. The response
541
+ # carries next_action.type=redirect with the URL to send the user's browser to; the user returns to return_url
542
+ # with request_id and result appended. Read the outcome with GET
543
+ # /v3/id-verification/wallets/verifications/{request_id}/ or from the webhook, never from the URL. Sandbox
544
+ # applications get a deterministic simulation (simulated: true) that never contacts the provider.
545
+ #
546
+ # +POST /v3/id-verification/wallets/eudi/+
547
+ #
548
+ # @param country [String] ISO 3166-1 alpha-3 country of the EUDI Wallet identity. * `AUT` - AUT * `BEL` - BEL *
549
+ # `BGR` - BGR * `HRV` - HRV * `CYP` - CYP * `CZE` - CZE * `DNK` - DNK * `EST` - EST * `FIN` - FIN * `FRA` - FRA
550
+ # * `DEU` - DEU * `GRC` - GRC * `HUN` - HUN * `IRL` - IRL * `ITA` - ITA * `LVA` - LVA * `LTU` - LTU * `LUX` -
551
+ # LUX * `MLT` - MLT * `NLD` - NLD * `POL` - POL * `PRT` - PRT * `ROU` - ROU * `SVK` - SVK * `SVN`...
552
+ # @param return_url [String] https URL the user's browser returns to after the wallet, with request_id and
553
+ # result appended. Its host must be registered in the application's allowed_return_hosts (or be its white-label
554
+ # domain). Never trust result on its own: read the outcome with GET .../verifications/{request_id}/ or the
555
+ # webhook.
556
+ # @param vendor_data [String, nil] Your own reference for this verification (e.g. your user id). Returned in
557
+ # results and webhooks.
558
+ # @param metadata [Hash, nil] Optional JSON object stored with the verification and returned in results and
559
+ # webhooks.
560
+ # @param sandbox_scenario [String] Sandbox applications only: the simulated outcome - 'wallet_cancelled',
561
+ # 'wallet_timeout' or 'wallet_provider_error'; any other scenario (or none) verifies. Rejected on live
562
+ # applications. The full catalog is available at GET /v1/sandbox/scenarios/.
563
+ # @param device [String] same_device when the user signs in on the device showing your page, cross_device when
564
+ # they use another one (e.g. BankID's QR code). * `same_device` - same_device * `cross_device` - cross_device
565
+ # @param idempotency_key [String] sent as the Idempotency-Key header
566
+ # @param request_options [Hash, nil] :timeout, :max_retries, :extra_headers, :extra_query, :extra_body
567
+ # @return [Didit::Types::DigitalIdWalletApiWalletVerificationResponse]
568
+ def start_eudi(
569
+ country:,
570
+ return_url:,
571
+ vendor_data: OMIT,
572
+ metadata: OMIT,
573
+ sandbox_scenario: OMIT,
574
+ device: OMIT,
575
+ idempotency_key: OMIT,
576
+ request_options: nil
577
+ )
578
+ @client.request(
579
+ :post,
580
+ "/v3/id-verification/wallets/eudi/",
581
+ body: {
582
+ "country" => country,
583
+ "return_url" => return_url,
584
+ "vendor_data" => vendor_data,
585
+ "metadata" => metadata,
586
+ "sandbox_scenario" => sandbox_scenario,
587
+ "device" => device
588
+ },
589
+ headers: { "Idempotency-Key" => idempotency_key },
590
+ response: Types::DigitalIdWalletApiWalletVerificationResponse,
591
+ request_options: request_options
592
+ )
593
+ end
594
+
595
+ # Start FranceConnect verification
596
+ #
597
+ # Start a FranceConnect sign-in (DINUM (French state); FRA) without any workflow. Billed once, only when the
598
+ # identity is verified. The response carries next_action.type=redirect with the URL to send the user's browser
599
+ # to; the user returns to return_url with request_id and result appended. Read the outcome with GET
600
+ # /v3/id-verification/wallets/verifications/{request_id}/ or from the webhook, never from the URL. Sandbox
601
+ # applications get a deterministic simulation (simulated: true) that never contacts the provider.
602
+ #
603
+ # +POST /v3/id-verification/wallets/franceconnect/+
604
+ #
605
+ # @param return_url [String] https URL the user's browser returns to after the wallet, with request_id and
606
+ # result appended. Its host must be registered in the application's allowed_return_hosts (or be its white-label
607
+ # domain). Never trust result on its own: read the outcome with GET .../verifications/{request_id}/ or the
608
+ # webhook.
609
+ # @param vendor_data [String, nil] Your own reference for this verification (e.g. your user id). Returned in
610
+ # results and webhooks.
611
+ # @param metadata [Hash, nil] Optional JSON object stored with the verification and returned in results and
612
+ # webhooks.
613
+ # @param sandbox_scenario [String] Sandbox applications only: the simulated outcome - 'wallet_cancelled',
614
+ # 'wallet_timeout' or 'wallet_provider_error'; any other scenario (or none) verifies. Rejected on live
615
+ # applications. The full catalog is available at GET /v1/sandbox/scenarios/.
616
+ # @param country [String] ISO 3166-1 alpha-3 country of the FranceConnect identity. Defaults to FRA, the only
617
+ # country it serves. * `FRA` - FRA
618
+ # @param device [String] same_device when the user signs in on the device showing your page, cross_device when
619
+ # they use another one (e.g. BankID's QR code). * `same_device` - same_device * `cross_device` - cross_device
620
+ # @param idempotency_key [String] sent as the Idempotency-Key header
621
+ # @param request_options [Hash, nil] :timeout, :max_retries, :extra_headers, :extra_query, :extra_body
622
+ # @return [Didit::Types::DigitalIdWalletApiWalletVerificationResponse]
623
+ def start_franceconnect(
624
+ return_url:,
625
+ vendor_data: OMIT,
626
+ metadata: OMIT,
627
+ sandbox_scenario: OMIT,
628
+ country: OMIT,
629
+ device: OMIT,
630
+ idempotency_key: OMIT,
631
+ request_options: nil
632
+ )
633
+ @client.request(
634
+ :post,
635
+ "/v3/id-verification/wallets/franceconnect/",
636
+ body: {
637
+ "return_url" => return_url,
638
+ "vendor_data" => vendor_data,
639
+ "metadata" => metadata,
640
+ "sandbox_scenario" => sandbox_scenario,
641
+ "country" => country,
642
+ "device" => device
643
+ },
644
+ headers: { "Idempotency-Key" => idempotency_key },
645
+ response: Types::DigitalIdWalletApiWalletVerificationResponse,
646
+ request_options: request_options
647
+ )
648
+ end
649
+
650
+ # Start Freja eID verification
651
+ #
652
+ # Start a Freja eID sign-in (Freja eID Group; SWE) without any workflow. Billed once, only when the identity is
653
+ # verified. The response carries next_action.type=redirect with the URL to send the user's browser to; the user
654
+ # returns to return_url with request_id and result appended. Read the outcome with GET
655
+ # /v3/id-verification/wallets/verifications/{request_id}/ or from the webhook, never from the URL. Sandbox
656
+ # applications get a deterministic simulation (simulated: true) that never contacts the provider.
657
+ #
658
+ # +POST /v3/id-verification/wallets/frejaid/+
659
+ #
660
+ # @param return_url [String] https URL the user's browser returns to after the wallet, with request_id and
661
+ # result appended. Its host must be registered in the application's allowed_return_hosts (or be its white-label
662
+ # domain). Never trust result on its own: read the outcome with GET .../verifications/{request_id}/ or the
663
+ # webhook.
664
+ # @param vendor_data [String, nil] Your own reference for this verification (e.g. your user id). Returned in
665
+ # results and webhooks.
666
+ # @param metadata [Hash, nil] Optional JSON object stored with the verification and returned in results and
667
+ # webhooks.
668
+ # @param sandbox_scenario [String] Sandbox applications only: the simulated outcome - 'wallet_cancelled',
669
+ # 'wallet_timeout' or 'wallet_provider_error'; any other scenario (or none) verifies. Rejected on live
670
+ # applications. The full catalog is available at GET /v1/sandbox/scenarios/.
671
+ # @param country [String] ISO 3166-1 alpha-3 country of the Freja eID identity. Defaults to SWE, the only
672
+ # country it serves. * `SWE` - SWE
673
+ # @param device [String] same_device when the user signs in on the device showing your page, cross_device when
674
+ # they use another one (e.g. BankID's QR code). * `same_device` - same_device * `cross_device` - cross_device
675
+ # @param idempotency_key [String] sent as the Idempotency-Key header
676
+ # @param request_options [Hash, nil] :timeout, :max_retries, :extra_headers, :extra_query, :extra_body
677
+ # @return [Didit::Types::DigitalIdWalletApiWalletVerificationResponse]
678
+ def start_frejaid(
679
+ return_url:,
680
+ vendor_data: OMIT,
681
+ metadata: OMIT,
682
+ sandbox_scenario: OMIT,
683
+ country: OMIT,
684
+ device: OMIT,
685
+ idempotency_key: OMIT,
686
+ request_options: nil
687
+ )
688
+ @client.request(
689
+ :post,
690
+ "/v3/id-verification/wallets/frejaid/",
691
+ body: {
692
+ "return_url" => return_url,
693
+ "vendor_data" => vendor_data,
694
+ "metadata" => metadata,
695
+ "sandbox_scenario" => sandbox_scenario,
696
+ "country" => country,
697
+ "device" => device
698
+ },
699
+ headers: { "Idempotency-Key" => idempotency_key },
700
+ response: Types::DigitalIdWalletApiWalletVerificationResponse,
701
+ request_options: request_options
702
+ )
703
+ end
704
+
705
+ # Start Finnish Trust Network verification
706
+ #
707
+ # Start a Finnish Trust Network sign-in (Finnish banks and mobile operators (FTN); FIN) without any workflow.
708
+ # Billed once, only when the identity is verified. The response carries next_action.type=redirect with the URL
709
+ # to send the user's browser to; the user returns to return_url with request_id and result appended. Read the
710
+ # outcome with GET /v3/id-verification/wallets/verifications/{request_id}/ or from the webhook, never from the
711
+ # URL. Sandbox applications get a deterministic simulation (simulated: true) that never contacts the provider.
712
+ #
713
+ # +POST /v3/id-verification/wallets/ftn/+
714
+ #
715
+ # @param return_url [String] https URL the user's browser returns to after the wallet, with request_id and
716
+ # result appended. Its host must be registered in the application's allowed_return_hosts (or be its white-label
717
+ # domain). Never trust result on its own: read the outcome with GET .../verifications/{request_id}/ or the
718
+ # webhook.
719
+ # @param vendor_data [String, nil] Your own reference for this verification (e.g. your user id). Returned in
720
+ # results and webhooks.
721
+ # @param metadata [Hash, nil] Optional JSON object stored with the verification and returned in results and
722
+ # webhooks.
723
+ # @param sandbox_scenario [String] Sandbox applications only: the simulated outcome - 'wallet_cancelled',
724
+ # 'wallet_timeout' or 'wallet_provider_error'; any other scenario (or none) verifies. Rejected on live
725
+ # applications. The full catalog is available at GET /v1/sandbox/scenarios/.
726
+ # @param country [String] ISO 3166-1 alpha-3 country of the Finnish Trust Network identity. Defaults to FIN, the
727
+ # only country it serves. * `FIN` - FIN
728
+ # @param device [String] same_device when the user signs in on the device showing your page, cross_device when
729
+ # they use another one (e.g. BankID's QR code). * `same_device` - same_device * `cross_device` - cross_device
730
+ # @param idempotency_key [String] sent as the Idempotency-Key header
731
+ # @param request_options [Hash, nil] :timeout, :max_retries, :extra_headers, :extra_query, :extra_body
732
+ # @return [Didit::Types::DigitalIdWalletApiWalletVerificationResponse]
733
+ def start_ftn(
734
+ return_url:,
735
+ vendor_data: OMIT,
736
+ metadata: OMIT,
737
+ sandbox_scenario: OMIT,
738
+ country: OMIT,
739
+ device: OMIT,
740
+ idempotency_key: OMIT,
741
+ request_options: nil
742
+ )
743
+ @client.request(
744
+ :post,
745
+ "/v3/id-verification/wallets/ftn/",
746
+ body: {
747
+ "return_url" => return_url,
748
+ "vendor_data" => vendor_data,
749
+ "metadata" => metadata,
750
+ "sandbox_scenario" => sandbox_scenario,
751
+ "country" => country,
752
+ "device" => device
753
+ },
754
+ headers: { "Idempotency-Key" => idempotency_key },
755
+ response: Types::DigitalIdWalletApiWalletVerificationResponse,
756
+ request_options: request_options
757
+ )
758
+ end
759
+
760
+ # Start gov.br verification
761
+ #
762
+ # Start a gov.br sign-in (Governo Federal do Brasil; BRA) without any workflow. Billed once, only when the
763
+ # identity is verified. The response carries next_action.type=redirect with the URL to send the user's browser
764
+ # to; the user returns to return_url with request_id and result appended. Read the outcome with GET
765
+ # /v3/id-verification/wallets/verifications/{request_id}/ or from the webhook, never from the URL. Sandbox
766
+ # applications get a deterministic simulation (simulated: true) that never contacts the provider.
767
+ #
768
+ # +POST /v3/id-verification/wallets/govbr/+
769
+ #
770
+ # @param return_url [String] https URL the user's browser returns to after the wallet, with request_id and
771
+ # result appended. Its host must be registered in the application's allowed_return_hosts (or be its white-label
772
+ # domain). Never trust result on its own: read the outcome with GET .../verifications/{request_id}/ or the
773
+ # webhook.
774
+ # @param vendor_data [String, nil] Your own reference for this verification (e.g. your user id). Returned in
775
+ # results and webhooks.
776
+ # @param metadata [Hash, nil] Optional JSON object stored with the verification and returned in results and
777
+ # webhooks.
778
+ # @param sandbox_scenario [String] Sandbox applications only: the simulated outcome - 'wallet_cancelled',
779
+ # 'wallet_timeout' or 'wallet_provider_error'; any other scenario (or none) verifies. Rejected on live
780
+ # applications. The full catalog is available at GET /v1/sandbox/scenarios/.
781
+ # @param country [String] ISO 3166-1 alpha-3 country of the gov.br identity. Defaults to BRA, the only country
782
+ # it serves. * `BRA` - BRA
783
+ # @param device [String] same_device when the user signs in on the device showing your page, cross_device when
784
+ # they use another one (e.g. BankID's QR code). * `same_device` - same_device * `cross_device` - cross_device
785
+ # @param idempotency_key [String] sent as the Idempotency-Key header
786
+ # @param request_options [Hash, nil] :timeout, :max_retries, :extra_headers, :extra_query, :extra_body
787
+ # @return [Didit::Types::DigitalIdWalletApiWalletVerificationResponse]
788
+ def start_govbr(
789
+ return_url:,
790
+ vendor_data: OMIT,
791
+ metadata: OMIT,
792
+ sandbox_scenario: OMIT,
793
+ country: OMIT,
794
+ device: OMIT,
795
+ idempotency_key: OMIT,
796
+ request_options: nil
797
+ )
798
+ @client.request(
799
+ :post,
800
+ "/v3/id-verification/wallets/govbr/",
801
+ body: {
802
+ "return_url" => return_url,
803
+ "vendor_data" => vendor_data,
804
+ "metadata" => metadata,
805
+ "sandbox_scenario" => sandbox_scenario,
806
+ "country" => country,
807
+ "device" => device
808
+ },
809
+ headers: { "Idempotency-Key" => idempotency_key },
810
+ response: Types::DigitalIdWalletApiWalletVerificationResponse,
811
+ request_options: request_options
812
+ )
813
+ end
814
+
815
+ # Start GOV.UK Wallet verification
816
+ #
817
+ # Start a GOV.UK Wallet sign-in (UK Government Digital Service; GBR) without any workflow. Billed once, only
818
+ # when the identity is verified. The response carries next_action.type=redirect with the URL to send the user's
819
+ # browser to; the user returns to return_url with request_id and result appended. Read the outcome with GET
820
+ # /v3/id-verification/wallets/verifications/{request_id}/ or from the webhook, never from the URL. Sandbox
821
+ # applications get a deterministic simulation (simulated: true) that never contacts the provider.
822
+ #
823
+ # +POST /v3/id-verification/wallets/govuk-wallet/+
824
+ #
825
+ # @param return_url [String] https URL the user's browser returns to after the wallet, with request_id and
826
+ # result appended. Its host must be registered in the application's allowed_return_hosts (or be its white-label
827
+ # domain). Never trust result on its own: read the outcome with GET .../verifications/{request_id}/ or the
828
+ # webhook.
829
+ # @param vendor_data [String, nil] Your own reference for this verification (e.g. your user id). Returned in
830
+ # results and webhooks.
831
+ # @param metadata [Hash, nil] Optional JSON object stored with the verification and returned in results and
832
+ # webhooks.
833
+ # @param sandbox_scenario [String] Sandbox applications only: the simulated outcome - 'wallet_cancelled',
834
+ # 'wallet_timeout' or 'wallet_provider_error'; any other scenario (or none) verifies. Rejected on live
835
+ # applications. The full catalog is available at GET /v1/sandbox/scenarios/.
836
+ # @param country [String] ISO 3166-1 alpha-3 country of the GOV.UK Wallet identity. Defaults to GBR, the only
837
+ # country it serves. * `GBR` - GBR
838
+ # @param device [String] same_device when the user signs in on the device showing your page, cross_device when
839
+ # they use another one (e.g. BankID's QR code). * `same_device` - same_device * `cross_device` - cross_device
840
+ # @param idempotency_key [String] sent as the Idempotency-Key header
841
+ # @param request_options [Hash, nil] :timeout, :max_retries, :extra_headers, :extra_query, :extra_body
842
+ # @return [Didit::Types::DigitalIdWalletApiWalletVerificationResponse]
843
+ def start_govuk_wallet(
844
+ return_url:,
845
+ vendor_data: OMIT,
846
+ metadata: OMIT,
847
+ sandbox_scenario: OMIT,
848
+ country: OMIT,
849
+ device: OMIT,
850
+ idempotency_key: OMIT,
851
+ request_options: nil
852
+ )
853
+ @client.request(
854
+ :post,
855
+ "/v3/id-verification/wallets/govuk-wallet/",
856
+ body: {
857
+ "return_url" => return_url,
858
+ "vendor_data" => vendor_data,
859
+ "metadata" => metadata,
860
+ "sandbox_scenario" => sandbox_scenario,
861
+ "country" => country,
862
+ "device" => device
863
+ },
864
+ headers: { "Idempotency-Key" => idempotency_key },
865
+ response: Types::DigitalIdWalletApiWalletVerificationResponse,
866
+ request_options: request_options
867
+ )
868
+ end
869
+
870
+ # Start Estonian ID-card verification
871
+ #
872
+ # Start a Estonian ID-card sign-in (Police and Border Guard Board (Estonia); EST) without any workflow. Billed
873
+ # once, only when the identity is verified. The response carries next_action.type=redirect with the URL to send
874
+ # the user's browser to; the user returns to return_url with request_id and result appended. Read the outcome
875
+ # with GET /v3/id-verification/wallets/verifications/{request_id}/ or from the webhook, never from the URL.
876
+ # Sandbox applications get a deterministic simulation (simulated: true) that never contacts the provider.
877
+ #
878
+ # +POST /v3/id-verification/wallets/idcard-ee/+
879
+ #
880
+ # @param return_url [String] https URL the user's browser returns to after the wallet, with request_id and
881
+ # result appended. Its host must be registered in the application's allowed_return_hosts (or be its white-label
882
+ # domain). Never trust result on its own: read the outcome with GET .../verifications/{request_id}/ or the
883
+ # webhook.
884
+ # @param vendor_data [String, nil] Your own reference for this verification (e.g. your user id). Returned in
885
+ # results and webhooks.
886
+ # @param metadata [Hash, nil] Optional JSON object stored with the verification and returned in results and
887
+ # webhooks.
888
+ # @param sandbox_scenario [String] Sandbox applications only: the simulated outcome - 'wallet_cancelled',
889
+ # 'wallet_timeout' or 'wallet_provider_error'; any other scenario (or none) verifies. Rejected on live
890
+ # applications. The full catalog is available at GET /v1/sandbox/scenarios/.
891
+ # @param country [String] ISO 3166-1 alpha-3 country of the Estonian ID-card identity. Defaults to EST, the only
892
+ # country it serves. * `EST` - EST
893
+ # @param device [String] same_device when the user signs in on the device showing your page, cross_device when
894
+ # they use another one (e.g. BankID's QR code). * `same_device` - same_device * `cross_device` - cross_device
895
+ # @param idempotency_key [String] sent as the Idempotency-Key header
896
+ # @param request_options [Hash, nil] :timeout, :max_retries, :extra_headers, :extra_query, :extra_body
897
+ # @return [Didit::Types::DigitalIdWalletApiWalletVerificationResponse]
898
+ def start_idcard_ee(
899
+ return_url:,
900
+ vendor_data: OMIT,
901
+ metadata: OMIT,
902
+ sandbox_scenario: OMIT,
903
+ country: OMIT,
904
+ device: OMIT,
905
+ idempotency_key: OMIT,
906
+ request_options: nil
907
+ )
908
+ @client.request(
909
+ :post,
910
+ "/v3/id-verification/wallets/idcard-ee/",
911
+ body: {
912
+ "return_url" => return_url,
913
+ "vendor_data" => vendor_data,
914
+ "metadata" => metadata,
915
+ "sandbox_scenario" => sandbox_scenario,
916
+ "country" => country,
917
+ "device" => device
918
+ },
919
+ headers: { "Idempotency-Key" => idempotency_key },
920
+ response: Types::DigitalIdWalletApiWalletVerificationResponse,
921
+ request_options: request_options
922
+ )
923
+ end
924
+
925
+ # Start iDIN verification
926
+ #
927
+ # Start a iDIN sign-in (Dutch banks (Currence iDIN); NLD) without any workflow. Billed once, only when the
928
+ # identity is verified. The response carries next_action.type=redirect with the URL to send the user's browser
929
+ # to; the user returns to return_url with request_id and result appended. Read the outcome with GET
930
+ # /v3/id-verification/wallets/verifications/{request_id}/ or from the webhook, never from the URL. Sandbox
931
+ # applications get a deterministic simulation (simulated: true) that never contacts the provider.
932
+ #
933
+ # +POST /v3/id-verification/wallets/idin/+
934
+ #
935
+ # @param return_url [String] https URL the user's browser returns to after the wallet, with request_id and
936
+ # result appended. Its host must be registered in the application's allowed_return_hosts (or be its white-label
937
+ # domain). Never trust result on its own: read the outcome with GET .../verifications/{request_id}/ or the
938
+ # webhook.
939
+ # @param vendor_data [String, nil] Your own reference for this verification (e.g. your user id). Returned in
940
+ # results and webhooks.
941
+ # @param metadata [Hash, nil] Optional JSON object stored with the verification and returned in results and
942
+ # webhooks.
943
+ # @param sandbox_scenario [String] Sandbox applications only: the simulated outcome - 'wallet_cancelled',
944
+ # 'wallet_timeout' or 'wallet_provider_error'; any other scenario (or none) verifies. Rejected on live
945
+ # applications. The full catalog is available at GET /v1/sandbox/scenarios/.
946
+ # @param country [String] ISO 3166-1 alpha-3 country of the iDIN identity. Defaults to NLD, the only country it
947
+ # serves. * `NLD` - NLD
948
+ # @param device [String] same_device when the user signs in on the device showing your page, cross_device when
949
+ # they use another one (e.g. BankID's QR code). * `same_device` - same_device * `cross_device` - cross_device
950
+ # @param idempotency_key [String] sent as the Idempotency-Key header
951
+ # @param request_options [Hash, nil] :timeout, :max_retries, :extra_headers, :extra_query, :extra_body
952
+ # @return [Didit::Types::DigitalIdWalletApiWalletVerificationResponse]
953
+ def start_idin(
954
+ return_url:,
955
+ vendor_data: OMIT,
956
+ metadata: OMIT,
957
+ sandbox_scenario: OMIT,
958
+ country: OMIT,
959
+ device: OMIT,
960
+ idempotency_key: OMIT,
961
+ request_options: nil
962
+ )
963
+ @client.request(
964
+ :post,
965
+ "/v3/id-verification/wallets/idin/",
966
+ body: {
967
+ "return_url" => return_url,
968
+ "vendor_data" => vendor_data,
969
+ "metadata" => metadata,
970
+ "sandbox_scenario" => sandbox_scenario,
971
+ "country" => country,
972
+ "device" => device
973
+ },
974
+ headers: { "Idempotency-Key" => idempotency_key },
975
+ response: Types::DigitalIdWalletApiWalletVerificationResponse,
976
+ request_options: request_options
977
+ )
978
+ end
979
+
980
+ # Start itsme verification
981
+ #
982
+ # Start a itsme sign-in (Belgian Mobile ID; BEL, LUX, NLD) without any workflow. Billed once, only when the
983
+ # identity is verified. The response carries next_action.type=redirect with the URL to send the user's browser
984
+ # to; the user returns to return_url with request_id and result appended. Read the outcome with GET
985
+ # /v3/id-verification/wallets/verifications/{request_id}/ or from the webhook, never from the URL. Sandbox
986
+ # applications get a deterministic simulation (simulated: true) that never contacts the provider.
987
+ #
988
+ # +POST /v3/id-verification/wallets/itsme/+
989
+ #
990
+ # @param country [String] ISO 3166-1 alpha-3 country of the itsme identity. * `BEL` - BEL * `LUX` - LUX * `NLD`
991
+ # - NLD
992
+ # @param return_url [String] https URL the user's browser returns to after the wallet, with request_id and
993
+ # result appended. Its host must be registered in the application's allowed_return_hosts (or be its white-label
994
+ # domain). Never trust result on its own: read the outcome with GET .../verifications/{request_id}/ or the
995
+ # webhook.
996
+ # @param vendor_data [String, nil] Your own reference for this verification (e.g. your user id). Returned in
997
+ # results and webhooks.
998
+ # @param metadata [Hash, nil] Optional JSON object stored with the verification and returned in results and
999
+ # webhooks.
1000
+ # @param sandbox_scenario [String] Sandbox applications only: the simulated outcome - 'wallet_cancelled',
1001
+ # 'wallet_timeout' or 'wallet_provider_error'; any other scenario (or none) verifies. Rejected on live
1002
+ # applications. The full catalog is available at GET /v1/sandbox/scenarios/.
1003
+ # @param device [String] same_device when the user signs in on the device showing your page, cross_device when
1004
+ # they use another one (e.g. BankID's QR code). * `same_device` - same_device * `cross_device` - cross_device
1005
+ # @param idempotency_key [String] sent as the Idempotency-Key header
1006
+ # @param request_options [Hash, nil] :timeout, :max_retries, :extra_headers, :extra_query, :extra_body
1007
+ # @return [Didit::Types::DigitalIdWalletApiWalletVerificationResponse]
1008
+ def start_itsme(
1009
+ country:,
1010
+ return_url:,
1011
+ vendor_data: OMIT,
1012
+ metadata: OMIT,
1013
+ sandbox_scenario: OMIT,
1014
+ device: OMIT,
1015
+ idempotency_key: OMIT,
1016
+ request_options: nil
1017
+ )
1018
+ @client.request(
1019
+ :post,
1020
+ "/v3/id-verification/wallets/itsme/",
1021
+ body: {
1022
+ "country" => country,
1023
+ "return_url" => return_url,
1024
+ "vendor_data" => vendor_data,
1025
+ "metadata" => metadata,
1026
+ "sandbox_scenario" => sandbox_scenario,
1027
+ "device" => device
1028
+ },
1029
+ headers: { "Idempotency-Key" => idempotency_key },
1030
+ response: Types::DigitalIdWalletApiWalletVerificationResponse,
1031
+ request_options: request_options
1032
+ )
1033
+ end
1034
+
1035
+ # Start MitID verification
1036
+ #
1037
+ # Start a MitID sign-in (Danish Agency for Digital Government; DNK) without any workflow. Billed once, only when
1038
+ # the identity is verified. The response carries next_action.type=redirect with the URL to send the user's
1039
+ # browser to; the user returns to return_url with request_id and result appended. Read the outcome with GET
1040
+ # /v3/id-verification/wallets/verifications/{request_id}/ or from the webhook, never from the URL. Sandbox
1041
+ # applications get a deterministic simulation (simulated: true) that never contacts the provider.
1042
+ #
1043
+ # +POST /v3/id-verification/wallets/mitid/+
1044
+ #
1045
+ # @param return_url [String] https URL the user's browser returns to after the wallet, with request_id and
1046
+ # result appended. Its host must be registered in the application's allowed_return_hosts (or be its white-label
1047
+ # domain). Never trust result on its own: read the outcome with GET .../verifications/{request_id}/ or the
1048
+ # webhook.
1049
+ # @param vendor_data [String, nil] Your own reference for this verification (e.g. your user id). Returned in
1050
+ # results and webhooks.
1051
+ # @param metadata [Hash, nil] Optional JSON object stored with the verification and returned in results and
1052
+ # webhooks.
1053
+ # @param sandbox_scenario [String] Sandbox applications only: the simulated outcome - 'wallet_cancelled',
1054
+ # 'wallet_timeout' or 'wallet_provider_error'; any other scenario (or none) verifies. Rejected on live
1055
+ # applications. The full catalog is available at GET /v1/sandbox/scenarios/.
1056
+ # @param country [String] ISO 3166-1 alpha-3 country of the MitID identity. Defaults to DNK, the only country it
1057
+ # serves. * `DNK` - DNK
1058
+ # @param device [String] same_device when the user signs in on the device showing your page, cross_device when
1059
+ # they use another one (e.g. BankID's QR code). * `same_device` - same_device * `cross_device` - cross_device
1060
+ # @param idempotency_key [String] sent as the Idempotency-Key header
1061
+ # @param request_options [Hash, nil] :timeout, :max_retries, :extra_headers, :extra_query, :extra_body
1062
+ # @return [Didit::Types::DigitalIdWalletApiWalletVerificationResponse]
1063
+ def start_mitid(
1064
+ return_url:,
1065
+ vendor_data: OMIT,
1066
+ metadata: OMIT,
1067
+ sandbox_scenario: OMIT,
1068
+ country: OMIT,
1069
+ device: OMIT,
1070
+ idempotency_key: OMIT,
1071
+ request_options: nil
1072
+ )
1073
+ @client.request(
1074
+ :post,
1075
+ "/v3/id-verification/wallets/mitid/",
1076
+ body: {
1077
+ "return_url" => return_url,
1078
+ "vendor_data" => vendor_data,
1079
+ "metadata" => metadata,
1080
+ "sandbox_scenario" => sandbox_scenario,
1081
+ "country" => country,
1082
+ "device" => device
1083
+ },
1084
+ headers: { "Idempotency-Key" => idempotency_key },
1085
+ response: Types::DigitalIdWalletApiWalletVerificationResponse,
1086
+ request_options: request_options
1087
+ )
1088
+ end
1089
+
1090
+ # Start Mobile-ID verification
1091
+ #
1092
+ # Start a Mobile-ID sign-in (SK ID Solutions with the national mobile operators; EST, LTU) without any workflow.
1093
+ # Billed once, only when the identity is verified. The response carries next_action.type=confirm_in_app with the
1094
+ # comparison code to show the user; the user confirms it and enters their PIN in the app (never collect the
1095
+ # PIN). Poll POST /v3/id-verification/wallets/verifications/{request_id}/poll/ every poll_interval_seconds, or
1096
+ # rely on the webhook: Didit polls in the background too. Sandbox applications get a deterministic simulation
1097
+ # (simulated: true) that never contacts the provider.
1098
+ #
1099
+ # +POST /v3/id-verification/wallets/mobile-id/+
1100
+ #
1101
+ # @param country [String] ISO 3166-1 alpha-3 country of the Mobile-ID identity. * `EST` - EST * `LTU` - LTU
1102
+ # @param personal_code [String] The user's national personal identification code. It addresses the user's
1103
+ # Mobile-ID app; the user confirms the comparison code and enters their PIN in the app. Never collect the PIN.
1104
+ # @param phone_number [String] The Mobile-ID phone number in E.164 format (+372... or +370...).
1105
+ # @param vendor_data [String, nil] Your own reference for this verification (e.g. your user id). Returned in
1106
+ # results and webhooks.
1107
+ # @param metadata [Hash, nil] Optional JSON object stored with the verification and returned in results and
1108
+ # webhooks.
1109
+ # @param sandbox_scenario [String] Sandbox applications only: the simulated outcome - 'wallet_cancelled',
1110
+ # 'wallet_timeout' or 'wallet_provider_error'; any other scenario (or none) verifies. Rejected on live
1111
+ # applications. The full catalog is available at GET /v1/sandbox/scenarios/.
1112
+ # @param idempotency_key [String] sent as the Idempotency-Key header
1113
+ # @param request_options [Hash, nil] :timeout, :max_retries, :extra_headers, :extra_query, :extra_body
1114
+ # @return [Didit::Types::DigitalIdWalletApiWalletVerificationResponse]
1115
+ def start_mobile_id(
1116
+ country:,
1117
+ personal_code:,
1118
+ phone_number:,
1119
+ vendor_data: OMIT,
1120
+ metadata: OMIT,
1121
+ sandbox_scenario: OMIT,
1122
+ idempotency_key: OMIT,
1123
+ request_options: nil
1124
+ )
1125
+ @client.request(
1126
+ :post,
1127
+ "/v3/id-verification/wallets/mobile-id/",
1128
+ body: {
1129
+ "country" => country,
1130
+ "personal_code" => personal_code,
1131
+ "phone_number" => phone_number,
1132
+ "vendor_data" => vendor_data,
1133
+ "metadata" => metadata,
1134
+ "sandbox_scenario" => sandbox_scenario
1135
+ },
1136
+ headers: { "Idempotency-Key" => idempotency_key },
1137
+ response: Types::DigitalIdWalletApiWalletVerificationResponse,
1138
+ request_options: request_options
1139
+ )
1140
+ end
1141
+
1142
+ # Start MojeID verification
1143
+ #
1144
+ # Start a MojeID sign-in (CZ.NIC; CZE) without any workflow. Billed once, only when the identity is verified.
1145
+ # The response carries next_action.type=redirect with the URL to send the user's browser to; the user returns to
1146
+ # return_url with request_id and result appended. Read the outcome with GET
1147
+ # /v3/id-verification/wallets/verifications/{request_id}/ or from the webhook, never from the URL. Sandbox
1148
+ # applications get a deterministic simulation (simulated: true) that never contacts the provider.
1149
+ #
1150
+ # +POST /v3/id-verification/wallets/mojeid/+
1151
+ #
1152
+ # @param return_url [String] https URL the user's browser returns to after the wallet, with request_id and
1153
+ # result appended. Its host must be registered in the application's allowed_return_hosts (or be its white-label
1154
+ # domain). Never trust result on its own: read the outcome with GET .../verifications/{request_id}/ or the
1155
+ # webhook.
1156
+ # @param vendor_data [String, nil] Your own reference for this verification (e.g. your user id). Returned in
1157
+ # results and webhooks.
1158
+ # @param metadata [Hash, nil] Optional JSON object stored with the verification and returned in results and
1159
+ # webhooks.
1160
+ # @param sandbox_scenario [String] Sandbox applications only: the simulated outcome - 'wallet_cancelled',
1161
+ # 'wallet_timeout' or 'wallet_provider_error'; any other scenario (or none) verifies. Rejected on live
1162
+ # applications. The full catalog is available at GET /v1/sandbox/scenarios/.
1163
+ # @param country [String] ISO 3166-1 alpha-3 country of the MojeID identity. Defaults to CZE, the only country
1164
+ # it serves. * `CZE` - CZE
1165
+ # @param device [String] same_device when the user signs in on the device showing your page, cross_device when
1166
+ # they use another one (e.g. BankID's QR code). * `same_device` - same_device * `cross_device` - cross_device
1167
+ # @param idempotency_key [String] sent as the Idempotency-Key header
1168
+ # @param request_options [Hash, nil] :timeout, :max_retries, :extra_headers, :extra_query, :extra_body
1169
+ # @return [Didit::Types::DigitalIdWalletApiWalletVerificationResponse]
1170
+ def start_mojeid(
1171
+ return_url:,
1172
+ vendor_data: OMIT,
1173
+ metadata: OMIT,
1174
+ sandbox_scenario: OMIT,
1175
+ country: OMIT,
1176
+ device: OMIT,
1177
+ idempotency_key: OMIT,
1178
+ request_options: nil
1179
+ )
1180
+ @client.request(
1181
+ :post,
1182
+ "/v3/id-verification/wallets/mojeid/",
1183
+ body: {
1184
+ "return_url" => return_url,
1185
+ "vendor_data" => vendor_data,
1186
+ "metadata" => metadata,
1187
+ "sandbox_scenario" => sandbox_scenario,
1188
+ "country" => country,
1189
+ "device" => device
1190
+ },
1191
+ headers: { "Idempotency-Key" => idempotency_key },
1192
+ response: Types::DigitalIdWalletApiWalletVerificationResponse,
1193
+ request_options: request_options
1194
+ )
1195
+ end
1196
+
1197
+ # Start OneID verification
1198
+ #
1199
+ # Start a OneID sign-in (OneID (UK bank-verified identity); GBR) without any workflow. Billed once, only when
1200
+ # the identity is verified. The response carries next_action.type=redirect with the URL to send the user's
1201
+ # browser to; the user returns to return_url with request_id and result appended. Read the outcome with GET
1202
+ # /v3/id-verification/wallets/verifications/{request_id}/ or from the webhook, never from the URL. Sandbox
1203
+ # applications get a deterministic simulation (simulated: true) that never contacts the provider.
1204
+ #
1205
+ # +POST /v3/id-verification/wallets/oneid/+
1206
+ #
1207
+ # @param return_url [String] https URL the user's browser returns to after the wallet, with request_id and
1208
+ # result appended. Its host must be registered in the application's allowed_return_hosts (or be its white-label
1209
+ # domain). Never trust result on its own: read the outcome with GET .../verifications/{request_id}/ or the
1210
+ # webhook.
1211
+ # @param vendor_data [String, nil] Your own reference for this verification (e.g. your user id). Returned in
1212
+ # results and webhooks.
1213
+ # @param metadata [Hash, nil] Optional JSON object stored with the verification and returned in results and
1214
+ # webhooks.
1215
+ # @param sandbox_scenario [String] Sandbox applications only: the simulated outcome - 'wallet_cancelled',
1216
+ # 'wallet_timeout' or 'wallet_provider_error'; any other scenario (or none) verifies. Rejected on live
1217
+ # applications. The full catalog is available at GET /v1/sandbox/scenarios/.
1218
+ # @param country [String] ISO 3166-1 alpha-3 country of the OneID identity. Defaults to GBR, the only country it
1219
+ # serves. * `GBR` - GBR
1220
+ # @param device [String] same_device when the user signs in on the device showing your page, cross_device when
1221
+ # they use another one (e.g. BankID's QR code). * `same_device` - same_device * `cross_device` - cross_device
1222
+ # @param idempotency_key [String] sent as the Idempotency-Key header
1223
+ # @param request_options [Hash, nil] :timeout, :max_retries, :extra_headers, :extra_query, :extra_body
1224
+ # @return [Didit::Types::DigitalIdWalletApiWalletVerificationResponse]
1225
+ def start_oneid(
1226
+ return_url:,
1227
+ vendor_data: OMIT,
1228
+ metadata: OMIT,
1229
+ sandbox_scenario: OMIT,
1230
+ country: OMIT,
1231
+ device: OMIT,
1232
+ idempotency_key: OMIT,
1233
+ request_options: nil
1234
+ )
1235
+ @client.request(
1236
+ :post,
1237
+ "/v3/id-verification/wallets/oneid/",
1238
+ body: {
1239
+ "return_url" => return_url,
1240
+ "vendor_data" => vendor_data,
1241
+ "metadata" => metadata,
1242
+ "sandbox_scenario" => sandbox_scenario,
1243
+ "country" => country,
1244
+ "device" => device
1245
+ },
1246
+ headers: { "Idempotency-Key" => idempotency_key },
1247
+ response: Types::DigitalIdWalletApiWalletVerificationResponse,
1248
+ request_options: request_options
1249
+ )
1250
+ end
1251
+
1252
+ # Start Personalausweis verification
1253
+ #
1254
+ # Start a Personalausweis sign-in (Bundesministerium des Innern (eID); DEU) without any workflow. Billed once,
1255
+ # only when the identity is verified. The response carries next_action.type=redirect with the URL to send the
1256
+ # user's browser to; the user returns to return_url with request_id and result appended. Read the outcome with
1257
+ # GET /v3/id-verification/wallets/verifications/{request_id}/ or from the webhook, never from the URL. Sandbox
1258
+ # applications get a deterministic simulation (simulated: true) that never contacts the provider.
1259
+ #
1260
+ # +POST /v3/id-verification/wallets/personalausweis/+
1261
+ #
1262
+ # @param return_url [String] https URL the user's browser returns to after the wallet, with request_id and
1263
+ # result appended. Its host must be registered in the application's allowed_return_hosts (or be its white-label
1264
+ # domain). Never trust result on its own: read the outcome with GET .../verifications/{request_id}/ or the
1265
+ # webhook.
1266
+ # @param vendor_data [String, nil] Your own reference for this verification (e.g. your user id). Returned in
1267
+ # results and webhooks.
1268
+ # @param metadata [Hash, nil] Optional JSON object stored with the verification and returned in results and
1269
+ # webhooks.
1270
+ # @param sandbox_scenario [String] Sandbox applications only: the simulated outcome - 'wallet_cancelled',
1271
+ # 'wallet_timeout' or 'wallet_provider_error'; any other scenario (or none) verifies. Rejected on live
1272
+ # applications. The full catalog is available at GET /v1/sandbox/scenarios/.
1273
+ # @param country [String] ISO 3166-1 alpha-3 country of the Personalausweis identity. Defaults to DEU, the only
1274
+ # country it serves. * `DEU` - DEU
1275
+ # @param device [String] same_device when the user signs in on the device showing your page, cross_device when
1276
+ # they use another one (e.g. BankID's QR code). * `same_device` - same_device * `cross_device` - cross_device
1277
+ # @param idempotency_key [String] sent as the Idempotency-Key header
1278
+ # @param request_options [Hash, nil] :timeout, :max_retries, :extra_headers, :extra_query, :extra_body
1279
+ # @return [Didit::Types::DigitalIdWalletApiWalletVerificationResponse]
1280
+ def start_personalausweis(
1281
+ return_url:,
1282
+ vendor_data: OMIT,
1283
+ metadata: OMIT,
1284
+ sandbox_scenario: OMIT,
1285
+ country: OMIT,
1286
+ device: OMIT,
1287
+ idempotency_key: OMIT,
1288
+ request_options: nil
1289
+ )
1290
+ @client.request(
1291
+ :post,
1292
+ "/v3/id-verification/wallets/personalausweis/",
1293
+ body: {
1294
+ "return_url" => return_url,
1295
+ "vendor_data" => vendor_data,
1296
+ "metadata" => metadata,
1297
+ "sandbox_scenario" => sandbox_scenario,
1298
+ "country" => country,
1299
+ "device" => device
1300
+ },
1301
+ headers: { "Idempotency-Key" => idempotency_key },
1302
+ response: Types::DigitalIdWalletApiWalletVerificationResponse,
1303
+ request_options: request_options
1304
+ )
1305
+ end
1306
+
1307
+ # Start Smart-ID verification
1308
+ #
1309
+ # Start a Smart-ID sign-in (SK ID Solutions; EST, LVA, LTU, BEL) without any workflow. Billed once, only when
1310
+ # the identity is verified. The response carries next_action.type=confirm_in_app with the comparison code to
1311
+ # show the user; the user confirms it and enters their PIN in the app (never collect the PIN). Poll POST
1312
+ # /v3/id-verification/wallets/verifications/{request_id}/poll/ every poll_interval_seconds, or rely on the
1313
+ # webhook: Didit polls in the background too. Sandbox applications get a deterministic simulation (simulated:
1314
+ # true) that never contacts the provider.
1315
+ #
1316
+ # +POST /v3/id-verification/wallets/smart-id/+
1317
+ #
1318
+ # @param country [String] ISO 3166-1 alpha-3 country of the Smart-ID identity. * `EST` - EST * `LVA` - LVA *
1319
+ # `LTU` - LTU * `BEL` - BEL
1320
+ # @param personal_code [String] The user's national personal identification code. It addresses the user's
1321
+ # Smart-ID app; the user confirms the comparison code and enters their PIN in the app. Never collect the PIN.
1322
+ # @param vendor_data [String, nil] Your own reference for this verification (e.g. your user id). Returned in
1323
+ # results and webhooks.
1324
+ # @param metadata [Hash, nil] Optional JSON object stored with the verification and returned in results and
1325
+ # webhooks.
1326
+ # @param sandbox_scenario [String] Sandbox applications only: the simulated outcome - 'wallet_cancelled',
1327
+ # 'wallet_timeout' or 'wallet_provider_error'; any other scenario (or none) verifies. Rejected on live
1328
+ # applications. The full catalog is available at GET /v1/sandbox/scenarios/.
1329
+ # @param idempotency_key [String] sent as the Idempotency-Key header
1330
+ # @param request_options [Hash, nil] :timeout, :max_retries, :extra_headers, :extra_query, :extra_body
1331
+ # @return [Didit::Types::DigitalIdWalletApiWalletVerificationResponse]
1332
+ def start_smart_id(
1333
+ country:,
1334
+ personal_code:,
1335
+ vendor_data: OMIT,
1336
+ metadata: OMIT,
1337
+ sandbox_scenario: OMIT,
1338
+ idempotency_key: OMIT,
1339
+ request_options: nil
1340
+ )
1341
+ @client.request(
1342
+ :post,
1343
+ "/v3/id-verification/wallets/smart-id/",
1344
+ body: {
1345
+ "country" => country,
1346
+ "personal_code" => personal_code,
1347
+ "vendor_data" => vendor_data,
1348
+ "metadata" => metadata,
1349
+ "sandbox_scenario" => sandbox_scenario
1350
+ },
1351
+ headers: { "Idempotency-Key" => idempotency_key },
1352
+ response: Types::DigitalIdWalletApiWalletVerificationResponse,
1353
+ request_options: request_options
1354
+ )
1355
+ end
1356
+
1357
+ # Start UAE PASS verification
1358
+ #
1359
+ # Start a UAE PASS sign-in (UAE Digital Government Authority; ARE) without any workflow. Billed once, only when
1360
+ # the identity is verified. The response carries next_action.type=redirect with the URL to send the user's
1361
+ # browser to; the user returns to return_url with request_id and result appended. Read the outcome with GET
1362
+ # /v3/id-verification/wallets/verifications/{request_id}/ or from the webhook, never from the URL. Sandbox
1363
+ # applications get a deterministic simulation (simulated: true) that never contacts the provider.
1364
+ #
1365
+ # +POST /v3/id-verification/wallets/uae-pass/+
1366
+ #
1367
+ # @param return_url [String] https URL the user's browser returns to after the wallet, with request_id and
1368
+ # result appended. Its host must be registered in the application's allowed_return_hosts (or be its white-label
1369
+ # domain). Never trust result on its own: read the outcome with GET .../verifications/{request_id}/ or the
1370
+ # webhook.
1371
+ # @param vendor_data [String, nil] Your own reference for this verification (e.g. your user id). Returned in
1372
+ # results and webhooks.
1373
+ # @param metadata [Hash, nil] Optional JSON object stored with the verification and returned in results and
1374
+ # webhooks.
1375
+ # @param sandbox_scenario [String] Sandbox applications only: the simulated outcome - 'wallet_cancelled',
1376
+ # 'wallet_timeout' or 'wallet_provider_error'; any other scenario (or none) verifies. Rejected on live
1377
+ # applications. The full catalog is available at GET /v1/sandbox/scenarios/.
1378
+ # @param country [String] ISO 3166-1 alpha-3 country of the UAE PASS identity. Defaults to ARE, the only country
1379
+ # it serves. * `ARE` - ARE
1380
+ # @param device [String] same_device when the user signs in on the device showing your page, cross_device when
1381
+ # they use another one (e.g. BankID's QR code). * `same_device` - same_device * `cross_device` - cross_device
1382
+ # @param idempotency_key [String] sent as the Idempotency-Key header
1383
+ # @param request_options [Hash, nil] :timeout, :max_retries, :extra_headers, :extra_query, :extra_body
1384
+ # @return [Didit::Types::DigitalIdWalletApiWalletVerificationResponse]
1385
+ def start_uae_pass(
1386
+ return_url:,
1387
+ vendor_data: OMIT,
1388
+ metadata: OMIT,
1389
+ sandbox_scenario: OMIT,
1390
+ country: OMIT,
1391
+ device: OMIT,
1392
+ idempotency_key: OMIT,
1393
+ request_options: nil
1394
+ )
1395
+ @client.request(
1396
+ :post,
1397
+ "/v3/id-verification/wallets/uae-pass/",
1398
+ body: {
1399
+ "return_url" => return_url,
1400
+ "vendor_data" => vendor_data,
1401
+ "metadata" => metadata,
1402
+ "sandbox_scenario" => sandbox_scenario,
1403
+ "country" => country,
1404
+ "device" => device
1405
+ },
1406
+ headers: { "Idempotency-Key" => idempotency_key },
1407
+ response: Types::DigitalIdWalletApiWalletVerificationResponse,
1408
+ request_options: request_options
1409
+ )
1410
+ end
1411
+
1412
+ # Start Vipps verification
1413
+ #
1414
+ # Start a Vipps sign-in (Vipps MobilePay / BankID NO; NOR) without any workflow. Billed once, only when the
1415
+ # identity is verified. The response carries next_action.type=redirect with the URL to send the user's browser
1416
+ # to; the user returns to return_url with request_id and result appended. Read the outcome with GET
1417
+ # /v3/id-verification/wallets/verifications/{request_id}/ or from the webhook, never from the URL. Sandbox
1418
+ # applications get a deterministic simulation (simulated: true) that never contacts the provider.
1419
+ #
1420
+ # +POST /v3/id-verification/wallets/vipps/+
1421
+ #
1422
+ # @param return_url [String] https URL the user's browser returns to after the wallet, with request_id and
1423
+ # result appended. Its host must be registered in the application's allowed_return_hosts (or be its white-label
1424
+ # domain). Never trust result on its own: read the outcome with GET .../verifications/{request_id}/ or the
1425
+ # webhook.
1426
+ # @param vendor_data [String, nil] Your own reference for this verification (e.g. your user id). Returned in
1427
+ # results and webhooks.
1428
+ # @param metadata [Hash, nil] Optional JSON object stored with the verification and returned in results and
1429
+ # webhooks.
1430
+ # @param sandbox_scenario [String] Sandbox applications only: the simulated outcome - 'wallet_cancelled',
1431
+ # 'wallet_timeout' or 'wallet_provider_error'; any other scenario (or none) verifies. Rejected on live
1432
+ # applications. The full catalog is available at GET /v1/sandbox/scenarios/.
1433
+ # @param country [String] ISO 3166-1 alpha-3 country of the Vipps identity. Defaults to NOR, the only country it
1434
+ # serves. * `NOR` - NOR
1435
+ # @param device [String] same_device when the user signs in on the device showing your page, cross_device when
1436
+ # they use another one (e.g. BankID's QR code). * `same_device` - same_device * `cross_device` - cross_device
1437
+ # @param idempotency_key [String] sent as the Idempotency-Key header
1438
+ # @param request_options [Hash, nil] :timeout, :max_retries, :extra_headers, :extra_query, :extra_body
1439
+ # @return [Didit::Types::DigitalIdWalletApiWalletVerificationResponse]
1440
+ def start_vipps(
1441
+ return_url:,
1442
+ vendor_data: OMIT,
1443
+ metadata: OMIT,
1444
+ sandbox_scenario: OMIT,
1445
+ country: OMIT,
1446
+ device: OMIT,
1447
+ idempotency_key: OMIT,
1448
+ request_options: nil
1449
+ )
1450
+ @client.request(
1451
+ :post,
1452
+ "/v3/id-verification/wallets/vipps/",
1453
+ body: {
1454
+ "return_url" => return_url,
1455
+ "vendor_data" => vendor_data,
1456
+ "metadata" => metadata,
1457
+ "sandbox_scenario" => sandbox_scenario,
1458
+ "country" => country,
1459
+ "device" => device
1460
+ },
1461
+ headers: { "Idempotency-Key" => idempotency_key },
1462
+ response: Types::DigitalIdWalletApiWalletVerificationResponse,
1463
+ request_options: request_options
1464
+ )
1465
+ end
1466
+ end
1467
+ end
1468
+ end