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.
@@ -190,6 +190,22 @@ module Didit
190
190
  VALUES = [ID_VERIFICATION, NFC, LIVENESS, FACEMATCH, PROOF_OF_ADDRESS, PHONE, EMAIL, AML, LOCATION, DATABASE_VALIDATION, QUESTIONNAIRE, DOCUMENT_AI, KYB_REGISTRY, KYB_DOCUMENTS, KYB_KEY_PEOPLE, GEOLOCATION, SIGNATURE].freeze
191
191
  end
192
192
 
193
+ # The kind of delivery point the address is, for United States and Canadian addresses: `street`, `po_box` (a PO
194
+ # box or lock box), `high_rise` (a high-rise or business complex), `rural_route`, `general_delivery`, `firm` (a
195
+ # firm or company address) or `building`. `null` for addresses in other countries, when the address has no type on
196
+ # record, and when `status` is `unavailable`.
197
+ module AddressValidationResultAddressType
198
+ STREET = "street"
199
+ PO_BOX = "po_box"
200
+ HIGH_RISE = "high_rise"
201
+ RURAL_ROUTE = "rural_route"
202
+ GENERAL_DELIVERY = "general_delivery"
203
+ FIRM = "firm"
204
+ BUILDING = "building"
205
+
206
+ VALUES = [STREET, PO_BOX, HIGH_RISE, RURAL_ROUTE, GENERAL_DELIVERY, FIRM, BUILDING].freeze
207
+ end
208
+
193
209
  # `verified`: the address was confirmed down to the building (or the flat or PO box). `partially_verified`: it was
194
210
  # confirmed only to the street, or to the most precise level the postal reference data holds for that place.
195
211
  # `not_verified`: only the region or the city matched, or nothing did. `unavailable`: the validation could not run
@@ -513,6 +529,26 @@ module Didit
513
529
  VALUES = [APPLIED, FAILED].freeze
514
530
  end
515
531
 
532
+ # Known values of an open enum: the API may send others.
533
+ module CaseBlueprintAiDraftAssignmentMethod
534
+ MANUAL = "MANUAL"
535
+ AUTOMATIC = "AUTOMATIC"
536
+
537
+ VALUES = [MANUAL, AUTOMATIC].freeze
538
+ end
539
+
540
+ # Known values of an open enum: the API may send others.
541
+ module CaseBlueprintAppliesToValues
542
+ GENERAL = "GENERAL"
543
+ VERIFICATION_REVIEW = "VERIFICATION_REVIEW"
544
+ BUSINESS_REVIEW = "BUSINESS_REVIEW"
545
+ AML = "AML"
546
+ TRANSACTION_MONITORING = "TRANSACTION_MONITORING"
547
+ DUPLICATES = "DUPLICATES"
548
+
549
+ VALUES = [GENERAL, VERIFICATION_REVIEW, BUSINESS_REVIEW, AML, TRANSACTION_MONITORING, DUPLICATES].freeze
550
+ end
551
+
516
552
  # Known values of an open enum: the API may send others.
517
553
  module CaseBlueprintDetailAssignmentMethod
518
554
  MANUAL = "MANUAL"
@@ -591,12 +627,14 @@ module Didit
591
627
  # * `session` - Session
592
628
  # * `business_session` - Business Session
593
629
  # * `transaction` - Transaction
630
+ # * `network` - Network containing the selected case subject
594
631
  module CaseDuplicateEntityTypeEnum
595
632
  SESSION = "session"
596
633
  BUSINESS_SESSION = "business_session"
597
634
  TRANSACTION = "transaction"
635
+ NETWORK = "network"
598
636
 
599
- VALUES = [SESSION, BUSINESS_SESSION, TRANSACTION].freeze
637
+ VALUES = [SESSION, BUSINESS_SESSION, TRANSACTION, NETWORK].freeze
600
638
  end
601
639
 
602
640
  # * `LOW` - Low
@@ -689,8 +727,9 @@ module Didit
689
727
  SESSION = "session"
690
728
  BUSINESS_SESSION = "business_session"
691
729
  TRANSACTION = "transaction"
730
+ NETWORK = "network"
692
731
 
693
- VALUES = [SESSION, BUSINESS_SESSION, TRANSACTION].freeze
732
+ VALUES = [SESSION, BUSINESS_SESSION, TRANSACTION, NETWORK].freeze
694
733
  end
695
734
 
696
735
  # Known values of an open enum: the API may send others.
@@ -786,6 +825,16 @@ module Didit
786
825
  VALUES = [USER, BUSINESS].freeze
787
826
  end
788
827
 
828
+ # Type of record to attach. A network must be visible and contain the selected case subject.
829
+ module CasesLinksCreateParamsEntityType
830
+ SESSION = "session"
831
+ BUSINESS_SESSION = "business_session"
832
+ TRANSACTION = "transaction"
833
+ NETWORK = "network"
834
+
835
+ VALUES = [SESSION, BUSINESS_SESSION, TRANSACTION, NETWORK].freeze
836
+ end
837
+
789
838
  # Face entries taken from a document-capture selfie: which selfie. Absent for liveness faces.
790
839
  module ComplianceListEntryMetadataFaceImageSource
791
840
  FRONT_IMAGE_CAMERA_FRONT = "front_image_camera_front"
@@ -3503,6 +3552,15 @@ module Didit
3503
3552
  VALUES = [ID_VERIFICATION, NFC, LIVENESS, FACEMATCH, PROOF_OF_ADDRESS, PHONE, EMAIL, AML, LOCATION, DATABASE_VALIDATION, QUESTIONNAIRE, DOCUMENT_AI, KYB_REGISTRY, KYB_DOCUMENTS, KYB_KEY_PEOPLE, GEOLOCATION, SIGNATURE].freeze
3504
3553
  end
3505
3554
 
3555
+ # `listed_company`: the company itself is listed on a stock exchange. `subsidiary_of_listed_company`: the company
3556
+ # is owned by a listed company.
3557
+ module SessionDecisionKeyPeopleChecksListedCompanyDeclarationType
3558
+ LISTED_COMPANY = "listed_company"
3559
+ SUBSIDIARY_OF_LISTED_COMPANY = "subsidiary_of_listed_company"
3560
+
3561
+ VALUES = [LISTED_COMPANY, SUBSIDIARY_OF_LISTED_COMPANY].freeze
3562
+ end
3563
+
3506
3564
  # Status of the AML screening run for this beneficial owner. `null` when no AML screening was run.
3507
3565
  module SessionDecisionKeyPeopleChecksRegistryBeneficialOwnersAmlStatus
3508
3566
  NOT_FINISHED = "Not Finished"
@@ -5750,6 +5808,17 @@ module Didit
5750
5808
  VALUES = [HOLD, REJECT, PROCEED].freeze
5751
5809
  end
5752
5810
 
5811
+ # Recorded cancellation reason, empty when unspecified.
5812
+ module TravelRuleTransferDetailCancelReason
5813
+ VALUE = ""
5814
+ USER_CANCELLED = "user_cancelled"
5815
+ WRONG_WALLET = "wrong_wallet"
5816
+ COMPLIANCE_DECISION = "compliance_decision"
5817
+ OTHER = "other"
5818
+
5819
+ VALUES = [VALUE, USER_CANCELLED, WRONG_WALLET, COMPLIANCE_DECISION, OTHER].freeze
5820
+ end
5821
+
5753
5822
  # Known values of an open enum: the API may send others.
5754
5823
  module TravelRuleTransferDetailDirection
5755
5824
  INBOUND = "INBOUND"
@@ -6093,7 +6162,7 @@ module Didit
6093
6162
  VALUES = [ESSENTIAL].freeze
6094
6163
  end
6095
6164
 
6096
- # directory for an entry of the shared directory; didit for a member of the Didit network.
6165
+ # directory for a shared or application-private directory entry; didit for a Didit network member.
6097
6166
  module VaspDirectoryEntryKind
6098
6167
  DIRECTORY = "directory"
6099
6168
  DIDIT = "didit"
@@ -6203,6 +6272,17 @@ module Didit
6203
6272
  VALUES = [VALUE, OWN_MEMBERSHIP, DIDIT_MEMBERSHIP, DIRECTORY, CONTACT, DIDIT_NETWORK].freeze
6204
6273
  end
6205
6274
 
6275
+ # directory for a shared directory entry, added_by_you for your application-private entry, or didit_network for a
6276
+ # directory entry linked to a Didit customer. Separate kind=didit member results may omit this field; use kind to
6277
+ # identify them.
6278
+ module VaspDirectoryEntrySource
6279
+ DIDIT_NETWORK = "didit_network"
6280
+ DIRECTORY = "directory"
6281
+ ADDED_BY_YOU = "added_by_you"
6282
+
6283
+ VALUES = [DIDIT_NETWORK, DIRECTORY, ADDED_BY_YOU].freeze
6284
+ end
6285
+
6206
6286
  # `created`: added to the book. `existing`: the wallet is already in the book and was left untouched. `duplicate`:
6207
6287
  # repeats an earlier row of this import. `failed`: see `errors`.
6208
6288
  module WalletAddressImportReportRowsStatus
@@ -6842,6 +6922,8 @@ module Didit
6842
6922
  field :formatted_address, "formatted_address", :string
6843
6923
  field :latitude, "latitude", :float
6844
6924
  field :longitude, "longitude", :float
6925
+ field :address_type, "address_type", :string
6926
+ field :is_residential, "is_residential", :boolean
6845
6927
  end
6846
6928
 
6847
6929
  # The normalised address. `null` when `status` is `unavailable`.
@@ -7148,6 +7230,7 @@ module Didit
7148
7230
  field :request_id, "request_id", :string
7149
7231
  field :result, "result", :string
7150
7232
  field :holder_name, "holder_name", :string
7233
+ field :name_match_score, "name_match_score", :integer
7151
7234
  field :account, "account", :string
7152
7235
  field :vendor_data, "vendor_data", :string
7153
7236
  field :created_at, "created_at", :datetime
@@ -7452,6 +7535,23 @@ module Didit
7452
7535
  field :email, "email", :string
7453
7536
  end
7454
7537
 
7538
+ # Unsaved, validated proposal. Fields are optional; review the result and select assignees, teams and routing
7539
+ # before saving.
7540
+ class CaseBlueprintAiDraft < Didit::Model
7541
+ field :name, "name", :string
7542
+ field :description, "description", :string
7543
+ field :content_config, "content_config", "CaseContentConfig"
7544
+ field :require_resolution_note, "require_resolution_note", :boolean
7545
+ field :assignment_method, "assignment_method", :string
7546
+ field :max_active_cases, "max_active_cases", :integer
7547
+ field :default_deadline_hours, "default_deadline_hours", :integer
7548
+ field :applies_to, "applies_to", [:array, :string]
7549
+ end
7550
+
7551
+ class CaseBlueprintAiDraftResponse < Didit::Model
7552
+ field :draft, "draft", "CaseBlueprintAiDraft"
7553
+ end
7554
+
7455
7555
  class CaseBlueprintDetail < Didit::Model
7456
7556
  field :uuid, "uuid", :string
7457
7557
  field :name, "name", :string
@@ -7469,66 +7569,14 @@ module Didit
7469
7569
  field :escalation_blueprint_name, "escalation_blueprint_name", :string
7470
7570
  field :four_eyes_checker_blueprint, "four_eyes_checker_blueprint", :string
7471
7571
  field :four_eyes_checker_blueprint_name, "four_eyes_checker_blueprint_name", :string
7472
- field :content_config, "content_config", "CaseBlueprintDetailContentConfig"
7572
+ field :content_config, "content_config", "CaseContentConfig"
7473
7573
  field :creation_sources, "creation_sources", [:array, "CaseBlueprintDetailCreationSources"]
7474
7574
  field :receives_escalation_from, "receives_escalation_from", [:array, "CaseBlueprintDetailReceivesEscalationFrom"]
7475
7575
  field :updated_at, "updated_at", :datetime
7476
7576
  field :version, "version", :integer
7477
7577
  field :default_deadline_hours, "default_deadline_hours", :integer
7478
- end
7479
-
7480
- # The six togglable sections that drive which tabs and fields appear on the case page. Unknown sections or keys
7481
- # are rejected.
7482
- class CaseBlueprintDetailContentConfig < Didit::Model
7483
- field :checklist, "checklist", "CaseBlueprintDetailContentConfigChecklist"
7484
- field :aml_control, "aml_control", "CaseBlueprintDetailContentConfigAmlControl"
7485
- field :identity, "identity", "CaseBlueprintDetailContentConfigIdentity"
7486
- field :verifications, "verifications", "CaseBlueprintDetailContentConfigVerifications"
7487
- field :reporting, "reporting", "CaseBlueprintDetailContentConfigReporting"
7488
- field :financial, "financial", "CaseBlueprintDetailContentConfigFinancial"
7489
- end
7490
-
7491
- class CaseBlueprintDetailContentConfigAmlControl < Didit::Model
7492
- field :enabled, "enabled", :boolean
7493
- field :financial, "financial", :boolean
7494
- field :identity, "identity", :boolean
7495
- end
7496
-
7497
- class CaseBlueprintDetailContentConfigChecklist < Didit::Model
7498
- field :enabled, "enabled", :boolean
7499
- field :optional, "optional", :boolean
7500
- field :items, "items", [:array, "CaseBlueprintDetailContentConfigChecklistItems"]
7501
- end
7502
-
7503
- class CaseBlueprintDetailContentConfigChecklistItems < Didit::Model
7504
- field :label, "label", :string
7505
- field :order, "order", :integer
7506
- end
7507
-
7508
- class CaseBlueprintDetailContentConfigFinancial < Didit::Model
7509
- field :enabled, "enabled", :boolean
7510
- field :payment_methods, "payment_methods", :boolean
7511
- field :transactions, "transactions", :boolean
7512
- end
7513
-
7514
- class CaseBlueprintDetailContentConfigIdentity < Didit::Model
7515
- field :enabled, "enabled", :boolean
7516
- field :personal_information, "personal_information", :boolean
7517
- field :applicant_tags, "applicant_tags", :boolean
7518
- field :contact_information, "contact_information", :boolean
7519
- field :risk_overview, "risk_overview", :boolean
7520
- field :poi_documents, "poi_documents", :boolean
7521
- field :poa_documents, "poa_documents", :boolean
7522
- end
7523
-
7524
- class CaseBlueprintDetailContentConfigReporting < Didit::Model
7525
- field :enabled, "enabled", :boolean
7526
- field :fiu_reports, "fiu_reports", :boolean
7527
- end
7528
-
7529
- class CaseBlueprintDetailContentConfigVerifications < Didit::Model
7530
- field :enabled, "enabled", :boolean
7531
- field :summary, "summary", :boolean
7578
+ field :applies_to, "applies_to", [:array, :string]
7579
+ field :stages, "stages", [:array, "CaseBlueprintStage"]
7532
7580
  end
7533
7581
 
7534
7582
  class CaseBlueprintDetailCreationSources < Didit::Model
@@ -7557,12 +7605,21 @@ module Didit
7557
7605
  field :created_at, "created_at", :datetime
7558
7606
  field :version, "version", :integer
7559
7607
  field :default_deadline_hours, "default_deadline_hours", :integer
7608
+ field :applies_to, "applies_to", [:array, :string]
7609
+ field :stages, "stages", [:array, "CaseBlueprintStage"]
7560
7610
  end
7561
7611
 
7562
7612
  class CaseBlueprintPresetInstallResult < Didit::Model
7563
7613
  field :created, "created", [:array, :string]
7564
7614
  end
7565
7615
 
7616
+ class CaseBlueprintStage < Didit::Model
7617
+ field :key, "key", :string
7618
+ field :label, "label", :string
7619
+ field :sla_hours, "sla_hours", :integer
7620
+ field :worked_by, "worked_by", :string
7621
+ end
7622
+
7566
7623
  class CaseBlueprintSummary < Didit::Model
7567
7624
  field :uuid, "uuid", :string
7568
7625
  field :name, "name", :string
@@ -7625,8 +7682,8 @@ module Didit
7625
7682
  field :results, "results", [:array, "CaseCollaborationCaseNote"]
7626
7683
  end
7627
7684
 
7628
- # The six togglable sections that drive which tabs and fields appear on the case page. Unknown sections or keys
7629
- # are rejected.
7685
+ # Case content sections and optional review stages. Unknown sections or keys are rejected. Cases retain the policy
7686
+ # snapshot accepted when opened; later blueprint edits do not rewrite it.
7630
7687
  class CaseContentConfig < Didit::Model
7631
7688
  field :checklist, "checklist", "CaseContentConfigChecklist"
7632
7689
  field :aml_control, "aml_control", "CaseContentConfigAmlControl"
@@ -7634,6 +7691,7 @@ module Didit
7634
7691
  field :verifications, "verifications", "CaseContentConfigVerifications"
7635
7692
  field :reporting, "reporting", "CaseContentConfigReporting"
7636
7693
  field :financial, "financial", "CaseContentConfigFinancial"
7694
+ field :stages, "stages", "CaseContentConfigStages"
7637
7695
  end
7638
7696
 
7639
7697
  class CaseContentConfigAmlControl < Didit::Model
@@ -7674,6 +7732,11 @@ module Didit
7674
7732
  field :fiu_reports, "fiu_reports", :boolean
7675
7733
  end
7676
7734
 
7735
+ # Ordered review stages. Omitted or empty items use the default Triage, Evidence review and Decision stages.
7736
+ class CaseContentConfigStages < Didit::Model
7737
+ field :items, "items", [:array, "CaseBlueprintStage"]
7738
+ end
7739
+
7677
7740
  class CaseContentConfigVerifications < Didit::Model
7678
7741
  field :enabled, "enabled", :boolean
7679
7742
  field :summary, "summary", :boolean
@@ -7829,7 +7892,7 @@ module Didit
7829
7892
  field :four_eyes_checker_blueprint, "four_eyes_checker_blueprint", :string
7830
7893
  field :four_eyes_checker_blueprint_name, "four_eyes_checker_blueprint_name", :string
7831
7894
  field :require_resolution_note, "require_resolution_note", :boolean
7832
- field :content_config, "content_config", :any
7895
+ field :content_config, "content_config", "CaseContentConfig"
7833
7896
  field :version, "version", :integer
7834
7897
  field :default_deadline_hours, "default_deadline_hours", :integer
7835
7898
  field :is_active, "is_active", :boolean
@@ -7838,6 +7901,8 @@ module Didit
7838
7901
  field :receives_escalation_from, "receives_escalation_from", [:array, :any]
7839
7902
  field :created_at, "created_at", :datetime
7840
7903
  field :updated_at, "updated_at", :datetime
7904
+ field :applies_to, "applies_to", [:array, :string]
7905
+ field :stages, "stages", [:array, "CaseBlueprintStage"]
7841
7906
  end
7842
7907
 
7843
7908
  class CasePublicationPaginatedPolicyRevisionList < Didit::Model
@@ -10930,9 +10995,25 @@ module Didit
10930
10995
  field :registry, "registry", "SessionDecisionKeyPeopleChecksRegistry"
10931
10996
  field :submitted, "submitted", "SessionDecisionKeyPeopleChecksSubmitted"
10932
10997
  field :ubo_kyc_summary, "ubo_kyc_summary", "SessionDecisionKeyPeopleChecksUboKycSummary"
10998
+ field :listed_company_declaration, "listed_company_declaration", "SessionDecisionKeyPeopleChecksListedCompanyDeclaration"
10933
10999
  field :warnings, "warnings", [:array, :any]
10934
11000
  end
10935
11001
 
11002
+ # The company's own declaration that it is listed on a stock exchange, or owned by a listed company, made on the
11003
+ # Key People screen instead of naming a beneficial owner. Present in every `key_people_checks` entry unless the
11004
+ # workflow's Returned data settings leave it out, and `null` unless the company made the declaration, which it can
11005
+ # only do where the workflow allows it (`kyb_key_people_allow_listed_company_declaration`). Didit does not check
11006
+ # the declaration against a stock exchange: the workflow's `kyb_key_people_listed_company_action` decides the Key
11007
+ # People outcome (Review by default) and the `KYB_LISTED_COMPANY_DECLARED` warning is added. The company must
11008
+ # still name at least one person who manages or represents it (director, non-executive director, chairman,
11009
+ # representative, authorized signatory or company officer).
11010
+ class SessionDecisionKeyPeopleChecksListedCompanyDeclaration < Didit::Model
11011
+ field :type, "type", :string
11012
+ field :stock_exchange, "stock_exchange", :string
11013
+ field :isin, "isin", :string
11014
+ field :listed_parent_company_name, "listed_parent_company_name", :string
11015
+ end
11016
+
10936
11017
  # Parties discovered via the registry check.
10937
11018
  class SessionDecisionKeyPeopleChecksRegistry < Didit::Model
10938
11019
  field :officers, "officers", [:array, "SessionDecisionKeyPeopleChecksRegistryOfficers"]
@@ -12235,6 +12316,7 @@ module Didit
12235
12316
  field :chain_details, "chain_details", "TravelRuleChainDetails"
12236
12317
  field :not_required_reason, "not_required_reason", :string
12237
12318
  field :proof_state, "proof_state", :string
12319
+ field :user_choice, "user_choice", "TravelRuleUserChoice"
12238
12320
  end
12239
12321
 
12240
12322
  # The counterparty's directory entry, or `null` when the transfer links none.
@@ -12471,6 +12553,7 @@ module Didit
12471
12553
  field :deliveries_truncated, "deliveries_truncated", :boolean
12472
12554
  field :not_required_reason, "not_required_reason", :string
12473
12555
  field :proof_state, "proof_state", :string
12556
+ field :user_choice, "user_choice", "TravelRuleUserChoice"
12474
12557
  end
12475
12558
 
12476
12559
  # The counterparty's directory entry, or `null` when the transfer links none.
@@ -12973,6 +13056,10 @@ module Didit
12973
13056
  field :deliveries_truncated, "deliveries_truncated", :boolean
12974
13057
  field :not_required_reason, "not_required_reason", :string
12975
13058
  field :proof_state, "proof_state", :string
13059
+ field :cancel_reason, "cancel_reason", :string
13060
+ field :cancelled_by, "cancelled_by", :string
13061
+ field :notify_on_answer, "notify_on_answer", :boolean
13062
+ field :user_choice, "user_choice", "TravelRuleUserChoice"
12976
13063
  end
12977
13064
 
12978
13065
  class TravelRuleTransferDetailCounterpartyVasp < Didit::Model
@@ -13027,6 +13114,22 @@ module Didit
13027
13114
  field :created_at, "created_at", :datetime
13028
13115
  end
13029
13116
 
13117
+ class TravelRuleUserChoice < Didit::Model
13118
+ field :active, "active", :boolean
13119
+ field :waiting, "waiting", :boolean
13120
+ field :end_user_link, "end_user_link", :string
13121
+ field :link_expires_at, "link_expires_at", :datetime
13122
+ field :emailed_to, "emailed_to", :string
13123
+ field :email_available, "email_available", :boolean
13124
+ end
13125
+
13126
+ class TravelRuleUserLinkResponse < Didit::Model
13127
+ field :end_user_link, "end_user_link", :string
13128
+ field :expires_at, "expires_at", :datetime
13129
+ field :emailed_to, "emailed_to", :string
13130
+ field :email_available, "email_available", :boolean
13131
+ end
13132
+
13030
13133
  # One input or output of a UTXO transaction, as the chain recorded it.
13031
13134
  class TravelRuleUtxoEntry < Didit::Model
13032
13135
  field :address, "address", :string
@@ -13213,6 +13316,7 @@ module Didit
13213
13316
  field :decision, "decision", "TravelRuleCounterpartyDecision"
13214
13317
  field :entity_screening, "entity_screening", "TravelRuleCounterpartyScreening"
13215
13318
  field :questionnaires, "questionnaires", [:array, "TravelRuleCounterpartyQuestionnaire"]
13319
+ field :source, "source", :string
13216
13320
  end
13217
13321
 
13218
13322
  class VaspDirectoryEntryAliases < Didit::Model
@@ -317,9 +317,9 @@ module Didit
317
317
  VALUES = [EN, AR, BG, BN, BS, CA, CNR, CS, DA, DE, EL, ES, ET, FA, FI, FR, HE, HI, HR, HU, HY, ID, IT, JA, KA, KK, KO, KY, LT, LV, MK, MN, MS, NL, NO, PL, PT_BR, PT, RO, RU, SK, SL, SO, SQ, SR, SV, TH, TR, UK, UZ, VI, ZH_CN, ZH_TW, ZH].freeze
318
318
  end
319
319
 
320
- # Current status of the session. Newly created sessions return `Not Started`. If a non-finished session already
321
- # existed for the same `vendor_data` on the workflow's latest published version, the returned status reflects that
322
- # existing session.
320
+ # Current status of the session. Newly created sessions return `Not Started`. For a User Verification workflow, if
321
+ # a non-finished session already existed for the same `vendor_data` on the workflow's latest published version,
322
+ # the returned status reflects that existing session.
323
323
  module SessionsCreateResponseStatus
324
324
  NOT_STARTED = "Not Started"
325
325
  IN_PROGRESS = "In Progress"
@@ -1368,6 +1368,7 @@ module Didit
1368
1368
  field :vendor_data, "vendor_data", :string
1369
1369
  field :metadata, "metadata", :any
1370
1370
  field :tags, "tags", [:array, :string]
1371
+ field :expires_at, "expires_at", :datetime
1371
1372
  field :status, "status", :string
1372
1373
  field :callback, "callback", :string
1373
1374
  field :workflow_id, "workflow_id", :string
@@ -30,6 +30,16 @@ module Didit
30
30
  VALUES = [INBOUND, OUTBOUND, IN, OUT].freeze
31
31
  end
32
32
 
33
+ # discovery uses automatic counterparty discovery. user asks the end user to choose, issues a link and attempts
34
+ # email when their Didit record has an address. Cannot be combined with beneficiary_data.counterparty_vasp_name or
35
+ # counterparty_vasp_lei. Read user_choice in the response; link or email failure does not fail creation.
36
+ module TransactionsCreateParamsTravelRuleDetailsCounterpartyChoice
37
+ DISCOVERY = "discovery"
38
+ USER = "user"
39
+
40
+ VALUES = [DISCOVERY, USER].freeze
41
+ end
42
+
33
43
  # Direction relative to the subject. Stored uppercase regardless of the casing submitted.
34
44
  module TransactionsListResponseResultsDirection
35
45
  INBOUND = "INBOUND"
@@ -137,6 +147,14 @@ module Didit
137
147
  VALUES = [MESSAGE, DOCUMENT_REQUEST].freeze
138
148
  end
139
149
 
150
+ # link returns a new link; email also attempts to send it to the end user's Didit-record email.
151
+ module TransactionsTravelRuleCreateUserLinkParamsChannel
152
+ LINK = "link"
153
+ EMAIL = "email"
154
+
155
+ VALUES = [LINK, EMAIL].freeze
156
+ end
157
+
140
158
  # What the Didit Test VASP declares the beneficiary to be. `accept` declares the holder's own name;
141
159
  # `name_mismatch` declares a name no holder agrees with. The decision itself is always yours.
142
160
  module TransactionsTravelRuleTriggerTestVaspInboundParamsScenario
@@ -152,14 +170,28 @@ module Didit
152
170
  # those three statuses; send "resend" afterwards. "update_originator_wallet" records the wallet the funds actually
153
171
  # left from (`wallet_address`, `memo`). "beneficiary_vasp" names the counterparty VASP yourself (requires
154
172
  # `beneficiary_vasp`) for an outbound transfer in one of those statuses: it is routed to that VASP and sent again.
173
+ # "add_vasp_hint" saves a counterparty name and optional LEI and country, then re-runs discovery on an outbound
174
+ # transfer in a resendable status.
155
175
  module TransactionsTravelRuleUpdateTransferParamsAction
156
176
  CANCEL = "cancel"
157
177
  RESEND = "resend"
158
178
  UPDATE_COMPLIANCE_EMAIL = "update_compliance_email"
159
179
  UPDATE_ORIGINATOR_WALLET = "update_originator_wallet"
160
180
  BENEFICIARY_VASP = "beneficiary_vasp"
181
+ ADD_VASP_HINT = "add_vasp_hint"
182
+
183
+ VALUES = [CANCEL, RESEND, UPDATE_COMPLIANCE_EMAIL, UPDATE_ORIGINATOR_WALLET, BENEFICIARY_VASP, ADD_VASP_HINT].freeze
184
+ end
185
+
186
+ # With action=cancel: your cancellation reason. Omitted or empty means unspecified.
187
+ module TransactionsTravelRuleUpdateTransferParamsReason
188
+ VALUE = ""
189
+ USER_CANCELLED = "user_cancelled"
190
+ WRONG_WALLET = "wrong_wallet"
191
+ COMPLIANCE_DECISION = "compliance_decision"
192
+ OTHER = "other"
161
193
 
162
- VALUES = [CANCEL, RESEND, UPDATE_COMPLIANCE_EMAIL, UPDATE_ORIGINATOR_WALLET, BENEFICIARY_VASP].freeze
194
+ VALUES = [VALUE, USER_CANCELLED, WRONG_WALLET, COMPLIANCE_DECISION, OTHER].freeze
163
195
  end
164
196
 
165
197
  class TransactionsCreateSdkTokenResponse < Didit::Model
data/lib/didit/types.rb CHANGED
@@ -55,6 +55,7 @@ module Didit
55
55
  autoload :AddressValidationResponse, "didit/types/components"
56
56
  autoload :AddressValidationResult, "didit/types/components"
57
57
  autoload :AddressValidationResultAddress, "didit/types/components"
58
+ autoload :AddressValidationResultAddressType, "didit/types/components"
58
59
  autoload :AddressValidationResultStatus, "didit/types/components"
59
60
  autoload :AddressValidationResultVerificationLevel, "didit/types/components"
60
61
  autoload :AgeEstimationEstimateResponse, "didit/types/age_estimation"
@@ -232,22 +233,19 @@ module Didit
232
233
  autoload :CaseActionEntityTypeEnum, "didit/types/components"
233
234
  autoload :CaseActionStatusEnum, "didit/types/components"
234
235
  autoload :CaseAssignee, "didit/types/components"
236
+ autoload :CaseBlueprintAiDraft, "didit/types/components"
237
+ autoload :CaseBlueprintAiDraftAssignmentMethod, "didit/types/components"
238
+ autoload :CaseBlueprintAiDraftResponse, "didit/types/components"
239
+ autoload :CaseBlueprintAppliesToValues, "didit/types/components"
235
240
  autoload :CaseBlueprintDetail, "didit/types/components"
236
241
  autoload :CaseBlueprintDetailAssignmentMethod, "didit/types/components"
237
- autoload :CaseBlueprintDetailContentConfig, "didit/types/components"
238
- autoload :CaseBlueprintDetailContentConfigAmlControl, "didit/types/components"
239
- autoload :CaseBlueprintDetailContentConfigChecklist, "didit/types/components"
240
- autoload :CaseBlueprintDetailContentConfigChecklistItems, "didit/types/components"
241
- autoload :CaseBlueprintDetailContentConfigFinancial, "didit/types/components"
242
- autoload :CaseBlueprintDetailContentConfigIdentity, "didit/types/components"
243
- autoload :CaseBlueprintDetailContentConfigReporting, "didit/types/components"
244
- autoload :CaseBlueprintDetailContentConfigVerifications, "didit/types/components"
245
242
  autoload :CaseBlueprintDetailCreationSources, "didit/types/components"
246
243
  autoload :CaseBlueprintDetailCreationSourcesKind, "didit/types/components"
247
244
  autoload :CaseBlueprintDetailReceivesEscalationFrom, "didit/types/components"
248
245
  autoload :CaseBlueprintListItem, "didit/types/components"
249
246
  autoload :CaseBlueprintListItemAssignmentMethod, "didit/types/components"
250
247
  autoload :CaseBlueprintPresetInstallResult, "didit/types/components"
248
+ autoload :CaseBlueprintStage, "didit/types/components"
251
249
  autoload :CaseBlueprintSummary, "didit/types/components"
252
250
  autoload :CaseBulkUpdateResult, "didit/types/components"
253
251
  autoload :CaseBulkUpdateResultFailures, "didit/types/components"
@@ -263,6 +261,7 @@ module Didit
263
261
  autoload :CaseContentConfigFinancial, "didit/types/components"
264
262
  autoload :CaseContentConfigIdentity, "didit/types/components"
265
263
  autoload :CaseContentConfigReporting, "didit/types/components"
264
+ autoload :CaseContentConfigStages, "didit/types/components"
266
265
  autoload :CaseContentConfigVerifications, "didit/types/components"
267
266
  autoload :CaseDetail, "didit/types/components"
268
267
  autoload :CaseDetailPendingResolution, "didit/types/components"
@@ -321,7 +320,7 @@ module Didit
321
320
  autoload :CasesBulkUpdateStatusParamsStatus, "didit/types/cases"
322
321
  autoload :CasesCreateParamsPriority, "didit/types/cases"
323
322
  autoload :CasesCreateParamsSubjectType, "didit/types/cases"
324
- autoload :CasesLinksCreateParamsEntityType, "didit/types/cases"
323
+ autoload :CasesLinksCreateParamsEntityType, "didit/types/components"
325
324
  autoload :CasesListEventsResponse, "didit/types/cases"
326
325
  autoload :CasesListParamsOrdering, "didit/types/cases"
327
326
  autoload :CasesListResponse, "didit/types/cases"
@@ -1140,6 +1139,8 @@ module Didit
1140
1139
  autoload :SessionDecisionIpAnalysesWarnings, "didit/types/components"
1141
1140
  autoload :SessionDecisionIpAnalysesWarningsFeature, "didit/types/components"
1142
1141
  autoload :SessionDecisionKeyPeopleChecks, "didit/types/components"
1142
+ autoload :SessionDecisionKeyPeopleChecksListedCompanyDeclaration, "didit/types/components"
1143
+ autoload :SessionDecisionKeyPeopleChecksListedCompanyDeclarationType, "didit/types/components"
1143
1144
  autoload :SessionDecisionKeyPeopleChecksRegistry, "didit/types/components"
1144
1145
  autoload :SessionDecisionKeyPeopleChecksRegistryBeneficialOwners, "didit/types/components"
1145
1146
  autoload :SessionDecisionKeyPeopleChecksRegistryBeneficialOwnersAmlStatus, "didit/types/components"
@@ -1548,6 +1549,7 @@ module Didit
1548
1549
  autoload :TransactionTravelRuleProofState, "didit/types/components"
1549
1550
  autoload :TransactionsCreateParamsTransactionCategory, "didit/types/transactions"
1550
1551
  autoload :TransactionsCreateParamsTransactionDetailsDirection, "didit/types/transactions"
1552
+ autoload :TransactionsCreateParamsTravelRuleDetailsCounterpartyChoice, "didit/types/transactions"
1551
1553
  autoload :TransactionsCreateSdkTokenResponse, "didit/types/transactions"
1552
1554
  autoload :TransactionsListRelatedResponse, "didit/types/transactions"
1553
1555
  autoload :TransactionsListResponse, "didit/types/transactions"
@@ -1568,8 +1570,10 @@ module Didit
1568
1570
  autoload :TransactionsRulesUpdateParamsEvaluationMode, "didit/types/transactions"
1569
1571
  autoload :TransactionsRulesUpdateParamsMode, "didit/types/transactions"
1570
1572
  autoload :TransactionsTravelRuleCreateMessageParamsKind, "didit/types/transactions"
1573
+ autoload :TransactionsTravelRuleCreateUserLinkParamsChannel, "didit/types/transactions"
1571
1574
  autoload :TransactionsTravelRuleTriggerTestVaspInboundParamsScenario, "didit/types/transactions"
1572
1575
  autoload :TransactionsTravelRuleUpdateTransferParamsAction, "didit/types/transactions"
1576
+ autoload :TransactionsTravelRuleUpdateTransferParamsReason, "didit/types/transactions"
1573
1577
  autoload :TravelRuleChainDetails, "didit/types/components"
1574
1578
  autoload :TravelRuleChainDetailsNotApplicableReason, "didit/types/components"
1575
1579
  autoload :TravelRuleChainDetailsShape, "didit/types/components"
@@ -1678,6 +1682,7 @@ module Didit
1678
1682
  autoload :TravelRuleSettingsDetailTimeoutOutcome, "didit/types/components"
1679
1683
  autoload :TravelRuleTestVaspInboundResponse, "didit/types/components"
1680
1684
  autoload :TravelRuleTransferDetail, "didit/types/components"
1685
+ autoload :TravelRuleTransferDetailCancelReason, "didit/types/components"
1681
1686
  autoload :TravelRuleTransferDetailCounterpartyVasp, "didit/types/components"
1682
1687
  autoload :TravelRuleTransferDetailCounterpartyVaspDdScoreBreakdownValue, "didit/types/components"
1683
1688
  autoload :TravelRuleTransferDetailDirection, "didit/types/components"
@@ -1701,6 +1706,8 @@ module Didit
1701
1706
  autoload :TravelRuleUpdateSettingsParamsSunrisePolicy, "didit/types/travel_rule"
1702
1707
  autoload :TravelRuleUpdateSettingsParamsTimeoutOutcome, "didit/types/travel_rule"
1703
1708
  autoload :TravelRuleUpdateVaspDecisionParamsDecision, "didit/types/travel_rule"
1709
+ autoload :TravelRuleUserChoice, "didit/types/components"
1710
+ autoload :TravelRuleUserLinkResponse, "didit/types/components"
1704
1711
  autoload :TravelRuleUtxoEntry, "didit/types/components"
1705
1712
  autoload :TravelRuleWalletAddressesListResponse, "didit/types/travel_rule"
1706
1713
  autoload :TravelRuleWalletProofFailureReason, "didit/types/components"
@@ -1776,6 +1783,7 @@ module Didit
1776
1783
  autoload :VaspDirectoryEntryRoutesReason, "didit/types/components"
1777
1784
  autoload :VaspDirectoryEntryRoutesStatus, "didit/types/components"
1778
1785
  autoload :VaspDirectoryEntryRoutesVia, "didit/types/components"
1786
+ autoload :VaspDirectoryEntrySource, "didit/types/components"
1779
1787
  autoload :VaspDirectoryEntryUmbrella, "didit/types/components"
1780
1788
  autoload :VerifyEmailResponse, "didit/types/account_components"
1781
1789
  autoload :WalletAddressEntry, "didit/types/components"
data/lib/didit/version.rb CHANGED
@@ -1,5 +1,5 @@
1
1
  # frozen_string_literal: true
2
2
 
3
3
  module Didit
4
- VERSION = "2.13.1" # x-release-please-version
4
+ VERSION = "2.15.0" # x-release-please-version
5
5
  end
@@ -16,7 +16,7 @@ module Didit
16
16
  def assign: (String case_uuid, assignee_user_id: String?, ?assignee_email: String?, ?assignee_name: String?, ?request_options: Didit::request_options?) -> Didit::Types::CaseDetail
17
17
  def bulk_assign: (case_uuids: Array[String], assignee_user_id: String?, ?assignee_email: String?, ?assignee_name: String?, ?request_options: Didit::request_options?) -> Didit::Types::CaseBulkUpdateResult
18
18
  def bulk_update_status: (case_uuids: Array[String], status: String, ?resolution: String, ?note: String?, ?request_options: Didit::request_options?) -> Didit::Types::CaseBulkUpdateResult
19
- def create: (title: String, ?blueprint: String?, ?priority: String, ?due_at: (Time | String)?, ?tags: Array[String], ?subject: Didit::Types::cases_create_params_subject, ?links: Array[Hash[String | Symbol, untyped]], ?assigned_to: String?, ?review_duplicates: bool, ?separate_incident_reason: String, ?source_context: Didit::Types::case_duplicate_case_fraud_source_context_request, ?request_options: Didit::request_options?) -> Didit::Types::CaseDetail
19
+ def create: (title: String, ?blueprint: String?, ?priority: String, ?due_at: (Time | String)?, ?tags: Array[String], ?subject: Didit::Types::cases_create_params_subject, ?links: Array[Didit::Types::cases_links_create_params], ?assigned_to: String?, ?review_duplicates: bool, ?separate_incident_reason: String, ?source_context: Didit::Types::case_duplicate_case_fraud_source_context_request, ?request_options: Didit::request_options?) -> Didit::Types::CaseDetail
20
20
  def delete: (String case_uuid, ?request_options: Didit::request_options?) -> nil
21
21
  def escalate: (String case_uuid, ?request_options: Didit::request_options?) -> Didit::Types::CaseDetail
22
22
  def find_duplicates: (?subject: Didit::Types::case_duplicate_case_subject_input_request, ?links: Array[Didit::Types::case_duplicate_case_link_create_request], ?offset: Integer, ?request_options: Didit::request_options?) -> Didit::Types::CaseDuplicateCaseDuplicatePage
@@ -36,7 +36,8 @@ module Didit
36
36
  def transfer: (String case_uuid, target_blueprint: String, ?request_options: Didit::request_options?) -> Didit::Types::CaseDetail
37
37
  def update: (String case_uuid, ?title: String, ?priority: String, ?due_at: (Time | String)?, ?tags: Array[String], ?team: String?, ?request_options: Didit::request_options?) -> Didit::Types::CaseDetail
38
38
  class Blueprints < Didit::Resource
39
- def create: (name: String, assignee_pool: Array[String], ?description: String?, ?assignment_method: String, ?max_active_cases: Integer?, ?escalation_enabled: bool, ?escalation_blueprint: String?, ?transfer_enabled: bool, ?four_eyes_checker_blueprint: String?, ?require_resolution_note: bool, ?content_config: Didit::Types::case_content_config, ?is_active: bool, ?default_deadline_hours: Integer?, ?publish: bool, ?request_options: Didit::request_options?) -> Didit::Types::CaseBlueprintDetail
39
+ def ai_draft: (prompt: String, ?request_options: Didit::request_options?) -> Didit::Types::CaseBlueprintAiDraftResponse
40
+ def create: (name: String, assignee_pool: Array[String], ?description: String?, ?assignment_method: String, ?max_active_cases: Integer?, ?escalation_enabled: bool, ?escalation_blueprint: String?, ?transfer_enabled: bool, ?four_eyes_checker_blueprint: String?, ?require_resolution_note: bool, ?content_config: Didit::Types::case_content_config, ?is_active: bool, ?default_deadline_hours: Integer?, ?publish: bool, ?applies_to: Array[String], ?request_options: Didit::request_options?) -> Didit::Types::CaseBlueprintDetail
40
41
  def delete: (String blueprint_uuid, ?request_options: Didit::request_options?) -> nil
41
42
  def discard_draft: (String blueprint_uuid, expected_version: Integer, expected_revision: String?, ?request_options: Didit::request_options?) -> nil
42
43
  def install_presets: (?preset_keys: Array[String]?, ?request_options: Didit::request_options?) -> Didit::Types::CaseBlueprintPresetInstallResult
@@ -47,7 +48,7 @@ module Didit
47
48
  def retrieve: (String blueprint_uuid, ?request_options: Didit::request_options?) -> Didit::Types::CaseBlueprintDetail
48
49
  def retrieve_draft: (String blueprint_uuid, ?request_options: Didit::request_options?) -> Didit::Types::CasePublicationPolicyDraftResponse
49
50
  def save_draft: (String blueprint_uuid, expected_version: Integer, expected_revision: String?, changes: Hash[String | Symbol, untyped], ?request_options: Didit::request_options?) -> Didit::Types::CasePublicationPolicyDraft
50
- def update: (String blueprint_uuid, ?name: String, ?description: String?, ?assignee_pool: Array[String], ?assignment_method: String, ?max_active_cases: Integer?, ?escalation_enabled: bool, ?escalation_blueprint: String?, ?transfer_enabled: bool, ?four_eyes_checker_blueprint: String?, ?require_resolution_note: bool, ?content_config: Didit::Types::case_content_config, ?is_active: bool, ?default_deadline_hours: Integer?, ?expected_version: Integer, ?request_options: Didit::request_options?) -> Didit::Types::CaseBlueprintDetail
51
+ def update: (String blueprint_uuid, ?name: String, ?description: String?, ?assignee_pool: Array[String], ?assignment_method: String, ?max_active_cases: Integer?, ?escalation_enabled: bool, ?escalation_blueprint: String?, ?transfer_enabled: bool, ?four_eyes_checker_blueprint: String?, ?require_resolution_note: bool, ?content_config: Didit::Types::case_content_config, ?is_active: bool, ?default_deadline_hours: Integer?, ?expected_version: Integer, ?applies_to: Array[String], ?request_options: Didit::request_options?) -> Didit::Types::CaseBlueprintDetail
51
52
  end
52
53
  class Checklist < Didit::Resource
53
54
  def list: (String case_uuid, ?request_options: Didit::request_options?) -> Array[Didit::Types::CaseChecklistItem]