didit-sdk 2.20.1 → 2.22.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.
- checksums.yaml +4 -4
- data/CHANGELOG.md +14 -0
- data/lib/didit/resources/address_validation.rb +3 -0
- data/lib/didit/resources/age_estimation.rb +3 -0
- data/lib/didit/resources/bank.rb +14 -3
- data/lib/didit/resources/biometric_templates.rb +6 -1
- data/lib/didit/resources/blocklist.rb +6 -0
- data/lib/didit/resources/businesses.rb +29 -3
- data/lib/didit/resources/cases.rb +204 -35
- data/lib/didit/resources/customization.rb +3 -0
- data/lib/didit/resources/database_validation.rb +3 -0
- data/lib/didit/resources/document_ai.rb +3 -0
- data/lib/didit/resources/email.rb +17 -1
- data/lib/didit/resources/face_match.rb +3 -0
- data/lib/didit/resources/face_search.rb +3 -0
- data/lib/didit/resources/fraud_checks.rb +6 -0
- data/lib/didit/resources/id_verification.rb +3 -0
- data/lib/didit/resources/id_wallets.rb +13 -8
- data/lib/didit/resources/investigator.rb +12 -2
- data/lib/didit/resources/ip.rb +3 -0
- data/lib/didit/resources/kyb.rb +26 -2
- data/lib/didit/resources/lists.rb +18 -5
- data/lib/didit/resources/monitoring_events.rb +12 -2
- data/lib/didit/resources/networks.rb +12 -4
- data/lib/didit/resources/passive_liveness.rb +3 -0
- data/lib/didit/resources/phone.rb +9 -0
- data/lib/didit/resources/proof_of_address.rb +3 -0
- data/lib/didit/resources/questionnaires.rb +9 -1
- data/lib/didit/resources/regulatory_reports.rb +15 -3
- data/lib/didit/resources/report_templates.rb +9 -2
- data/lib/didit/resources/reports.rb +3 -0
- data/lib/didit/resources/sessions.rb +170 -29
- data/lib/didit/resources/transactions.rb +51 -8
- data/lib/didit/resources/travel_rule.rb +115 -24
- data/lib/didit/resources/users.rb +23 -3
- data/lib/didit/resources/wallet_screening.rb +3 -1
- data/lib/didit/resources/webhooks.rb +23 -3
- data/lib/didit/resources/workflows.rb +11 -3
- data/lib/didit/types/components.rb +30 -1
- data/lib/didit/types/sessions.rb +22 -0
- data/lib/didit/types.rb +3 -0
- data/lib/didit/version.rb +1 -1
- data/sig/didit/resources/address_validation.rbs +1 -1
- data/sig/didit/resources/age_estimation.rbs +1 -1
- data/sig/didit/resources/bank.rbs +1 -1
- data/sig/didit/resources/biometric_templates.rbs +2 -2
- data/sig/didit/resources/blocklist.rbs +2 -2
- data/sig/didit/resources/businesses.rbs +7 -7
- data/sig/didit/resources/cases.rbs +44 -44
- data/sig/didit/resources/customization.rbs +1 -1
- data/sig/didit/resources/database_validation.rbs +1 -1
- data/sig/didit/resources/document_ai.rbs +1 -1
- data/sig/didit/resources/email.rbs +3 -3
- data/sig/didit/resources/face_match.rbs +1 -1
- data/sig/didit/resources/face_search.rbs +1 -1
- data/sig/didit/resources/fraud_checks.rbs +2 -2
- data/sig/didit/resources/id_verification.rbs +1 -1
- data/sig/didit/resources/id_wallets.rbs +3 -3
- data/sig/didit/resources/investigator.rbs +4 -4
- data/sig/didit/resources/ip.rbs +1 -1
- data/sig/didit/resources/kyb.rbs +4 -4
- data/sig/didit/resources/lists.rbs +6 -6
- data/sig/didit/resources/monitoring_events.rbs +4 -4
- data/sig/didit/resources/networks.rbs +4 -4
- data/sig/didit/resources/passive_liveness.rbs +1 -1
- data/sig/didit/resources/phone.rbs +3 -3
- data/sig/didit/resources/proof_of_address.rbs +1 -1
- data/sig/didit/resources/questionnaires.rbs +3 -3
- data/sig/didit/resources/regulatory_reports.rbs +5 -5
- data/sig/didit/resources/report_templates.rbs +3 -3
- data/sig/didit/resources/reports.rbs +1 -1
- data/sig/didit/resources/sessions.rbs +39 -39
- data/sig/didit/resources/transactions.rbs +15 -15
- data/sig/didit/resources/travel_rule.rbs +33 -33
- data/sig/didit/resources/users.rbs +7 -7
- data/sig/didit/resources/wallet_screening.rbs +1 -1
- data/sig/didit/resources/webhooks.rbs +5 -5
- data/sig/didit/resources/workflows.rbs +3 -3
- data/sig/didit/types/components.rbs +20 -0
- data/sig/didit/types/sessions.rbs +21 -0
- metadata +1 -1
|
@@ -70,6 +70,7 @@ module Didit
|
|
|
70
70
|
# aspect ratio), shown on a dark background. PNG, JPG or WebP, at least 512 px on the long side, at most **1
|
|
71
71
|
# MB**. Returned as `logo_rectangular_dark`.
|
|
72
72
|
# @param image_favicon [Pathname, IO, String, Didit::FilePart] Favicon image. Max **500 KB**.
|
|
73
|
+
# @param idempotency_key [String] sent as the Idempotency-Key header
|
|
73
74
|
# @param request_options [Hash, nil] :timeout, :max_retries, :extra_headers, :extra_query, :extra_body
|
|
74
75
|
# @return [Didit::Types::BrandingCustomization]
|
|
75
76
|
def update(
|
|
@@ -104,6 +105,7 @@ module Didit
|
|
|
104
105
|
image_rectangular: OMIT,
|
|
105
106
|
image_rectangular_dark: OMIT,
|
|
106
107
|
image_favicon: OMIT,
|
|
108
|
+
idempotency_key: OMIT,
|
|
107
109
|
request_options: nil
|
|
108
110
|
)
|
|
109
111
|
@client.request(
|
|
@@ -144,6 +146,7 @@ module Didit
|
|
|
144
146
|
},
|
|
145
147
|
encoding: :auto,
|
|
146
148
|
file_fields: %w[image_favicon image_rectangular image_rectangular_dark image_square],
|
|
149
|
+
headers: { "Idempotency-Key" => idempotency_key },
|
|
147
150
|
response: Types::BrandingCustomization,
|
|
148
151
|
request_options: request_options
|
|
149
152
|
)
|
|
@@ -212,6 +212,7 @@ module Didit
|
|
|
212
212
|
# images are compressed to ~1.5 MB before upload to the registry) for biometric validation services, e.g.
|
|
213
213
|
# Argentina RENAPER (`arg_renaper`) and Panama SIB (`pan_cedula_sib`, `pan_cedula_sib_plus`). Required whenever
|
|
214
214
|
# a selected service lists it as a required field. Only available via `multipart/form-data`.
|
|
215
|
+
# @param idempotency_key [String] sent as the Idempotency-Key header
|
|
215
216
|
# @param request_options [Hash, nil] :timeout, :max_retries, :extra_headers, :extra_query, :extra_body
|
|
216
217
|
# @return [Didit::Types::DatabaseValidationValidateResponse]
|
|
217
218
|
def validate(
|
|
@@ -298,6 +299,7 @@ module Didit
|
|
|
298
299
|
vendor_data: OMIT,
|
|
299
300
|
metadata: OMIT,
|
|
300
301
|
selfie: OMIT,
|
|
302
|
+
idempotency_key: OMIT,
|
|
301
303
|
request_options: nil
|
|
302
304
|
)
|
|
303
305
|
@client.request(
|
|
@@ -390,6 +392,7 @@ module Didit
|
|
|
390
392
|
},
|
|
391
393
|
encoding: :auto,
|
|
392
394
|
file_fields: %w[selfie],
|
|
395
|
+
headers: { "Idempotency-Key" => idempotency_key },
|
|
393
396
|
response: Types::DatabaseValidationValidateResponse,
|
|
394
397
|
request_options: request_options
|
|
395
398
|
)
|
|
@@ -94,6 +94,7 @@ module Didit
|
|
|
94
94
|
# @param metadata [Hash] Optional JSON object stored with the session (when `save_api_request=true`) and echoed
|
|
95
95
|
# back in the response. In multipart requests, send it as a JSON-encoded string field (e.g.
|
|
96
96
|
# `metadata={"flow":"onboarding"}`) - it is parsed into an object.
|
|
97
|
+
# @param idempotency_key [String] sent as the Idempotency-Key header
|
|
97
98
|
# @param request_options [Hash, nil] :timeout, :max_retries, :extra_headers, :extra_query, :extra_body
|
|
98
99
|
# @return [Didit::Types::DocumentAiAnalyzeResponse]
|
|
99
100
|
def analyze(
|
|
@@ -112,6 +113,7 @@ module Didit
|
|
|
112
113
|
save_api_request: OMIT,
|
|
113
114
|
vendor_data: OMIT,
|
|
114
115
|
metadata: OMIT,
|
|
116
|
+
idempotency_key: OMIT,
|
|
115
117
|
request_options: nil
|
|
116
118
|
)
|
|
117
119
|
@client.request(
|
|
@@ -136,6 +138,7 @@ module Didit
|
|
|
136
138
|
},
|
|
137
139
|
encoding: :multipart,
|
|
138
140
|
file_fields: %w[document],
|
|
141
|
+
headers: { "Idempotency-Key" => idempotency_key },
|
|
139
142
|
response: Types::DocumentAiAnalyzeResponse,
|
|
140
143
|
request_options: request_options
|
|
141
144
|
)
|
|
@@ -48,6 +48,7 @@ module Didit
|
|
|
48
48
|
# @param enable_social [Boolean] When true, also look up the social footprint of the address - the email,
|
|
49
49
|
# social, professional, e-commerce and entertainment platforms it is registered on. Billed as one `email_social`
|
|
50
50
|
# unit per request in addition to this endpoint's own price.
|
|
51
|
+
# @param idempotency_key [String] sent as the Idempotency-Key header
|
|
51
52
|
# @param request_options [Hash, nil] :timeout, :max_retries, :extra_headers, :extra_query, :extra_body
|
|
52
53
|
# @return [Didit::Types::EmailRiskResponse]
|
|
53
54
|
def assess_risk(
|
|
@@ -57,6 +58,7 @@ module Didit
|
|
|
57
58
|
vendor_data: OMIT,
|
|
58
59
|
metadata: OMIT,
|
|
59
60
|
enable_social: OMIT,
|
|
61
|
+
idempotency_key: OMIT,
|
|
60
62
|
request_options: nil
|
|
61
63
|
)
|
|
62
64
|
@client.request(
|
|
@@ -70,6 +72,7 @@ module Didit
|
|
|
70
72
|
"metadata" => metadata,
|
|
71
73
|
"enable_social" => enable_social
|
|
72
74
|
},
|
|
75
|
+
headers: { "Idempotency-Key" => idempotency_key },
|
|
73
76
|
response: Types::EmailRiskResponse,
|
|
74
77
|
request_options: request_options
|
|
75
78
|
)
|
|
@@ -161,6 +164,7 @@ module Didit
|
|
|
161
164
|
# @param email_no_social_presence_action [String] Action when the social footprint check finds the address
|
|
162
165
|
# registered on none of the platforms it covers. Only NO_ACTION and DECLINE are accepted on this endpoint;
|
|
163
166
|
# REVIEW is available on the workflow configuration key of the same name.
|
|
167
|
+
# @param idempotency_key [String] sent as the Idempotency-Key header
|
|
164
168
|
# @param request_options [Hash, nil] :timeout, :max_retries, :extra_headers, :extra_query, :extra_body
|
|
165
169
|
# @return [Didit::Types::EmailVerificationCheckResponse]
|
|
166
170
|
def check_code(
|
|
@@ -175,6 +179,7 @@ module Didit
|
|
|
175
179
|
frequent_email_breach_action: OMIT,
|
|
176
180
|
enable_social: OMIT,
|
|
177
181
|
email_no_social_presence_action: OMIT,
|
|
182
|
+
idempotency_key: OMIT,
|
|
178
183
|
request_options: nil
|
|
179
184
|
)
|
|
180
185
|
@client.request(
|
|
@@ -193,6 +198,7 @@ module Didit
|
|
|
193
198
|
"enable_social" => enable_social,
|
|
194
199
|
"email_no_social_presence_action" => email_no_social_presence_action
|
|
195
200
|
},
|
|
201
|
+
headers: { "Idempotency-Key" => idempotency_key },
|
|
196
202
|
response: Types::EmailVerificationCheckResponse,
|
|
197
203
|
request_options: request_options
|
|
198
204
|
)
|
|
@@ -253,9 +259,18 @@ module Didit
|
|
|
253
259
|
# and the Business Console. Use it to correlate Didit's `request_id` with your user record.
|
|
254
260
|
# @param metadata [Hash, nil] Optional free-form JSON object persisted on the session and echoed back in the
|
|
255
261
|
# send response, the matching check response, webhooks, and the Business Console.
|
|
262
|
+
# @param idempotency_key [String] sent as the Idempotency-Key header
|
|
256
263
|
# @param request_options [Hash, nil] :timeout, :max_retries, :extra_headers, :extra_query, :extra_body
|
|
257
264
|
# @return [Didit::Types::EmailVerificationSendResponse]
|
|
258
|
-
def send_code(
|
|
265
|
+
def send_code(
|
|
266
|
+
email:,
|
|
267
|
+
options: OMIT,
|
|
268
|
+
signals: OMIT,
|
|
269
|
+
vendor_data: OMIT,
|
|
270
|
+
metadata: OMIT,
|
|
271
|
+
idempotency_key: OMIT,
|
|
272
|
+
request_options: nil
|
|
273
|
+
)
|
|
259
274
|
@client.request(
|
|
260
275
|
:post,
|
|
261
276
|
"/v3/email/send/",
|
|
@@ -266,6 +281,7 @@ module Didit
|
|
|
266
281
|
"vendor_data" => vendor_data,
|
|
267
282
|
"metadata" => metadata
|
|
268
283
|
},
|
|
284
|
+
headers: { "Idempotency-Key" => idempotency_key },
|
|
269
285
|
response: Types::EmailVerificationSendResponse,
|
|
270
286
|
request_options: request_options
|
|
271
287
|
)
|
|
@@ -68,6 +68,7 @@ module Didit
|
|
|
68
68
|
# @param metadata [Hash] Optional JSON object stored with the session (when `save_api_request=true`) and echoed
|
|
69
69
|
# back in the response. In multipart requests, send it as a JSON-encoded string field (e.g.
|
|
70
70
|
# `metadata={"flow":"login"}`) - it is parsed into an object.
|
|
71
|
+
# @param idempotency_key [String] sent as the Idempotency-Key header
|
|
71
72
|
# @param request_options [Hash, nil] :timeout, :max_retries, :extra_headers, :extra_query, :extra_body
|
|
72
73
|
# @return [Didit::Types::FaceMatchCompareResponse]
|
|
73
74
|
def compare(
|
|
@@ -78,6 +79,7 @@ module Didit
|
|
|
78
79
|
save_api_request: OMIT,
|
|
79
80
|
vendor_data: OMIT,
|
|
80
81
|
metadata: OMIT,
|
|
82
|
+
idempotency_key: OMIT,
|
|
81
83
|
request_options: nil
|
|
82
84
|
)
|
|
83
85
|
@client.request(
|
|
@@ -94,6 +96,7 @@ module Didit
|
|
|
94
96
|
},
|
|
95
97
|
encoding: :multipart,
|
|
96
98
|
file_fields: %w[ref_image user_image],
|
|
99
|
+
headers: { "Idempotency-Key" => idempotency_key },
|
|
97
100
|
response: Types::FaceMatchCompareResponse,
|
|
98
101
|
request_options: request_options
|
|
99
102
|
)
|
|
@@ -70,6 +70,7 @@ module Didit
|
|
|
70
70
|
# session and echoed back. It does not exclude same-user faces from the search results.
|
|
71
71
|
# @param metadata [Hash] Optional JSON object stored with the session (when `save_api_request=true`) and echoed
|
|
72
72
|
# back. In multipart requests, send it as a JSON-encoded string field - it is parsed into an object.
|
|
73
|
+
# @param idempotency_key [String] sent as the Idempotency-Key header
|
|
73
74
|
# @param request_options [Hash, nil] :timeout, :max_retries, :extra_headers, :extra_query, :extra_body
|
|
74
75
|
# @return [Didit::Types::FaceSearchSearchResponse]
|
|
75
76
|
def search(
|
|
@@ -79,6 +80,7 @@ module Didit
|
|
|
79
80
|
save_api_request: OMIT,
|
|
80
81
|
vendor_data: OMIT,
|
|
81
82
|
metadata: OMIT,
|
|
83
|
+
idempotency_key: OMIT,
|
|
82
84
|
request_options: nil
|
|
83
85
|
)
|
|
84
86
|
@client.request(
|
|
@@ -94,6 +96,7 @@ module Didit
|
|
|
94
96
|
},
|
|
95
97
|
encoding: :multipart,
|
|
96
98
|
file_fields: %w[user_image],
|
|
99
|
+
headers: { "Idempotency-Key" => idempotency_key },
|
|
97
100
|
response: Types::FaceSearchSearchResponse,
|
|
98
101
|
request_options: request_options
|
|
99
102
|
)
|
|
@@ -29,6 +29,7 @@ module Didit
|
|
|
29
29
|
# @param checks [Hash]
|
|
30
30
|
# @param vendor_data [String]
|
|
31
31
|
# @param metadata [Object]
|
|
32
|
+
# @param idempotency_key [String] sent as the Idempotency-Key header
|
|
32
33
|
# @param request_options [Hash, nil] :timeout, :max_retries, :extra_headers, :extra_query, :extra_body
|
|
33
34
|
# @return [Didit::Types::FraudCheckResponse]
|
|
34
35
|
def create(
|
|
@@ -40,6 +41,7 @@ module Didit
|
|
|
40
41
|
checks: OMIT,
|
|
41
42
|
vendor_data: OMIT,
|
|
42
43
|
metadata: OMIT,
|
|
44
|
+
idempotency_key: OMIT,
|
|
43
45
|
request_options: nil
|
|
44
46
|
)
|
|
45
47
|
@client.request(
|
|
@@ -55,6 +57,7 @@ module Didit
|
|
|
55
57
|
"vendor_data" => vendor_data,
|
|
56
58
|
"metadata" => metadata
|
|
57
59
|
},
|
|
60
|
+
headers: { "Idempotency-Key" => idempotency_key },
|
|
58
61
|
response: Types::FraudCheckResponse,
|
|
59
62
|
request_options: request_options
|
|
60
63
|
)
|
|
@@ -76,6 +79,7 @@ module Didit
|
|
|
76
79
|
# @param checks [Hash]
|
|
77
80
|
# @param vendor_data [String]
|
|
78
81
|
# @param metadata [Object]
|
|
82
|
+
# @param idempotency_key [String] sent as the Idempotency-Key header
|
|
79
83
|
# @param request_options [Hash, nil] :timeout, :max_retries, :extra_headers, :extra_query, :extra_body
|
|
80
84
|
# @return [Didit::Types::FraudCheckPlan]
|
|
81
85
|
def plan(
|
|
@@ -87,6 +91,7 @@ module Didit
|
|
|
87
91
|
checks: OMIT,
|
|
88
92
|
vendor_data: OMIT,
|
|
89
93
|
metadata: OMIT,
|
|
94
|
+
idempotency_key: OMIT,
|
|
90
95
|
request_options: nil
|
|
91
96
|
)
|
|
92
97
|
@client.request(
|
|
@@ -102,6 +107,7 @@ module Didit
|
|
|
102
107
|
"vendor_data" => vendor_data,
|
|
103
108
|
"metadata" => metadata
|
|
104
109
|
},
|
|
110
|
+
headers: { "Idempotency-Key" => idempotency_key },
|
|
105
111
|
response: Types::FraudCheckPlan,
|
|
106
112
|
request_options: request_options
|
|
107
113
|
)
|
|
@@ -113,6 +113,7 @@ module Didit
|
|
|
113
113
|
# @param metadata [Hash] Optional JSON object stored with the session (when `save_api_request=true`) and echoed
|
|
114
114
|
# back in the response. In multipart requests, send it as a JSON-encoded string field (e.g.
|
|
115
115
|
# `metadata={"flow":"onboarding"}`) - it is parsed into an object.
|
|
116
|
+
# @param idempotency_key [String] sent as the Idempotency-Key header
|
|
116
117
|
# @param request_options [Hash, nil] :timeout, :max_retries, :extra_headers, :extra_query, :extra_body
|
|
117
118
|
# @return [Didit::Types::IdVerificationVerifyResponse]
|
|
118
119
|
def verify(
|
|
@@ -131,6 +132,7 @@ module Didit
|
|
|
131
132
|
save_api_request: OMIT,
|
|
132
133
|
vendor_data: OMIT,
|
|
133
134
|
metadata: OMIT,
|
|
135
|
+
idempotency_key: OMIT,
|
|
134
136
|
request_options: nil
|
|
135
137
|
)
|
|
136
138
|
@client.request(
|
|
@@ -155,6 +157,7 @@ module Didit
|
|
|
155
157
|
},
|
|
156
158
|
encoding: :multipart,
|
|
157
159
|
file_fields: %w[back_image front_image],
|
|
160
|
+
headers: { "Idempotency-Key" => idempotency_key },
|
|
158
161
|
response: Types::IdVerificationVerifyResponse,
|
|
159
162
|
request_options: request_options
|
|
160
163
|
)
|
|
@@ -16,13 +16,15 @@ module Didit
|
|
|
16
16
|
# +POST /v3/id-verification/wallets/verifications/{request_id}/cancel/+
|
|
17
17
|
#
|
|
18
18
|
# @param request_id [String] The request_id the start endpoint returned.
|
|
19
|
+
# @param idempotency_key [String] sent as the Idempotency-Key header
|
|
19
20
|
# @param request_options [Hash, nil] :timeout, :max_retries, :extra_headers, :extra_query, :extra_body
|
|
20
21
|
# @return [Didit::Types::DigitalIdWalletApiWalletVerificationResponse]
|
|
21
|
-
def cancel_verification(request_id, request_options: nil)
|
|
22
|
+
def cancel_verification(request_id, idempotency_key: OMIT, request_options: nil)
|
|
22
23
|
@client.request(
|
|
23
24
|
:post,
|
|
24
25
|
"/v3/id-verification/wallets/verifications/{request_id}/cancel/",
|
|
25
26
|
path_params: { "request_id" => request_id },
|
|
27
|
+
headers: { "Idempotency-Key" => idempotency_key },
|
|
26
28
|
response: Types::DigitalIdWalletApiWalletVerificationResponse,
|
|
27
29
|
request_options: request_options
|
|
28
30
|
)
|
|
@@ -55,13 +57,15 @@ module Didit
|
|
|
55
57
|
# +POST /v3/id-verification/wallets/verifications/{request_id}/poll/+
|
|
56
58
|
#
|
|
57
59
|
# @param request_id [String] The request_id the start endpoint returned.
|
|
60
|
+
# @param idempotency_key [String] sent as the Idempotency-Key header
|
|
58
61
|
# @param request_options [Hash, nil] :timeout, :max_retries, :extra_headers, :extra_query, :extra_body
|
|
59
62
|
# @return [Didit::Types::DigitalIdWalletApiWalletVerificationResponse]
|
|
60
|
-
def poll_verification(request_id, request_options: nil)
|
|
63
|
+
def poll_verification(request_id, idempotency_key: OMIT, request_options: nil)
|
|
61
64
|
@client.request(
|
|
62
65
|
:post,
|
|
63
66
|
"/v3/id-verification/wallets/verifications/{request_id}/poll/",
|
|
64
67
|
path_params: { "request_id" => request_id },
|
|
68
|
+
headers: { "Idempotency-Key" => idempotency_key },
|
|
65
69
|
response: Types::DigitalIdWalletApiWalletVerificationResponse,
|
|
66
70
|
request_options: request_options
|
|
67
71
|
)
|
|
@@ -1411,11 +1415,10 @@ module Didit
|
|
|
1411
1415
|
|
|
1412
1416
|
# Start UAE PASS verification
|
|
1413
1417
|
#
|
|
1414
|
-
#
|
|
1415
|
-
#
|
|
1416
|
-
#
|
|
1417
|
-
#
|
|
1418
|
-
# applications get a deterministic simulation (simulated: true) that never contacts the provider.
|
|
1418
|
+
# UAE PASS (UAE Digital Government Authority; ARE) never returns an identity: it only confirms whether the
|
|
1419
|
+
# details you declared for your user (expected_details: name, date of birth, Emirates ID number) match, so it
|
|
1420
|
+
# runs only inside a verification session created with expected_details. This endpoint never starts it and
|
|
1421
|
+
# always answers 403 wallet_unavailable, sandbox applications included.
|
|
1419
1422
|
#
|
|
1420
1423
|
# +POST /v3/id-verification/wallets/uae-pass/+
|
|
1421
1424
|
#
|
|
@@ -1533,9 +1536,10 @@ module Didit
|
|
|
1533
1536
|
# @param response [Hash] Exactly what the wallet returned: {protocol, data} of the DigitalCredential from
|
|
1534
1537
|
# navigator.credentials.get, or the parsed credentialJson of Android's DigitalCredential. Encrypted to Didit; do
|
|
1535
1538
|
# not alter it.
|
|
1539
|
+
# @param idempotency_key [String] sent as the Idempotency-Key header
|
|
1536
1540
|
# @param request_options [Hash, nil] :timeout, :max_retries, :extra_headers, :extra_query, :extra_body
|
|
1537
1541
|
# @return [Didit::Types::DigitalIdWalletApiWalletVerificationResponse]
|
|
1538
|
-
def submit_verification_response(request_id, response:, request_options: nil)
|
|
1542
|
+
def submit_verification_response(request_id, response:, idempotency_key: OMIT, request_options: nil)
|
|
1539
1543
|
@client.request(
|
|
1540
1544
|
:post,
|
|
1541
1545
|
"/v3/id-verification/wallets/verifications/{request_id}/response/",
|
|
@@ -1543,6 +1547,7 @@ module Didit
|
|
|
1543
1547
|
body: {
|
|
1544
1548
|
"response" => response
|
|
1545
1549
|
},
|
|
1550
|
+
headers: { "Idempotency-Key" => idempotency_key },
|
|
1546
1551
|
response: Types::DigitalIdWalletApiWalletVerificationResponse,
|
|
1547
1552
|
request_options: request_options
|
|
1548
1553
|
)
|
|
@@ -18,6 +18,7 @@ module Didit
|
|
|
18
18
|
# @param send_email [Boolean] Email the person about the decision.
|
|
19
19
|
# @param email_address [String] Required when `send_email` is true.
|
|
20
20
|
# @param email_language [String]
|
|
21
|
+
# @param idempotency_key [String] sent as the Idempotency-Key header
|
|
21
22
|
# @param request_options [Hash, nil] :timeout, :max_retries, :extra_headers, :extra_query, :extra_body
|
|
22
23
|
# @return [Didit::Types::InvestigatorDecision]
|
|
23
24
|
def accept_run(
|
|
@@ -26,6 +27,7 @@ module Didit
|
|
|
26
27
|
send_email: OMIT,
|
|
27
28
|
email_address: OMIT,
|
|
28
29
|
email_language: OMIT,
|
|
30
|
+
idempotency_key: OMIT,
|
|
29
31
|
request_options: nil
|
|
30
32
|
)
|
|
31
33
|
@client.request(
|
|
@@ -38,6 +40,7 @@ module Didit
|
|
|
38
40
|
"email_address" => email_address,
|
|
39
41
|
"email_language" => email_language
|
|
40
42
|
},
|
|
43
|
+
headers: { "Idempotency-Key" => idempotency_key },
|
|
41
44
|
response: Types::InvestigatorDecision,
|
|
42
45
|
request_options: request_options
|
|
43
46
|
)
|
|
@@ -52,15 +55,17 @@ module Didit
|
|
|
52
55
|
# +POST /v3/investigator/runs/batch-accept/+
|
|
53
56
|
#
|
|
54
57
|
# @param run_ids [Array<String>]
|
|
58
|
+
# @param idempotency_key [String] sent as the Idempotency-Key header
|
|
55
59
|
# @param request_options [Hash, nil] :timeout, :max_retries, :extra_headers, :extra_query, :extra_body
|
|
56
60
|
# @return [Didit::Types::InvestigatorBatchAcceptResponse]
|
|
57
|
-
def batch_accept_runs(run_ids:, request_options: nil)
|
|
61
|
+
def batch_accept_runs(run_ids:, idempotency_key: OMIT, request_options: nil)
|
|
58
62
|
@client.request(
|
|
59
63
|
:post,
|
|
60
64
|
"/v3/investigator/runs/batch-accept/",
|
|
61
65
|
body: {
|
|
62
66
|
"run_ids" => run_ids
|
|
63
67
|
},
|
|
68
|
+
headers: { "Idempotency-Key" => idempotency_key },
|
|
64
69
|
response: Types::InvestigatorBatchAcceptResponse,
|
|
65
70
|
request_options: request_options
|
|
66
71
|
)
|
|
@@ -229,6 +234,7 @@ module Didit
|
|
|
229
234
|
# @param send_email [Boolean] Email the person about the decision.
|
|
230
235
|
# @param email_address [String] Required when `send_email` is true.
|
|
231
236
|
# @param email_language [String]
|
|
237
|
+
# @param idempotency_key [String] sent as the Idempotency-Key header
|
|
232
238
|
# @param request_options [Hash, nil] :timeout, :max_retries, :extra_headers, :extra_query, :extra_body
|
|
233
239
|
# @return [Didit::Types::InvestigatorDecision]
|
|
234
240
|
def override_run(
|
|
@@ -239,6 +245,7 @@ module Didit
|
|
|
239
245
|
send_email: OMIT,
|
|
240
246
|
email_address: OMIT,
|
|
241
247
|
email_language: OMIT,
|
|
248
|
+
idempotency_key: OMIT,
|
|
242
249
|
request_options: nil
|
|
243
250
|
)
|
|
244
251
|
@client.request(
|
|
@@ -253,6 +260,7 @@ module Didit
|
|
|
253
260
|
"email_address" => email_address,
|
|
254
261
|
"email_language" => email_language
|
|
255
262
|
},
|
|
263
|
+
headers: { "Idempotency-Key" => idempotency_key },
|
|
256
264
|
response: Types::InvestigatorDecision,
|
|
257
265
|
request_options: request_options
|
|
258
266
|
)
|
|
@@ -403,9 +411,10 @@ module Didit
|
|
|
403
411
|
# @param stage [String]
|
|
404
412
|
# @param monthly_spend_limit [String, nil] Monthly limit in your billing currency, 0.01 to 1,000,000. Null turns
|
|
405
413
|
# it off.
|
|
414
|
+
# @param idempotency_key [String] sent as the Idempotency-Key header
|
|
406
415
|
# @param request_options [Hash, nil] :timeout, :max_retries, :extra_headers, :extra_query, :extra_body
|
|
407
416
|
# @return [Didit::Types::InvestigatorSettings]
|
|
408
|
-
def update_settings(stage: OMIT, monthly_spend_limit: OMIT, request_options: nil)
|
|
417
|
+
def update_settings(stage: OMIT, monthly_spend_limit: OMIT, idempotency_key: OMIT, request_options: nil)
|
|
409
418
|
@client.request(
|
|
410
419
|
:patch,
|
|
411
420
|
"/v3/investigator/settings/",
|
|
@@ -413,6 +422,7 @@ module Didit
|
|
|
413
422
|
"stage" => stage,
|
|
414
423
|
"monthly_spend_limit" => monthly_spend_limit
|
|
415
424
|
},
|
|
425
|
+
headers: { "Idempotency-Key" => idempotency_key },
|
|
416
426
|
response: Types::InvestigatorSettings,
|
|
417
427
|
request_options: request_options
|
|
418
428
|
)
|
data/lib/didit/resources/ip.rb
CHANGED
|
@@ -39,6 +39,7 @@ module Didit
|
|
|
39
39
|
# the response.
|
|
40
40
|
# @param metadata [Hash, nil] Your non-sensitive JSON metadata. Stored on the API session and echoed in the
|
|
41
41
|
# response.
|
|
42
|
+
# @param idempotency_key [String] sent as the Idempotency-Key header
|
|
42
43
|
# @param request_options [Hash, nil] :timeout, :max_retries, :extra_headers, :extra_query, :extra_body
|
|
43
44
|
# @return [Didit::Types::IPRiskResponse]
|
|
44
45
|
def assess_risk(
|
|
@@ -47,6 +48,7 @@ module Didit
|
|
|
47
48
|
user_agent: OMIT,
|
|
48
49
|
vendor_data: OMIT,
|
|
49
50
|
metadata: OMIT,
|
|
51
|
+
idempotency_key: OMIT,
|
|
50
52
|
request_options: nil
|
|
51
53
|
)
|
|
52
54
|
@client.request(
|
|
@@ -59,6 +61,7 @@ module Didit
|
|
|
59
61
|
"vendor_data" => vendor_data,
|
|
60
62
|
"metadata" => metadata
|
|
61
63
|
},
|
|
64
|
+
headers: { "Idempotency-Key" => idempotency_key },
|
|
62
65
|
response: Types::IPRiskResponse,
|
|
63
66
|
request_options: request_options
|
|
64
67
|
)
|
data/lib/didit/resources/kyb.rb
CHANGED
|
@@ -41,6 +41,7 @@ module Didit
|
|
|
41
41
|
# @param metadata [Hash, nil] Free-form JSON stored with the business session and echoed back.
|
|
42
42
|
# @param save_api_request [Boolean] Must be `true` (the default). KYB registry selects are always persisted so
|
|
43
43
|
# billing and retrieval can be tracked; `false` returns `400`.
|
|
44
|
+
# @param idempotency_key [String] sent as the Idempotency-Key header
|
|
44
45
|
# @param request_options [Hash, nil] :timeout, :max_retries, :extra_headers, :extra_query, :extra_body
|
|
45
46
|
# @return [Didit::Types::KybListShareholdersResponse, Didit::Types::KybListShareholdersResponse202]
|
|
46
47
|
def list_shareholders(
|
|
@@ -48,6 +49,7 @@ module Didit
|
|
|
48
49
|
vendor_data: OMIT,
|
|
49
50
|
metadata: OMIT,
|
|
50
51
|
save_api_request: OMIT,
|
|
52
|
+
idempotency_key: OMIT,
|
|
51
53
|
request_options: nil
|
|
52
54
|
)
|
|
53
55
|
@client.request(
|
|
@@ -59,6 +61,7 @@ module Didit
|
|
|
59
61
|
"metadata" => metadata,
|
|
60
62
|
"save_api_request" => save_api_request
|
|
61
63
|
},
|
|
64
|
+
headers: { "Idempotency-Key" => idempotency_key },
|
|
62
65
|
response: { 200 => Types::KybListShareholdersResponse, 202 => Types::KybListShareholdersResponse202 },
|
|
63
66
|
request_options: request_options
|
|
64
67
|
)
|
|
@@ -101,9 +104,17 @@ module Didit
|
|
|
101
104
|
# @param metadata [Hash, nil] Free-form JSON stored with the business session and echoed back.
|
|
102
105
|
# @param save_api_request [Boolean] Must be `true` (the default). KYB registry selects are always persisted so
|
|
103
106
|
# billing and retrieval can be tracked; `false` returns `400`.
|
|
107
|
+
# @param idempotency_key [String] sent as the Idempotency-Key header
|
|
104
108
|
# @param request_options [Hash, nil] :timeout, :max_retries, :extra_headers, :extra_query, :extra_body
|
|
105
109
|
# @return [Didit::Types::KybListUbosResponse, Didit::Types::KybListUbosResponse202]
|
|
106
|
-
def list_ubos(
|
|
110
|
+
def list_ubos(
|
|
111
|
+
kyb_response_id:,
|
|
112
|
+
vendor_data: OMIT,
|
|
113
|
+
metadata: OMIT,
|
|
114
|
+
save_api_request: OMIT,
|
|
115
|
+
idempotency_key: OMIT,
|
|
116
|
+
request_options: nil
|
|
117
|
+
)
|
|
107
118
|
@client.request(
|
|
108
119
|
:post,
|
|
109
120
|
"/v3/kyb/ubo/",
|
|
@@ -113,6 +124,7 @@ module Didit
|
|
|
113
124
|
"metadata" => metadata,
|
|
114
125
|
"save_api_request" => save_api_request
|
|
115
126
|
},
|
|
127
|
+
headers: { "Idempotency-Key" => idempotency_key },
|
|
116
128
|
response: { 200 => Types::KybListUbosResponse, 202 => Types::KybListUbosResponse202 },
|
|
117
129
|
request_options: request_options
|
|
118
130
|
)
|
|
@@ -183,6 +195,7 @@ module Didit
|
|
|
183
195
|
# @param metadata [Hash, nil] Free-form JSON; echoed back and included in the webhook callback.
|
|
184
196
|
# @param webhook_url [String] Switches the search to asynchronous mode: the API returns immediately and POSTs an
|
|
185
197
|
# unsigned `kyb.registry_search.resolved` callback to this URL when the candidate list is ready.
|
|
198
|
+
# @param idempotency_key [String] sent as the Idempotency-Key header
|
|
186
199
|
# @param request_options [Hash, nil] :timeout, :max_retries, :extra_headers, :extra_query, :extra_body
|
|
187
200
|
# @return [Didit::Types::KybSearchResponse]
|
|
188
201
|
def search(
|
|
@@ -194,6 +207,7 @@ module Didit
|
|
|
194
207
|
vendor_data: OMIT,
|
|
195
208
|
metadata: OMIT,
|
|
196
209
|
webhook_url: OMIT,
|
|
210
|
+
idempotency_key: OMIT,
|
|
197
211
|
request_options: nil
|
|
198
212
|
)
|
|
199
213
|
@client.request(
|
|
@@ -209,6 +223,7 @@ module Didit
|
|
|
209
223
|
"metadata" => metadata,
|
|
210
224
|
"webhook_url" => webhook_url
|
|
211
225
|
},
|
|
226
|
+
headers: { "Idempotency-Key" => idempotency_key },
|
|
212
227
|
response: Types::KybSearchResponse,
|
|
213
228
|
request_options: request_options
|
|
214
229
|
)
|
|
@@ -242,9 +257,17 @@ module Didit
|
|
|
242
257
|
# @param metadata [Hash, nil] Free-form JSON stored with the business session and echoed back.
|
|
243
258
|
# @param save_api_request [Boolean] Must be `true` (the default). KYB registry selects are always persisted so
|
|
244
259
|
# billing and retrieval can be tracked; `false` returns `400`.
|
|
260
|
+
# @param idempotency_key [String] sent as the Idempotency-Key header
|
|
245
261
|
# @param request_options [Hash, nil] :timeout, :max_retries, :extra_headers, :extra_query, :extra_body
|
|
246
262
|
# @return [Didit::Types::KybSelectResponse]
|
|
247
|
-
def select(
|
|
263
|
+
def select(
|
|
264
|
+
kyb_response_id:,
|
|
265
|
+
vendor_data: OMIT,
|
|
266
|
+
metadata: OMIT,
|
|
267
|
+
save_api_request: OMIT,
|
|
268
|
+
idempotency_key: OMIT,
|
|
269
|
+
request_options: nil
|
|
270
|
+
)
|
|
248
271
|
@client.request(
|
|
249
272
|
:post,
|
|
250
273
|
"/v3/kyb/select/",
|
|
@@ -254,6 +277,7 @@ module Didit
|
|
|
254
277
|
"metadata" => metadata,
|
|
255
278
|
"save_api_request" => save_api_request
|
|
256
279
|
},
|
|
280
|
+
headers: { "Idempotency-Key" => idempotency_key },
|
|
257
281
|
response: Types::KybSelectResponse,
|
|
258
282
|
request_options: request_options
|
|
259
283
|
)
|
|
@@ -30,9 +30,10 @@ module Didit
|
|
|
30
30
|
# (ISO 3166-1 alpha-3), `user` or `business` (your `vendor_data`), or `key` (any string). It decides how entry
|
|
31
31
|
# values are validated and matched. Cannot be changed later.
|
|
32
32
|
# @param description [String] Optional free-text description.
|
|
33
|
+
# @param idempotency_key [String] sent as the Idempotency-Key header
|
|
33
34
|
# @param request_options [Hash, nil] :timeout, :max_retries, :extra_headers, :extra_query, :extra_body
|
|
34
35
|
# @return [Didit::Types::ComplianceList]
|
|
35
|
-
def create(name:, list_type:, entry_type:, description: OMIT, request_options: nil)
|
|
36
|
+
def create(name:, list_type:, entry_type:, description: OMIT, idempotency_key: OMIT, request_options: nil)
|
|
36
37
|
@client.request(
|
|
37
38
|
:post,
|
|
38
39
|
"/v3/lists/",
|
|
@@ -42,6 +43,7 @@ module Didit
|
|
|
42
43
|
"entry_type" => entry_type,
|
|
43
44
|
"description" => description
|
|
44
45
|
},
|
|
46
|
+
headers: { "Idempotency-Key" => idempotency_key },
|
|
45
47
|
response: Types::ComplianceList,
|
|
46
48
|
request_options: request_options
|
|
47
49
|
)
|
|
@@ -59,13 +61,15 @@ module Didit
|
|
|
59
61
|
# +DELETE /v3/lists/{list_uuid}/+
|
|
60
62
|
#
|
|
61
63
|
# @param list_uuid [String] UUID of the list, as returned by List lists or Create a list.
|
|
64
|
+
# @param idempotency_key [String] sent as the Idempotency-Key header
|
|
62
65
|
# @param request_options [Hash, nil] :timeout, :max_retries, :extra_headers, :extra_query, :extra_body
|
|
63
66
|
# @return [nil]
|
|
64
|
-
def delete(list_uuid, request_options: nil)
|
|
67
|
+
def delete(list_uuid, idempotency_key: OMIT, request_options: nil)
|
|
65
68
|
@client.request(
|
|
66
69
|
:delete,
|
|
67
70
|
"/v3/lists/{list_uuid}/",
|
|
68
71
|
path_params: { "list_uuid" => list_uuid },
|
|
72
|
+
headers: { "Idempotency-Key" => idempotency_key },
|
|
69
73
|
request_options: request_options
|
|
70
74
|
)
|
|
71
75
|
end
|
|
@@ -140,9 +144,10 @@ module Didit
|
|
|
140
144
|
# @param list_uuid [String] UUID of the list, as returned by List lists or Create a list.
|
|
141
145
|
# @param name [String] New name. Must differ from the name of every other list of the application.
|
|
142
146
|
# @param description [String] New description. Send an empty string to clear it.
|
|
147
|
+
# @param idempotency_key [String] sent as the Idempotency-Key header
|
|
143
148
|
# @param request_options [Hash, nil] :timeout, :max_retries, :extra_headers, :extra_query, :extra_body
|
|
144
149
|
# @return [Didit::Types::ListsUpdateResponse]
|
|
145
|
-
def update(list_uuid, name: OMIT, description: OMIT, request_options: nil)
|
|
150
|
+
def update(list_uuid, name: OMIT, description: OMIT, idempotency_key: OMIT, request_options: nil)
|
|
146
151
|
@client.request(
|
|
147
152
|
:patch,
|
|
148
153
|
"/v3/lists/{list_uuid}/",
|
|
@@ -151,6 +156,7 @@ module Didit
|
|
|
151
156
|
"name" => name,
|
|
152
157
|
"description" => description
|
|
153
158
|
},
|
|
159
|
+
headers: { "Idempotency-Key" => idempotency_key },
|
|
154
160
|
response: Types::ListsUpdateResponse,
|
|
155
161
|
request_options: request_options
|
|
156
162
|
)
|
|
@@ -201,6 +207,7 @@ module Didit
|
|
|
201
207
|
# `reference_id` so the console links back to the source. `reference_image_url` and `front_image_url` are set
|
|
202
208
|
# by Didit only and are dropped if you send them. For an entry read from a session, Didit's keys are merged
|
|
203
209
|
# with yours.
|
|
210
|
+
# @param idempotency_key [String] sent as the Idempotency-Key header
|
|
204
211
|
# @param request_options [Hash, nil] :timeout, :max_retries, :extra_headers, :extra_query, :extra_body
|
|
205
212
|
# @return [Didit::Types::ComplianceListEntry]
|
|
206
213
|
def create(
|
|
@@ -213,6 +220,7 @@ module Didit
|
|
|
213
220
|
display_label: OMIT,
|
|
214
221
|
comment: OMIT,
|
|
215
222
|
metadata: OMIT,
|
|
223
|
+
idempotency_key: OMIT,
|
|
216
224
|
request_options: nil
|
|
217
225
|
)
|
|
218
226
|
@client.request(
|
|
@@ -229,6 +237,7 @@ module Didit
|
|
|
229
237
|
"comment" => comment,
|
|
230
238
|
"metadata" => metadata
|
|
231
239
|
},
|
|
240
|
+
headers: { "Idempotency-Key" => idempotency_key },
|
|
232
241
|
response: Types::ComplianceListEntry,
|
|
233
242
|
request_options: request_options
|
|
234
243
|
)
|
|
@@ -248,13 +257,15 @@ module Didit
|
|
|
248
257
|
#
|
|
249
258
|
# @param list_uuid [String] UUID of the list that holds the entry.
|
|
250
259
|
# @param entry_uuid [String] UUID of the entry, as returned by List list entries or Create a list entry.
|
|
260
|
+
# @param idempotency_key [String] sent as the Idempotency-Key header
|
|
251
261
|
# @param request_options [Hash, nil] :timeout, :max_retries, :extra_headers, :extra_query, :extra_body
|
|
252
262
|
# @return [nil]
|
|
253
|
-
def delete(list_uuid, entry_uuid, request_options: nil)
|
|
263
|
+
def delete(list_uuid, entry_uuid, idempotency_key: OMIT, request_options: nil)
|
|
254
264
|
@client.request(
|
|
255
265
|
:delete,
|
|
256
266
|
"/v3/lists/{list_uuid}/entries/{entry_uuid}/",
|
|
257
267
|
path_params: { "list_uuid" => list_uuid, "entry_uuid" => entry_uuid },
|
|
268
|
+
headers: { "Idempotency-Key" => idempotency_key },
|
|
258
269
|
request_options: request_options
|
|
259
270
|
)
|
|
260
271
|
end
|
|
@@ -311,9 +322,10 @@ module Didit
|
|
|
311
322
|
# @param image [String] Base64-encoded JPEG or PNG, at most 2 MB once decoded, showing a clearly visible face.
|
|
312
323
|
# Send the bare base64 string, without a `data:image/...;base64,` prefix.
|
|
313
324
|
# @param comment [String] Optional free-text note, such as the reason for listing.
|
|
325
|
+
# @param idempotency_key [String] sent as the Idempotency-Key header
|
|
314
326
|
# @param request_options [Hash, nil] :timeout, :max_retries, :extra_headers, :extra_query, :extra_body
|
|
315
327
|
# @return [Didit::Types::ComplianceListEntry]
|
|
316
|
-
def upload_face(list_uuid, image:, comment: OMIT, request_options: nil)
|
|
328
|
+
def upload_face(list_uuid, image:, comment: OMIT, idempotency_key: OMIT, request_options: nil)
|
|
317
329
|
@client.request(
|
|
318
330
|
:post,
|
|
319
331
|
"/v3/lists/{list_uuid}/entries/face-upload/",
|
|
@@ -322,6 +334,7 @@ module Didit
|
|
|
322
334
|
"image" => image,
|
|
323
335
|
"comment" => comment
|
|
324
336
|
},
|
|
337
|
+
headers: { "Idempotency-Key" => idempotency_key },
|
|
325
338
|
response: Types::ComplianceListEntry,
|
|
326
339
|
request_options: request_options
|
|
327
340
|
)
|