didit-sdk 2.16.0 → 2.18.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/CHANGELOG.md +211 -0
- data/lib/didit/resources/reports.rb +114 -0
- data/lib/didit/resources/travel_rule.rb +372 -8
- data/lib/didit/resources/webhooks.rb +29 -0
- data/lib/didit/resources.rb +6 -0
- data/lib/didit/types/components.rb +442 -5
- data/lib/didit/types/reports.rb +8 -0
- data/lib/didit/types/travel_rule.rb +44 -0
- data/lib/didit/types.rb +50 -1
- data/lib/didit/version.rb +1 -1
- data/sig/didit/resources/reports.rbs +11 -0
- data/sig/didit/resources/travel_rule.rbs +20 -3
- data/sig/didit/resources/webhooks.rbs +1 -0
- data/sig/didit/resources.rbs +1 -0
- data/sig/didit/types/components.rbs +398 -1
- data/sig/didit/types/reports.rbs +7 -0
- data/sig/didit/types/travel_rule.rbs +55 -2
- metadata +5 -1
|
@@ -287,6 +287,39 @@ module Didit
|
|
|
287
287
|
VALUES = [SESSIONS_VOLUME, WORKFLOW_FUNNEL, AVERAGE_VERIFICATION_TIME, COUNTRY_DISTRIBUTION, WARNING_INSIGHTS, CONVERSION_RATE, CONVERSION_BY_COUNTRY, RESUBMISSION_INSIGHTS, ORIGINAL_STATUS_DISTRIBUTION, DATABASE_VALIDATION_COVERAGE, DATABASE_VALIDATION_LATENCY, DEMOGRAPHICS, DEVICE_DETAILS, HORIZONTAL_BAR, KYB_REGISTRY_COVERAGE, KYB_REGISTRY_DATA_COMPLETENESS, METRIC, TIME_SERIES, BREAKDOWN, STATUS_TIME_SERIES, LEADERBOARD, HISTOGRAM].freeze
|
|
288
288
|
end
|
|
289
289
|
|
|
290
|
+
# Export or compliance-report kind.
|
|
291
|
+
module AsyncReportReportType
|
|
292
|
+
SESSION_EXPORT = "SESSION_EXPORT"
|
|
293
|
+
TRANSACTION_EXPORT = "TRANSACTION_EXPORT"
|
|
294
|
+
BUSINESS_EXPORT = "BUSINESS_EXPORT"
|
|
295
|
+
VENDOR_USER_EXPORT = "VENDOR_USER_EXPORT"
|
|
296
|
+
VENDOR_BUSINESS_EXPORT = "VENDOR_BUSINESS_EXPORT"
|
|
297
|
+
CASE_EXPORT = "CASE_EXPORT"
|
|
298
|
+
CASE_SLA_EXPORT = "CASE_SLA_EXPORT"
|
|
299
|
+
LIST_ENTRY_EXPORT = "LIST_ENTRY_EXPORT"
|
|
300
|
+
EVENT_EXPORT = "EVENT_EXPORT"
|
|
301
|
+
COMPLIANCE_KYC_KYB = "COMPLIANCE_KYC_KYB"
|
|
302
|
+
COMPLIANCE_AML_LOG = "COMPLIANCE_AML_LOG"
|
|
303
|
+
COMPLIANCE_TRAVEL_RULE = "COMPLIANCE_TRAVEL_RULE"
|
|
304
|
+
COMPLIANCE_SANCTIONS_PEP = "COMPLIANCE_SANCTIONS_PEP"
|
|
305
|
+
COMPLIANCE_RISK_SUMMARY = "COMPLIANCE_RISK_SUMMARY"
|
|
306
|
+
COMPLIANCE_SAR_STR_DRAFT = "COMPLIANCE_SAR_STR_DRAFT"
|
|
307
|
+
COMPLIANCE_CTR = "COMPLIANCE_CTR"
|
|
308
|
+
COMPLIANCE_CASE_SUMMARY = "COMPLIANCE_CASE_SUMMARY"
|
|
309
|
+
|
|
310
|
+
VALUES = [SESSION_EXPORT, TRANSACTION_EXPORT, BUSINESS_EXPORT, VENDOR_USER_EXPORT, VENDOR_BUSINESS_EXPORT, CASE_EXPORT, CASE_SLA_EXPORT, LIST_ENTRY_EXPORT, EVENT_EXPORT, COMPLIANCE_KYC_KYB, COMPLIANCE_AML_LOG, COMPLIANCE_TRAVEL_RULE, COMPLIANCE_SANCTIONS_PEP, COMPLIANCE_RISK_SUMMARY, COMPLIANCE_SAR_STR_DRAFT, COMPLIANCE_CTR, COMPLIANCE_CASE_SUMMARY].freeze
|
|
311
|
+
end
|
|
312
|
+
|
|
313
|
+
# Generation state. READY may include individual failures; inspect failed_count.
|
|
314
|
+
module AsyncReportStatus
|
|
315
|
+
PENDING = "PENDING"
|
|
316
|
+
PROCESSING = "PROCESSING"
|
|
317
|
+
READY = "READY"
|
|
318
|
+
FAILED = "FAILED"
|
|
319
|
+
|
|
320
|
+
VALUES = [PENDING, PROCESSING, READY, FAILED].freeze
|
|
321
|
+
end
|
|
322
|
+
|
|
290
323
|
# `match`: the bank holds the account under the name you sent. `close_match`: under a close name, for example a
|
|
291
324
|
# missing middle name or a typo. `no_match`: under another name, or there is no such account. `cannot_verify`: the
|
|
292
325
|
# bank answered without comparing the name, for example for a blocked or closed account.
|
|
@@ -5271,6 +5304,30 @@ module Didit
|
|
|
5271
5304
|
VALUES = [SENT, ANSWERED, EXPIRED].freeze
|
|
5272
5305
|
end
|
|
5273
5306
|
|
|
5307
|
+
# Known values of an open enum: the API may send others.
|
|
5308
|
+
module TravelRuleCounterpartyScreeningHitsReviewStatus
|
|
5309
|
+
UNREVIEWED = "Unreviewed"
|
|
5310
|
+
CONFIRMED_MATCH = "Confirmed Match"
|
|
5311
|
+
FALSE_POSITIVE = "False Positive"
|
|
5312
|
+
INCONCLUSIVE = "Inconclusive"
|
|
5313
|
+
|
|
5314
|
+
VALUES = [UNREVIEWED, CONFIRMED_MATCH, FALSE_POSITIVE, INCONCLUSIVE].freeze
|
|
5315
|
+
end
|
|
5316
|
+
|
|
5317
|
+
# Known values of an open enum: the API may send others.
|
|
5318
|
+
module TravelRuleCounterpartyScreeningPeopleScreeningReason
|
|
5319
|
+
PEOPLE_NOT_PROVIDED = "people_not_provided"
|
|
5320
|
+
|
|
5321
|
+
VALUES = [PEOPLE_NOT_PROVIDED].freeze
|
|
5322
|
+
end
|
|
5323
|
+
|
|
5324
|
+
# Known values of an open enum: the API may send others.
|
|
5325
|
+
module TravelRuleCounterpartyScreeningPeopleScreeningStatus
|
|
5326
|
+
NOT_RUN = "not_run"
|
|
5327
|
+
|
|
5328
|
+
VALUES = [NOT_RUN].freeze
|
|
5329
|
+
end
|
|
5330
|
+
|
|
5274
5331
|
# screened: a new screening ran and was billed (201). reused: a fresh screening was returned and nothing was
|
|
5275
5332
|
# billed (200).
|
|
5276
5333
|
module TravelRuleCounterpartyScreeningResultOutcome
|
|
@@ -5280,6 +5337,13 @@ module Didit
|
|
|
5280
5337
|
VALUES = [SCREENED, REUSED].freeze
|
|
5281
5338
|
end
|
|
5282
5339
|
|
|
5340
|
+
# What was screened: the company name only. People are never inferred from the due-diligence questionnaire.
|
|
5341
|
+
module TravelRuleCounterpartyScreeningScope
|
|
5342
|
+
COMPANY = "company"
|
|
5343
|
+
|
|
5344
|
+
VALUES = [COMPANY].freeze
|
|
5345
|
+
end
|
|
5346
|
+
|
|
5283
5347
|
# Approved: no possible match needs attention. In Review or Declined: a possible sanctions or adverse-media match.
|
|
5284
5348
|
module TravelRuleCounterpartyScreeningStatusValues
|
|
5285
5349
|
APPROVED = "Approved"
|
|
@@ -5481,6 +5545,25 @@ module Didit
|
|
|
5481
5545
|
VALUES = [INTERNAL_ADDRESS_BOOK, WALLET_ATTRIBUTION, NETWORK_LOOKUP, CUSTOMER_HINT, END_USER].freeze
|
|
5482
5546
|
end
|
|
5483
5547
|
|
|
5548
|
+
# Known values of an open enum: the API may send others.
|
|
5549
|
+
module TravelRuleDocumentContentType
|
|
5550
|
+
APPLICATION_PDF = "application/pdf"
|
|
5551
|
+
|
|
5552
|
+
VALUES = [APPLICATION_PDF].freeze
|
|
5553
|
+
end
|
|
5554
|
+
|
|
5555
|
+
# `questionnaire`: the due-diligence questionnaire answers. `incorporation`: certificate of incorporation.
|
|
5556
|
+
# `licence`: licence or registration. `aml_policy`: AML and CFT policy. `ownership`: ownership structure.
|
|
5557
|
+
module TravelRuleDocumentKind
|
|
5558
|
+
QUESTIONNAIRE = "questionnaire"
|
|
5559
|
+
INCORPORATION = "incorporation"
|
|
5560
|
+
LICENCE = "licence"
|
|
5561
|
+
AML_POLICY = "aml_policy"
|
|
5562
|
+
OWNERSHIP = "ownership"
|
|
5563
|
+
|
|
5564
|
+
VALUES = [QUESTIONNAIRE, INCORPORATION, LICENCE, AML_POLICY, OWNERSHIP].freeze
|
|
5565
|
+
end
|
|
5566
|
+
|
|
5484
5567
|
# The wallet the exchange was routed by. Default `STRICT`.
|
|
5485
5568
|
module TravelRuleMatchingRulesCompanyAccount
|
|
5486
5569
|
NONE = "NONE"
|
|
@@ -5684,6 +5767,21 @@ module Didit
|
|
|
5684
5767
|
VALUES = [DRAFT, SUBMITTED, CHANGES_REQUESTED, APPROVED, REJECTED].freeze
|
|
5685
5768
|
end
|
|
5686
5769
|
|
|
5770
|
+
# Known values of an open enum: the API may send others.
|
|
5771
|
+
module TravelRuleNetworkStateLoadErrorCode
|
|
5772
|
+
NETWORK_STATE_UNAVAILABLE = "network_state_unavailable"
|
|
5773
|
+
|
|
5774
|
+
VALUES = [NETWORK_STATE_UNAVAILABLE].freeze
|
|
5775
|
+
end
|
|
5776
|
+
|
|
5777
|
+
# `error` when this network's row could not be loaded; the other networks are unaffected.
|
|
5778
|
+
module TravelRuleNetworkStateLoadStatus
|
|
5779
|
+
LOADED = "loaded"
|
|
5780
|
+
ERROR = "error"
|
|
5781
|
+
|
|
5782
|
+
VALUES = [LOADED, ERROR].freeze
|
|
5783
|
+
end
|
|
5784
|
+
|
|
5687
5785
|
# own: the application's connected membership is used; didit: Didit's membership carries the application as its
|
|
5688
5786
|
# own active participant; off: platform routing disabled in disabled_networks with no own membership; unavailable:
|
|
5689
5787
|
# nothing can send on this network yet (see state and reason).
|
|
@@ -5924,6 +6022,16 @@ module Didit
|
|
|
5924
6022
|
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
|
|
5925
6023
|
end
|
|
5926
6024
|
|
|
6025
|
+
# COMPLETED when the request was completed; otherwise EXPIRED once expires_at has passed, or PENDING. This is the
|
|
6026
|
+
# request status, not the proof verdict.
|
|
6027
|
+
module TravelRuleTransferProofRequestStatus
|
|
6028
|
+
PENDING = "PENDING"
|
|
6029
|
+
COMPLETED = "COMPLETED"
|
|
6030
|
+
EXPIRED = "EXPIRED"
|
|
6031
|
+
|
|
6032
|
+
VALUES = [PENDING, COMPLETED, EXPIRED].freeze
|
|
6033
|
+
end
|
|
6034
|
+
|
|
5927
6035
|
# Known values of an open enum: the API may send others.
|
|
5928
6036
|
module TravelRuleTransferRowBeneficiaryWalletType
|
|
5929
6037
|
VASP = "vasp"
|
|
@@ -6024,6 +6132,40 @@ module Didit
|
|
|
6024
6132
|
VALUES = [VERIFIED].freeze
|
|
6025
6133
|
end
|
|
6026
6134
|
|
|
6135
|
+
# Proof method, or null when no proof exists.
|
|
6136
|
+
module TravelRuleWalletOwnershipProofMethod
|
|
6137
|
+
MESSAGE_SIGNING = "MESSAGE_SIGNING"
|
|
6138
|
+
SATOSHI_TEST = "SATOSHI_TEST"
|
|
6139
|
+
SCREENSHOT = "SCREENSHOT"
|
|
6140
|
+
SELF_DECLARATION = "SELF_DECLARATION"
|
|
6141
|
+
|
|
6142
|
+
VALUES = [MESSAGE_SIGNING, SATOSHI_TEST, SCREENSHOT, SELF_DECLARATION].freeze
|
|
6143
|
+
end
|
|
6144
|
+
|
|
6145
|
+
# NOT_LINKED when holder_vendor_data is empty; otherwise OWNERSHIP_CHANGED after reassignment without a current
|
|
6146
|
+
# proof; VERIFIED for a current proof on a verified wallet; otherwise the latest REJECTED or EXPIRED status, or
|
|
6147
|
+
# AWAITING_PROOF.
|
|
6148
|
+
module TravelRuleWalletOwnershipProofReuseStatus
|
|
6149
|
+
NOT_LINKED = "NOT_LINKED"
|
|
6150
|
+
OWNERSHIP_CHANGED = "OWNERSHIP_CHANGED"
|
|
6151
|
+
VERIFIED = "VERIFIED"
|
|
6152
|
+
REJECTED = "REJECTED"
|
|
6153
|
+
EXPIRED = "EXPIRED"
|
|
6154
|
+
AWAITING_PROOF = "AWAITING_PROOF"
|
|
6155
|
+
|
|
6156
|
+
VALUES = [NOT_LINKED, OWNERSHIP_CHANGED, VERIFIED, REJECTED, EXPIRED, AWAITING_PROOF].freeze
|
|
6157
|
+
end
|
|
6158
|
+
|
|
6159
|
+
# Proof status, or null when no proof exists.
|
|
6160
|
+
module TravelRuleWalletOwnershipProofStatus
|
|
6161
|
+
PENDING = "PENDING"
|
|
6162
|
+
VERIFIED = "VERIFIED"
|
|
6163
|
+
REJECTED = "REJECTED"
|
|
6164
|
+
EXPIRED = "EXPIRED"
|
|
6165
|
+
|
|
6166
|
+
VALUES = [PENDING, VERIFIED, REJECTED, EXPIRED].freeze
|
|
6167
|
+
end
|
|
6168
|
+
|
|
6027
6169
|
# Why a wallet-ownership proof, or its last attempt, fell short of VERIFIED. Empty when nothing failed. A PENDING
|
|
6028
6170
|
# proof can carry one: the last attempt failed and the end user can try again. DEPOSIT_MISMATCH, DEPOSIT_STALE,
|
|
6029
6171
|
# TXID_REUSED and REVIEW_REJECTED close the proof as REJECTED. SIGNATURE_INVALID: the signature does not match the
|
|
@@ -6035,11 +6177,13 @@ module Didit
|
|
|
6035
6177
|
# this chain. WINDOW_EXPIRED: the test window closed. OWNERSHIP_CHANGED: the wallet's holder changed, or the
|
|
6036
6178
|
# wallet was deleted from your address book, after the widget session was minted. METHOD_SWITCHED: the end user
|
|
6037
6179
|
# picked another method before finishing this one. REVIEW_REJECTED: your reviewer rejected the screenshot.
|
|
6038
|
-
# ABANDONED: the widget session lapsed before the end user finished.
|
|
6180
|
+
# ABANDONED: the widget session lapsed before the end user finished. SIGNATURE_LOOKUP_FAILED: the chain could not
|
|
6181
|
+
# be checked for a smart-contract wallet signature; retry verification.
|
|
6039
6182
|
module TravelRuleWalletProofFailureReason
|
|
6040
6183
|
VALUE = ""
|
|
6041
6184
|
SIGNATURE_INVALID = "SIGNATURE_INVALID"
|
|
6042
6185
|
SIGNATURE_UNSUPPORTED_SCHEME = "SIGNATURE_UNSUPPORTED_SCHEME"
|
|
6186
|
+
SIGNATURE_LOOKUP_FAILED = "SIGNATURE_LOOKUP_FAILED"
|
|
6043
6187
|
DEPOSIT_NOT_FOUND = "DEPOSIT_NOT_FOUND"
|
|
6044
6188
|
DEPOSIT_UNCONFIRMED = "DEPOSIT_UNCONFIRMED"
|
|
6045
6189
|
DEPOSIT_LOOKUP_FAILED = "DEPOSIT_LOOKUP_FAILED"
|
|
@@ -6053,7 +6197,17 @@ module Didit
|
|
|
6053
6197
|
REVIEW_REJECTED = "REVIEW_REJECTED"
|
|
6054
6198
|
ABANDONED = "ABANDONED"
|
|
6055
6199
|
|
|
6056
|
-
VALUES = [VALUE, SIGNATURE_INVALID, SIGNATURE_UNSUPPORTED_SCHEME, DEPOSIT_NOT_FOUND, DEPOSIT_UNCONFIRMED, DEPOSIT_LOOKUP_FAILED, DEPOSIT_MISMATCH, DEPOSIT_STALE, TXID_REUSED, CHAIN_UNSUPPORTED, WINDOW_EXPIRED, OWNERSHIP_CHANGED, METHOD_SWITCHED, REVIEW_REJECTED, ABANDONED].freeze
|
|
6200
|
+
VALUES = [VALUE, SIGNATURE_INVALID, SIGNATURE_UNSUPPORTED_SCHEME, SIGNATURE_LOOKUP_FAILED, DEPOSIT_NOT_FOUND, DEPOSIT_UNCONFIRMED, DEPOSIT_LOOKUP_FAILED, DEPOSIT_MISMATCH, DEPOSIT_STALE, TXID_REUSED, CHAIN_UNSUPPORTED, WINDOW_EXPIRED, OWNERSHIP_CHANGED, METHOD_SWITCHED, REVIEW_REJECTED, ABANDONED].freeze
|
|
6201
|
+
end
|
|
6202
|
+
|
|
6203
|
+
# Known values of an open enum: the API may send others.
|
|
6204
|
+
module TravelRuleWalletProofMethod
|
|
6205
|
+
MESSAGE_SIGNING = "MESSAGE_SIGNING"
|
|
6206
|
+
SATOSHI_TEST = "SATOSHI_TEST"
|
|
6207
|
+
SCREENSHOT = "SCREENSHOT"
|
|
6208
|
+
SELF_DECLARATION = "SELF_DECLARATION"
|
|
6209
|
+
|
|
6210
|
+
VALUES = [MESSAGE_SIGNING, SATOSHI_TEST, SCREENSHOT, SELF_DECLARATION].freeze
|
|
6057
6211
|
end
|
|
6058
6212
|
|
|
6059
6213
|
# Known values of an open enum: the API may send others.
|
|
@@ -6073,6 +6227,36 @@ module Didit
|
|
|
6073
6227
|
VALUES = [PENDING, VERIFIED, REJECTED, EXPIRED].freeze
|
|
6074
6228
|
end
|
|
6075
6229
|
|
|
6230
|
+
# Known values of an open enum: the API may send others.
|
|
6231
|
+
module TravelRuleWalletProofStatus
|
|
6232
|
+
PENDING = "PENDING"
|
|
6233
|
+
VERIFIED = "VERIFIED"
|
|
6234
|
+
REJECTED = "REJECTED"
|
|
6235
|
+
EXPIRED = "EXPIRED"
|
|
6236
|
+
|
|
6237
|
+
VALUES = [PENDING, VERIFIED, REJECTED, EXPIRED].freeze
|
|
6238
|
+
end
|
|
6239
|
+
|
|
6240
|
+
# Proof method, or null when no proof exists.
|
|
6241
|
+
module TravelRuleWalletProofSummaryMethod
|
|
6242
|
+
MESSAGE_SIGNING = "MESSAGE_SIGNING"
|
|
6243
|
+
SATOSHI_TEST = "SATOSHI_TEST"
|
|
6244
|
+
SCREENSHOT = "SCREENSHOT"
|
|
6245
|
+
SELF_DECLARATION = "SELF_DECLARATION"
|
|
6246
|
+
|
|
6247
|
+
VALUES = [MESSAGE_SIGNING, SATOSHI_TEST, SCREENSHOT, SELF_DECLARATION].freeze
|
|
6248
|
+
end
|
|
6249
|
+
|
|
6250
|
+
# Proof status, or null when no proof exists.
|
|
6251
|
+
module TravelRuleWalletProofSummaryStatus
|
|
6252
|
+
PENDING = "PENDING"
|
|
6253
|
+
VERIFIED = "VERIFIED"
|
|
6254
|
+
REJECTED = "REJECTED"
|
|
6255
|
+
EXPIRED = "EXPIRED"
|
|
6256
|
+
|
|
6257
|
+
VALUES = [PENDING, VERIFIED, REJECTED, EXPIRED].freeze
|
|
6258
|
+
end
|
|
6259
|
+
|
|
6076
6260
|
# Known values of an open enum: the API may send others.
|
|
6077
6261
|
module TravelRuleWalletTransferStatus
|
|
6078
6262
|
AWAITING_COUNTERPARTY = "AWAITING_COUNTERPARTY"
|
|
@@ -6376,6 +6560,24 @@ module Didit
|
|
|
6376
6560
|
VALUES = [DIDIT_NETWORK, DIRECTORY, ADDED_BY_YOU].freeze
|
|
6377
6561
|
end
|
|
6378
6562
|
|
|
6563
|
+
# Wallet owner type.
|
|
6564
|
+
module WalletAddressEntryOwnerType
|
|
6565
|
+
CUSTOMER = "customer"
|
|
6566
|
+
INTERNAL = "internal"
|
|
6567
|
+
VASP = "vasp"
|
|
6568
|
+
|
|
6569
|
+
VALUES = [CUSTOMER, INTERNAL, VASP].freeze
|
|
6570
|
+
end
|
|
6571
|
+
|
|
6572
|
+
# Wallet owner type.
|
|
6573
|
+
module WalletAddressEntryUpdateResponseOwnerType
|
|
6574
|
+
CUSTOMER = "customer"
|
|
6575
|
+
INTERNAL = "internal"
|
|
6576
|
+
VASP = "vasp"
|
|
6577
|
+
|
|
6578
|
+
VALUES = [CUSTOMER, INTERNAL, VASP].freeze
|
|
6579
|
+
end
|
|
6580
|
+
|
|
6379
6581
|
# `created`: added to the book. `existing`: the wallet is already in the book and was left untouched. `duplicate`:
|
|
6380
6582
|
# repeats an earlier row of this import. `failed`: see `errors`.
|
|
6381
6583
|
module WalletAddressImportReportRowsStatus
|
|
@@ -6553,6 +6755,13 @@ module Didit
|
|
|
6553
6755
|
VALUES = [V1, V2, V3].freeze
|
|
6554
6756
|
end
|
|
6555
6757
|
|
|
6758
|
+
# Activity type.
|
|
6759
|
+
module WebhookDestinationActivityType
|
|
6760
|
+
FAILURE_ALERT = "failure_alert"
|
|
6761
|
+
|
|
6762
|
+
VALUES = [FAILURE_ALERT].freeze
|
|
6763
|
+
end
|
|
6764
|
+
|
|
6556
6765
|
# Supported webhook event name. Use these exact strings in `subscribed_events`; unsupported values are rejected.
|
|
6557
6766
|
module WebhookEvent
|
|
6558
6767
|
STATUS_UPDATED = "status.updated"
|
|
@@ -7313,6 +7522,53 @@ module Didit
|
|
|
7313
7522
|
field :reached, "reached", :integer
|
|
7314
7523
|
end
|
|
7315
7524
|
|
|
7525
|
+
class AsyncReport < Didit::Model
|
|
7526
|
+
field :uuid, "uuid", :string
|
|
7527
|
+
field :report_type, "report_type", :string
|
|
7528
|
+
field :report_type_display, "report_type_display", :string
|
|
7529
|
+
field :status, "status", :string
|
|
7530
|
+
field :status_display, "status_display", :string
|
|
7531
|
+
field :parameters, "parameters", :any
|
|
7532
|
+
field :requested_by_user_id, "requested_by_user_id", :string
|
|
7533
|
+
field :requested_by_email, "requested_by_email", :string
|
|
7534
|
+
field :requested_by_name, "requested_by_name", :string
|
|
7535
|
+
field :row_count, "row_count", :integer
|
|
7536
|
+
field :failed_item_ids, "failed_item_ids", [:array, :string]
|
|
7537
|
+
field :failed_count, "failed_count", :integer
|
|
7538
|
+
field :file_size, "file_size", :integer
|
|
7539
|
+
field :files, "files", [:array, "AsyncReportFile"]
|
|
7540
|
+
field :scheduled_report, "scheduled_report", :string
|
|
7541
|
+
field :error_message, "error_message", :string
|
|
7542
|
+
field :deletion_pending, "deletion_pending", :boolean
|
|
7543
|
+
field :eta_seconds, "eta_seconds", :integer
|
|
7544
|
+
field :started_at, "started_at", :datetime
|
|
7545
|
+
field :completed_at, "completed_at", :datetime
|
|
7546
|
+
field :expires_at, "expires_at", :datetime
|
|
7547
|
+
field :created_at, "created_at", :datetime
|
|
7548
|
+
field :updated_at, "updated_at", :datetime
|
|
7549
|
+
end
|
|
7550
|
+
|
|
7551
|
+
class AsyncReportFile < Didit::Model
|
|
7552
|
+
field :name, "name", :string
|
|
7553
|
+
field :format, "format", :string
|
|
7554
|
+
field :rows, "rows", :integer
|
|
7555
|
+
field :bytes, "bytes", :integer
|
|
7556
|
+
end
|
|
7557
|
+
|
|
7558
|
+
class AsyncReportList < Didit::Model
|
|
7559
|
+
field :count, "count", :integer
|
|
7560
|
+
field :next, "next", :string
|
|
7561
|
+
field :previous, "previous", :string
|
|
7562
|
+
field :results, "results", [:array, "AsyncReport"]
|
|
7563
|
+
field :counts, "counts", "AsyncReportListCounts"
|
|
7564
|
+
end
|
|
7565
|
+
|
|
7566
|
+
# Counts of all reports the caller can read, before the list filters.
|
|
7567
|
+
class AsyncReportListCounts < Didit::Model
|
|
7568
|
+
field :report_type, "report_type", [:map, :integer]
|
|
7569
|
+
field :status, "status", [:map, :integer]
|
|
7570
|
+
end
|
|
7571
|
+
|
|
7316
7572
|
# Account check: the person types their account number and Didit checks it with the bank. Priced per country.
|
|
7317
7573
|
class BankAccountCheckPricing < Didit::Model
|
|
7318
7574
|
field :available, "available", :boolean
|
|
@@ -12426,6 +12682,7 @@ module Didit
|
|
|
12426
12682
|
field :not_required_reason, "not_required_reason", :string
|
|
12427
12683
|
field :proof_state, "proof_state", :string
|
|
12428
12684
|
field :user_choice, "user_choice", "TravelRuleUserChoice"
|
|
12685
|
+
field :proof_request, "proof_request", "TravelRuleTransferProofRequest"
|
|
12429
12686
|
end
|
|
12430
12687
|
|
|
12431
12688
|
# The counterparty's directory entry, or `null` when the transfer links none.
|
|
@@ -12663,6 +12920,7 @@ module Didit
|
|
|
12663
12920
|
field :not_required_reason, "not_required_reason", :string
|
|
12664
12921
|
field :proof_state, "proof_state", :string
|
|
12665
12922
|
field :user_choice, "user_choice", "TravelRuleUserChoice"
|
|
12923
|
+
field :proof_request, "proof_request", "TravelRuleTransferProofRequest"
|
|
12666
12924
|
end
|
|
12667
12925
|
|
|
12668
12926
|
# The counterparty's directory entry, or `null` when the transfer links none.
|
|
@@ -12727,6 +12985,9 @@ module Didit
|
|
|
12727
12985
|
field :invalid_detail, "invalid_detail", :string
|
|
12728
12986
|
field :invalid_at, "invalid_at", :datetime
|
|
12729
12987
|
field :created_at, "created_at", :datetime
|
|
12988
|
+
field :role, "role", :string
|
|
12989
|
+
field :phone, "phone", :string
|
|
12990
|
+
field :receives_requests, "receives_requests", :boolean
|
|
12730
12991
|
end
|
|
12731
12992
|
|
|
12732
12993
|
# Your application's decision on a counterparty VASP. Private to your application: it never changes the shared
|
|
@@ -12765,6 +13026,16 @@ module Didit
|
|
|
12765
13026
|
field :valid_until, "valid_until", :datetime
|
|
12766
13027
|
field :current, "current", :boolean
|
|
12767
13028
|
field :answers, "answers", [:map, :string]
|
|
13029
|
+
field :requested_items, "requested_items", [:array, :string]
|
|
13030
|
+
field :reminder_sent_at, "reminder_sent_at", :datetime
|
|
13031
|
+
field :documents, "documents", [:array, "TravelRuleCounterpartyQuestionnaireDocuments"]
|
|
13032
|
+
end
|
|
13033
|
+
|
|
13034
|
+
class TravelRuleCounterpartyQuestionnaireDocuments < Didit::Model
|
|
13035
|
+
field :id, "id", :string
|
|
13036
|
+
field :name, "name", :string
|
|
13037
|
+
field :kind, "kind", :string
|
|
13038
|
+
field :received_at, "received_at", :datetime
|
|
12768
13039
|
end
|
|
12769
13040
|
|
|
12770
13041
|
class TravelRuleCounterpartyQuestionnaireList < Didit::Model
|
|
@@ -12781,6 +13052,29 @@ module Didit
|
|
|
12781
13052
|
field :screened_at, "screened_at", :datetime
|
|
12782
13053
|
field :fresh, "fresh", :boolean
|
|
12783
13054
|
field :flagged, "flagged", :boolean
|
|
13055
|
+
field :scope, "scope", :string
|
|
13056
|
+
field :people_screening, "people_screening", "TravelRuleCounterpartyScreeningPeopleScreening"
|
|
13057
|
+
field :hits, "hits", [:array, "TravelRuleCounterpartyScreeningHits"]
|
|
13058
|
+
end
|
|
13059
|
+
|
|
13060
|
+
class TravelRuleCounterpartyScreeningHits < Didit::Model
|
|
13061
|
+
field :id, "id", :string
|
|
13062
|
+
field :review, "review", "TravelRuleCounterpartyScreeningHitsReview"
|
|
13063
|
+
field :dismissed, "dismissed", :boolean
|
|
13064
|
+
end
|
|
13065
|
+
|
|
13066
|
+
# The review recorded for the hit, or null while nobody reviewed it.
|
|
13067
|
+
class TravelRuleCounterpartyScreeningHitsReview < Didit::Model
|
|
13068
|
+
field :status, "status", :string
|
|
13069
|
+
field :reason, "reason", :string
|
|
13070
|
+
field :reviewed_by, "reviewed_by", :string
|
|
13071
|
+
field :reviewed_at, "reviewed_at", :datetime
|
|
13072
|
+
end
|
|
13073
|
+
|
|
13074
|
+
# People screening is not run for counterparties.
|
|
13075
|
+
class TravelRuleCounterpartyScreeningPeopleScreening < Didit::Model
|
|
13076
|
+
field :status, "status", :string
|
|
13077
|
+
field :reason, "reason", :string
|
|
12784
13078
|
end
|
|
12785
13079
|
|
|
12786
13080
|
class TravelRuleCounterpartyScreeningResult < Didit::Model
|
|
@@ -12825,6 +13119,14 @@ module Didit
|
|
|
12825
13119
|
field :actor, "actor", :string
|
|
12826
13120
|
end
|
|
12827
13121
|
|
|
13122
|
+
class TravelRuleDecisionEvent < Didit::Model
|
|
13123
|
+
field :id, "id", :string
|
|
13124
|
+
field :decision, "decision", :string
|
|
13125
|
+
field :reason, "reason", :string
|
|
13126
|
+
field :actor, "actor", :string
|
|
13127
|
+
field :created_at, "created_at", :datetime
|
|
13128
|
+
end
|
|
13129
|
+
|
|
12828
13130
|
# Where the latest message the transfer owes the other side stands. Didit contacts the counterparty after the
|
|
12829
13131
|
# request that created or changed the transfer has returned, so this object says whether that message got through:
|
|
12830
13132
|
# queued, being sent, waiting to be retried after an error, delivered, or failed. A failure the network may still
|
|
@@ -12894,6 +13196,21 @@ module Didit
|
|
|
12894
13196
|
field :at, "at", :datetime
|
|
12895
13197
|
end
|
|
12896
13198
|
|
|
13199
|
+
# A PDF document. Never carries the file content.
|
|
13200
|
+
class TravelRuleDocument < Didit::Model
|
|
13201
|
+
field :id, "id", :string
|
|
13202
|
+
field :name, "name", :string
|
|
13203
|
+
field :kind, "kind", :string
|
|
13204
|
+
field :uploaded_at, "uploaded_at", :datetime
|
|
13205
|
+
field :received_at, "received_at", :datetime
|
|
13206
|
+
field :content_type, "content_type", :string
|
|
13207
|
+
end
|
|
13208
|
+
|
|
13209
|
+
class TravelRuleDocumentShare < Didit::Model
|
|
13210
|
+
field :shared_with, "shared_with", :string
|
|
13211
|
+
field :url, "url", :string
|
|
13212
|
+
end
|
|
13213
|
+
|
|
12897
13214
|
class TravelRuleInboundResponse < Didit::Model
|
|
12898
13215
|
field :transaction_id, "transaction_id", :string
|
|
12899
13216
|
field :txn_id, "txn_id", :string
|
|
@@ -12989,6 +13306,8 @@ module Didit
|
|
|
12989
13306
|
field :suspended_at, "suspended_at", :datetime
|
|
12990
13307
|
field :last_error, "last_error", :string
|
|
12991
13308
|
field :history, "history", [:array, "TravelRuleNetworkParticipantHistory"]
|
|
13309
|
+
field :notify_status_changes, "notify_status_changes", :boolean
|
|
13310
|
+
field :notification_email, "notification_email", :string
|
|
12992
13311
|
end
|
|
12993
13312
|
|
|
12994
13313
|
class TravelRuleNetworkParticipantHistory < Didit::Model
|
|
@@ -13066,6 +13385,14 @@ module Didit
|
|
|
13066
13385
|
field :participant, "participant", "TravelRuleNetworkParticipantSummary"
|
|
13067
13386
|
field :vasps_reachable, "vasps_reachable", :integer
|
|
13068
13387
|
field :routed_30d, "routed_30d", :integer
|
|
13388
|
+
field :load_status, "load_status", :string
|
|
13389
|
+
field :load_error, "load_error", "TravelRuleNetworkStateLoadError"
|
|
13390
|
+
end
|
|
13391
|
+
|
|
13392
|
+
# Present only when `load_status` is `error`.
|
|
13393
|
+
class TravelRuleNetworkStateLoadError < Didit::Model
|
|
13394
|
+
field :code, "code", :string
|
|
13395
|
+
field :retryable, "retryable", :boolean
|
|
13069
13396
|
end
|
|
13070
13397
|
|
|
13071
13398
|
class TravelRuleNetworksOverview < Didit::Model
|
|
@@ -13073,6 +13400,7 @@ module Didit
|
|
|
13073
13400
|
field :questionnaire, "questionnaire", "TravelRuleNetworkQuestionnaire"
|
|
13074
13401
|
field :participants, "participants", [:array, "TravelRuleNetworkParticipant"]
|
|
13075
13402
|
field :networks, "networks", "TravelRuleNetworksOverviewNetworks"
|
|
13403
|
+
field :notification_email, "notification_email", :string
|
|
13076
13404
|
end
|
|
13077
13405
|
|
|
13078
13406
|
# Per network, how this application would send and why it cannot. No network, including GTR, is included by
|
|
@@ -13191,6 +13519,7 @@ module Didit
|
|
|
13191
13519
|
field :cancelled_by, "cancelled_by", :string
|
|
13192
13520
|
field :notify_on_answer, "notify_on_answer", :boolean
|
|
13193
13521
|
field :user_choice, "user_choice", "TravelRuleUserChoice"
|
|
13522
|
+
field :proof_request, "proof_request", "TravelRuleTransferProofRequest"
|
|
13194
13523
|
end
|
|
13195
13524
|
|
|
13196
13525
|
class TravelRuleTransferDetailCounterpartyVasp < Didit::Model
|
|
@@ -13216,6 +13545,13 @@ module Didit
|
|
|
13216
13545
|
field :reason, "reason", :string
|
|
13217
13546
|
end
|
|
13218
13547
|
|
|
13548
|
+
class TravelRuleTransferProofRequest < Didit::Model
|
|
13549
|
+
field :request_id, "request_id", :string
|
|
13550
|
+
field :status, "status", :string
|
|
13551
|
+
field :expires_at, "expires_at", :datetime
|
|
13552
|
+
field :proof, "proof", "TravelRuleWalletProof"
|
|
13553
|
+
end
|
|
13554
|
+
|
|
13219
13555
|
# One Travel Rule transfer as the transfers list shows it: VASP names, wallets, memos, the transaction's review
|
|
13220
13556
|
# decision, your own end user's name (masked exactly as the transaction detail masks it), the counterparty VASP's
|
|
13221
13557
|
# jurisdiction, the chain and the fiat amount. It never carries the counterparty's person data.
|
|
@@ -13276,6 +13612,21 @@ module Didit
|
|
|
13276
13612
|
field :vout, "vout", :integer
|
|
13277
13613
|
end
|
|
13278
13614
|
|
|
13615
|
+
# The member the VASP is assigned to, or null. The assignment is private to your application.
|
|
13616
|
+
class TravelRuleVaspAssignee < Didit::Model
|
|
13617
|
+
field :uuid, "uuid", :string
|
|
13618
|
+
field :full_name, "full_name", :string
|
|
13619
|
+
field :email, "email", :string
|
|
13620
|
+
field :assigned_at, "assigned_at", :datetime
|
|
13621
|
+
end
|
|
13622
|
+
|
|
13623
|
+
class TravelRuleVaspReviewer < Didit::Model
|
|
13624
|
+
field :user_id, "user_id", :string
|
|
13625
|
+
field :email, "email", :string
|
|
13626
|
+
field :name, "name", :string
|
|
13627
|
+
field :role, "role", :string
|
|
13628
|
+
end
|
|
13629
|
+
|
|
13279
13630
|
class TravelRuleWalletLookup < Didit::Model
|
|
13280
13631
|
field :match, "match", :string
|
|
13281
13632
|
field :directory_checked, "directory_checked", :boolean
|
|
@@ -13284,6 +13635,47 @@ module Didit
|
|
|
13284
13635
|
field :proof_state, "proof_state", :string
|
|
13285
13636
|
end
|
|
13286
13637
|
|
|
13638
|
+
# Current valid proof, preferring the most recently verified proof; otherwise the latest attempt. A failed retry
|
|
13639
|
+
# does not replace a current valid proof. This metadata is read-only.
|
|
13640
|
+
class TravelRuleWalletOwnershipProof < Didit::Model
|
|
13641
|
+
field :proof_id, "proof_id", :string
|
|
13642
|
+
field :method_, "method", :string
|
|
13643
|
+
field :status, "status", :string
|
|
13644
|
+
field :failure_reason, "failure_reason", :string
|
|
13645
|
+
field :latest_attempt, "latest_attempt", "TravelRuleWalletProofSummary"
|
|
13646
|
+
field :network_eligible, "network_eligible", :boolean
|
|
13647
|
+
field :reuse_status, "reuse_status", :string
|
|
13648
|
+
end
|
|
13649
|
+
|
|
13650
|
+
# Proof attached to a transfer request. Supports every ownership method; screenshot-only metadata can be null.
|
|
13651
|
+
# Review history, notes and decision attribution remain available.
|
|
13652
|
+
class TravelRuleWalletProof < Didit::Model
|
|
13653
|
+
field :proof_id, "proof_id", :string
|
|
13654
|
+
field :method_, "method", :string
|
|
13655
|
+
field :status, "status", :string
|
|
13656
|
+
field :wallet_address, "wallet_address", :string
|
|
13657
|
+
field :chain, "chain", :string
|
|
13658
|
+
field :holder_name, "holder_name", :string
|
|
13659
|
+
field :is_ownership_verified, "is_ownership_verified", :boolean
|
|
13660
|
+
field :transaction_id, "transaction_id", :string
|
|
13661
|
+
field :file_name, "file_name", :string
|
|
13662
|
+
field :content_type, "content_type", :string
|
|
13663
|
+
field :screenshot_url, "screenshot_url", :string
|
|
13664
|
+
field :attempts, "attempts", :integer
|
|
13665
|
+
field :failure_reason, "failure_reason", :string
|
|
13666
|
+
field :method_chosen_at, "method_chosen_at", :datetime
|
|
13667
|
+
field :decided_at, "decided_at", :datetime
|
|
13668
|
+
field :decided_by, "decided_by", :string
|
|
13669
|
+
field :review_note, "review_note", :string
|
|
13670
|
+
field :created_at, "created_at", :datetime
|
|
13671
|
+
field :application_id, "application_id", :string
|
|
13672
|
+
field :user_id, "user_id", :string
|
|
13673
|
+
field :holder_vendor_data, "holder_vendor_data", :string
|
|
13674
|
+
field :wallet_label, "wallet_label", :string
|
|
13675
|
+
end
|
|
13676
|
+
|
|
13677
|
+
# Uploaded screenshot proof returned by the review queue and decision endpoint. Submitter attribution is
|
|
13678
|
+
# independent of the current wallet holder.
|
|
13287
13679
|
class TravelRuleWalletProofReview < Didit::Model
|
|
13288
13680
|
field :proof_id, "proof_id", :string
|
|
13289
13681
|
field :method_, "method", :string
|
|
@@ -13303,6 +13695,29 @@ module Didit
|
|
|
13303
13695
|
field :decided_by, "decided_by", :string
|
|
13304
13696
|
field :review_note, "review_note", :string
|
|
13305
13697
|
field :created_at, "created_at", :datetime
|
|
13698
|
+
field :application_id, "application_id", :string
|
|
13699
|
+
field :user_id, "user_id", :string
|
|
13700
|
+
field :holder_vendor_data, "holder_vendor_data", :string
|
|
13701
|
+
field :wallet_label, "wallet_label", :string
|
|
13702
|
+
end
|
|
13703
|
+
|
|
13704
|
+
class TravelRuleWalletProofSummary < Didit::Model
|
|
13705
|
+
field :proof_id, "proof_id", :string
|
|
13706
|
+
field :method_, "method", :string
|
|
13707
|
+
field :status, "status", :string
|
|
13708
|
+
field :failure_reason, "failure_reason", :string
|
|
13709
|
+
end
|
|
13710
|
+
|
|
13711
|
+
# Exact totals over the entire application-scoped wallet set before limit/offset pagination. Method counts overlap
|
|
13712
|
+
# and must not be summed to obtain distinct verified wallets.
|
|
13713
|
+
class TravelRuleWalletProofTotals < Didit::Model
|
|
13714
|
+
field :wallets, "wallets", :integer
|
|
13715
|
+
field :customer_wallets, "customer_wallets", :integer
|
|
13716
|
+
field :verified_control_wallets, "verified_control_wallets", :integer
|
|
13717
|
+
field :message_signing, "MESSAGE_SIGNING", :integer
|
|
13718
|
+
field :satoshi_test, "SATOSHI_TEST", :integer
|
|
13719
|
+
field :screenshot, "SCREENSHOT", :integer
|
|
13720
|
+
field :self_declaration, "SELF_DECLARATION", :integer
|
|
13306
13721
|
end
|
|
13307
13722
|
|
|
13308
13723
|
class TravelRuleWalletTransfer < Didit::Model
|
|
@@ -13469,6 +13884,7 @@ module Didit
|
|
|
13469
13884
|
field :entity_screening, "entity_screening", "TravelRuleCounterpartyScreening"
|
|
13470
13885
|
field :questionnaires, "questionnaires", [:array, "TravelRuleCounterpartyQuestionnaire"]
|
|
13471
13886
|
field :source, "source", :string
|
|
13887
|
+
field :assignee, "assignee", "TravelRuleVaspAssignee"
|
|
13472
13888
|
end
|
|
13473
13889
|
|
|
13474
13890
|
class VaspDirectoryEntryAliases < Didit::Model
|
|
@@ -13579,15 +13995,22 @@ module Didit
|
|
|
13579
13995
|
field :address_hash, "address_hash", :string
|
|
13580
13996
|
field :memo, "memo", :string
|
|
13581
13997
|
field :receiving_travel_address, "receiving_travel_address", :string
|
|
13998
|
+
field :ownership_proof, "ownership_proof", "TravelRuleWalletOwnershipProof"
|
|
13999
|
+
field :label, "label", :string
|
|
14000
|
+
field :owner_type, "owner_type", :string
|
|
13582
14001
|
end
|
|
13583
14002
|
|
|
13584
|
-
#
|
|
13585
|
-
#
|
|
13586
|
-
class
|
|
14003
|
+
# Updated holder metadata and read-only ownership metadata. This is a partial wallet representation, not the full
|
|
14004
|
+
# list/create entry.
|
|
14005
|
+
class WalletAddressEntryUpdateResponse < Didit::Model
|
|
13587
14006
|
field :holder_name, "holder_name", :string
|
|
13588
14007
|
field :holder_vendor_data, "holder_vendor_data", :string
|
|
13589
14008
|
field :entity_type, "entity_type", :string
|
|
13590
14009
|
field :travel_address, "travel_address", :string
|
|
14010
|
+
field :receiving_travel_address, "receiving_travel_address", :string
|
|
14011
|
+
field :label, "label", :string
|
|
14012
|
+
field :owner_type, "owner_type", :string
|
|
14013
|
+
field :ownership_proof, "ownership_proof", "TravelRuleWalletOwnershipProof"
|
|
13591
14014
|
end
|
|
13592
14015
|
|
|
13593
14016
|
# What happened to each row of an import, in the order sent.
|
|
@@ -13746,6 +14169,20 @@ module Didit
|
|
|
13746
14169
|
field :updated_at, "updated_at", :datetime
|
|
13747
14170
|
end
|
|
13748
14171
|
|
|
14172
|
+
class WebhookDestinationActivity < Didit::Model
|
|
14173
|
+
field :id, "id", :string
|
|
14174
|
+
field :type, "type", :string
|
|
14175
|
+
field :occurred_at, "occurred_at", :datetime
|
|
14176
|
+
field :failure_count, "failure_count", :integer
|
|
14177
|
+
end
|
|
14178
|
+
|
|
14179
|
+
class WebhookDestinationActivityList < Didit::Model
|
|
14180
|
+
field :count, "count", :integer
|
|
14181
|
+
field :next, "next", :string
|
|
14182
|
+
field :previous, "previous", :string
|
|
14183
|
+
field :results, "results", [:array, "WebhookDestinationActivity"]
|
|
14184
|
+
end
|
|
14185
|
+
|
|
13749
14186
|
# One delivery attempt to a webhook destination. The first send of an event, each automatic retry and each resend
|
|
13750
14187
|
# are separate deliveries.
|
|
13751
14188
|
class WebhookDestinationDelivery < Didit::Model
|