didit-sdk 2.13.1 → 2.15.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 +21 -0
- data/lib/didit/resources/account.rb +6 -4
- data/lib/didit/resources/address_validation.rb +2 -1
- data/lib/didit/resources/bank.rb +9 -4
- data/lib/didit/resources/cases.rb +62 -16
- data/lib/didit/resources/sessions.rb +18 -9
- data/lib/didit/resources/transactions.rb +62 -6
- data/lib/didit/resources/travel_rule.rb +40 -1
- data/lib/didit/resources/workflows.rb +12 -0
- data/lib/didit/types/account_components.rb +5 -4
- data/lib/didit/types/cases.rb +0 -9
- data/lib/didit/types/components.rb +165 -61
- data/lib/didit/types/sessions.rb +4 -3
- data/lib/didit/types/transactions.rb +33 -1
- data/lib/didit/types.rb +17 -9
- data/lib/didit/version.rb +1 -1
- data/sig/didit/resources/cases.rbs +4 -3
- data/sig/didit/resources/sessions.rbs +1 -1
- data/sig/didit/resources/transactions.rbs +2 -1
- data/sig/didit/resources/travel_rule.rbs +2 -1
- data/sig/didit/resources/workflows.rbs +2 -2
- data/sig/didit/types/account_components.rbs +1 -0
- data/sig/didit/types/cases.rbs +5 -13
- data/sig/didit/types/components.rbs +142 -55
- data/sig/didit/types/sessions.rbs +2 -1
- data/sig/didit/types/transactions.rbs +29 -2
- data/sig/didit/types/travel_rule.rbs +2 -0
- data/sig/didit/types/workflows.rbs +2 -2
- metadata +1 -1
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA256:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: 97801d2b0ff521137a0a3ee9b944982989e81d9f6af6612210d1a67ac496ca84
|
|
4
|
+
data.tar.gz: 774649779cd7c8ecb6b6bc45ecfc78ab9dd6ceb1059363cb3bc937a8b5787a6f
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: ffb2f0d32d840b2d75eb6ca483aad10fd6e24b1097dbb482734c545caf1f196bf863430143a4fe6edb109fc667759a9fd3ead4c6a4656e3ad12928badeb297b1
|
|
7
|
+
data.tar.gz: d30065b7e2b1c6507e9eda1943a7f6a19bac26d3d71614c6d3e629a4a24d61a8f2596bdea7c4ebe9cd7c8c095291d6ed6bc5546f78873acf741e7610ede53d1c
|
data/CHANGELOG.md
CHANGED
|
@@ -1,5 +1,26 @@
|
|
|
1
1
|
# Changelog
|
|
2
2
|
|
|
3
|
+
## [2.15.0](https://github.com/didit-protocol/sdk-ruby/compare/v2.14.0...v2.15.0) (2026-11-13)
|
|
4
|
+
|
|
5
|
+
|
|
6
|
+
### Features
|
|
7
|
+
|
|
8
|
+
* **spec:** sync API spec 2026-11-13 ([9668e12](https://github.com/didit-protocol/sdk-ruby/commit/9668e1273ce001ec5208334bf1fa1fd61f9ebe51))
|
|
9
|
+
|
|
10
|
+
## [2.14.0](https://github.com/didit-protocol/sdk-ruby/compare/v2.13.1...v2.14.0) (2026-11-12)
|
|
11
|
+
|
|
12
|
+
|
|
13
|
+
### API changes that can break typed code
|
|
14
|
+
|
|
15
|
+
* **spec:** `cases.blueprints.publish` (`POST /v3/organization/{organization_id}/application/{application_id}/cases/blueprints/{blueprint_uuid}/publish/`): response `content_config`: type changed from any to object ([f28c0c9](https://github.com/didit-protocol/sdk-ruby/commit/f28c0c91f98e2d6081605397792d6af844c0939b))
|
|
16
|
+
* **spec:** `cases.create` (`POST /v3/organization/{organization_id}/application/{application_id}/cases/`): request body `links[].entity_type`: added (required) ([f28c0c9](https://github.com/didit-protocol/sdk-ruby/commit/f28c0c91f98e2d6081605397792d6af844c0939b))
|
|
17
|
+
* **spec:** `cases.create` (`POST /v3/organization/{organization_id}/application/{application_id}/cases/`): request body `links[].entity_uuid`: added (required) ([f28c0c9](https://github.com/didit-protocol/sdk-ruby/commit/f28c0c91f98e2d6081605397792d6af844c0939b))
|
|
18
|
+
|
|
19
|
+
|
|
20
|
+
### Features
|
|
21
|
+
|
|
22
|
+
* **spec:** sync API spec 2026-11-12 ([f28c0c9](https://github.com/didit-protocol/sdk-ruby/commit/f28c0c91f98e2d6081605397792d6af844c0939b))
|
|
23
|
+
|
|
3
24
|
## [2.13.1](https://github.com/didit-protocol/sdk-ruby/compare/v2.13.0...v2.13.1) (2026-11-12)
|
|
4
25
|
|
|
5
26
|
|
|
@@ -157,8 +157,9 @@ module Didit
|
|
|
157
157
|
# @param description [String] Internal description for the application (not shown to end users).
|
|
158
158
|
# @param data_location [String] Where the application's verification data is stored and processed, chosen when
|
|
159
159
|
# the application is created. `eu` is the European Union (Ireland), the default. `au` (Australia, Sydney),
|
|
160
|
-
# `mx` (Mexico)
|
|
161
|
-
# data location is not available yet.` An organization's Sandbox
|
|
160
|
+
# `mx` (Mexico), `ae` (United Arab Emirates) and `us` (United States, N. Virginia) are coming soon: a request
|
|
161
|
+
# that names them answers 400 `This data location is not available yet.` An organization's Sandbox
|
|
162
|
+
# applicatio...
|
|
162
163
|
# @param initiate_login_uri [String] Application sign-in URL for an admin-sent sign-in link. Optional; an
|
|
163
164
|
# empty string disables sending. A nonempty value must use HTTPS and the exact hostname of website_url
|
|
164
165
|
# (subdomains must match), with no userinfo, query, fragment or whitespace and no port other than 443. The
|
|
@@ -281,8 +282,9 @@ module Didit
|
|
|
281
282
|
# @param description [String] Internal description for the application.
|
|
282
283
|
# @param data_location [String] Where the application's verification data is stored and processed, chosen when
|
|
283
284
|
# the application is created. `eu` is the European Union (Ireland), the default. `au` (Australia, Sydney),
|
|
284
|
-
# `mx` (Mexico)
|
|
285
|
-
# data location is not available yet.` An organization's Sandbox
|
|
285
|
+
# `mx` (Mexico), `ae` (United Arab Emirates) and `us` (United States, N. Virginia) are coming soon: a request
|
|
286
|
+
# that names them answers 400 `This data location is not available yet.` An organization's Sandbox
|
|
287
|
+
# applicatio...
|
|
286
288
|
# @param initiate_login_uri [String] Application sign-in URL for an admin-sent sign-in link. Optional; an
|
|
287
289
|
# empty string disables sending. A nonempty value must use HTTPS and the exact hostname of website_url
|
|
288
290
|
# (subdomains must match), with no userinfo, query, fragment or whitespace and no port other than 443. The
|
|
@@ -23,7 +23,8 @@ module Didit
|
|
|
23
23
|
# stored apart from the usage record: no session is created and the result is returned only in this response.
|
|
24
24
|
#
|
|
25
25
|
# **Sandbox.** Sandbox keys validate the request and always return a deterministic `verified` result that echoes
|
|
26
|
-
# the address sent,
|
|
26
|
+
# the address sent, with `address_type` and `is_residential` always `null` (the keys are present), without
|
|
27
|
+
# consuming credits.
|
|
27
28
|
#
|
|
28
29
|
# **Authentication.** Send your application's API key in `x-api-key`. Missing or invalid credentials return
|
|
29
30
|
# `403` - this API never returns `401`.
|
data/lib/didit/resources/bank.rb
CHANGED
|
@@ -16,8 +16,11 @@ module Didit
|
|
|
16
16
|
# business account.
|
|
17
17
|
#
|
|
18
18
|
# **What you get back.** `result` is `match`, `close_match`, `no_match` or `cannot_verify`. On a `close_match`,
|
|
19
|
-
# `holder_name` is the name the bank holds the account under, when the bank returned it. `
|
|
20
|
-
#
|
|
19
|
+
# `holder_name` is the name the bank holds the account under, when the bank returned it. `name_match_score` is
|
|
20
|
+
# the 0 to 100 similarity `result` was decided on, so you can apply your own threshold; `result` stays
|
|
21
|
+
# authoritative, decided with the default thresholds (a `match` from 85, a `close_match` from 70). It is `null`
|
|
22
|
+
# when no name was compared: a `cannot_verify`, or a `no_match` for an account that does not exist. `account`
|
|
23
|
+
# comes back masked to its last 4 characters.
|
|
21
24
|
#
|
|
22
25
|
# **Billing.** Each check the bank answers is billed once at the Account check price of the account's country,
|
|
23
26
|
# whatever the result: a `no_match`, an account that does not exist and a `cannot_verify` are billed too. A
|
|
@@ -28,8 +31,10 @@ module Didit
|
|
|
28
31
|
#
|
|
29
32
|
# **Sandbox.** Use a sandbox API key with the sample account details. A sandbox key calls no bank and is charged
|
|
30
33
|
# nothing. The last 4 characters of the IBAN, else of the account number, choose the answer: `0001` a
|
|
31
|
-
# `close_match` with a `holder_name`, `0002` a `close_match` without one
|
|
32
|
-
# `
|
|
34
|
+
# `close_match` with a `holder_name`, `0002` a `close_match` without one (`name_match_score` 78), `0003` a
|
|
35
|
+
# `no_match` (`name_match_score` 0), `0006` a `no_match` for an account that does not exist (`name_match_score`
|
|
36
|
+
# null), `0004` `cannot_verify`, `0005` a `503` and `0009` a `400`. Any other ending is a `match`
|
|
37
|
+
# (`name_match_score` 100).
|
|
33
38
|
#
|
|
34
39
|
# **API keys.** A scoped API key needs write access to sessions.
|
|
35
40
|
#
|
|
@@ -204,7 +204,10 @@ module Didit
|
|
|
204
204
|
# Create case
|
|
205
205
|
#
|
|
206
206
|
# Create a case anchored to exactly one subject (a user or a business), directly or by deriving the subject from
|
|
207
|
-
# an attached session/transaction link. Source is always `MANUAL` for API-created cases.
|
|
207
|
+
# an attached session/transaction link. Source is always `MANUAL` for API-created cases. Network links require
|
|
208
|
+
# write:cases plus read:networks, Networks access and investigation access for the network scope. The network
|
|
209
|
+
# must be visible and contain the case subject. Manually adding links to network-generated cases is not allowed.
|
|
210
|
+
# An explicit subject is required whenever links includes a network.
|
|
208
211
|
#
|
|
209
212
|
# +POST /v3/organization/{organization_id}/application/{application_id}/cases/+
|
|
210
213
|
#
|
|
@@ -213,10 +216,11 @@ module Didit
|
|
|
213
216
|
# @param priority [String]
|
|
214
217
|
# @param due_at [Time, String, nil]
|
|
215
218
|
# @param tags [Array<String>]
|
|
216
|
-
# @param subject [Hash]
|
|
217
|
-
#
|
|
218
|
-
#
|
|
219
|
-
#
|
|
219
|
+
# @param subject [Hash] Exactly one user or business. Supply explicitly when any network link is supplied, even
|
|
220
|
+
# alongside other link types; otherwise may be derived from links.
|
|
221
|
+
# @param links [Array<Hash>] Up to 500 session, business_session, transaction or network links; at most 20 when
|
|
222
|
+
# review_duplicates=true. When any network link is present, subject must be supplied explicitly. Otherwise the
|
|
223
|
+
# subject may be derived from a linked record.
|
|
220
224
|
# @param assigned_to [String, nil] User UUID to assign immediately.
|
|
221
225
|
# @param review_duplicates [Boolean] Recheck existing investigations before creating the case. When true, a
|
|
222
226
|
# subject with existing cases requires a nonblank separate_incident_reason. The console always enables this
|
|
@@ -770,11 +774,39 @@ module Didit
|
|
|
770
774
|
|
|
771
775
|
# The +cases.blueprints+ resource.
|
|
772
776
|
class Blueprints < Didit::Resource
|
|
777
|
+
# Draft case blueprint with AI
|
|
778
|
+
#
|
|
779
|
+
# Generate an unsaved blueprint proposal. Requires write:cases. Returns a draft object, not a blueprint UUID;
|
|
780
|
+
# no blueprint or saved policy draft is created. Review the proposal, choose assignees and any teams,
|
|
781
|
+
# approvals or routing, then create or update a blueprint separately. Invalid generated content or generation
|
|
782
|
+
# failure returns 503. See [blueprint AI drafts](/management-api/case-blueprints/ai-draft).
|
|
783
|
+
#
|
|
784
|
+
# +POST /v3/organization/{organization_id}/application/{application_id}/cases/blueprints/ai-draft/+
|
|
785
|
+
#
|
|
786
|
+
# @param prompt [String] Nonblank description of the review policy to propose.
|
|
787
|
+
# @param request_options [Hash, nil] :timeout, :max_retries, :extra_headers, :extra_query, :extra_body
|
|
788
|
+
# @return [Didit::Types::CaseBlueprintAiDraftResponse]
|
|
789
|
+
def ai_draft(prompt:, request_options: nil)
|
|
790
|
+
@client.request(
|
|
791
|
+
:post,
|
|
792
|
+
"/v3/organization/{organization_id}/application/{application_id}/cases/blueprints/ai-draft/",
|
|
793
|
+
body: {
|
|
794
|
+
"prompt" => prompt
|
|
795
|
+
},
|
|
796
|
+
scope: :application,
|
|
797
|
+
response: Types::CaseBlueprintAiDraftResponse,
|
|
798
|
+
request_options: request_options
|
|
799
|
+
)
|
|
800
|
+
end
|
|
801
|
+
|
|
773
802
|
# Create blueprint
|
|
774
803
|
#
|
|
775
804
|
# Create a case blueprint: general settings (assignment, escalation, transfer, 4-eyes pairing) plus
|
|
776
805
|
# content_config, the six sections that drive the case page. Set publish=false to create an unpublished draft;
|
|
777
|
-
# Publish creates its first live version. Discarding a never-published draft deletes it.
|
|
806
|
+
# Publish creates its first live version. Discarding a never-published draft deletes it. applies_to accepts
|
|
807
|
+
# the six case-type values. content_config.stages.items[].worked_by is an optional active review-team UUID
|
|
808
|
+
# from this application. These settings are preserved in case policy snapshots; later edits do not change
|
|
809
|
+
# existing snapshots.
|
|
778
810
|
#
|
|
779
811
|
# +POST /v3/organization/{organization_id}/application/{application_id}/cases/blueprints/+
|
|
780
812
|
#
|
|
@@ -792,14 +824,16 @@ module Didit
|
|
|
792
824
|
# @param four_eyes_checker_blueprint [String, nil] Setting this enables 4-eyes review: resolutions on this
|
|
793
825
|
# blueprint stage on the checker blueprint's queue.
|
|
794
826
|
# @param require_resolution_note [Boolean]
|
|
795
|
-
# @param content_config [Hash]
|
|
796
|
-
#
|
|
827
|
+
# @param content_config [Hash] Case content sections and optional review stages. Unknown sections or keys are
|
|
828
|
+
# rejected. Cases retain the policy snapshot accepted when opened; later blueprint edits do not rewrite it.
|
|
797
829
|
# @param is_active [Boolean]
|
|
798
830
|
# @param default_deadline_hours [Integer, nil] Default deadline for newly opened cases. Existing case
|
|
799
831
|
# deadlines are unchanged.
|
|
800
832
|
# @param publish [Boolean] Set false to save a never-published draft. The record remains inactive at version 0
|
|
801
833
|
# until the draft is explicitly published. Omitting this field preserves immediate creation for existing
|
|
802
834
|
# integrations.
|
|
835
|
+
# @param applies_to [Array<String>] Case types this blueprint describes. Optional on create and update; new
|
|
836
|
+
# blueprints default to an empty list. Stored in the accepted case policy snapshot.
|
|
803
837
|
# @param request_options [Hash, nil] :timeout, :max_retries, :extra_headers, :extra_query, :extra_body
|
|
804
838
|
# @return [Didit::Types::CaseBlueprintDetail]
|
|
805
839
|
def create(
|
|
@@ -817,6 +851,7 @@ module Didit
|
|
|
817
851
|
is_active: OMIT,
|
|
818
852
|
default_deadline_hours: OMIT,
|
|
819
853
|
publish: OMIT,
|
|
854
|
+
applies_to: OMIT,
|
|
820
855
|
request_options: nil
|
|
821
856
|
)
|
|
822
857
|
@client.request(
|
|
@@ -836,7 +871,8 @@ module Didit
|
|
|
836
871
|
"content_config" => content_config,
|
|
837
872
|
"is_active" => is_active,
|
|
838
873
|
"default_deadline_hours" => default_deadline_hours,
|
|
839
|
-
"publish" => publish
|
|
874
|
+
"publish" => publish,
|
|
875
|
+
"applies_to" => applies_to
|
|
840
876
|
},
|
|
841
877
|
scope: :application,
|
|
842
878
|
response: Types::CaseBlueprintDetail,
|
|
@@ -1063,7 +1099,10 @@ module Didit
|
|
|
1063
1099
|
|
|
1064
1100
|
# Update blueprint
|
|
1065
1101
|
#
|
|
1066
|
-
# Partially update a blueprint's general settings or content_config.
|
|
1102
|
+
# Partially update a blueprint's general settings or content_config. applies_to accepts the six case-type
|
|
1103
|
+
# values. content_config.stages.items[].worked_by is an optional active review-team UUID from this
|
|
1104
|
+
# application. These settings are preserved in case policy snapshots; later edits do not change existing
|
|
1105
|
+
# snapshots.
|
|
1067
1106
|
#
|
|
1068
1107
|
# +PATCH /v3/organization/{organization_id}/application/{application_id}/cases/blueprints/{blueprint_uuid}/+
|
|
1069
1108
|
#
|
|
@@ -1082,13 +1121,15 @@ module Didit
|
|
|
1082
1121
|
# @param four_eyes_checker_blueprint [String, nil] Setting this enables 4-eyes review: resolutions on this
|
|
1083
1122
|
# blueprint stage on the checker blueprint's queue.
|
|
1084
1123
|
# @param require_resolution_note [Boolean]
|
|
1085
|
-
# @param content_config [Hash]
|
|
1086
|
-
#
|
|
1124
|
+
# @param content_config [Hash] Case content sections and optional review stages. Unknown sections or keys are
|
|
1125
|
+
# rejected. Cases retain the policy snapshot accepted when opened; later blueprint edits do not rewrite it.
|
|
1087
1126
|
# @param is_active [Boolean]
|
|
1088
1127
|
# @param default_deadline_hours [Integer, nil] Default deadline for newly opened cases. Existing case
|
|
1089
1128
|
# deadlines are unchanged.
|
|
1090
1129
|
# @param expected_version [Integer] The version opened by the editor. A stale version returns 409 without
|
|
1091
1130
|
# changing the review policy.
|
|
1131
|
+
# @param applies_to [Array<String>] Case types this blueprint describes. Optional on create and update; new
|
|
1132
|
+
# blueprints default to an empty list. Stored in the accepted case policy snapshot.
|
|
1092
1133
|
# @param request_options [Hash, nil] :timeout, :max_retries, :extra_headers, :extra_query, :extra_body
|
|
1093
1134
|
# @return [Didit::Types::CaseBlueprintDetail]
|
|
1094
1135
|
def update(
|
|
@@ -1107,6 +1148,7 @@ module Didit
|
|
|
1107
1148
|
is_active: OMIT,
|
|
1108
1149
|
default_deadline_hours: OMIT,
|
|
1109
1150
|
expected_version: OMIT,
|
|
1151
|
+
applies_to: OMIT,
|
|
1110
1152
|
request_options: nil
|
|
1111
1153
|
)
|
|
1112
1154
|
@client.request(
|
|
@@ -1127,7 +1169,8 @@ module Didit
|
|
|
1127
1169
|
"content_config" => content_config,
|
|
1128
1170
|
"is_active" => is_active,
|
|
1129
1171
|
"default_deadline_hours" => default_deadline_hours,
|
|
1130
|
-
"expected_version" => expected_version
|
|
1172
|
+
"expected_version" => expected_version,
|
|
1173
|
+
"applies_to" => applies_to
|
|
1131
1174
|
},
|
|
1132
1175
|
scope: :application,
|
|
1133
1176
|
response: Types::CaseBlueprintDetail,
|
|
@@ -1190,13 +1233,16 @@ module Didit
|
|
|
1190
1233
|
class Links < Didit::Resource
|
|
1191
1234
|
# Add case link
|
|
1192
1235
|
#
|
|
1193
|
-
# Attach a session, business session, or
|
|
1194
|
-
# different subject than the case.
|
|
1236
|
+
# Attach a session, business session, transaction, or network to the case. Rejected with 400 if the entity
|
|
1237
|
+
# belongs to a different subject than the case. Network links require write:cases plus read:networks, Networks
|
|
1238
|
+
# access and investigation access for the network scope. The network must be visible and contain the case
|
|
1239
|
+
# subject. Manually adding links to network-generated cases is not allowed.
|
|
1195
1240
|
#
|
|
1196
1241
|
# +POST /v3/organization/{organization_id}/application/{application_id}/cases/{case_uuid}/links/+
|
|
1197
1242
|
#
|
|
1198
1243
|
# @param case_uuid [String] Case UUID.
|
|
1199
|
-
# @param entity_type [String]
|
|
1244
|
+
# @param entity_type [String] Type of record to attach. A network must be visible and contain the selected
|
|
1245
|
+
# case subject.
|
|
1200
1246
|
# @param entity_uuid [String]
|
|
1201
1247
|
# @param request_options [Hash, nil] :timeout, :max_retries, :extra_headers, :extra_query, :extra_body
|
|
1202
1248
|
# @return [Didit::Types::CaseLink]
|
|
@@ -391,18 +391,20 @@ module Didit
|
|
|
391
391
|
# published workflow (created in the Console [Workflows](https://docs.didit.me/console/workflows) page) and an
|
|
392
392
|
# application API key with available credits. Sandbox applications bypass the credit check.
|
|
393
393
|
#
|
|
394
|
-
# **Idempotency:** when `vendor_data` is provided and an unfinished session
|
|
395
|
-
# `Resubmitted`, or `Awaiting User`) with the same `vendor_data` already exists
|
|
396
|
-
# latest published version** (and that session already has a hosted verification
|
|
397
|
-
# returned (still `201`) instead of creating a duplicate - with its `callback` and
|
|
398
|
-
# newly provided values. An unfinished session created on an older version of the
|
|
399
|
-
# been republished) is **not** reused; a new session pinned to the latest published
|
|
400
|
-
# Sessions in `Approved`, `Declined`, `In Review`, `Expired`, `Abandoned`, or `Kyc
|
|
394
|
+
# **Idempotency:** for a User Verification workflow, when `vendor_data` is provided and an unfinished session
|
|
395
|
+
# (`Not Started`, `In Progress`, `Resubmitted`, or `Awaiting User`) with the same `vendor_data` already exists
|
|
396
|
+
# on the workflow's **current latest published version** (and that session already has a hosted verification
|
|
397
|
+
# URL), the existing session is returned (still `201`) instead of creating a duplicate - with its `callback` and
|
|
398
|
+
# `metadata` updated to the newly provided values. An unfinished session created on an older version of the
|
|
399
|
+
# workflow (one that has since been republished) is **not** reused; a new session pinned to the latest published
|
|
400
|
+
# version is created instead. Sessions in `Approved`, `Declined`, `In Review`, `Expired`, `Abandoned`, or `Kyc
|
|
401
|
+
# Expired` are never reused. A Business Verification workflow creates a new session on every call.
|
|
401
402
|
#
|
|
402
403
|
# **Side effects:** the hosted verification URL is generated and stored; if
|
|
403
404
|
# `contact_details.send_notification_emails` is `true` and an email is provided, a verification invite email is
|
|
404
|
-
# sent. The session expires after
|
|
405
|
-
# `contact_details.phone` and
|
|
405
|
+
# sent. The session expires after `session_expiration_time` seconds when the request sets it, otherwise after
|
|
406
|
+
# the workflow's configured session expiration time. For KYB workflows, `contact_details.phone` and
|
|
407
|
+
# `expected_details` are ignored.
|
|
406
408
|
#
|
|
407
409
|
# +POST /v3/session/+
|
|
408
410
|
#
|
|
@@ -435,6 +437,11 @@ module Didit
|
|
|
435
437
|
# characters. Names are case-insensitive and stored in upper case. A name that does not exist yet in the
|
|
436
438
|
# application is created as a new tag. The tags show on the session in the console, where you can filter by
|
|
437
439
|
# them.
|
|
440
|
+
# @param session_expiration_time [Integer] Seconds this session's link stays valid, overriding the workflow's
|
|
441
|
+
# `session_expiration_time` for this session only. Whole number between 3600 (1 hour) and 2419200 (4 weeks), the
|
|
442
|
+
# same bounds as the workflow setting. Omit it to use the workflow's setting. A value outside the range, or one
|
|
443
|
+
# that is not a whole number, returns `400` on `session_expiration_time`. A session created by this call takes
|
|
444
|
+
# th...
|
|
438
445
|
# @param language [String] Language code (ISO 639-1) for the verification process interface. Controls the
|
|
439
446
|
# language displayed to the end user during verification. If not provided, the browser's language will be
|
|
440
447
|
# automatically detected and used. Check all the supported languages [here](/integration/supported-languages).
|
|
@@ -476,6 +483,7 @@ module Didit
|
|
|
476
483
|
callback_method: OMIT,
|
|
477
484
|
metadata: OMIT,
|
|
478
485
|
tags: OMIT,
|
|
486
|
+
session_expiration_time: OMIT,
|
|
479
487
|
language: OMIT,
|
|
480
488
|
contact_details: OMIT,
|
|
481
489
|
expected_details: OMIT,
|
|
@@ -497,6 +505,7 @@ module Didit
|
|
|
497
505
|
"callback_method" => callback_method,
|
|
498
506
|
"metadata" => metadata,
|
|
499
507
|
"tags" => tags,
|
|
508
|
+
"session_expiration_time" => session_expiration_time,
|
|
500
509
|
"language" => language,
|
|
501
510
|
"contact_details" => contact_details,
|
|
502
511
|
"expected_details" => expected_details,
|
|
@@ -850,6 +850,35 @@ module Didit
|
|
|
850
850
|
)
|
|
851
851
|
end
|
|
852
852
|
|
|
853
|
+
# Create or email a Travel Rule end-user link
|
|
854
|
+
#
|
|
855
|
+
# Issue a new link and revoke previous open links for this transfer. Requires write access to transactions and
|
|
856
|
+
# an outbound transfer in AWAITING_COUNTERPARTY, COUNTERPARTY_VASP_NOT_FOUND, COUNTERPARTY_VASP_NOT_REACHABLE,
|
|
857
|
+
# UNCONFIRMED_OWNERSHIP or ON_HOLD. channel=email uses the end user's Didit-record email and
|
|
858
|
+
# verification-session language when available. A send failure returns the link with emailed_to empty;
|
|
859
|
+
# email_available reports address availability, not delivery. See [User
|
|
860
|
+
# links](/management-api/travel-rule/create-user-link).
|
|
861
|
+
#
|
|
862
|
+
# +POST /v3/transactions/{transaction_id}/travel-rule/user-link/+
|
|
863
|
+
#
|
|
864
|
+
# @param transaction_id [String] Didit-stable transaction UUID that owns the transfer.
|
|
865
|
+
# @param channel [String] link returns a new link; email also attempts to send it to the end user's
|
|
866
|
+
# Didit-record email.
|
|
867
|
+
# @param request_options [Hash, nil] :timeout, :max_retries, :extra_headers, :extra_query, :extra_body
|
|
868
|
+
# @return [Didit::Types::TravelRuleUserLinkResponse]
|
|
869
|
+
def create_user_link(transaction_id, channel: OMIT, request_options: nil)
|
|
870
|
+
@client.request(
|
|
871
|
+
:post,
|
|
872
|
+
"/v3/transactions/{transaction_id}/travel-rule/user-link/",
|
|
873
|
+
path_params: { "transaction_id" => transaction_id },
|
|
874
|
+
body: {
|
|
875
|
+
"channel" => channel
|
|
876
|
+
},
|
|
877
|
+
response: Types::TravelRuleUserLinkResponse,
|
|
878
|
+
request_options: request_options
|
|
879
|
+
)
|
|
880
|
+
end
|
|
881
|
+
|
|
853
882
|
# List Travel Rule delivery history
|
|
854
883
|
#
|
|
855
884
|
# Read the complete delivery history for a transaction, oldest first. Requires transaction read permission.
|
|
@@ -946,7 +975,7 @@ module Didit
|
|
|
946
975
|
)
|
|
947
976
|
end
|
|
948
977
|
|
|
949
|
-
#
|
|
978
|
+
# Update a Travel Rule transfer
|
|
950
979
|
#
|
|
951
980
|
# Provide `payment_txn_id` to report the on-chain hash and move an outbound COMPLETED transfer to FINISHED
|
|
952
981
|
# (its INTERNAL-rail counterpart also moves to FINISHED), `{"action": "cancel"}` to cancel a non-terminal
|
|
@@ -968,7 +997,12 @@ module Didit
|
|
|
968
997
|
# updated the same way. `{"action": "beneficiary_vasp", "beneficiary_vasp": "<directory VASP id>"}` names the
|
|
969
998
|
# counterparty yourself when discovery could not, on an outbound transfer in COUNTERPARTY_VASP_NOT_FOUND,
|
|
970
999
|
# COUNTERPARTY_VASP_NOT_REACHABLE or NOT_ENOUGH_COUNTERPARTY_DATA: the transfer is routed to that VASP and
|
|
971
|
-
# sent again.
|
|
1000
|
+
# sent again. Cancellation accepts an optional reason and returns cancel_reason and cancelled_by. Resend
|
|
1001
|
+
# accepts notify_on_answer; omission preserves the saved preference, initially false. Resend invalidates the
|
|
1002
|
+
# previous counterparty pickup link. action=add_vasp_hint requires name, accepts lei and country, saves the
|
|
1003
|
+
# hint and re-runs discovery under the same outbound/status restrictions as resend. update_compliance_email
|
|
1004
|
+
# also accepts vasp_name and saves the address as an application-private contact when the transfer has a known
|
|
1005
|
+
# directory VASP.
|
|
972
1006
|
#
|
|
973
1007
|
# +PATCH /v3/transactions/{transaction_id}/travel-rule/+
|
|
974
1008
|
#
|
|
@@ -980,15 +1014,25 @@ module Didit
|
|
|
980
1014
|
# NOT_ENOUGH_COUNTERPARTY_DATA. "update_compliance_email" replaces the compliance email the request goes to,
|
|
981
1015
|
# on an outbound transfer in one of those three statuses; send "resend" afterwards. "update_originator_wallet"
|
|
982
1016
|
# records the walle...
|
|
983
|
-
# @param compliance_email [String] Required with
|
|
984
|
-
#
|
|
985
|
-
#
|
|
1017
|
+
# @param compliance_email [String] Required with action=update_compliance_email. Saved in
|
|
1018
|
+
# beneficiary_data.counterparty_vasp_email. If the transfer has a known directory VASP, also saved as your
|
|
1019
|
+
# application-private contact for that VASP.
|
|
986
1020
|
# @param wallet_address [String] With `action: update_originator_wallet`: the wallet the funds left from. When
|
|
987
1021
|
# the transfer's UTXO inputs are known it must be one of them.
|
|
988
1022
|
# @param memo [String] With `action: update_originator_wallet`: the wallet's memo or tag on a memo network.
|
|
989
1023
|
# Optional.
|
|
990
1024
|
# @param beneficiary_vasp [String] Required with action=beneficiary_vasp: the `id` of a directory VASP, from
|
|
991
1025
|
# `GET /v3/travel-rule/vasps/`. Your choice outranks every automatic discovery step, which never overrides it.
|
|
1026
|
+
# @param reason [String] With action=cancel: your cancellation reason. Omitted or empty means unspecified.
|
|
1027
|
+
# @param notify_on_answer [Boolean] With action=resend: whether your team should be notified when the
|
|
1028
|
+
# counterparty answers. Initially false; omission preserves the saved preference.
|
|
1029
|
+
# @param name [String] Required with action=add_vasp_hint. Counterparty VASP name.
|
|
1030
|
+
# @param lei [String] With action=add_vasp_hint: optional LEI, normalized to uppercase. Empty clears the
|
|
1031
|
+
# previous LEI hint.
|
|
1032
|
+
# @param country [String] With action=add_vasp_hint: optional country hint, normalized to uppercase. Empty
|
|
1033
|
+
# clears the previous country hint.
|
|
1034
|
+
# @param vasp_name [String] With action=update_compliance_email: optional counterparty name saved with the
|
|
1035
|
+
# address when nonempty.
|
|
992
1036
|
# @param request_options [Hash, nil] :timeout, :max_retries, :extra_headers, :extra_query, :extra_body
|
|
993
1037
|
# @return [Didit::Types::TravelRuleTransferDetail]
|
|
994
1038
|
def update_transfer(
|
|
@@ -999,6 +1043,12 @@ module Didit
|
|
|
999
1043
|
wallet_address: OMIT,
|
|
1000
1044
|
memo: OMIT,
|
|
1001
1045
|
beneficiary_vasp: OMIT,
|
|
1046
|
+
reason: OMIT,
|
|
1047
|
+
notify_on_answer: OMIT,
|
|
1048
|
+
name: OMIT,
|
|
1049
|
+
lei: OMIT,
|
|
1050
|
+
country: OMIT,
|
|
1051
|
+
vasp_name: OMIT,
|
|
1002
1052
|
request_options: nil
|
|
1003
1053
|
)
|
|
1004
1054
|
@client.request(
|
|
@@ -1011,7 +1061,13 @@ module Didit
|
|
|
1011
1061
|
"compliance_email" => compliance_email,
|
|
1012
1062
|
"wallet_address" => wallet_address,
|
|
1013
1063
|
"memo" => memo,
|
|
1014
|
-
"beneficiary_vasp" => beneficiary_vasp
|
|
1064
|
+
"beneficiary_vasp" => beneficiary_vasp,
|
|
1065
|
+
"reason" => reason,
|
|
1066
|
+
"notify_on_answer" => notify_on_answer,
|
|
1067
|
+
"name" => name,
|
|
1068
|
+
"lei" => lei,
|
|
1069
|
+
"country" => country,
|
|
1070
|
+
"vasp_name" => vasp_name
|
|
1015
1071
|
},
|
|
1016
1072
|
response: Types::TravelRuleTransferDetail,
|
|
1017
1073
|
request_options: request_options
|
|
@@ -61,6 +61,38 @@ module Didit
|
|
|
61
61
|
)
|
|
62
62
|
end
|
|
63
63
|
|
|
64
|
+
# Create a private VASP directory entry
|
|
65
|
+
#
|
|
66
|
+
# Add a VASP privately to your application and optionally invite it. Requires write access to transactions. The
|
|
67
|
+
# response uses source=added_by_you. A matching visible name or LEI returns 409 with the existing vasp_id. See
|
|
68
|
+
# [Search the directory](/management-api/travel-rule/search-vasps).
|
|
69
|
+
#
|
|
70
|
+
# +POST /v3/travel-rule/vasps/+
|
|
71
|
+
#
|
|
72
|
+
# @param name [String] VASP name, trimmed; must not be empty.
|
|
73
|
+
# @param email [String] Compliance email saved as an application-private contact and used for an optional
|
|
74
|
+
# invitation.
|
|
75
|
+
# @param lei [String] Optional LEI, normalized to uppercase.
|
|
76
|
+
# @param jurisdiction [String] Optional ISO 3166 alpha-2 or alpha-3 country code, normalized to uppercase.
|
|
77
|
+
# @param invite [Boolean] Send an invitation to the supplied email.
|
|
78
|
+
# @param request_options [Hash, nil] :timeout, :max_retries, :extra_headers, :extra_query, :extra_body
|
|
79
|
+
# @return [Didit::Types::VaspDirectoryEntry]
|
|
80
|
+
def create_vasp(name:, email:, lei: OMIT, jurisdiction: OMIT, invite: OMIT, request_options: nil)
|
|
81
|
+
@client.request(
|
|
82
|
+
:post,
|
|
83
|
+
"/v3/travel-rule/vasps/",
|
|
84
|
+
body: {
|
|
85
|
+
"name" => name,
|
|
86
|
+
"email" => email,
|
|
87
|
+
"lei" => lei,
|
|
88
|
+
"jurisdiction" => jurisdiction,
|
|
89
|
+
"invite" => invite
|
|
90
|
+
},
|
|
91
|
+
response: Types::VaspDirectoryEntry,
|
|
92
|
+
request_options: request_options
|
|
93
|
+
)
|
|
94
|
+
end
|
|
95
|
+
|
|
64
96
|
# Mint a wallet-ownership widget session
|
|
65
97
|
#
|
|
66
98
|
# Mint a hosted wallet-ownership widget URL/token. Send the customer to the returned url to prove control of a
|
|
@@ -143,7 +175,9 @@ module Didit
|
|
|
143
175
|
# ESMA interim MiCA register, the public TRISA directory, the global LEI register and its own curation, plus the
|
|
144
176
|
# members of the Didit network. Each row carries the routes your application has to it today. Your own
|
|
145
177
|
# application's profile is never listed. Rows also carry the shared due-diligence assessment and your
|
|
146
|
-
# application's own decision, entity screening and questionnaires.
|
|
178
|
+
# application's own decision, entity screening and questionnaires. Includes entries your application added
|
|
179
|
+
# privately. The optional source field distinguishes their provenance; kind=didit member results may omit
|
|
180
|
+
# source.
|
|
147
181
|
#
|
|
148
182
|
# +GET /v3/travel-rule/vasps/+
|
|
149
183
|
#
|
|
@@ -809,6 +843,9 @@ module Didit
|
|
|
809
843
|
#
|
|
810
844
|
# +GET /v3/travel-rule/transfers/+
|
|
811
845
|
#
|
|
846
|
+
# @param search [String] Exact transfer or transaction UUID, or a case-insensitive fragment of txn_id, either
|
|
847
|
+
# side's declared or resolved wallet address, or VASP name. Whitespace is trimmed; only the first 255
|
|
848
|
+
# characters are searched. Combines with the other filters.
|
|
812
849
|
# @param direction [String] INBOUND, OUTBOUND, or both comma-separated. Case-sensitive.
|
|
813
850
|
# @param status [String] One or more transfer statuses, comma-separated.
|
|
814
851
|
# @param rail [String] One or more of INTERNAL, TRP, GTR, TRUST, VERIFYVASP, SYGNA, EMAIL, TEST_VASP,
|
|
@@ -824,6 +861,7 @@ module Didit
|
|
|
824
861
|
# @param request_options [Hash, nil] :timeout, :max_retries, :extra_headers, :extra_query, :extra_body
|
|
825
862
|
# @return [Didit::Page<Didit::Types::TravelRuleTransferRow>]
|
|
826
863
|
def list(
|
|
864
|
+
search: OMIT,
|
|
827
865
|
direction: OMIT,
|
|
828
866
|
status: OMIT,
|
|
829
867
|
rail: OMIT,
|
|
@@ -840,6 +878,7 @@ module Didit
|
|
|
840
878
|
:get,
|
|
841
879
|
"/v3/travel-rule/transfers/",
|
|
842
880
|
query: {
|
|
881
|
+
"search" => search,
|
|
843
882
|
"direction" => direction,
|
|
844
883
|
"status" => status,
|
|
845
884
|
"rail" => rail,
|
|
@@ -24,6 +24,10 @@ module Didit
|
|
|
24
24
|
# @param is_white_label_enabled [Boolean] Enable white-label customization for sessions created with this
|
|
25
25
|
# workflow.
|
|
26
26
|
# @param is_desktop_allowed [Boolean] Allow the verification flow to run on desktop browsers.
|
|
27
|
+
# @param is_session_reference_enabled [Boolean] On Declined and In review results, the person being verified
|
|
28
|
+
# sees a short reference to the session, such as `S-20481`, shown on one line. This is the session number as the
|
|
29
|
+
# console shows it, so your support team can find the session in the console by typing it. When `false`, the
|
|
30
|
+
# result screens show no reference. Applies to the hosted flow and the SDKs.
|
|
27
31
|
# @param max_retry_attempts [Integer] Maximum retry attempts allowed after a declined verification. `0` blocks
|
|
28
32
|
# the user after the first decline.
|
|
29
33
|
# @param retry_window_days [Integer, nil] Rolling window in days used to count retries. `null` enforces an
|
|
@@ -45,6 +49,7 @@ module Didit
|
|
|
45
49
|
status: OMIT,
|
|
46
50
|
is_white_label_enabled: OMIT,
|
|
47
51
|
is_desktop_allowed: OMIT,
|
|
52
|
+
is_session_reference_enabled: OMIT,
|
|
48
53
|
max_retry_attempts: OMIT,
|
|
49
54
|
retry_window_days: OMIT,
|
|
50
55
|
face_liveness_max_attempts: OMIT,
|
|
@@ -62,6 +67,7 @@ module Didit
|
|
|
62
67
|
"status" => status,
|
|
63
68
|
"is_white_label_enabled" => is_white_label_enabled,
|
|
64
69
|
"is_desktop_allowed" => is_desktop_allowed,
|
|
70
|
+
"is_session_reference_enabled" => is_session_reference_enabled,
|
|
65
71
|
"max_retry_attempts" => max_retry_attempts,
|
|
66
72
|
"retry_window_days" => retry_window_days,
|
|
67
73
|
"face_liveness_max_attempts" => face_liveness_max_attempts,
|
|
@@ -161,6 +167,10 @@ module Didit
|
|
|
161
167
|
# @param is_white_label_enabled [Boolean] Enable white-label customization for sessions created with this
|
|
162
168
|
# workflow.
|
|
163
169
|
# @param is_desktop_allowed [Boolean] Allow the verification flow to run on desktop browsers.
|
|
170
|
+
# @param is_session_reference_enabled [Boolean] On Declined and In review results, the person being verified
|
|
171
|
+
# sees a short reference to the session, such as `S-20481`, shown on one line. This is the session number as the
|
|
172
|
+
# console shows it, so your support team can find the session in the console by typing it. When `false`, the
|
|
173
|
+
# result screens show no reference. Applies to the hosted flow and the SDKs.
|
|
164
174
|
# @param max_retry_attempts [Integer] Maximum retry attempts allowed after a declined verification. `0` blocks
|
|
165
175
|
# the user after the first decline.
|
|
166
176
|
# @param retry_window_days [Integer, nil] Rolling window in days used to count retries. `null` enforces an
|
|
@@ -181,6 +191,7 @@ module Didit
|
|
|
181
191
|
features: OMIT,
|
|
182
192
|
is_white_label_enabled: OMIT,
|
|
183
193
|
is_desktop_allowed: OMIT,
|
|
194
|
+
is_session_reference_enabled: OMIT,
|
|
184
195
|
max_retry_attempts: OMIT,
|
|
185
196
|
retry_window_days: OMIT,
|
|
186
197
|
face_liveness_max_attempts: OMIT,
|
|
@@ -199,6 +210,7 @@ module Didit
|
|
|
199
210
|
"features" => features,
|
|
200
211
|
"is_white_label_enabled" => is_white_label_enabled,
|
|
201
212
|
"is_desktop_allowed" => is_desktop_allowed,
|
|
213
|
+
"is_session_reference_enabled" => is_session_reference_enabled,
|
|
202
214
|
"max_retry_attempts" => max_retry_attempts,
|
|
203
215
|
"retry_window_days" => retry_window_days,
|
|
204
216
|
"face_liveness_max_attempts" => face_liveness_max_attempts,
|
|
@@ -15,16 +15,17 @@ module Didit
|
|
|
15
15
|
end
|
|
16
16
|
|
|
17
17
|
# Where the application's verification data is stored and processed, chosen when the application is created. `eu`
|
|
18
|
-
# is the European Union (Ireland), the default. `au` (Australia, Sydney), `mx` (Mexico)
|
|
19
|
-
# Emirates) are coming soon: a request that names them answers 400 `This
|
|
20
|
-
# organization's Sandbox application is always in the European Union.
|
|
18
|
+
# is the European Union (Ireland), the default. `au` (Australia, Sydney), `mx` (Mexico), `ae` (United Arab
|
|
19
|
+
# Emirates) and `us` (United States, N. Virginia) are coming soon: a request that names them answers 400 `This
|
|
20
|
+
# data location is not available yet.` An organization's Sandbox application is always in the European Union.
|
|
21
21
|
module ApplicationDataLocation
|
|
22
22
|
EU = "eu"
|
|
23
23
|
AU = "au"
|
|
24
24
|
MX = "mx"
|
|
25
25
|
AE = "ae"
|
|
26
|
+
US = "us"
|
|
26
27
|
|
|
27
|
-
VALUES = [EU, AU, MX, AE].freeze
|
|
28
|
+
VALUES = [EU, AU, MX, AE, US].freeze
|
|
28
29
|
end
|
|
29
30
|
|
|
30
31
|
# The application's environment. A `live` application bills every verification session and check created with its
|
data/lib/didit/types/cases.rb
CHANGED
|
@@ -66,15 +66,6 @@ module Didit
|
|
|
66
66
|
VALUES = [USER, BUSINESS].freeze
|
|
67
67
|
end
|
|
68
68
|
|
|
69
|
-
# Known values of an open enum: the API may send others.
|
|
70
|
-
module CasesLinksCreateParamsEntityType
|
|
71
|
-
SESSION = "session"
|
|
72
|
-
BUSINESS_SESSION = "business_session"
|
|
73
|
-
TRANSACTION = "transaction"
|
|
74
|
-
|
|
75
|
-
VALUES = [SESSION, BUSINESS_SESSION, TRANSACTION].freeze
|
|
76
|
-
end
|
|
77
|
-
|
|
78
69
|
# Known values of an open enum: the API may send others.
|
|
79
70
|
module CasesListParamsOrdering
|
|
80
71
|
CREATED_AT = "created_at"
|