didit-sdk 2.13.0 → 2.14.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.
@@ -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,
@@ -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"
@@ -513,6 +513,26 @@ module Didit
513
513
  VALUES = [APPLIED, FAILED].freeze
514
514
  end
515
515
 
516
+ # Known values of an open enum: the API may send others.
517
+ module CaseBlueprintAiDraftAssignmentMethod
518
+ MANUAL = "MANUAL"
519
+ AUTOMATIC = "AUTOMATIC"
520
+
521
+ VALUES = [MANUAL, AUTOMATIC].freeze
522
+ end
523
+
524
+ # Known values of an open enum: the API may send others.
525
+ module CaseBlueprintAppliesToValues
526
+ GENERAL = "GENERAL"
527
+ VERIFICATION_REVIEW = "VERIFICATION_REVIEW"
528
+ BUSINESS_REVIEW = "BUSINESS_REVIEW"
529
+ AML = "AML"
530
+ TRANSACTION_MONITORING = "TRANSACTION_MONITORING"
531
+ DUPLICATES = "DUPLICATES"
532
+
533
+ VALUES = [GENERAL, VERIFICATION_REVIEW, BUSINESS_REVIEW, AML, TRANSACTION_MONITORING, DUPLICATES].freeze
534
+ end
535
+
516
536
  # Known values of an open enum: the API may send others.
517
537
  module CaseBlueprintDetailAssignmentMethod
518
538
  MANUAL = "MANUAL"
@@ -591,12 +611,14 @@ module Didit
591
611
  # * `session` - Session
592
612
  # * `business_session` - Business Session
593
613
  # * `transaction` - Transaction
614
+ # * `network` - Network containing the selected case subject
594
615
  module CaseDuplicateEntityTypeEnum
595
616
  SESSION = "session"
596
617
  BUSINESS_SESSION = "business_session"
597
618
  TRANSACTION = "transaction"
619
+ NETWORK = "network"
598
620
 
599
- VALUES = [SESSION, BUSINESS_SESSION, TRANSACTION].freeze
621
+ VALUES = [SESSION, BUSINESS_SESSION, TRANSACTION, NETWORK].freeze
600
622
  end
601
623
 
602
624
  # * `LOW` - Low
@@ -689,8 +711,9 @@ module Didit
689
711
  SESSION = "session"
690
712
  BUSINESS_SESSION = "business_session"
691
713
  TRANSACTION = "transaction"
714
+ NETWORK = "network"
692
715
 
693
- VALUES = [SESSION, BUSINESS_SESSION, TRANSACTION].freeze
716
+ VALUES = [SESSION, BUSINESS_SESSION, TRANSACTION, NETWORK].freeze
694
717
  end
695
718
 
696
719
  # Known values of an open enum: the API may send others.
@@ -786,6 +809,16 @@ module Didit
786
809
  VALUES = [USER, BUSINESS].freeze
787
810
  end
788
811
 
812
+ # Type of record to attach. A network must be visible and contain the selected case subject.
813
+ module CasesLinksCreateParamsEntityType
814
+ SESSION = "session"
815
+ BUSINESS_SESSION = "business_session"
816
+ TRANSACTION = "transaction"
817
+ NETWORK = "network"
818
+
819
+ VALUES = [SESSION, BUSINESS_SESSION, TRANSACTION, NETWORK].freeze
820
+ end
821
+
789
822
  # Face entries taken from a document-capture selfie: which selfie. Absent for liveness faces.
790
823
  module ComplianceListEntryMetadataFaceImageSource
791
824
  FRONT_IMAGE_CAMERA_FRONT = "front_image_camera_front"
@@ -3503,6 +3536,15 @@ module Didit
3503
3536
  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
3537
  end
3505
3538
 
3539
+ # `listed_company`: the company itself is listed on a stock exchange. `subsidiary_of_listed_company`: the company
3540
+ # is owned by a listed company.
3541
+ module SessionDecisionKeyPeopleChecksListedCompanyDeclarationType
3542
+ LISTED_COMPANY = "listed_company"
3543
+ SUBSIDIARY_OF_LISTED_COMPANY = "subsidiary_of_listed_company"
3544
+
3545
+ VALUES = [LISTED_COMPANY, SUBSIDIARY_OF_LISTED_COMPANY].freeze
3546
+ end
3547
+
3506
3548
  # Status of the AML screening run for this beneficial owner. `null` when no AML screening was run.
3507
3549
  module SessionDecisionKeyPeopleChecksRegistryBeneficialOwnersAmlStatus
3508
3550
  NOT_FINISHED = "Not Finished"
@@ -5750,6 +5792,17 @@ module Didit
5750
5792
  VALUES = [HOLD, REJECT, PROCEED].freeze
5751
5793
  end
5752
5794
 
5795
+ # Recorded cancellation reason, empty when unspecified.
5796
+ module TravelRuleTransferDetailCancelReason
5797
+ VALUE = ""
5798
+ USER_CANCELLED = "user_cancelled"
5799
+ WRONG_WALLET = "wrong_wallet"
5800
+ COMPLIANCE_DECISION = "compliance_decision"
5801
+ OTHER = "other"
5802
+
5803
+ VALUES = [VALUE, USER_CANCELLED, WRONG_WALLET, COMPLIANCE_DECISION, OTHER].freeze
5804
+ end
5805
+
5753
5806
  # Known values of an open enum: the API may send others.
5754
5807
  module TravelRuleTransferDetailDirection
5755
5808
  INBOUND = "INBOUND"
@@ -6093,7 +6146,7 @@ module Didit
6093
6146
  VALUES = [ESSENTIAL].freeze
6094
6147
  end
6095
6148
 
6096
- # directory for an entry of the shared directory; didit for a member of the Didit network.
6149
+ # directory for a shared or application-private directory entry; didit for a Didit network member.
6097
6150
  module VaspDirectoryEntryKind
6098
6151
  DIRECTORY = "directory"
6099
6152
  DIDIT = "didit"
@@ -6203,6 +6256,17 @@ module Didit
6203
6256
  VALUES = [VALUE, OWN_MEMBERSHIP, DIDIT_MEMBERSHIP, DIRECTORY, CONTACT, DIDIT_NETWORK].freeze
6204
6257
  end
6205
6258
 
6259
+ # directory for a shared directory entry, added_by_you for your application-private entry, or didit_network for a
6260
+ # directory entry linked to a Didit customer. Separate kind=didit member results may omit this field; use kind to
6261
+ # identify them.
6262
+ module VaspDirectoryEntrySource
6263
+ DIDIT_NETWORK = "didit_network"
6264
+ DIRECTORY = "directory"
6265
+ ADDED_BY_YOU = "added_by_you"
6266
+
6267
+ VALUES = [DIDIT_NETWORK, DIRECTORY, ADDED_BY_YOU].freeze
6268
+ end
6269
+
6206
6270
  # `created`: added to the book. `existing`: the wallet is already in the book and was left untouched. `duplicate`:
6207
6271
  # repeats an earlier row of this import. `failed`: see `errors`.
6208
6272
  module WalletAddressImportReportRowsStatus
@@ -7452,6 +7516,23 @@ module Didit
7452
7516
  field :email, "email", :string
7453
7517
  end
7454
7518
 
7519
+ # Unsaved, validated proposal. Fields are optional; review the result and select assignees, teams and routing
7520
+ # before saving.
7521
+ class CaseBlueprintAiDraft < Didit::Model
7522
+ field :name, "name", :string
7523
+ field :description, "description", :string
7524
+ field :content_config, "content_config", "CaseContentConfig"
7525
+ field :require_resolution_note, "require_resolution_note", :boolean
7526
+ field :assignment_method, "assignment_method", :string
7527
+ field :max_active_cases, "max_active_cases", :integer
7528
+ field :default_deadline_hours, "default_deadline_hours", :integer
7529
+ field :applies_to, "applies_to", [:array, :string]
7530
+ end
7531
+
7532
+ class CaseBlueprintAiDraftResponse < Didit::Model
7533
+ field :draft, "draft", "CaseBlueprintAiDraft"
7534
+ end
7535
+
7455
7536
  class CaseBlueprintDetail < Didit::Model
7456
7537
  field :uuid, "uuid", :string
7457
7538
  field :name, "name", :string
@@ -7469,66 +7550,14 @@ module Didit
7469
7550
  field :escalation_blueprint_name, "escalation_blueprint_name", :string
7470
7551
  field :four_eyes_checker_blueprint, "four_eyes_checker_blueprint", :string
7471
7552
  field :four_eyes_checker_blueprint_name, "four_eyes_checker_blueprint_name", :string
7472
- field :content_config, "content_config", "CaseBlueprintDetailContentConfig"
7553
+ field :content_config, "content_config", "CaseContentConfig"
7473
7554
  field :creation_sources, "creation_sources", [:array, "CaseBlueprintDetailCreationSources"]
7474
7555
  field :receives_escalation_from, "receives_escalation_from", [:array, "CaseBlueprintDetailReceivesEscalationFrom"]
7475
7556
  field :updated_at, "updated_at", :datetime
7476
7557
  field :version, "version", :integer
7477
7558
  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
7559
+ field :applies_to, "applies_to", [:array, :string]
7560
+ field :stages, "stages", [:array, "CaseBlueprintStage"]
7532
7561
  end
7533
7562
 
7534
7563
  class CaseBlueprintDetailCreationSources < Didit::Model
@@ -7557,12 +7586,21 @@ module Didit
7557
7586
  field :created_at, "created_at", :datetime
7558
7587
  field :version, "version", :integer
7559
7588
  field :default_deadline_hours, "default_deadline_hours", :integer
7589
+ field :applies_to, "applies_to", [:array, :string]
7590
+ field :stages, "stages", [:array, "CaseBlueprintStage"]
7560
7591
  end
7561
7592
 
7562
7593
  class CaseBlueprintPresetInstallResult < Didit::Model
7563
7594
  field :created, "created", [:array, :string]
7564
7595
  end
7565
7596
 
7597
+ class CaseBlueprintStage < Didit::Model
7598
+ field :key, "key", :string
7599
+ field :label, "label", :string
7600
+ field :sla_hours, "sla_hours", :integer
7601
+ field :worked_by, "worked_by", :string
7602
+ end
7603
+
7566
7604
  class CaseBlueprintSummary < Didit::Model
7567
7605
  field :uuid, "uuid", :string
7568
7606
  field :name, "name", :string
@@ -7625,8 +7663,8 @@ module Didit
7625
7663
  field :results, "results", [:array, "CaseCollaborationCaseNote"]
7626
7664
  end
7627
7665
 
7628
- # The six togglable sections that drive which tabs and fields appear on the case page. Unknown sections or keys
7629
- # are rejected.
7666
+ # Case content sections and optional review stages. Unknown sections or keys are rejected. Cases retain the policy
7667
+ # snapshot accepted when opened; later blueprint edits do not rewrite it.
7630
7668
  class CaseContentConfig < Didit::Model
7631
7669
  field :checklist, "checklist", "CaseContentConfigChecklist"
7632
7670
  field :aml_control, "aml_control", "CaseContentConfigAmlControl"
@@ -7634,6 +7672,7 @@ module Didit
7634
7672
  field :verifications, "verifications", "CaseContentConfigVerifications"
7635
7673
  field :reporting, "reporting", "CaseContentConfigReporting"
7636
7674
  field :financial, "financial", "CaseContentConfigFinancial"
7675
+ field :stages, "stages", "CaseContentConfigStages"
7637
7676
  end
7638
7677
 
7639
7678
  class CaseContentConfigAmlControl < Didit::Model
@@ -7674,6 +7713,11 @@ module Didit
7674
7713
  field :fiu_reports, "fiu_reports", :boolean
7675
7714
  end
7676
7715
 
7716
+ # Ordered review stages. Omitted or empty items use the default Triage, Evidence review and Decision stages.
7717
+ class CaseContentConfigStages < Didit::Model
7718
+ field :items, "items", [:array, "CaseBlueprintStage"]
7719
+ end
7720
+
7677
7721
  class CaseContentConfigVerifications < Didit::Model
7678
7722
  field :enabled, "enabled", :boolean
7679
7723
  field :summary, "summary", :boolean
@@ -7829,7 +7873,7 @@ module Didit
7829
7873
  field :four_eyes_checker_blueprint, "four_eyes_checker_blueprint", :string
7830
7874
  field :four_eyes_checker_blueprint_name, "four_eyes_checker_blueprint_name", :string
7831
7875
  field :require_resolution_note, "require_resolution_note", :boolean
7832
- field :content_config, "content_config", :any
7876
+ field :content_config, "content_config", "CaseContentConfig"
7833
7877
  field :version, "version", :integer
7834
7878
  field :default_deadline_hours, "default_deadline_hours", :integer
7835
7879
  field :is_active, "is_active", :boolean
@@ -7838,6 +7882,8 @@ module Didit
7838
7882
  field :receives_escalation_from, "receives_escalation_from", [:array, :any]
7839
7883
  field :created_at, "created_at", :datetime
7840
7884
  field :updated_at, "updated_at", :datetime
7885
+ field :applies_to, "applies_to", [:array, :string]
7886
+ field :stages, "stages", [:array, "CaseBlueprintStage"]
7841
7887
  end
7842
7888
 
7843
7889
  class CasePublicationPaginatedPolicyRevisionList < Didit::Model
@@ -10930,9 +10976,25 @@ module Didit
10930
10976
  field :registry, "registry", "SessionDecisionKeyPeopleChecksRegistry"
10931
10977
  field :submitted, "submitted", "SessionDecisionKeyPeopleChecksSubmitted"
10932
10978
  field :ubo_kyc_summary, "ubo_kyc_summary", "SessionDecisionKeyPeopleChecksUboKycSummary"
10979
+ field :listed_company_declaration, "listed_company_declaration", "SessionDecisionKeyPeopleChecksListedCompanyDeclaration"
10933
10980
  field :warnings, "warnings", [:array, :any]
10934
10981
  end
10935
10982
 
10983
+ # The company's own declaration that it is listed on a stock exchange, or owned by a listed company, made on the
10984
+ # Key People screen instead of naming a beneficial owner. Present in every `key_people_checks` entry unless the
10985
+ # workflow's Returned data settings leave it out, and `null` unless the company made the declaration, which it can
10986
+ # only do where the workflow allows it (`kyb_key_people_allow_listed_company_declaration`). Didit does not check
10987
+ # the declaration against a stock exchange: the workflow's `kyb_key_people_listed_company_action` decides the Key
10988
+ # People outcome (Review by default) and the `KYB_LISTED_COMPANY_DECLARED` warning is added. The company must
10989
+ # still name at least one person who manages or represents it (director, non-executive director, chairman,
10990
+ # representative, authorized signatory or company officer).
10991
+ class SessionDecisionKeyPeopleChecksListedCompanyDeclaration < Didit::Model
10992
+ field :type, "type", :string
10993
+ field :stock_exchange, "stock_exchange", :string
10994
+ field :isin, "isin", :string
10995
+ field :listed_parent_company_name, "listed_parent_company_name", :string
10996
+ end
10997
+
10936
10998
  # Parties discovered via the registry check.
10937
10999
  class SessionDecisionKeyPeopleChecksRegistry < Didit::Model
10938
11000
  field :officers, "officers", [:array, "SessionDecisionKeyPeopleChecksRegistryOfficers"]
@@ -12235,6 +12297,7 @@ module Didit
12235
12297
  field :chain_details, "chain_details", "TravelRuleChainDetails"
12236
12298
  field :not_required_reason, "not_required_reason", :string
12237
12299
  field :proof_state, "proof_state", :string
12300
+ field :user_choice, "user_choice", "TravelRuleUserChoice"
12238
12301
  end
12239
12302
 
12240
12303
  # The counterparty's directory entry, or `null` when the transfer links none.
@@ -12471,6 +12534,7 @@ module Didit
12471
12534
  field :deliveries_truncated, "deliveries_truncated", :boolean
12472
12535
  field :not_required_reason, "not_required_reason", :string
12473
12536
  field :proof_state, "proof_state", :string
12537
+ field :user_choice, "user_choice", "TravelRuleUserChoice"
12474
12538
  end
12475
12539
 
12476
12540
  # The counterparty's directory entry, or `null` when the transfer links none.
@@ -12973,6 +13037,10 @@ module Didit
12973
13037
  field :deliveries_truncated, "deliveries_truncated", :boolean
12974
13038
  field :not_required_reason, "not_required_reason", :string
12975
13039
  field :proof_state, "proof_state", :string
13040
+ field :cancel_reason, "cancel_reason", :string
13041
+ field :cancelled_by, "cancelled_by", :string
13042
+ field :notify_on_answer, "notify_on_answer", :boolean
13043
+ field :user_choice, "user_choice", "TravelRuleUserChoice"
12976
13044
  end
12977
13045
 
12978
13046
  class TravelRuleTransferDetailCounterpartyVasp < Didit::Model
@@ -13027,6 +13095,22 @@ module Didit
13027
13095
  field :created_at, "created_at", :datetime
13028
13096
  end
13029
13097
 
13098
+ class TravelRuleUserChoice < Didit::Model
13099
+ field :active, "active", :boolean
13100
+ field :waiting, "waiting", :boolean
13101
+ field :end_user_link, "end_user_link", :string
13102
+ field :link_expires_at, "link_expires_at", :datetime
13103
+ field :emailed_to, "emailed_to", :string
13104
+ field :email_available, "email_available", :boolean
13105
+ end
13106
+
13107
+ class TravelRuleUserLinkResponse < Didit::Model
13108
+ field :end_user_link, "end_user_link", :string
13109
+ field :expires_at, "expires_at", :datetime
13110
+ field :emailed_to, "emailed_to", :string
13111
+ field :email_available, "email_available", :boolean
13112
+ end
13113
+
13030
13114
  # One input or output of a UTXO transaction, as the chain recorded it.
13031
13115
  class TravelRuleUtxoEntry < Didit::Model
13032
13116
  field :address, "address", :string
@@ -13213,6 +13297,7 @@ module Didit
13213
13297
  field :decision, "decision", "TravelRuleCounterpartyDecision"
13214
13298
  field :entity_screening, "entity_screening", "TravelRuleCounterpartyScreening"
13215
13299
  field :questionnaires, "questionnaires", [:array, "TravelRuleCounterpartyQuestionnaire"]
13300
+ field :source, "source", :string
13216
13301
  end
13217
13302
 
13218
13303
  class VaspDirectoryEntryAliases < Didit::Model
@@ -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