didit-sdk 2.15.0 → 2.17.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.
@@ -4448,7 +4448,7 @@ module Didit
4448
4448
  VALUES = [TYPED, DRAWN].freeze
4449
4449
  end
4450
4450
 
4451
- # `null` for a Simple signature, which has no code.
4451
+ # `null` for a Simple signature, which has no code. Always `sms` for a Qualified (QES) signature.
4452
4452
  module SignatureResultConfirmationChannel
4453
4453
  EMAIL = "email"
4454
4454
  SMS = "sms"
@@ -4456,6 +4456,16 @@ module Didit
4456
4456
  VALUES = [EMAIL, SMS].freeze
4457
4457
  end
4458
4458
 
4459
+ # Who sent the code: `didit`, or `qualified_provider` for a Qualified (QES) signature, whose code comes by SMS
4460
+ # from the qualified trust service provider and authorizes the signer's qualified certificate. `null` for a Simple
4461
+ # signature.
4462
+ module SignatureResultConfirmationSentBy
4463
+ DIDIT = "didit"
4464
+ QUALIFIED_PROVIDER = "qualified_provider"
4465
+
4466
+ VALUES = [DIDIT, QUALIFIED_PROVIDER].freeze
4467
+ end
4468
+
4459
4469
  # Known values of an open enum: the API may send others.
4460
4470
  module SignatureResultDeclinedAction
4461
4471
  DECLINE = "DECLINE"
@@ -4498,7 +4508,7 @@ module Didit
4498
4508
  VALUES = [SIGNED, DECLINED, NOT_SIGNED, NOT_REACHED].freeze
4499
4509
  end
4500
4510
 
4501
- # `pdf` for a Simple signature, `pades` for Advanced (AES).
4511
+ # `pdf` for a Simple signature, `pades` for Advanced (AES) and Qualified (QES).
4502
4512
  module SignatureResultFormat
4503
4513
  PDF = "pdf"
4504
4514
  PADES = "pades"
@@ -4506,7 +4516,8 @@ module Didit
4506
4516
  VALUES = [PDF, PADES].freeze
4507
4517
  end
4508
4518
 
4509
- # `simple` (default) or `aes`. `qes` (Qualified Electronic Signature, QES) is an add-on that is not available yet.
4519
+ # `simple` (default), `aes` or `qes` (Qualified electronic signature, QES, an add-on: a qualified trust service
4520
+ # provider issues the signer a qualified certificate and signs after the signer enters the code it texts them).
4510
4521
  module SignatureResultLevel
4511
4522
  SIMPLE = "simple"
4512
4523
  AES = "aes"
@@ -4542,6 +4553,20 @@ module Didit
4542
4553
  VALUES = [INTRO, REVIEW, CODE, SIGNING, SIGNED, DECLINED].freeze
4543
4554
  end
4544
4555
 
4556
+ # Known values of an open enum: the API may send others.
4557
+ module SignatureResultValidationDocumentsFailedChecks
4558
+ INTEGRITY = "integrity"
4559
+ TRUSTED = "trusted"
4560
+ NOT_REVOKED = "not_revoked"
4561
+ COVERAGE = "coverage"
4562
+ TIMESTAMP = "timestamp"
4563
+ QUALIFIED_CERTIFICATE = "qualified_certificate"
4564
+ SIGNER_NAMED = "signer_named"
4565
+ ORIGINAL_KEPT = "original_kept"
4566
+
4567
+ VALUES = [INTEGRITY, TRUSTED, NOT_REVOKED, COVERAGE, TIMESTAMP, QUALIFIED_CERTIFICATE, SIGNER_NAMED, ORIGINAL_KEPT].freeze
4568
+ end
4569
+
4545
4570
  # The step's outcome. A warning sets it through its rule; custom status rules apply after.
4546
4571
  module SignatureResultVerdict
4547
4572
  NOT_FINISHED = "Not Finished"
@@ -5246,6 +5271,30 @@ module Didit
5246
5271
  VALUES = [SENT, ANSWERED, EXPIRED].freeze
5247
5272
  end
5248
5273
 
5274
+ # Known values of an open enum: the API may send others.
5275
+ module TravelRuleCounterpartyScreeningHitsReviewStatus
5276
+ UNREVIEWED = "Unreviewed"
5277
+ CONFIRMED_MATCH = "Confirmed Match"
5278
+ FALSE_POSITIVE = "False Positive"
5279
+ INCONCLUSIVE = "Inconclusive"
5280
+
5281
+ VALUES = [UNREVIEWED, CONFIRMED_MATCH, FALSE_POSITIVE, INCONCLUSIVE].freeze
5282
+ end
5283
+
5284
+ # Known values of an open enum: the API may send others.
5285
+ module TravelRuleCounterpartyScreeningPeopleScreeningReason
5286
+ PEOPLE_NOT_PROVIDED = "people_not_provided"
5287
+
5288
+ VALUES = [PEOPLE_NOT_PROVIDED].freeze
5289
+ end
5290
+
5291
+ # Known values of an open enum: the API may send others.
5292
+ module TravelRuleCounterpartyScreeningPeopleScreeningStatus
5293
+ NOT_RUN = "not_run"
5294
+
5295
+ VALUES = [NOT_RUN].freeze
5296
+ end
5297
+
5249
5298
  # screened: a new screening ran and was billed (201). reused: a fresh screening was returned and nothing was
5250
5299
  # billed (200).
5251
5300
  module TravelRuleCounterpartyScreeningResultOutcome
@@ -5255,6 +5304,13 @@ module Didit
5255
5304
  VALUES = [SCREENED, REUSED].freeze
5256
5305
  end
5257
5306
 
5307
+ # What was screened: the company name only. People are never inferred from the due-diligence questionnaire.
5308
+ module TravelRuleCounterpartyScreeningScope
5309
+ COMPANY = "company"
5310
+
5311
+ VALUES = [COMPANY].freeze
5312
+ end
5313
+
5258
5314
  # Approved: no possible match needs attention. In Review or Declined: a possible sanctions or adverse-media match.
5259
5315
  module TravelRuleCounterpartyScreeningStatusValues
5260
5316
  APPROVED = "Approved"
@@ -5335,6 +5391,15 @@ module Didit
5335
5391
  VALUES = [OWNERSHIP_CONFIRMED, WALLET_PROOF, ADDRESS_BOOK_MATCH, OWN_VERIFIED_WALLET, INQUIRY_APPROVED, KNOWN_PAYMENT_METHOD, TRAVEL_ADDRESS].freeze
5336
5392
  end
5337
5393
 
5394
+ # `email_undeliverable`: the email bounced or the address does not accept mail. `delivery_failed`: any other
5395
+ # failure.
5396
+ module TravelRuleDeliveryFailureCode
5397
+ EMAIL_UNDELIVERABLE = "email_undeliverable"
5398
+ DELIVERY_FAILED = "delivery_failed"
5399
+
5400
+ VALUES = [EMAIL_UNDELIVERABLE, DELIVERY_FAILED].freeze
5401
+ end
5402
+
5338
5403
  # What the message carries. `SEND`: the transfer's first message to the counterparty (outbound; the rail is chosen
5339
5404
  # when it is sent). `ANSWER`: your accept or decline, owed to the network that asked (inbound). `TXID`: the
5340
5405
  # on-chain transaction hash, after you finish the transfer. `CANCEL`: the cancellation, after you cancel it.
@@ -5350,6 +5415,15 @@ module Didit
5350
5415
  VALUES = [SEND, ANSWER, TXID, CANCEL, POLL].freeze
5351
5416
  end
5352
5417
 
5418
+ # `email_undeliverable`: the email bounced or the address does not accept mail. `delivery_failed`: any other
5419
+ # failure.
5420
+ module TravelRuleDeliveryLogEntryFailureCode
5421
+ EMAIL_UNDELIVERABLE = "email_undeliverable"
5422
+ DELIVERY_FAILED = "delivery_failed"
5423
+
5424
+ VALUES = [EMAIL_UNDELIVERABLE, DELIVERY_FAILED].freeze
5425
+ end
5426
+
5353
5427
  # What the message carries. `SEND`: the transfer's first message to the counterparty (outbound; the rail is chosen
5354
5428
  # when it is sent). `ANSWER`: your accept or decline, owed to the network that asked (inbound). `TXID`: the
5355
5429
  # on-chain transaction hash, after you finish the transfer. `CANCEL`: the cancellation, after you cancel it.
@@ -5395,9 +5469,10 @@ module Didit
5395
5469
  VERIFYVASP = "VERIFYVASP"
5396
5470
  SYGNA = "SYGNA"
5397
5471
  EMAIL = "EMAIL"
5472
+ TEST_VASP = "TEST_VASP"
5398
5473
  VALUE = ""
5399
5474
 
5400
- VALUES = [INTERNAL, TRP, GTR, TRUST, VERIFYVASP, SYGNA, EMAIL, VALUE].freeze
5475
+ VALUES = [INTERNAL, TRP, GTR, TRUST, VERIFYVASP, SYGNA, EMAIL, TEST_VASP, VALUE].freeze
5401
5476
  end
5402
5477
 
5403
5478
  # `QUEUED`: waiting to be sent. `SENDING`: an attempt is running. `RETRYING`: an attempt failed and the next one
@@ -5640,6 +5715,21 @@ module Didit
5640
5715
  VALUES = [DRAFT, SUBMITTED, CHANGES_REQUESTED, APPROVED, REJECTED].freeze
5641
5716
  end
5642
5717
 
5718
+ # Known values of an open enum: the API may send others.
5719
+ module TravelRuleNetworkStateLoadErrorCode
5720
+ NETWORK_STATE_UNAVAILABLE = "network_state_unavailable"
5721
+
5722
+ VALUES = [NETWORK_STATE_UNAVAILABLE].freeze
5723
+ end
5724
+
5725
+ # `error` when this network's row could not be loaded; the other networks are unaffected.
5726
+ module TravelRuleNetworkStateLoadStatus
5727
+ LOADED = "loaded"
5728
+ ERROR = "error"
5729
+
5730
+ VALUES = [LOADED, ERROR].freeze
5731
+ end
5732
+
5643
5733
  # own: the application's connected membership is used; didit: Didit's membership carries the application as its
5644
5734
  # own active participant; off: platform routing disabled in disabled_networks with no own membership; unavailable:
5645
5735
  # nothing can send on this network yet (see state and reason).
@@ -5931,6 +6021,17 @@ module Didit
5931
6021
  VALUES = [INTERNAL, TRP, GTR, TRUST, VERIFYVASP, SYGNA, EMAIL, TEST_VASP].freeze
5932
6022
  end
5933
6023
 
6024
+ # The transaction's own review decision, which can differ from the transfer's `status`: a transfer may wait on its
6025
+ # counterparty while its transaction is approved, or be stuck while its transaction is in review.
6026
+ module TravelRuleTransferRowReviewStatus
6027
+ APPROVED = "APPROVED"
6028
+ IN_REVIEW = "IN_REVIEW"
6029
+ DECLINED = "DECLINED"
6030
+ AWAITING_USER = "AWAITING_USER"
6031
+
6032
+ VALUES = [APPROVED, IN_REVIEW, DECLINED, AWAITING_USER].freeze
6033
+ end
6034
+
5934
6035
  # Known values of an open enum: the API may send others.
5935
6036
  module TravelRuleTransferRowStatus
5936
6037
  AWAITING_COUNTERPARTY = "AWAITING_COUNTERPARTY"
@@ -5950,6 +6051,25 @@ module Didit
5950
6051
  VALUES = [AWAITING_COUNTERPARTY, ON_HOLD, COMPLETED, FINISHED, CANCELLED, EXPIRED, COUNTERPARTY_MISMATCHED_DATA, COUNTERPARTY_VASP_NOT_FOUND, COUNTERPARTY_VASP_NOT_REACHABLE, UNCONFIRMED_OWNERSHIP, COUNTERPARTY_VASP_GENERAL_DECLINE, NOT_ENOUGH_COUNTERPARTY_DATA, NOT_APPLICABLE].freeze
5951
6052
  end
5952
6053
 
6054
+ # `book`: the wallet is in your address book (`entry_id`). `didit`: exactly one other Didit participant has proven
6055
+ # ownership of it (`vasp_name`, `proof_state`). `ambiguous`: more than one other participant has proven it, so
6056
+ # nothing about them is returned. `none`: no match.
6057
+ module TravelRuleWalletLookupMatch
6058
+ BOOK = "book"
6059
+ DIDIT = "didit"
6060
+ AMBIGUOUS = "ambiguous"
6061
+ NONE = "none"
6062
+
6063
+ VALUES = [BOOK, DIDIT, AMBIGUOUS, NONE].freeze
6064
+ end
6065
+
6066
+ # Only with `match: didit`.
6067
+ module TravelRuleWalletLookupProofState
6068
+ VERIFIED = "verified"
6069
+
6070
+ VALUES = [VERIFIED].freeze
6071
+ end
6072
+
5953
6073
  # Why a wallet-ownership proof, or its last attempt, fell short of VERIFIED. Empty when nothing failed. A PENDING
5954
6074
  # proof can carry one: the last attempt failed and the end user can try again. DEPOSIT_MISMATCH, DEPOSIT_STALE,
5955
6075
  # TXID_REUSED and REVIEW_REJECTED close the proof as REJECTED. SIGNATURE_INVALID: the signature does not match the
@@ -5999,6 +6119,25 @@ module Didit
5999
6119
  VALUES = [PENDING, VERIFIED, REJECTED, EXPIRED].freeze
6000
6120
  end
6001
6121
 
6122
+ # Known values of an open enum: the API may send others.
6123
+ module TravelRuleWalletTransferStatus
6124
+ AWAITING_COUNTERPARTY = "AWAITING_COUNTERPARTY"
6125
+ ON_HOLD = "ON_HOLD"
6126
+ COMPLETED = "COMPLETED"
6127
+ FINISHED = "FINISHED"
6128
+ CANCELLED = "CANCELLED"
6129
+ EXPIRED = "EXPIRED"
6130
+ COUNTERPARTY_MISMATCHED_DATA = "COUNTERPARTY_MISMATCHED_DATA"
6131
+ COUNTERPARTY_VASP_NOT_FOUND = "COUNTERPARTY_VASP_NOT_FOUND"
6132
+ COUNTERPARTY_VASP_NOT_REACHABLE = "COUNTERPARTY_VASP_NOT_REACHABLE"
6133
+ UNCONFIRMED_OWNERSHIP = "UNCONFIRMED_OWNERSHIP"
6134
+ COUNTERPARTY_VASP_GENERAL_DECLINE = "COUNTERPARTY_VASP_GENERAL_DECLINE"
6135
+ NOT_ENOUGH_COUNTERPARTY_DATA = "NOT_ENOUGH_COUNTERPARTY_DATA"
6136
+ NOT_APPLICABLE = "NOT_APPLICABLE"
6137
+
6138
+ VALUES = [AWAITING_COUNTERPARTY, ON_HOLD, COMPLETED, FINISHED, CANCELLED, EXPIRED, COUNTERPARTY_MISMATCHED_DATA, COUNTERPARTY_VASP_NOT_FOUND, COUNTERPARTY_VASP_NOT_REACHABLE, UNCONFIRMED_OWNERSHIP, COUNTERPARTY_VASP_GENERAL_DECLINE, NOT_ENOUGH_COUNTERPARTY_DATA, NOT_APPLICABLE].freeze
6139
+ end
6140
+
6002
6141
  # Structured rejection reason. Empty when none was recorded; a new claim or approval clears it. Read review_note
6003
6142
  # for the explanation.
6004
6143
  module TravelRuleWorkspaceClaimRejectionReason
@@ -11942,6 +12081,7 @@ module Didit
11942
12081
  end
11943
12082
 
11944
12083
  class SignatureResultConfirmation < Didit::Model
12084
+ field :sent_by, "sent_by", :string
11945
12085
  field :channel, "channel", :string
11946
12086
  field :destination, "destination", :string
11947
12087
  field :confirmed_at, "confirmed_at", :datetime
@@ -12015,6 +12155,7 @@ module Didit
12015
12155
  field :reason, "reason", :string
12016
12156
  field :checked_at, "checked_at", :datetime
12017
12157
  field :documents, "documents", [:array, "SignatureResultValidationDocuments"]
12158
+ field :profile, "profile", :string
12018
12159
  end
12019
12160
 
12020
12161
  class SignatureResultValidationDocuments < Didit::Model
@@ -12027,6 +12168,9 @@ module Didit
12027
12168
  field :trusted_list, "trusted_list", "SignatureResultValidationDocumentsTrustedList"
12028
12169
  field :certificate, "certificate", "SignatureResultValidationDocumentsCertificate"
12029
12170
  field :timestamp, "timestamp", "SignatureResultValidationDocumentsTimestamp"
12171
+ field :qualified, "qualified", :boolean
12172
+ field :profile, "profile", :string
12173
+ field :failed_checks, "failed_checks", [:array, :string]
12030
12174
  end
12031
12175
 
12032
12176
  # The certificate the documents were signed with. `null` until signed, and always `null` for a Simple signature.
@@ -12036,17 +12180,28 @@ module Didit
12036
12180
  field :serial, "serial", :string
12037
12181
  field :valid_from, "valid_from", :datetime
12038
12182
  field :valid_until, "valid_until", :datetime
12183
+ field :qualified_statements, "qualified_statements", "SignatureResultValidationDocumentsCertificateQualifiedStatements"
12039
12184
  end
12040
12185
 
12041
- # The RFC 3161 timestamp in the signature, issued by Didit. `null` until signed, and always `null` for a Simple
12042
- # signature.
12186
+ # QES: which ETSI EN 319 412-5 statements the certificate carries.
12187
+ class SignatureResultValidationDocumentsCertificateQualifiedStatements < Didit::Model
12188
+ field :qc_compliance, "qc_compliance", :boolean
12189
+ field :qc_sscd, "qc_sscd", :boolean
12190
+ field :qc_type_esign, "qc_type_esign", :boolean
12191
+ end
12192
+
12193
+ # The RFC 3161 timestamp in the signature: issued by Didit for AES, by the qualified trust service provider for
12194
+ # QES. `null` until signed, and always `null` for a Simple signature.
12043
12195
  class SignatureResultValidationDocumentsTimestamp < Didit::Model
12044
12196
  field :time, "time", :datetime
12045
12197
  field :qualified, "qualified", :boolean
12046
12198
  field :valid, "valid", :boolean
12047
12199
  end
12048
12200
 
12049
- # EU Trusted List check. For AES: `{"status": "not_applicable", "reason": "aes_not_qualified"}`.
12201
+ # EU Trusted List check. AES: `{"status": "not_applicable", "reason": "aes_not_qualified"}`. QES: `{"status":
12202
+ # "granted"}` when the certificate is a qualified certificate for electronic signatures issued under the qualified
12203
+ # trust service provider's Trusted List entry, else `{"status": "not_granted", ...}`. A sandbox session's
12204
+ # qualified level is sealed by Didit: `{"status": "not_applicable", "reason": "sandbox"}`.
12050
12205
  class SignatureResultValidationDocumentsTrustedList < Didit::Model
12051
12206
  field :status, "status", :string
12052
12207
  field :reason, "reason", :string
@@ -12672,6 +12827,29 @@ module Didit
12672
12827
  field :screened_at, "screened_at", :datetime
12673
12828
  field :fresh, "fresh", :boolean
12674
12829
  field :flagged, "flagged", :boolean
12830
+ field :scope, "scope", :string
12831
+ field :people_screening, "people_screening", "TravelRuleCounterpartyScreeningPeopleScreening"
12832
+ field :hits, "hits", [:array, "TravelRuleCounterpartyScreeningHits"]
12833
+ end
12834
+
12835
+ class TravelRuleCounterpartyScreeningHits < Didit::Model
12836
+ field :id, "id", :string
12837
+ field :review, "review", "TravelRuleCounterpartyScreeningHitsReview"
12838
+ field :dismissed, "dismissed", :boolean
12839
+ end
12840
+
12841
+ # The review recorded for the hit, or null while nobody reviewed it.
12842
+ class TravelRuleCounterpartyScreeningHitsReview < Didit::Model
12843
+ field :status, "status", :string
12844
+ field :reason, "reason", :string
12845
+ field :reviewed_by, "reviewed_by", :string
12846
+ field :reviewed_at, "reviewed_at", :datetime
12847
+ end
12848
+
12849
+ # People screening is not run for counterparties.
12850
+ class TravelRuleCounterpartyScreeningPeopleScreening < Didit::Model
12851
+ field :status, "status", :string
12852
+ field :reason, "reason", :string
12675
12853
  end
12676
12854
 
12677
12855
  class TravelRuleCounterpartyScreeningResult < Didit::Model
@@ -12732,6 +12910,16 @@ module Didit
12732
12910
  field :last_error, "last_error", :string
12733
12911
  field :next_attempt_at, "next_attempt_at", :datetime
12734
12912
  field :delivered_at, "delivered_at", :datetime
12913
+ field :updated_at, "updated_at", :datetime
12914
+ field :failure, "failure", "TravelRuleDeliveryFailure"
12915
+ field :route, "route", :string
12916
+ end
12917
+
12918
+ # Why the last attempt failed, or null while the message has not failed. The message is a fixed customer-safe
12919
+ # sentence: it never carries the counterparty's own text or a transport error.
12920
+ class TravelRuleDeliveryFailure < Didit::Model
12921
+ field :code, "code", :string
12922
+ field :message, "message", :string
12735
12923
  end
12736
12924
 
12737
12925
  # One supplier-neutral entry in the delivery history.
@@ -12743,6 +12931,18 @@ module Didit
12743
12931
  field :created_at, "created_at", :datetime
12744
12932
  field :delivered_at, "delivered_at", :datetime
12745
12933
  field :detail_lines, "detail_lines", [:array, :string]
12934
+ field :attempts, "attempts", :integer
12935
+ field :updated_at, "updated_at", :datetime
12936
+ field :next_attempt_at, "next_attempt_at", :datetime
12937
+ field :failure, "failure", "TravelRuleDeliveryLogEntryFailure"
12938
+ field :route, "route", :string
12939
+ end
12940
+
12941
+ # Why the last attempt failed, or null while the message has not failed. The message is a fixed customer-safe
12942
+ # sentence: it never carries the counterparty's own text or a transport error.
12943
+ class TravelRuleDeliveryLogEntryFailure < Didit::Model
12944
+ field :code, "code", :string
12945
+ field :message, "message", :string
12746
12946
  end
12747
12947
 
12748
12948
  class TravelRuleDeliveryLogPage < Didit::Model
@@ -12858,6 +13058,8 @@ module Didit
12858
13058
  field :suspended_at, "suspended_at", :datetime
12859
13059
  field :last_error, "last_error", :string
12860
13060
  field :history, "history", [:array, "TravelRuleNetworkParticipantHistory"]
13061
+ field :notify_status_changes, "notify_status_changes", :boolean
13062
+ field :notification_email, "notification_email", :string
12861
13063
  end
12862
13064
 
12863
13065
  class TravelRuleNetworkParticipantHistory < Didit::Model
@@ -12935,6 +13137,14 @@ module Didit
12935
13137
  field :participant, "participant", "TravelRuleNetworkParticipantSummary"
12936
13138
  field :vasps_reachable, "vasps_reachable", :integer
12937
13139
  field :routed_30d, "routed_30d", :integer
13140
+ field :load_status, "load_status", :string
13141
+ field :load_error, "load_error", "TravelRuleNetworkStateLoadError"
13142
+ end
13143
+
13144
+ # Present only when `load_status` is `error`.
13145
+ class TravelRuleNetworkStateLoadError < Didit::Model
13146
+ field :code, "code", :string
13147
+ field :retryable, "retryable", :boolean
12938
13148
  end
12939
13149
 
12940
13150
  class TravelRuleNetworksOverview < Didit::Model
@@ -12942,6 +13152,7 @@ module Didit
12942
13152
  field :questionnaire, "questionnaire", "TravelRuleNetworkQuestionnaire"
12943
13153
  field :participants, "participants", [:array, "TravelRuleNetworkParticipant"]
12944
13154
  field :networks, "networks", "TravelRuleNetworksOverviewNetworks"
13155
+ field :notification_email, "notification_email", :string
12945
13156
  end
12946
13157
 
12947
13158
  # Per network, how this application would send and why it cannot. No network, including GTR, is included by
@@ -13085,22 +13296,29 @@ module Didit
13085
13296
  field :reason, "reason", :string
13086
13297
  end
13087
13298
 
13088
- # One Travel Rule transfer as the transfers list shows it: VASP names, wallets and memos only, never the
13089
- # originator or beneficiary person data.
13299
+ # One Travel Rule transfer as the transfers list shows it: VASP names, wallets, memos, the transaction's review
13300
+ # decision, your own end user's name (masked exactly as the transaction detail masks it), the counterparty VASP's
13301
+ # jurisdiction, the chain and the fiat amount. It never carries the counterparty's person data.
13090
13302
  class TravelRuleTransferRow < Didit::Model
13091
13303
  field :id, "id", :string
13092
13304
  field :transaction_id, "transaction_id", :string
13093
13305
  field :txn_id, "txn_id", :string
13094
13306
  field :txn_date, "txn_date", :datetime
13307
+ field :review_status, "review_status", :string
13308
+ field :person_name, "person_name", :string
13095
13309
  field :kind, "kind", :string
13096
13310
  field :direction, "direction", :string
13097
13311
  field :status, "status", :string
13098
13312
  field :reason, "reason", :string
13099
13313
  field :rail, "rail", :string
13100
13314
  field :asset, "asset", :string
13315
+ field :chain, "chain", :string
13101
13316
  field :amount, "amount", :string
13317
+ field :fiat_amount, "fiat_amount", :string
13318
+ field :fiat_currency, "fiat_currency", :string
13102
13319
  field :originator_vasp, "originator_vasp", :string
13103
13320
  field :beneficiary_vasp, "beneficiary_vasp", :string
13321
+ field :counterparty_jurisdiction, "counterparty_jurisdiction", :string
13104
13322
  field :originator_wallet, "originator_wallet", :string
13105
13323
  field :beneficiary_wallet, "beneficiary_wallet", :string
13106
13324
  field :originator_memo, "originator_memo", :string
@@ -13138,6 +13356,29 @@ module Didit
13138
13356
  field :vout, "vout", :integer
13139
13357
  end
13140
13358
 
13359
+ # The member the VASP is assigned to, or null. The assignment is private to your application.
13360
+ class TravelRuleVaspAssignee < Didit::Model
13361
+ field :uuid, "uuid", :string
13362
+ field :full_name, "full_name", :string
13363
+ field :email, "email", :string
13364
+ field :assigned_at, "assigned_at", :datetime
13365
+ end
13366
+
13367
+ class TravelRuleVaspReviewer < Didit::Model
13368
+ field :user_id, "user_id", :string
13369
+ field :email, "email", :string
13370
+ field :name, "name", :string
13371
+ field :role, "role", :string
13372
+ end
13373
+
13374
+ class TravelRuleWalletLookup < Didit::Model
13375
+ field :match, "match", :string
13376
+ field :directory_checked, "directory_checked", :boolean
13377
+ field :entry_id, "entry_id", :string
13378
+ field :vasp_name, "vasp_name", :string
13379
+ field :proof_state, "proof_state", :string
13380
+ end
13381
+
13141
13382
  class TravelRuleWalletProofReview < Didit::Model
13142
13383
  field :proof_id, "proof_id", :string
13143
13384
  field :method_, "method", :string
@@ -13159,6 +13400,12 @@ module Didit
13159
13400
  field :created_at, "created_at", :datetime
13160
13401
  end
13161
13402
 
13403
+ class TravelRuleWalletTransfer < Didit::Model
13404
+ field :transfer_id, "transfer_id", :string
13405
+ field :status, "status", :string
13406
+ field :created_at, "created_at", :datetime
13407
+ end
13408
+
13162
13409
  class TravelRuleWidgetSessionResponse < Didit::Model
13163
13410
  field :widget_session_id, "widget_session_id", :string
13164
13411
  field :token, "token", :string
@@ -13317,6 +13564,7 @@ module Didit
13317
13564
  field :entity_screening, "entity_screening", "TravelRuleCounterpartyScreening"
13318
13565
  field :questionnaires, "questionnaires", [:array, "TravelRuleCounterpartyQuestionnaire"]
13319
13566
  field :source, "source", :string
13567
+ field :assignee, "assignee", "TravelRuleVaspAssignee"
13320
13568
  end
13321
13569
 
13322
13570
  class VaspDirectoryEntryAliases < Didit::Model
@@ -3,6 +3,16 @@
3
3
 
4
4
  module Didit
5
5
  module Types
6
+ # Only with `wallet_entry_id`. `ensure` and `resend` return the entry's active link when it has one (`200`) and
7
+ # create one otherwise (`201`). `new` revokes the active link and creates another; it needs `request_key`.
8
+ module TravelRuleCreateWidgetSessionParamsRequestAction
9
+ ENSURE = "ensure"
10
+ RESEND = "resend"
11
+ NEW = "new"
12
+
13
+ VALUES = [ENSURE, RESEND, NEW].freeze
14
+ end
15
+
6
16
  # Known values of an open enum: the API may send others.
7
17
  module TravelRuleListVaspsParamsKind
8
18
  DIRECTORY = "directory"
@@ -40,6 +50,16 @@ module Didit
40
50
  VALUES = [LOW, MEDIUM, HIGH].freeze
41
51
  end
42
52
 
53
+ # Known values of an open enum: the API may send others.
54
+ module TravelRuleReviewVaspScreeningHitParamsReviewStatus
55
+ UNREVIEWED = "Unreviewed"
56
+ CONFIRMED_MATCH = "Confirmed Match"
57
+ FALSE_POSITIVE = "False Positive"
58
+ INCONCLUSIVE = "Inconclusive"
59
+
60
+ VALUES = [UNREVIEWED, CONFIRMED_MATCH, FALSE_POSITIVE, INCONCLUSIVE].freeze
61
+ end
62
+
43
63
  # Known values of an open enum: the API may send others.
44
64
  module TravelRuleUpdateSettingsParamsDisabledNetworks
45
65
  GTR = "GTR"
@@ -126,6 +146,12 @@ module Didit
126
146
  VALUES = [PENDING, VERIFIED, REJECTED, EXPIRED].freeze
127
147
  end
128
148
 
149
+ class TravelRuleAssignVaspResponse < Didit::Model
150
+ field :id, "id", :string
151
+ field :assignee, "assignee", "TravelRuleVaspAssignee"
152
+ field :changed, "changed", :boolean
153
+ end
154
+
129
155
  class TravelRuleCounterpartyContactsListResponse < Didit::Model
130
156
  field :count, "count", :integer
131
157
  field :next, "next", :string
@@ -133,6 +159,10 @@ module Didit
133
159
  field :results, "results", [:array, "TravelRuleCounterpartyContact"]
134
160
  end
135
161
 
162
+ class TravelRuleListVaspReviewersResponse < Didit::Model
163
+ field :results, "results", [:array, "TravelRuleVaspReviewer"]
164
+ end
165
+
136
166
  class TravelRuleListVaspsResponse < Didit::Model
137
167
  field :count, "count", :integer
138
168
  field :next, "next", :string
@@ -140,6 +170,11 @@ module Didit
140
170
  field :results, "results", [:array, "VaspDirectoryEntry"]
141
171
  end
142
172
 
173
+ class TravelRuleReviewVaspScreeningHitResponse < Didit::Model
174
+ field :screening, "screening", "TravelRuleCounterpartyScreening"
175
+ field :changed, "changed", :boolean
176
+ end
177
+
143
178
  class TravelRuleSendComplianceEmailConfirmationResponse < Didit::Model
144
179
  field :sent_to, "sent_to", :string
145
180
  end
@@ -165,6 +200,13 @@ module Didit
165
200
  field :results, "results", [:array, "WalletAddressEntry"]
166
201
  end
167
202
 
203
+ class TravelRuleWalletAddressesListTransfersResponse < Didit::Model
204
+ field :count, "count", :integer
205
+ field :next, "next", :string
206
+ field :previous, "previous", :string
207
+ field :results, "results", [:array, "TravelRuleWalletTransfer"]
208
+ end
209
+
168
210
  class TravelRuleWalletProofsListResponse < Didit::Model
169
211
  field :count, "count", :integer
170
212
  field :next, "next", :string
data/lib/didit/types.rb CHANGED
@@ -1429,6 +1429,7 @@ module Didit
1429
1429
  autoload :SignatureResultCertificate, "didit/types/components"
1430
1430
  autoload :SignatureResultConfirmation, "didit/types/components"
1431
1431
  autoload :SignatureResultConfirmationChannel, "didit/types/components"
1432
+ autoload :SignatureResultConfirmationSentBy, "didit/types/components"
1432
1433
  autoload :SignatureResultDeclinedAction, "didit/types/components"
1433
1434
  autoload :SignatureResultDocuments, "didit/types/components"
1434
1435
  autoload :SignatureResultDocumentsConversion, "didit/types/components"
@@ -1447,6 +1448,8 @@ module Didit
1447
1448
  autoload :SignatureResultValidation, "didit/types/components"
1448
1449
  autoload :SignatureResultValidationDocuments, "didit/types/components"
1449
1450
  autoload :SignatureResultValidationDocumentsCertificate, "didit/types/components"
1451
+ autoload :SignatureResultValidationDocumentsCertificateQualifiedStatements, "didit/types/components"
1452
+ autoload :SignatureResultValidationDocumentsFailedChecks, "didit/types/components"
1450
1453
  autoload :SignatureResultValidationDocumentsTimestamp, "didit/types/components"
1451
1454
  autoload :SignatureResultValidationDocumentsTrustedList, "didit/types/components"
1452
1455
  autoload :SignatureResultVerdict, "didit/types/components"
@@ -1574,6 +1577,7 @@ module Didit
1574
1577
  autoload :TransactionsTravelRuleTriggerTestVaspInboundParamsScenario, "didit/types/transactions"
1575
1578
  autoload :TransactionsTravelRuleUpdateTransferParamsAction, "didit/types/transactions"
1576
1579
  autoload :TransactionsTravelRuleUpdateTransferParamsReason, "didit/types/transactions"
1580
+ autoload :TravelRuleAssignVaspResponse, "didit/types/travel_rule"
1577
1581
  autoload :TravelRuleChainDetails, "didit/types/components"
1578
1582
  autoload :TravelRuleChainDetailsNotApplicableReason, "didit/types/components"
1579
1583
  autoload :TravelRuleChainDetailsShape, "didit/types/components"
@@ -1594,10 +1598,18 @@ module Didit
1594
1598
  autoload :TravelRuleCounterpartyQuestionnaireList, "didit/types/components"
1595
1599
  autoload :TravelRuleCounterpartyQuestionnaireStatus, "didit/types/components"
1596
1600
  autoload :TravelRuleCounterpartyScreening, "didit/types/components"
1601
+ autoload :TravelRuleCounterpartyScreeningHits, "didit/types/components"
1602
+ autoload :TravelRuleCounterpartyScreeningHitsReview, "didit/types/components"
1603
+ autoload :TravelRuleCounterpartyScreeningHitsReviewStatus, "didit/types/components"
1604
+ autoload :TravelRuleCounterpartyScreeningPeopleScreening, "didit/types/components"
1605
+ autoload :TravelRuleCounterpartyScreeningPeopleScreeningReason, "didit/types/components"
1606
+ autoload :TravelRuleCounterpartyScreeningPeopleScreeningStatus, "didit/types/components"
1597
1607
  autoload :TravelRuleCounterpartyScreeningResult, "didit/types/components"
1598
1608
  autoload :TravelRuleCounterpartyScreeningResultOutcome, "didit/types/components"
1609
+ autoload :TravelRuleCounterpartyScreeningScope, "didit/types/components"
1599
1610
  autoload :TravelRuleCounterpartyScreeningStatus, "didit/types/components"
1600
1611
  autoload :TravelRuleCounterpartyScreeningStatusValues, "didit/types/components"
1612
+ autoload :TravelRuleCreateWidgetSessionParamsRequestAction, "didit/types/travel_rule"
1601
1613
  autoload :TravelRuleDataMatch, "didit/types/components"
1602
1614
  autoload :TravelRuleDataMatchFieldsValue, "didit/types/components"
1603
1615
  autoload :TravelRuleDataMatchFieldsValueResult, "didit/types/components"
@@ -1609,8 +1621,12 @@ module Didit
1609
1621
  autoload :TravelRuleDataUnmasked, "didit/types/components"
1610
1622
  autoload :TravelRuleDataUnmaskedReason, "didit/types/components"
1611
1623
  autoload :TravelRuleDelivery, "didit/types/components"
1624
+ autoload :TravelRuleDeliveryFailure, "didit/types/components"
1625
+ autoload :TravelRuleDeliveryFailureCode, "didit/types/components"
1612
1626
  autoload :TravelRuleDeliveryKind, "didit/types/components"
1613
1627
  autoload :TravelRuleDeliveryLogEntry, "didit/types/components"
1628
+ autoload :TravelRuleDeliveryLogEntryFailure, "didit/types/components"
1629
+ autoload :TravelRuleDeliveryLogEntryFailureCode, "didit/types/components"
1614
1630
  autoload :TravelRuleDeliveryLogEntryKind, "didit/types/components"
1615
1631
  autoload :TravelRuleDeliveryLogEntryRail, "didit/types/components"
1616
1632
  autoload :TravelRuleDeliveryLogEntryStatus, "didit/types/components"
@@ -1621,6 +1637,7 @@ module Didit
1621
1637
  autoload :TravelRuleDiscoveryStepOutcome, "didit/types/components"
1622
1638
  autoload :TravelRuleDiscoveryStepStep, "didit/types/components"
1623
1639
  autoload :TravelRuleInboundResponse, "didit/types/components"
1640
+ autoload :TravelRuleListVaspReviewersResponse, "didit/types/travel_rule"
1624
1641
  autoload :TravelRuleListVaspsParamsKind, "didit/types/travel_rule"
1625
1642
  autoload :TravelRuleListVaspsParamsNetwork, "didit/types/travel_rule"
1626
1643
  autoload :TravelRuleListVaspsParamsResponsiveness, "didit/types/travel_rule"
@@ -1661,6 +1678,9 @@ module Didit
1661
1678
  autoload :TravelRuleNetworkQuestionnaireHistory, "didit/types/components"
1662
1679
  autoload :TravelRuleNetworkQuestionnaireStatus, "didit/types/components"
1663
1680
  autoload :TravelRuleNetworkState, "didit/types/components"
1681
+ autoload :TravelRuleNetworkStateLoadError, "didit/types/components"
1682
+ autoload :TravelRuleNetworkStateLoadErrorCode, "didit/types/components"
1683
+ autoload :TravelRuleNetworkStateLoadStatus, "didit/types/components"
1664
1684
  autoload :TravelRuleNetworkStateMode, "didit/types/components"
1665
1685
  autoload :TravelRuleNetworkStateRail, "didit/types/components"
1666
1686
  autoload :TravelRuleNetworkStateReason, "didit/types/components"
@@ -1669,6 +1689,8 @@ module Didit
1669
1689
  autoload :TravelRuleNetworksOverviewNetworks, "didit/types/components"
1670
1690
  autoload :TravelRuleNextAction, "didit/types/components"
1671
1691
  autoload :TravelRuleNextActionAction, "didit/types/components"
1692
+ autoload :TravelRuleReviewVaspScreeningHitParamsReviewStatus, "didit/types/travel_rule"
1693
+ autoload :TravelRuleReviewVaspScreeningHitResponse, "didit/types/travel_rule"
1672
1694
  autoload :TravelRuleSendComplianceEmailConfirmationResponse, "didit/types/travel_rule"
1673
1695
  autoload :TravelRuleSettingsDetail, "didit/types/components"
1674
1696
  autoload :TravelRuleSettingsDetailDiditNetwork, "didit/types/components"
@@ -1696,6 +1718,7 @@ module Didit
1696
1718
  autoload :TravelRuleTransferRowKind, "didit/types/components"
1697
1719
  autoload :TravelRuleTransferRowOriginatorWalletType, "didit/types/components"
1698
1720
  autoload :TravelRuleTransferRowRail, "didit/types/components"
1721
+ autoload :TravelRuleTransferRowReviewStatus, "didit/types/components"
1699
1722
  autoload :TravelRuleTransferRowStatus, "didit/types/components"
1700
1723
  autoload :TravelRuleTransfersListResponse, "didit/types/travel_rule"
1701
1724
  autoload :TravelRuleUnmatchedDepositsListResponse, "didit/types/travel_rule"
@@ -1709,7 +1732,13 @@ module Didit
1709
1732
  autoload :TravelRuleUserChoice, "didit/types/components"
1710
1733
  autoload :TravelRuleUserLinkResponse, "didit/types/components"
1711
1734
  autoload :TravelRuleUtxoEntry, "didit/types/components"
1735
+ autoload :TravelRuleVaspAssignee, "didit/types/components"
1736
+ autoload :TravelRuleVaspReviewer, "didit/types/components"
1712
1737
  autoload :TravelRuleWalletAddressesListResponse, "didit/types/travel_rule"
1738
+ autoload :TravelRuleWalletAddressesListTransfersResponse, "didit/types/travel_rule"
1739
+ autoload :TravelRuleWalletLookup, "didit/types/components"
1740
+ autoload :TravelRuleWalletLookupMatch, "didit/types/components"
1741
+ autoload :TravelRuleWalletLookupProofState, "didit/types/components"
1713
1742
  autoload :TravelRuleWalletProofFailureReason, "didit/types/components"
1714
1743
  autoload :TravelRuleWalletProofReview, "didit/types/components"
1715
1744
  autoload :TravelRuleWalletProofReviewMethod, "didit/types/components"
@@ -1717,6 +1746,8 @@ module Didit
1717
1746
  autoload :TravelRuleWalletProofsDecideParamsDecision, "didit/types/travel_rule"
1718
1747
  autoload :TravelRuleWalletProofsListParamsStatus, "didit/types/travel_rule"
1719
1748
  autoload :TravelRuleWalletProofsListResponse, "didit/types/travel_rule"
1749
+ autoload :TravelRuleWalletTransfer, "didit/types/components"
1750
+ autoload :TravelRuleWalletTransferStatus, "didit/types/components"
1720
1751
  autoload :TravelRuleWidgetSessionResponse, "didit/types/components"
1721
1752
  autoload :TravelRuleWorkspace, "didit/types/components"
1722
1753
  autoload :TravelRuleWorkspaceClaim, "didit/types/components"